Struct rinecs::entity::EntitiesCreation

pub struct EntitiesCreation<'a> { /* fields omitted */ }

EntitiesCreation is passed to CreationSystem when they are run and allows to access and modify components but also to create new components for already exisiting entities or create new entities and resources.

Implementations

impl<'a> EntitiesCreation<'a>

pub fn iter_for<'e, S: UnorderedData<'e> + ReadOnlyOp<'e>>(
    &'e self
) -> <S as UnorderedData<'e>>::Iter

Iterator over all the components that match the operator

for (pos, vel) in entities.iter_for_mut::<(Write<Position>, Read<Velocity>)>(){
    pos.x += vel.x;
    pos.y += vel.y;
}

Will iterate over all the entities that have both position and velocity and update the position by adding the velocity to it. In this example position can be modified cause we use the Write operator but velocity can only be read.

pub fn iter_for_mut<'e, S: UnorderedData<'e>>(
    &'e mut self
) -> <S as UnorderedData<'e>>::IterMut

Iterator over all the components that match the operator

for (pos, vel) in entities.iter_for_mut::<(Write<Position>, Read<Velocity>)>(){
    pos.x += vel.x;
    pos.y += vel.y;
}

Will iterate over all the entities that have both position and velocity and update the position by adding the velocity to it. In this example position can be modified cause we use the Write operator but velocity can only be read.

pub fn ordered_iter_for<'e, S: OrderedData<'e> + ReadOnlyOrderedOp<'e>>(
    &'e self
) -> <S as OrderedData<'e>>::Iter

Iterator over ordered data

Similar to iter_for but to be used with operators that specify an order like ReadAndParent in which parents will be processed first and then their children

pub fn ordered_iter_for_mut<'e, S: OrderedData<'e>>(
    &'e mut self
) -> <S as OrderedData<'e>>::Iter

Iterator over ordered data

Similar to iter_for but to be used with operators that specify an order like ReadAndParent in which parents will be processed first and then their children

pub fn iter_for_entities<'e, U, E>(&'e self, entities: E) -> E::IntoEntitiesIter where
    E: IntoEntitiesIterator<'e, U::Storage>,
    U: UnorderedData<'e>,
    U::Storage: ReadOnlyStorage, 

Iterator for the specified operators over a set of entities instead of every entity in the world

It’s usage is similar to iter_for but instead of iterating over all the entities it only returns components that match the operators for the entities passed as parameter

let e1 = world.new_entity()
    .add(Position{x: 0., y: 0.})
    .build();
let e2 = world.new_entity()
    .add(Position{x: 0., y: 0.})
    .build();
let e3 = world.new_entity()
    .add(Position{x: 0., y: 0.})
    .build();
let entities = world.entities();
for pos in entities.iter_for_entities::<Read<Position>, _>(&vec![e1, e2]){
    //...
}

The operators parameter in this method needs a second type for the entities iterator type which can jsut be elided with a _ since it’ll be guessed from the passed parameter

pub fn iter_for_entities_mut<'e, U, E>(
    &'e mut self,
    entities: E
) -> E::IntoEntitiesIterMut where
    E: IntoEntitiesIterator<'e, U::Storage>,
    U: UnorderedData<'e>, 

pub fn iter_for_entities_opt<'e, U, E>(
    &'e self,
    entities: E
) -> E::IntoEntitiesOptIter where
    E: IntoEntitiesIterator<'e, U::Storage>,
    U: UnorderedData<'e>,
    U::Storage: ReadOnlyStorage, 

pub fn iter_for_entities_opt_mut<'e, U, E>(
    &'e mut self,
    entities: E
) -> E::IntoEntitiesOptIterMut where
    E: IntoEntitiesIterator<'e, U::Storage>,
    U: UnorderedData<'e>, 

pub unsafe fn unsafe_iter_for_entities_mut<'e, U, E>(
    &'e mut self,
    entities: E
) -> EntitiesComponentIter<'_, <E as IntoIterator>::IntoIter, <U as UnorderedData<'e>>::Storage> where
    U: UnorderedData<'e>,
    E: IntoIterator<Item = Entity>,
    <U as UnorderedData<'e>>::Storage: StorageRef<'e>, 

pub fn changed_iter_for<'r, S>(
    &'r self
) -> EntitiesComponentIter<'r, S::ChangedIter, <S as UnorderedData<'r>>::Storage> where
    S: ChangedData<'r> + EntitiesData + ReadOnlyOp<'r> + 'r,
    <S as UnorderedData<'r>>::Storage: StorageRef<'r>, 

pub fn changed_iter_for_mut<'r, S>(
    &'r mut self
) -> EntitiesComponentIter<'r, S::ChangedIter, <S as UnorderedData<'r>>::Storage> where
    S: ChangedData<'r> + EntitiesData + 'r,
    <S as UnorderedData<'r>>::Storage: StorageRef<'r>, 

pub fn update_changed<C: ComponentThreadLocal>(&self) where
    <C as Component>::Storage: AutoChangedStorageExt<'a>, 

pub fn has_storage_changed<'r, C: ComponentThreadLocal>(self) -> bool where
    <C as Component>::Storage: Storage<'s, C>,
    <C as Component>::Storage: ChangedStorageExt<'r>, 

pub fn entity_components<'r, S>(
    &'r self,
    entity: &Entity
) -> Option<<S as UnorderedData<'r>>::ComponentsRef> where
    S: UnorderedData<'r> + ReadOnlyOp<'r> + 'r,
    S::Storage: StorageRef<'r, Component = S::ComponentsRef>, 

Similar to iter_for_entities but for one entity instead of several

let e1 = world.new_entity()
    .add(Position{x: 0., y: 0.})
    .add(Velocity{x: 0., y: 0.})
    .build();
let entities = world.entities();
let (pos, vel) = entities
    .entity_components::<(Read<Position>, Read<Velocity>)>(&e1)
    .unwrap();

pub fn entity_components_mut<'r, S>(
    &'r mut self,
    entity: &Entity
) -> Option<<S as UnorderedData<'r>>::ComponentsRef> where
    S: UnorderedData<'r> + 'r,
    S::Storage: StorageRef<'r, Component = S::ComponentsRef>, 

pub fn component_for<C: Component>(&self, entity: &Entity) -> Option<Ptr<'_, C>> where
    <C as Component>::Storage: Storage<'s, C>, 

Returns a component for reading for the passed entity

let e1 = world.new_entity()
    .add(Position{x: 0., y: 0.})
    .build();
let entities = world.entities();
let pos = entities.component_for::<Position>(&e1).unwrap();

pub fn component_for_mut<C: Component>(
    &self,
    entity: &Entity
) -> Option<PtrMut<'_, C>> where
    <C as Component>::Storage: Storage<'s, C>, 

Returns a component for writing for the passed entity

let e1 = world.new_entity()
    .add(Position{x: 0., y: 0.})
    .build();
let entities = world.entities();
let mut pos = entities.component_for_mut::<Position>(&e1).unwrap();

pub fn has_component<C: 'static>(&self, entity: &Entity) -> bool

Returns true if the entity has the specified component

let e1 = world.new_entity()
    .add(Position{x: 0., y: 0.})
    .build();
let entities = world.entities();
assert!(entities.has_component::<Position>(&e1));

pub fn tree_node_for<C: Component>(
    &self,
    entity: &Entity
) -> Option<NodePtr<'_, C>> where
    <C as Component>::Storage: HierarchicalStorage<'b, C>, 

Returns the node for a hierarchical component

pub fn tree_node_for_mut<C: Component>(
    &self,
    entity: &Entity
) -> Option<NodePtrMut<'_, C>> where
    <C as Component>::Storage: HierarchicalStorage<'b, C>, 

Returns the node for a hierarchical component for writing

pub fn new_entity(&mut self) -> EntityBuilder<'_>

Returns an EntityBuilder that allows to create an entity and it’s components.

let e = world.new_entity()
    .add(Position{x: 0., y: 0.})
    .add(Velocity{x: 0., y: 0.})
    .build();

pub fn add_component_to<'r, C: ComponentSend>(
    &mut self,
    entity: &Entity,
    component: C
) where
    <C as Component>::Storage: Storage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a Send Component to an already existing Entity.

pub fn add_component_to_thread_local<'r, C: ComponentThreadLocal>(
    &mut self,
    entity: &Entity,
    component: C
) where
    <C as Component>::Storage: Storage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a non Send Component to an already existing Entity.

pub fn add_tag_to<C: 'static>(&mut self, entity: &Entity)

pub fn add_child_component_to<'r, C: ComponentSend>(
    &mut self,
    parent: &Entity,
    entity: &Entity,
    component: C
) where
    <C as Component>::Storage: HierarchicalStorage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a Send Component to an already existing Entity.

pub fn add_child_component_to_thread_local<'r, C: ComponentThreadLocal>(
    &mut self,
    parent: &Entity,
    entity: &Entity,
    component: C
) where
    <C as Component>::Storage: HierarchicalStorage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a non Send Component to an already existing Entity.

pub fn add_slice_component_to<'r, C, I>(
    &mut self,
    entity: &Entity,
    component: I
) where
    C: OneToNComponentSend,
    <C as Component>::Storage: OneToNStorage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter,
    I: IntoIterator<Item = C>, 

Adds a Send OneToNComponent to an already existing Entity.

This allows to add a slice of components to an entity instead of only one component. This components are stored contiguously in memory for all the entities.

pub fn add_slice_component_to_thread_local<'r, C, I>(
    &mut self,
    entity: &Entity,
    component: I
) where
    C: OneToNComponentThreadLocal,
    <C as Component>::Storage: OneToNStorage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter,
    I: IntoIterator<Item = C>, 

Adds a non Send OneToNComponent to an already existing Entity.

This allows to add a slice of components to an entity instead of only one component. This components are stored contiguously in memory for all the entities.

pub fn remove_component_from<'r, C: Component>(&mut self, entity: &Entity) where
    <C as Component>::Storage: Storage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Removes a compoenent of the specified type from an entity.

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

Removes an Entity and all it’s compoenents.

pub fn to_thread_local(&self) -> &EntitiesThreadLocal<'_>

pub fn to_send(&self) -> &Entities<'_>

pub fn creation_storage<C: Component>(&mut self) -> CreationSto<'_, C>

pub fn storage_for<'r, S>(&'r self) -> Sto<'r, S> where
    S: UnorderedData<'r> + ReadOnlyOp<'r>, 

Storage for the operator passed as type parameter

Calling iter_for can be slow if it needs to be called lots of times. In those cases calling instead storage_for once and then iter() on it multiple times can make performance much better

let mut storage = entities.storage_for_mut::<(Write<Position>, Read<Velocity>)>().unwrap();
for i in 0..1000000 {
    for (pos, vel) in storage.iter_mut() {
        pos.x += vel.x;
        pos.y += vel.y;
    }
}

pub fn storage_for_mut<'r, S>(&'r mut self) -> Sto<'r, S> where
    S: UnorderedData<'r>, 

pub fn clone(&mut self) -> EntitiesCreation<'_>

pub fn as_storages(&mut self) -> EntityStoragesCreation<'_>

pub fn split<D: DataAccesses>(
    &mut self
) -> (EntitiesCreation<'_>, EntitiesCreation<'_>)

Trait Implementations

impl<'a> EntitiesCreationExt<'a> for EntitiesCreation<'a>

fn with_entities_creation<'e, F, R>(&'e mut self, f: F) -> R where
    F: FnOnce(EntitiesCreation<'e>) -> R, 

fn new_entity(&mut self) -> EntityBuilder<'_>

Returns an EntityBuilder that allows to create an entity and it’s components.

fn creation_storage<C: Component>(&mut self) -> CreationSto<'_, C>

fn add_component_to<'r, C: ComponentSend>(
    &mut self,
    entity: &Entity,
    component: C
) where
    <C as Component>::Storage: Storage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a Send Component to an already existing Entity.

fn add_component_to_thread_local<'r, C: ComponentThreadLocal>(
    &mut self,
    entity: &Entity,
    component: C
) where
    <C as Component>::Storage: Storage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a non Send Component to an already existing Entity.

fn add_tag_to<C: 'static>(&mut self, entity: &Entity)

Adds a Tag to an already existing Entity.

fn add_child_component_to<'r, C: ComponentSend>(
    &mut self,
    parent: &Entity,
    entity: &Entity,
    component: C
) where
    <C as Component>::Storage: HierarchicalStorage<'b, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a Send Component to an already existing Entity.

fn add_child_component_to_thread_local<'r, C: ComponentThreadLocal>(
    &mut self,
    parent: &Entity,
    entity: &Entity,
    component: C
) where
    <C as Component>::Storage: HierarchicalStorage<'b, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a non Send Component to an already existing Entity.

fn add_slice_component_to<'r, C, I>(&mut self, entity: &Entity, component: I) where
    C: OneToNComponentSend,
    <C as Component>::Storage: OneToNStorage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter,
    I: IntoIterator<Item = C>, 

Adds a Send OneToNComponent to an already existing Entity.

fn add_slice_component_to_thread_local<'r, C, I>(
    &mut self,
    entity: &Entity,
    component: I
) where
    C: OneToNComponentThreadLocal,
    <C as Component>::Storage: OneToNStorage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter,
    I: IntoIterator<Item = C>, 

Adds a non Send OneToNComponent to an already existing Entity.

fn remove_component_from<'r, C: Component>(&mut self, entity: &Entity) where
    <C as Component>::Storage: Storage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Removes a compoenent of the specified type from an entity.

fn remove_entity(&mut self, entity: &Entity)

Removes an Entity and all it’s compoenents.

impl<'a> EntitiesExt<'a> for EntitiesCreation<'a>

fn iter_for<'e, S: UnorderedDataSend<'e> + ReadOnlyOp<'e>>(
    &'e self
) -> <S as UnorderedData<'e>>::Iter

Iterator over all the components that match the operator

fn iter_for_mut<'e, S: UnorderedDataSend<'e>>(
    &'e mut self
) -> <S as UnorderedData<'e>>::IterMut

Iterator over all the components that match the operator

fn ordered_iter_for<'e, S: OrderedDataSend<'e> + ReadOnlyOrderedOp<'e>>(
    &'e self
) -> <S as OrderedData<'e>>::Iter

Iterator over ordered data

fn ordered_iter_for_mut<'e, S: OrderedDataSend<'e>>(
    &'e mut self
) -> <S as OrderedData<'e>>::Iter

Iterator over ordered data

fn iter_for_entities<'e, U, E>(&'e self, entities: E) -> E::IntoEntitiesIter where
    E: IntoEntitiesIterator<'e, U::Storage>,
    U: UnorderedDataSend<'e>,
    U::Storage: ReadOnlyStorage, 

Iterator for the specified operators over a set of entities instead of every entity in the world

fn iter_for_entities_mut<'e, U, E>(
    &'e mut self,
    entities: E
) -> E::IntoEntitiesIterMut where
    E: IntoEntitiesIterator<'e, U::Storage>,
    U: UnorderedDataSend<'e>, 

fn iter_for_entities_opt<'e, U, E>(
    &'e self,
    entities: E
) -> E::IntoEntitiesOptIter where
    E: IntoEntitiesIterator<'e, U::Storage>,
    U: UnorderedDataSend<'e>,
    U::Storage: ReadOnlyStorage, 

fn iter_for_entities_opt_mut<'e, U, E>(
    &'e mut self,
    entities: E
) -> E::IntoEntitiesOptIterMut where
    E: IntoEntitiesIterator<'e, U::Storage>,
    U: UnorderedDataSend<'e>, 

fn entity_components<'r, S>(
    &'r self,
    entity: &Entity
) -> Option<<S as UnorderedData<'r>>::ComponentsRef> where
    S: UnorderedDataSend<'r> + ReadOnlyOp<'r> + 'r,
    S::Storage: StorageRef<'r, Component = S::ComponentsRef>, 

Similar to iter_for_entities but for one entity instead of several

fn entity_components_mut<'r, S>(
    &'r mut self,
    entity: &Entity
) -> Option<<S as UnorderedData<'r>>::ComponentsRef> where
    S: UnorderedDataSend<'r> + 'r,
    S::Storage: StorageRef<'r, Component = S::ComponentsRef>, 

fn component_for<C: ComponentSend>(&self, entity: &Entity) -> Option<Ptr<'_, C>> where
    <C as Component>::Storage: Storage<'s, C>, 

Returns a component for reading for the passed entity

fn component_for_mut<C: ComponentSend>(
    &self,
    entity: &Entity
) -> Option<PtrMut<'_, C>> where
    <C as Component>::Storage: Storage<'s, C>, 

Returns a component for writing for the passed entity

fn has_component<C: 'static>(&self, entity: &Entity) -> bool

Returns true if the entity has the specified component

fn tree_node_for<C: ComponentSend>(
    &self,
    entity: &Entity
) -> Option<NodePtr<'_, C>> where
    <C as Component>::Storage: HierarchicalStorage<'b, C>, 

Returns the node for a hierarchical component

fn tree_node_for_mut<C: ComponentSend>(
    &self,
    entity: &Entity
) -> Option<NodePtrMut<'_, C>> where
    <C as Component>::Storage: HierarchicalStorage<'b, C>, 

Returns the node for a hierarchical component for writing

fn changed_iter_for<'r, S>(
    &'r self
) -> EntitiesComponentIter<'r, S::ChangedIter, <S as UnorderedData<'r>>::Storage> where
    S: ChangedDataSend<'r> + EntitiesData + ReadOnlyOp<'r> + 'r,
    <S as UnorderedData<'r>>::Storage: StorageRef<'r>, 

Iterator for the specified operators only over the entities whose component as specified in the first operator has changed

fn changed_iter_for_mut<'r, S>(
    &'r mut self
) -> EntitiesComponentIter<'r, S::ChangedIter, <S as UnorderedData<'r>>::Storage> where
    S: ChangedDataSend<'r> + EntitiesData + 'r,
    <S as UnorderedData<'r>>::Storage: StorageRef<'r>, 

fn storage_for<'r, S>(&'r self) -> Sto<'r, S> where
    S: UnorderedDataSend<'r> + ReadOnlyOp<'r>, 

Storage for the operator passed as type parameter

fn storage_for_mut<'r, S>(&'r mut self) -> Sto<'r, S> where
    S: UnorderedDataSend<'r>, 

impl<'a> EntitiesStorage for EntitiesCreation<'a>

fn storage<C: Component>(
    &self
) -> Option<ReadGuardRef<'_, <C as Component>::Storage>>

fn storage_mut<C: Component>(
    &self
) -> Option<WriteGuardRef<'_, <C as Component>::Storage, <C as Component>::MutStorageCacheGuard>>

fn entities_ref(&self) -> &[(Entity, MaskType)]

fn component_mask<C: 'static>(&self) -> MaskType

fn entities_for_mask<S: FastIndexExt>(
    &self,
    query_mask: Bitmask,
    storage: &S
) -> IndexGuard<'_>

fn lazy_entities_for_mask(&self, query_mask: Bitmask) -> LazyIndexGuard<'_>

fn ordered_entities_for<C: Component, S: FastIndexExt>(
    &self,
    query_mask: Bitmask,
    unordered_storage: &S
) -> OrderedIndexGuard<'_> where
    <C as Component>::Storage: HierarchicalStorage<'b, C>,