Enum weasel::entity::EntityId

pub enum EntityId<R: BattleRules> {
    Creature(CreatureId<R>),
    Object(ObjectId<R>),
}

Id to uniquely identify an entity. EntityId is used as global id to identify entities in the game world regardless of their type.

Variants

Creature(CreatureId<R>)

Standard creature.

Object(ObjectId<R>)

Inanimate object.

Implementations

impl<R: BattleRules> EntityId<R>

pub fn is_character(&self) -> bool

Returns whether this entity id refers to an object that satisfies the Character trait.

pub fn is_actor(&self) -> bool

Returns whether this entity id refers to an object that satisfies the Actor trait.

pub fn creature(&self) -> WeaselResult<CreatureId<R>, R>

Extracts a creature id out of this entity id.

Returns an error if the entity id's type is not Creature.

pub fn object(&self) -> WeaselResult<ObjectId<R>, R>

Extracts an object id out of this entity id.

Returns an error if the entity id's type is not Object.

Trait Implementations

impl<R: BattleRules> Clone for EntityId<R>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: BattleRules> Copy for EntityId<R> where
    CreatureId<R>: Copy,
    ObjectId<R>: Copy, 

impl<R: BattleRules> Debug for EntityId<R>

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

Formats the value using the given formatter.

impl<'de, R: BattleRules> Deserialize<'de> for EntityId<R> where
    CreatureId<R>: Deserialize<'de>,
    ObjectId<R>: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<R: BattleRules> Display for EntityId<R> where
    CreatureId<R>: Display,
    ObjectId<R>: Display, 

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

Formats the value using the given formatter.

impl<R: BattleRules> Eq for EntityId<R>

impl<R: BattleRules> Hash for EntityId<R>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<R: BattleRules> PartialEq<EntityId<R>> for EntityId<R>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<R: BattleRules> Serialize for EntityId<R> where
    CreatureId<R>: Serialize,
    ObjectId<R>: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.