Struct entity_data::archetype::ArchetypeStorage

pub struct ArchetypeStorage { /* private fields */ }

A collection of entities with unique combination of components. An archetype can hold a maximum of 2^32-1 entities.

Implementations

impl ArchetypeStorage

pub fn add_entity<S>(&mut self, state: S) -> u32where S: ArchetypeState,

Creates a new entity and returns its identifier.

pub fn contains(&self, entity_id: ArchEntityId) -> bool

Returns true if the archetype contains the specified entity.

pub fn component<C: Component>(&self) -> Option<ComponentStorageRef<'_, C>>

pub fn component_mut<C: Component>( &mut self ) -> Option<ComponentStorageMut<'_, C>>

pub fn get<C: Component>(&self, entity_id: ArchEntityId) -> Option<&C>

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

pub fn get_mut<C: Component>( &mut self, entity_id: ArchEntityId ) -> Option<&mut C>

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

pub fn get_state<S: StaticArchetype>( &self, entity_id: ArchEntityId ) -> Option<&S>

Returns a reference to the state at entity_id. Panics if TypeId of S != self.ty().

pub fn get_state_mut<S: StaticArchetype>( &mut self, entity_id: ArchEntityId ) -> Option<&mut S>

Returns a mutable reference to the state at entity_id. Panics if TypeId of S != self.ty().

pub fn iter_component_infos(&self) -> impl Iterator<Item = &ComponentInfo>

Returns iterator of archetype constituent components.

pub fn count_entities(&self) -> usize

Returns the number of entities in the archetype.

pub fn ty(&self) -> &TypeId

Returns the TypeId of a single state in this archetype.

Trait Implementations

impl Drop for ArchetypeStorage

fn drop(&mut self)

Executes the destructor for this type.

impl Sync for ArchetypeStorage