Struct bevy::ecs::entity::Entities

pub struct Entities {
    pub meta: Vec<EntityMeta, Global>,
    // some fields omitted
}

Fields

meta: Vec<EntityMeta, Global>

Implementations

impl Entities

pub fn reserve_entities(&self, count: u32) -> ReserveEntitiesIterator<'_>

Reserve entity IDs concurrently

Storage for entity generation and location is lazily allocated by calling flush.

pub fn reserve_entity(&self) -> Entity

Reserve one entity ID concurrently

Equivalent to self.reserve_entities(1).next().unwrap(), but more efficient.

pub fn alloc(&mut self) -> Entity

Allocate an entity ID directly

Location should be written immediately.

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.

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().

pub fn reserve(&mut self, additional: u32)

Ensure at least n allocations can succeed without reallocating

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

pub fn clear(&mut self)

pub fn get_mut(&mut self, entity: Entity) -> Option<&mut EntityLocation>

Access the location storage of an entity

Must not be called on pending entities.

pub fn get(&self, entity: Entity) -> Option<EntityLocation>

Returns Ok(Location { archetype: 0, index: undefined }) for pending entities

pub unsafe fn resolve_unknown_gen(&self, id: u32) -> Entity

Panics if the given id would represent an index outside of meta.

Safety

Must only be called for currently allocated ids.

pub 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.

pub fn len(&self) -> u32

pub fn is_empty(&self) -> bool

Trait Implementations

impl Debug for Entities

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

Formats the value using the given formatter.

impl Default for Entities

pub fn default() -> Entities

Returns the “default value” for a type.

impl<'a> SystemParam for &'a Entities

type Fetch = EntitiesState