Struct ReactResMut

pub struct ReactResMut<'w, R: ReactResource> { /* private fields */ }

Mutable wrapper for reactive resources.

Implementations

impl<'w, R: ReactResource> ReactResMut<'w, R>

pub fn get_mut<'a>(&'a mut self, c: &mut Commands<'_, '_>) -> &'a mut R

Mutably access the resource and trigger reactions.

pub fn get_noreact(&mut self) -> &mut R

Mutably access the resource without triggering reactions.

pub fn set_if_neq(&mut self, c: &mut Commands<'_, '_>, new: R) -> Option<R>

where R: PartialEq,

Sets the resource value and triggers mutations only if the value will change.

Returns the previous value if it changed.

Trait Implementations

impl<'w, R: ReactResource> Deref for ReactResMut<'w, R>

type Target = R

The resulting type after dereferencing.

fn deref(&self) -> &R

Dereferences the value.

impl<'w, R: ReactResource> DetectChanges for ReactResMut<'w, R>

fn is_added(&self) -> bool

Returns true if this value was added after the system last ran.

fn is_changed(&self) -> bool

Returns true if this value was added or mutably dereferenced either since the last time the system ran or, if the system never ran, since the beginning of the program.

fn last_changed(&self) -> Tick

Returns the change tick recording the time this data was most recently changed.

impl<R: ReactResource> SystemParam for ReactResMut<'_, R>

type State = FetchState<R>

Used to store data which persists across invocations of a system.

type Item<'w, 's> = ReactResMut<'w, R>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).a

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next apply_deferred.

unsafe fn validate_param<'w, 's>( state: &'s Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, ) -> bool

Validates that the param can be acquired by the get_param. Built-in executors use this to prevent systems with invalid params from running. For nested SystemParams validation will fail if any delegated validation fails.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's, R: ReactResource> ReadOnlySystemParam for ReactResMut<'w, R>

where ResMut<'w, ReactResInner<R>>: ReadOnlySystemParam,