pub struct World {
pub resources: Resources,
pub components: ComponentStores,
}
Expand description
The World
is simply a collection of Resources
, and ComponentStores
.
Also stored in the world is the Entities
, but it is stored as a resource.
World
is designed to be trivially Clone
ed to allow for snapshotting the world state. The
is especially useful in the context of rollback networking, which requires the ability to
snapshot and restore state.
Fields§
§resources: Resources
Stores the world resources.
components: ComponentStores
Stores the world components.
Implementations§
source§impl World
impl World
sourcepub fn with_entities(entities: AtomicResource<Entities>) -> World
pub fn with_entities(entities: AtomicResource<Entities>) -> World
Create a new world that uses the provided entities resource.
This allows multiple worlds to avoid allocating the same entity IDs.
sourcepub fn maintain(&self)
pub fn maintain(&self)
Remove the component info for dead entities.
This should be called every game frame to cleanup entities that have been killed.
This will remove the component storage for all killed entities, and allow their slots to be re-used for any new entities.
sourcepub fn run_system<'system, R, In, Out, S>(&self, system: S, input: In) -> Outwhere
In: 'system,
Out: 'system,
S: IntoSystem<R, In, Out>,
<S as IntoSystem<R, In, Out>>::Sys: 'system,
pub fn run_system<'system, R, In, Out, S>(&self, system: S, input: In) -> Outwhere
In: 'system,
Out: 'system,
S: IntoSystem<R, In, Out>,
<S as IntoSystem<R, In, Out>>::Sys: 'system,
Run a system once.
This is good for initializing the world with setup systems.
sourcepub fn init_resource<R>(&mut self) -> RefMut<'_, R>
pub fn init_resource<R>(&mut self) -> RefMut<'_, R>
Initialize a resource of type T
by inserting it’s default value.
sourcepub fn insert_resource<R>(&mut self, resource: R) -> Option<R>where
R: HasSchema,
pub fn insert_resource<R>(&mut self, resource: R) -> Option<R>where
R: HasSchema,
Insert a resource.
sourcepub fn resource_mut<T>(&self) -> RefMut<'_, T>where
T: HasSchema,
pub fn resource_mut<T>(&self) -> RefMut<'_, T>where
T: HasSchema,
sourcepub fn get_resource<T>(&self) -> Option<Ref<'_, T>>where
T: HasSchema,
pub fn get_resource<T>(&self) -> Option<Ref<'_, T>>where
T: HasSchema,
Borrow a resource from the world, if it exists.
sourcepub fn get_resource_mut<T>(&mut self) -> Option<RefMut<'_, T>>where
T: HasSchema,
pub fn get_resource_mut<T>(&mut self) -> Option<RefMut<'_, T>>where
T: HasSchema,
Borrow a resource from the world, if it exists.
sourcepub fn component<T>(&self) -> Ref<'_, ComponentStore<T>>where
T: HasSchema,
pub fn component<T>(&self) -> Ref<'_, ComponentStore<T>>where
T: HasSchema,
Borrow a component store from the world.
Panics
Panics if the component store does not exist in the world.
sourcepub fn component_mut<T>(&self) -> RefMut<'_, ComponentStore<T>>where
T: HasSchema,
pub fn component_mut<T>(&self) -> RefMut<'_, ComponentStore<T>>where
T: HasSchema,
Mutably borrow a component store from the world.
Panics
Panics if the component store does not exist in the world.
sourcepub fn reset_internals(&mut self, reset_components: bool, reset_entities: bool)
pub fn reset_internals(&mut self, reset_components: bool, reset_entities: bool)
Provides an interface for resetting entities, and components.
Trait Implementations§
source§impl SystemParam for &World
impl SystemParam for &World
§type Param<'s> = &'s World
type Param<'s> = &'s World
source§fn get_state(_world: &World) -> <&World as SystemParam>::State
fn get_state(_world: &World) -> <&World as SystemParam>::State
source§fn borrow<'s>(
world: &'s World,
_state: &'s mut <&World as SystemParam>::State
) -> <&World as SystemParam>::Param<'s>
fn borrow<'s>( world: &'s World, _state: &'s mut <&World as SystemParam>::State ) -> <&World as SystemParam>::Param<'s>
Auto Trait Implementations§
impl !RefUnwindSafe for World
impl Send for World
impl Sync for World
impl Unpin for World
impl !UnwindSafe for World
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &World) -> T
fn from_world(_world: &World) -> T
Self
using data from the given World
.