Struct bevy::ecs::world::WorldCell

pub struct WorldCell<'w> { /* private fields */ }

Exposes safe mutable access to multiple resources at a time in a World. Attempting to access World in a way that violates Rust’s mutability rules will panic thanks to runtime checks.

Implementations

impl<'w> WorldCell<'w>

pub fn get_resource<T>(&self) -> Option<WorldBorrow<'_, T>>

where T: Resource,

Gets a reference to the resource of the given type

pub fn resource<T>(&self) -> WorldBorrow<'_, T>

where T: Resource,

Gets a reference to the resource of the given type

Panics

Panics if the resource does not exist. Use get_resource instead if you want to handle this case.

pub fn get_resource_mut<T>(&self) -> Option<WorldBorrowMut<'_, T>>

where T: Resource,

Gets a mutable reference to the resource of the given type

pub fn resource_mut<T>(&self) -> WorldBorrowMut<'_, T>

where T: Resource,

Gets a mutable reference to the resource of the given type

Panics

Panics if the resource does not exist. Use get_resource_mut instead if you want to handle this case.

pub fn get_non_send_resource<T>(&self) -> Option<WorldBorrow<'_, T>>

where T: 'static,

Gets an immutable reference to the non-send resource of the given type, if it exists.

pub fn non_send_resource<T>(&self) -> WorldBorrow<'_, T>

where T: 'static,

Gets an immutable reference to the non-send resource of the given type, if it exists.

Panics

Panics if the resource does not exist. Use get_non_send_resource instead if you want to handle this case.

pub fn get_non_send_resource_mut<T>(&self) -> Option<WorldBorrowMut<'_, T>>

where T: 'static,

Gets a mutable reference to the non-send resource of the given type, if it exists.

pub fn non_send_resource_mut<T>(&self) -> WorldBorrowMut<'_, T>

where T: 'static,

Gets a mutable reference to the non-send resource of the given type, if it exists.

Panics

Panics if the resource does not exist. Use get_non_send_resource_mut instead if you want to handle this case.

pub fn send_event<E>(&self, event: E)

where E: Event,

Sends an Event.

pub fn send_event_default<E>(&self)

where E: Event + Default,

Sends the default value of the Event of type E.

pub fn send_event_batch<E>(&self, events: impl Iterator<Item = E>)

where E: Event,

Sends a batch of Events from an iterator.

Trait Implementations

impl<'w> Drop for WorldCell<'w>

fn drop(&mut self)

Executes the destructor for this type.