Struct entity_data::EntityStorage

pub struct EntityStorage { /* private fields */ }

A container of entities.

Implementations

impl EntityStorage

pub fn new(layout: &EntityStorageLayout) -> EntityStorage

Creates an empty EntityStorage.

pub fn add_entity<const N: usize, const D: usize>(
    &mut self,
    archetype_id: u32,
    state: EntityState<N, D>
) -> EntityId

Builds a new entity and returns its identifier.

Panics

• if specified archetype is not found;
• if specified component types != archetype component types;

pub fn get_archetype(&self, id: u32) -> Option<&Archetype>

Returns a reference to the specified archetype.

pub fn get_archetype_mut(&mut self, id: u32) -> Option<&mut Archetype>

Returns a mutable reference to the specified archetype.

pub fn get<C: 'static>(&self, entity: &EntityId) -> Option<&C>

Returns a reference to the component C of the specified entity.

pub fn get_mut<C: 'static>(&mut self, entity: &EntityId) -> Option<&mut C>

Returns a mutable reference to the component C of the specified entity.

pub fn remove(&mut self, entity: &EntityId) -> bool

Removes an entity from the storage. Returns true if the entity was present in the storage.

pub fn len(&mut self) -> usize

Returns the number of entities in the storage.