Struct World 

pub struct World {
    pub resources: Resources,
    /* private fields */
}

The central ECS container: archetypes, entity allocator, resources, events.

Fields

resources: Resources

Global singleton resources.

Implementations

impl World

pub fn new() -> Self

Creates an empty world.

pub fn tick(&self) -> u32

Returns the current change-detection tick.

pub fn increment_tick(&mut self)

Advances the tick counter by 1.

pub fn spawn<B: Bundle>(&mut self, bundle: B) -> Entity

Spawns an entity with the given bundle and returns its handle.

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

Despawns an entity, returning true if it was alive.

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

true if entity is currently alive.

pub fn insert<C: Component>(&mut self, entity: Entity, component: C)

Inserts component C onto an entity, migrating its archetype if needed.

pub fn remove<C: Component>(&mut self, entity: Entity)

Removes component C from an entity.

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

Returns &C for entity, or None.

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

Returns &mut C for entity, updating changed tick.

pub fn entity_ref(&self, entity: Entity) -> Option<EntityRef<'_>>

Read-only view of an entity’s components.

pub fn entity_mut(&mut self, entity: Entity) -> Option<EntityMut<'_>>

Read-write view of an entity’s components.

pub fn query<Q: WorldQuery, F: QueryFilter>(&self) -> QueryIter<'_, Q, F>

Returns an iterator over entities matching Q and filter F.

pub fn query_all<Q: WorldQuery>(&self) -> QueryIter<'_, Q, ()>

Query with no filter.

pub fn query_single<Q: WorldQuery>(&self) -> Option<Q::Item<'_>>

Returns the single matching entity, or None if zero or multiple.

pub fn insert_resource<T: 'static + Send + Sync>(&mut self, v: T)

Inserts a resource.

pub fn resource<T: 'static + Send + Sync>(&self) -> Option<Res<'_, T>>

Returns Res<T>.

pub fn resource_mut<T: 'static + Send + Sync>( &mut self, ) -> Option<ResMut<'_, T>>

Returns ResMut<T>.

pub fn remove_resource<T: 'static + Send + Sync>(&mut self) -> Option<T>

Removes and returns T.

pub fn add_event<E: 'static + Send + Sync>(&mut self)

Registers event type E.

pub fn events<E: 'static + Send + Sync>(&self) -> Option<&Events<E>>

Returns &Events<E>.

pub fn events_mut<E: 'static + Send + Sync>(&mut self) -> Option<&mut Events<E>>

Returns &mut Events<E>.

pub fn send_event<E: 'static + Send + Sync>(&mut self, event: E)

Sends event E (auto-creates queue).

pub fn entities(&self) -> impl Iterator<Item = Entity> + '_

Iterator over all live entities.

pub fn entity_count(&self) -> usize

Total number of live entities.

pub fn archetype_count(&self) -> usize

Number of archetypes.

Trait Implementations

impl Default for World

fn default() -> Self

Returns the “default value” for a type.