Struct Entities

pub struct Entities<R: BattleRules> { /* private fields */ }

Data structure to manage ownership of teams and entities.

Implementations

impl<R: BattleRules> Entities<R>

pub fn creatures(&self) -> impl Iterator<Item = &Creature<R>>

Returns an iterator over creatures.

pub fn creatures_mut(&mut self) -> impl Iterator<Item = &mut Creature<R>>

Returns a mutable iterator over creatures.

pub fn creature(&self, id: &CreatureId<R>) -> Option<&Creature<R>>

Returns the creature with the given id.

pub fn creature_mut(&mut self, id: &CreatureId<R>) -> Option<&mut Creature<R>>

Returns a mutable reference to the creature with the given id.

pub fn objects(&self) -> impl Iterator<Item = &Object<R>>

Returns an iterator over objects.

pub fn objects_mut(&mut self) -> impl Iterator<Item = &mut Object<R>>

Returns a mutable iterator over objects.

pub fn object(&self, id: &ObjectId<R>) -> Option<&Object<R>>

Returns the object with the given id.

pub fn object_mut(&mut self, id: &ObjectId<R>) -> Option<&mut Object<R>>

Returns a mutable reference to the object with the given id.

pub fn teams(&self) -> impl Iterator<Item = &Team<R>>

Returns an iterator over teams.

pub fn teams_mut(&mut self) -> impl Iterator<Item = &mut Team<R>>

Returns a mutable iterator over teams.

pub fn team(&self, id: &TeamId<R>) -> Option<&Team<R>>

Returns the team with the given id.

pub fn team_mut(&mut self, id: &TeamId<R>) -> Option<&mut Team<R>>

Returns a mutable reference to the team with the given id.

pub fn entities(&self) -> impl Iterator<Item = &dyn Entity<R>>

Returns an iterator over entities.

pub fn entities_mut(&mut self) -> impl Iterator<Item = &mut dyn Entity<R>>

Returns a mutable iterator over entities.

pub fn entity(&self, id: &EntityId<R>) -> Option<&dyn Entity<R>>

Returns the entity with the given id.

pub fn entity_mut(&mut self, id: &EntityId<R>) -> Option<&mut dyn Entity<R>>

Returns a mutable reference to the entity with the given id.

pub fn characters(&self) -> impl Iterator<Item = &dyn Character<R>>

Returns an iterator over characters.

pub fn characters_mut(&mut self) -> impl Iterator<Item = &mut dyn Character<R>>

Returns a mutable iterator over characters.

pub fn character(&self, id: &EntityId<R>) -> Option<&dyn Character<R>>

Returns the character with the given id.

pub fn character_mut( &mut self, id: &EntityId<R>, ) -> Option<&mut dyn Character<R>>

Returns a mutable reference to the character with the given id.

pub fn actors(&self) -> impl Iterator<Item = &dyn Actor<R>>

Returns an iterator over actors.

pub fn actors_mut(&mut self) -> impl Iterator<Item = &mut dyn Actor<R>>

Returns a mutable iterator over actors.

pub fn actor(&self, id: &EntityId<R>) -> Option<&dyn Actor<R>>

Returns the character with the given id.

pub fn actor_mut(&mut self, id: &EntityId<R>) -> Option<&mut dyn Actor<R>>

Returns a mutable reference to the actor with the given id.

pub fn relation( &self, first: &TeamId<R>, second: &TeamId<R>, ) -> Option<Relation>

Returns the Relation between two teams. Relations are symmetric.

The relation of a team towards itself is Kin.

pub fn allies_id<'a>( &'a self, id: &'a TeamId<R>, ) -> impl Iterator<Item = TeamId<R>> + 'a

Returns all allied teams’ id of a team.

pub fn allies<'a>( &'a self, id: &'a TeamId<R>, ) -> impl Iterator<Item = &Team<R>> + 'a

Returns all allied teams of a team.

pub fn enemies_id<'a>( &'a self, id: &'a TeamId<R>, ) -> impl Iterator<Item = TeamId<R>> + 'a

Returns all enemy teams’ id of a team.

pub fn enemies<'a>( &'a self, id: &'a TeamId<R>, ) -> impl Iterator<Item = &Team<R>> + 'a

Returns all enemy teams of a team.

pub fn victorious(&self) -> impl Iterator<Item = &Team<R>>

Returns all victorious teams.

pub fn victorious_id(&self) -> impl Iterator<Item = TeamId<R>> + '_

Returns the id of all victorious teams.

pub fn defeated(&self) -> impl Iterator<Item = &Team<R>>

Returns all defeated teams.

pub fn defeated_id(&self) -> impl Iterator<Item = TeamId<R>> + '_

Returns the id of all defeated teams.