pub struct Entities { /* private fields */ }
Implementations§
source§impl Entities
impl Entities
sourcepub fn reserve_entities(&self, count: u32) -> ReserveEntitiesIterator<'_> ⓘ
pub fn reserve_entities(&self, count: u32) -> ReserveEntitiesIterator<'_> ⓘ
Reserve entity IDs concurrently.
Storage for entity generation and location is lazily allocated by calling flush
.
sourcepub fn reserve_entity(&self) -> Entity
pub fn reserve_entity(&self) -> Entity
Reserve one entity ID concurrently.
Equivalent to self.reserve_entities(1).next().unwrap()
, but more efficient.
sourcepub fn alloc_at(&mut self, entity: Entity) -> Option<EntityLocation>
pub fn alloc_at(&mut self, entity: Entity) -> Option<EntityLocation>
Allocate a specific entity ID, overwriting its generation.
Returns the location of the entity currently using the given ID, if any. Location should be written immediately.
sourcepub fn alloc_at_without_replacement(
&mut self,
entity: Entity
) -> AllocAtWithoutReplacement
pub fn alloc_at_without_replacement(
&mut self,
entity: Entity
) -> AllocAtWithoutReplacement
Allocate a specific entity ID, overwriting its generation.
Returns the location of the entity currently using the given ID, if any.
sourcepub fn free(&mut self, entity: Entity) -> Option<EntityLocation>
pub fn free(&mut self, entity: Entity) -> Option<EntityLocation>
Destroy an entity, allowing it to be reused.
Must not be called while reserved entities are awaiting flush()
.
sourcepub fn reserve(&mut self, additional: u32)
pub fn reserve(&mut self, additional: u32)
Ensure at least n
allocations can succeed without reallocating.
pub fn clear(&mut self)
sourcepub fn get(&self, entity: Entity) -> Option<EntityLocation>
pub fn get(&self, entity: Entity) -> Option<EntityLocation>
Returns Ok(Location { archetype: Archetype::invalid(), index: undefined })
for pending entities.
sourcepub fn resolve_from_id(&self, index: u32) -> Option<Entity>
pub fn resolve_from_id(&self, index: u32) -> Option<Entity>
Get the Entity
with a given id, if it exists in this Entities
collection
Returns None
if this Entity
is outside of the range of currently reserved Entities
Note: This method may return Entities
which are currently free
Note that contains
will correctly return false for freed
entities, since it checks the generation
sourcepub unsafe fn flush(&mut self, init: impl FnMut(Entity, &mut EntityLocation))
pub unsafe fn flush(&mut self, init: impl FnMut(Entity, &mut EntityLocation))
Allocates space for entities previously reserved with reserve_entity
or
reserve_entities
, then initializes each one using the supplied function.
Safety
Flush must set the entity location to the correct ArchetypeId
for the given Entity
each time init is called. This can be ArchetypeId::INVALID
, provided the Entity
has not been assigned to an Archetype
.
Note: freshly-allocated entities (ones which don’t come from the pending list) are guaranteed to be initialized with the invalid archetype.
pub fn flush_as_invalid(&mut self)
sourcepub unsafe fn flush_and_reserve_invalid_assuming_no_entities(
&mut self,
count: usize
)
pub unsafe fn flush_and_reserve_invalid_assuming_no_entities(
&mut self,
count: usize
)
Safety
This function is safe if and only if the world this Entities is on has no entities.
pub fn len(&self) -> u32
pub fn is_empty(&self) -> bool
Trait Implementations§
Auto Trait Implementations§
impl RefUnwindSafe for Entities
impl Send for Entities
impl Sync for Entities
impl Unpin for Entities
impl UnwindSafe for Entities
Blanket Implementations§
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read moresource§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read moresource§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read moresource§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read moresource§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World