Struct dces::prelude::ComponentStore

pub struct ComponentStore { /* private fields */ }

The ComponentStore stores the components of entities and uses strings as component keys. It could be used to borrow the components of the entities.

Implementations

impl ComponentStore

pub fn append(
    &mut self,
    entity: Entity,
    components: (BuildComponents, BuildSharedComponents)
)

Appends the given components to the entity.

pub fn remove_entity(&mut self, entity: impl Into<Entity>)

Removes and entity from the store.

pub fn print_entity(&self, entity: impl Into<Entity>)

Print infos about the given entity.

pub fn entities_of_component(
    &self,
    key: impl Into<String>,
    entity: Entity
) -> Vec<Entity>

Returns a list of entities that references the same component.

pub fn register<C: Component>(
    &mut self,
    key: impl Into<String>,
    entity: Entity,
    component: C
)

Register a component for the given entity.

pub fn register_shared<C: Component>(
    &mut self,
    key: &str,
    target: Entity,
    source: Entity
)

Registers a sharing of the given component between the given entities. Uses as source key the component key.

pub fn register_shared_by_source_key<C: Component>(
    &mut self,
    key: &str,
    source_key: &str,
    target: Entity,
    source: Entity
)

Registers a sharing of the given component between the given entities.

pub fn register_shared_box(
    &mut self,
    key: &str,
    target: Entity,
    source: SharedComponentBox
)

Registers a sharing of the given component between the given entities. Uses as source key the component key.

pub fn register_shared_box_by_source_key(
    &mut self,
    key: &str,
    source_key: &str,
    target: Entity,
    source: SharedComponentBox
)

Registers a sharing of the given component between the given entities.

pub fn register_box(
    &mut self,
    key: &str,
    entity: Entity,
    component_box: ComponentBox
)

Register a component_box for the given entity.

pub fn len(&self) -> usize

Returns the number of components in the store.

pub fn is_empty(&self) -> bool

Returns true if the components are empty.

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

Returns true if the store contains the specific entity.

pub fn is_origin<C: Component>(&self, key: &str, entity: Entity) -> bool

Returns true if entity is the origin of the requested component false.

pub fn target_key(
    &self,
    source: Entity,
    target: Entity,
    source_key: impl Into<String>
) -> Result<String, NotFound>

Returns the target key for a given source and target.

pub fn source(
    &self,
    entity: Entity,
    key: impl Into<String>
) -> Result<(Entity, String), NotFound>

Returns the source. First search in entities map. If not found search in shared entity map.

pub fn is<C: Component>(
    &self,
    key: &str,
    entity: Entity
) -> Result<bool, NotFound>

Check if the given component has the given type.

pub fn get<C: Component>(
    &self,
    key: &str,
    entity: Entity
) -> Result<&C, NotFound>

Returns a reference of a component of type C from the given entity. If the entity does not exists or it doesn’t have a component of type C NotFound will be returned.

pub fn get_mut<C: Component>(
    &mut self,
    key: &str,
    entity: Entity
) -> Result<&mut C, NotFound>

Returns a mutable reference of a component of type C from the given entity. If the entity does not exists or it doesn’t have a component of type C NotFound will be returned.

Trait Implementations

impl Debug for ComponentStore

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

Formats the value using the given formatter.

impl Default for ComponentStore

fn default() -> ComponentStore

Returns the “default value” for a type.