Struct veloren_common::uid::IdMaps

pub struct IdMaps {
    uid_mapping: HashMap<Uid, Entity>,
    uid_allocator: UidAllocator,
    character_to_ecs: HashMap<CharacterId, Entity>,
    rtsim_to_ecs: HashMap<RtSimEntity, Entity>,
}

Mappings from various Id types to Entitys.

Fields

uid_mapping: HashMap<Uid, Entity>

“Universal” IDs (used to communicate entity identity over the network).

uid_allocator: UidAllocator

character_to_ecs: HashMap<CharacterId, Entity>

Character IDs.

rtsim_to_ecs: HashMap<RtSimEntity, Entity>

Rtsim Entities.

Implementations

impl IdMaps

pub fn new() -> Self

pub fn uid_entity(&self, id: Uid) -> Option<Entity>

Given a Uid retrieve the corresponding Entity.

pub fn character_entity(&self, id: CharacterId) -> Option<Entity>

Given a CharacterId retrieve the corresponding Entity.

pub fn rtsim_entity(&self, id: RtSimEntity) -> Option<Entity>

Given a RtSimEntity retrieve the corresponding Entity.

pub fn remove_entity( &mut self, expected_entity: Option<Entity>, uid: Option<Uid>, cid: Option<CharacterId>, rid: Option<RtSimEntity> ) -> Option<Entity>

Removes mappings for the provided Id(s).

Returns the Entity that the provided Uid was mapped to.

Used on both the client and the server when deleting entities, although the client only ever provides a Some value for the Uid parameter since the other mappings are not used on the client.

pub fn add_entity(&mut self, uid: Uid, entity: Entity)

Only used on the client (server solely uses Self::allocate to allocate and add Uid mappings and Self::remap to move the Uid to a different entity).

pub fn add_character(&mut self, cid: CharacterId, entity: Entity)

Only used on the server.

pub fn add_rtsim(&mut self, rid: RtSimEntity, entity: Entity)

Only used on the server.

pub fn allocate(&mut self, entity: Entity) -> Uid

Allocates a new Uid and links it to the provided entity.

Only used on the server.

pub fn remap_entity(&mut self, uid: Uid, new_entity: Entity)

Links an existing Uid to a new entity.

Only used on the server.

Used for handle_exit_ingame which moves the same Uid to a new entity.

fn already_present<ID>()

fn insert<ID: Hash + Eq>( mapping: &mut HashMap<ID, Entity>, new_id: ID, entity: Entity )

Trait Implementations

impl Debug for IdMaps

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for IdMaps

fn default() -> IdMaps

Returns the “default value” for a type.