Struct Resources 

pub struct Resources { /* private fields */ }

Container for singleton resources stored inside the ECS world.

All resources live on a single hidden entity so they participate in the same borrow-checking rules as regular components. Resources is passed to every system alongside the hecs::World.

Implementations

impl Resources

pub fn new(world: &mut World) -> Self

Create a new Resources container, spawning the internal resource entity.

pub fn insert_resource<T>(&mut self, world: &mut World, res: T)

where T: Component,

Insert or replace a resource of type T.

pub fn get_resource<'a, T>(&self, world: &'a World) -> Ref<'a, T>

where T: Component,

Borrow resource T, panicking if it is not present.

pub fn get_resource_mut<'a, T>(&self, world: &'a World) -> RefMut<'a, T>

where T: Component,

Mutably borrow resource T, panicking if it is not present.

pub fn has_resource<T>(&self, world: &World) -> bool

where T: Component,

Returns true if resource T is currently present.

pub fn get_command_buffer<'a>(&'a self) -> RefMut<'a, CommandBuffer>

Borrow the shared command buffer used to defer world mutations.

pub fn try_insert<T>(&mut self, world: &mut World, res: T) -> bool

where T: Component,

Insert resource T only if it is not already present.

Returns true if the resource was inserted, false if it already existed.

Trait Implementations

impl SystemParam for &'static Resources

type Item<'a> = &'a Resources

type State = ()

fn fetch<'a>( _state: &'a mut Self::State, _world: &'a World, resources: &'a Resources, ) -> Self::Item<'a>