Struct bevy_ecs::change_detection::ResMut

pub struct ResMut<'a, T: Resource> { /* fields omitted */ }

Unique mutable borrow of a resource.

See the World documentation to see the usage of a resource.

If you need a shared borrow, use Res instead.

Panics

Panics when used as a SystemParam if the resource does not exist.

Use Option<ResMut<T>> instead if the resource might not always exist.

Implementations

impl<'a, T: Resource> ResMut<'a, T>

pub fn into_inner(self) -> &'a mut T

Consume self and return a mutable reference to the contained value while marking self as “changed”.

Trait Implementations

impl<'a, T: Resource> AsMut<T> for ResMut<'a, T>

fn as_mut(&mut self) -> &mut T

Performs the conversion.

impl<'a, T: Resource> AsRef<T> for ResMut<'a, T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<'a, T: Resource> Debug for ResMut<'a, T> where
    T: Debug, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, T: Resource> Deref for ResMut<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T: Resource> DerefMut for ResMut<'a, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T: Resource> DetectChanges for ResMut<'a, T>

fn is_added(&self) -> bool

Returns true if (and only if) this value been added since the last execution of this system.

fn is_changed(&self) -> bool

Returns true if (and only if) this value been changed since the last execution of this system.

fn set_changed(&mut self)

Manually flags this value as having been changed. This normally isn’t required because accessing this pointer mutably automatically flags this value as “changed”.

impl<'a, T: Resource> SystemParam for ResMut<'a, T>

type Fetch = ResMutState<T>