Struct shard_ecs::Registry

pub struct Registry { /* fields omitted */ }

The main Registry of the ECS. Essentially an instance of the ECS. Systems in this ECS implementation are implicit, meaning anything can be a system as decided by the user.

Implementations

impl Registry

pub fn collections(&mut self) -> &mut [ArchetypePoolCollection]

pub fn scatter_pools(&mut self)

Internal function which scatters the pools of each archetype collection.

pub fn add_entity<'c, C: ComponentGroup<'c>>(
    &mut self,
    components: C
) -> Result<Entity, (C, ECSError)>

Adds a new entity to the Registry, constructed of the components in the given componentgroup instance.

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

Erases an existing entity, dropping it’s components. Returns true if succeeded.

pub fn remove_entity<'a, G: ComponentGroup<'a>>(
    &mut self,
    entity: Entity
) -> Option<G>

Only removes an entity if it exactly matches the components. Otherwise the entity is not removed. Returns the components of the entity if removal was succesfull.

pub fn add_component<C: Component>(
    &mut self,
    entity: Entity,
    component: C
) -> Result<(), (C, ECSError)>

Adds a component instance to the given entity. Fails, returning the component, if allocation fails, already contains the given type, or the entity already has max amount of components. Also fails if given entity handle is invalid.

pub fn remove_component<C: Component>(
    &mut self,
    entity: Entity
) -> Result<C, ECSError>

Removes a component instance from the given entity. Fails if such entity does not exist. Also fails if entity cannot be moved due to allocation failure.

pub fn erase_component<C: Component>(
    &mut self,
    entity: Entity
) -> Result<(), ECSError>

Erases a component instance from the given entity. Fails if such entity does not exist. Essentially the same as remove_component, but drops the component instead of returning it. Also fails if entity cannot be moved due to allocation failure.

pub fn get_component<C: Component>(
    &self,
    entity: Entity
) -> Option<<C::Allocator as ComponentAllocator<'_, C>>::RefType>

Returns a reference to a entity’s component of type C, if the entity contains such component.

pub fn get_component_mut<C: Component>(
    &mut self,
    entity: Entity
) -> Option<<C::Allocator as ComponentAllocator<'_, C>>::MutRefType>

Returns a mutable reference to a entity’s component of type C, if the entity contains such component.

pub fn get_components<'r, G: ComponentGroup<'r>>(
    &self,
    _entity: Entity
) -> Option<G::RefTuple>

Returns a reference to a entity’s components of types G, if the entity contains such components.

pub fn get_components_mut<'r, G: ComponentGroup<'r>>(
    &mut self,
    _entity: Entity
) -> Option<G::MutRefTuple>

Returns a reference to a entity’s components of types G, if the entity contains such components.

pub fn iter_components_exact<'r, G: ComponentGroup<'r>>(
    &'r self
) -> ComponentIteratorExact<'_, G>

Returns an iterator over all entities containing exactly and only the given component types.

pub fn iter_components_exact_mut<'r, G: ComponentGroup<'r>>(
    &'r mut self
) -> ComponentIteratorExactMut<'_, G>

Returns a mutable iterator over all entities containing exactly and only the given component types.

pub fn iter_components<'r, G: ComponentGroup<'r>>(
    &'r self
) -> ComponentIterator<'r, G>

Returns an iterator over all entities containing the given component types.

pub fn iter_components_mut<'r, G: ComponentGroup<'r>>(
    &'r mut self
) -> ComponentIterator<'r, G>

Returns an iterator over all entities containing the given component types.

Trait Implementations

impl Debug for Registry

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

Formats the value using the given formatter.