Struct World

pub struct World { /* private fields */ }

Sparse typed storage with generational entities and checked component borrows.

RefCell deliberately makes World !Sync. Parallel mutation should use separate worlds or explicit synchronization around the whole world.

Implementations

impl World

pub fn new() -> World

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

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

where B: Bundle,

Spawns one entity containing zero to four components. Panics if a bundle repeats a component type; no entity is allocated in that case.

pub fn try_spawn<B>(&mut self, bundle: B) -> Result<Entity, Error>

where B: Bundle,

pub fn despawn(&mut self, entity: Entity) -> Result<(), Error>

Drops every component and invalidates the handle before reusing its slot.

pub fn insert<B>(&mut self, entity: Entity, bundle: B) -> Result<(), Error>

where B: Bundle,

Inserts or replaces a bundle’s components. Other components remain unchanged. Invalid identities and duplicate bundle types are rejected before any writes.

pub fn remove<T>(&mut self, entity: Entity) -> Result<T, Error>

where T: 'static,

pub fn has<T>(&self, entity: Entity) -> bool

where T: 'static,

pub fn get<A>(&self, entity: Entity) -> Result<<A as Access>::Item<'_>, Error>

where A: Access,

Reads or mutates a typed component through an explicit access type. Use get::<&T> or get::<&mut T>; returned guards enforce runtime aliasing.

pub fn get_mut<T>(&self, entity: Entity) -> Result<RefMut<'_, T>, Error>

where T: 'static,

pub fn query<Q>(&self) -> QueryBorrow<'_, Q>

where Q: Query,

Queries up to four component access types, optionally including Entity. Repeated shared access is valid; any repeated mutable access is rejected.

pub fn try_query<Q>(&self) -> Result<QueryBorrow<'_, Q>, Error>

where Q: Query,

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

Live identities in stable slot order, without borrowing any components.

Trait Implementations

impl Default for World

fn default() -> World

Returns the “default value” for a type.