Struct plank_ecs::Entities

pub struct Entities { /* fields omitted */ }

Holds a list of alive entities. It also holds a list of entities that were recently killed, which allows to remove components of deleted entities at the end of a game frame.

Implementations

impl Entities

pub fn create(&mut self) -> Entity

Creates a new Entity and returns it. This function will not reuse the index of an entity that is still in the killed entities.

pub fn is_alive(&self, entity: Entity) -> bool

Checks if the Entity is still alive. Returns true if it is alive. Returns false if it has been killed.

pub fn kill(&mut self, entity: Entity)

Kill an entity.

pub fn killed(&self) -> &Vec<Entity, Global>

Returns entities in the killed list.

pub fn clear_killed(&mut self)

Clears the killed entity list.

pub fn bitset(&self) -> &Vec<[u32; 8], Global>

Returns a bitset where each index where the bit is set to 1 indicates the index of an alive entity. Useful for joining over Entity and Component<T> at the same time.

pub fn iter_with_bitset(
    &'a self,
    bitset: Rc<Vec<[u32; 8], Global>>
) -> EntityIterator<'a>

Iterates over entities using the provided bitset.

Trait Implementations

impl Default for Entities

pub fn default() -> Entities

Returns the “default value” for a type.