Struct ark_api::world::EntityArena

pub struct EntityArena { /* private fields */ }

An EntityArena is a collection for holding on to entities. Use it to keep track of sets of entities A global arena exists in which entities can be created and cloned

Implementations

impl EntityArena

pub fn insert(&mut self, entity: EntityOwned) -> Entity

Adds an owned entity to the arena

pub fn remove(&mut self, entity: Entity) -> Option<EntityOwned>

Removes an entity from the arena using the entity handle, If the entity was in the arena it is returned, otherwise None.

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

Schedules an entity for destruction using the entity handle, Will be destroyed on the next call to destroy_pending_entities. If the entity is in the arena a handle to it is returned, otherwise None.

pub fn destroy_pending_entities(&mut self)

Destroys all entities that have been scheduled for destruction using the schedule_for_destruction function.

pub fn destroy_all(&mut self)

Destroys all entities in the arena

pub fn global() -> &'static mut Self

Returns the global entity arena, used by Entity::create functions

Trait Implementations

impl Default for EntityArena

fn default() -> EntityArena

Returns the “default value” for a type.