Struct specs::EntitiesRes
[−]
[src]
pub struct EntitiesRes { /* fields omitted */ }
The entities of this ECS. This is a resource, stored in the World
.
If you just want to access it in your system, you can also use the Entities
type def.
Please note that you should never fetch this mutably in a system, because it would block all the other systems.
You need to call World::maintain
after creating / deleting
entities with this struct.
Methods
impl EntitiesRes
[src]
fn create(&self) -> Entity
Creates a new entity atomically.
This will be persistent as soon
as you call World::maintain
.
fn create_iter(&self) -> CreateIterAtomic
Returns an iterator which creates
new entities atomically.
They will be persistent as soon
as you call World::maintain
.
fn delete(&self, e: Entity)
Deletes an entity atomically.
The associated components will be
deleted as soon as you call World::maintain
.
fn is_alive(&self, e: Entity) -> bool
Returns true
if the specified entity is
alive.
Trait Implementations
impl Debug for EntitiesRes
[src]
impl Default for EntitiesRes
[src]
fn default() -> EntitiesRes
Returns the "default value" for a type. Read more
impl<'a> Join for &'a EntitiesRes
[src]
type Type = Entity
Type of joined components.
type Value = Self
Type of joined storages.
type Mask = BitSetOr<&'a BitSet, &'a AtomicBitSet>
Type of joined bit mask.
fn open(self) -> (Self::Mask, Self)
Open this join by returning the mask and the storages.
unsafe fn get(v: &mut &'a EntitiesRes, idx: Index) -> Entity
Get a joined component value by a given index.
fn join(self) -> JoinIter<Self> where
Self: Sized,
Self: Sized,
Create a joined iterator over the contents.
impl<'a> ParJoin for &'a EntitiesRes
[src]
fn par_join(self) -> JoinParIter<Self> where
Self: Sized,
Self: Sized,
Create a joined parallel iterator over the contents.