pub struct ReactResMut<'w, R: ReactResource> { /* private fields */ }
Expand description
Mutable wrapper for reactive resources.
Implementations§
Source§impl<'w, R: ReactResource> ReactResMut<'w, R>
impl<'w, R: ReactResource> ReactResMut<'w, R>
Sourcepub fn get_mut<'a>(&'a mut self, c: &mut Commands<'_, '_>) -> &'a mut R
pub fn get_mut<'a>(&'a mut self, c: &mut Commands<'_, '_>) -> &'a mut R
Mutably access the resource and trigger reactions.
Sourcepub fn get_noreact(&mut self) -> &mut R
pub fn get_noreact(&mut self) -> &mut R
Mutably access the resource without triggering reactions.
Sourcepub fn set_if_neq(&mut self, c: &mut Commands<'_, '_>, new: R) -> Option<R>where
R: PartialEq,
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§
Source§impl<'w, R: ReactResource> Deref for ReactResMut<'w, R>
impl<'w, R: ReactResource> Deref for ReactResMut<'w, R>
Source§impl<'w, R: ReactResource> DetectChanges for ReactResMut<'w, R>
impl<'w, R: ReactResource> DetectChanges for ReactResMut<'w, R>
Source§fn is_changed(&self) -> bool
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. Read moreSource§fn last_changed(&self) -> Tick
fn last_changed(&self) -> Tick
Returns the change tick recording the time this data was most recently changed. Read more
Source§impl<R: ReactResource> SystemParam for ReactResMut<'_, R>
impl<R: ReactResource> SystemParam for ReactResMut<'_, R>
Source§type Item<'w, 's> = ReactResMut<'w, R>
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. Read moreSource§fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State
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
.Source§unsafe fn new_archetype(
state: &mut Self::State,
archetype: &Archetype,
system_meta: &mut SystemMeta,
)
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 Read moreSource§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
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
.Source§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>,
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )
Queues any deferred mutations to be applied at the next
apply_deferred
.Source§unsafe fn validate_param<'w, 's>(
state: &'s Self::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
) -> bool
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 SystemParam
s validation will fail if any
delegated validation fails. Read moreSource§unsafe fn get_param<'w, 's>(
state: &'s mut Self::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
change_tick: Tick,
) -> Self::Item<'w, 's>
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
. Read moreimpl<'w, 's, R: ReactResource> ReadOnlySystemParam for ReactResMut<'w, R>where
ResMut<'w, ReactResInner<R>>: ReadOnlySystemParam,
Auto Trait Implementations§
impl<'w, R> Freeze for ReactResMut<'w, R>
impl<'w, R> RefUnwindSafe for ReactResMut<'w, R>where
R: RefUnwindSafe,
impl<'w, R> Send for ReactResMut<'w, R>
impl<'w, R> Sync for ReactResMut<'w, R>
impl<'w, R> Unpin for ReactResMut<'w, R>
impl<'w, R> !UnwindSafe for ReactResMut<'w, R>
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
Mutably borrows from an owned value. Read more
Source§impl<T, C, D> Curve<T> for D
impl<T, C, D> Curve<T> for D
Source§fn sample_unchecked(&self, t: f32) -> T
fn sample_unchecked(&self, t: f32) -> T
Sample a point on this curve at the parameter value
t
, extracting the associated value.
This is the unchecked version of sampling, which should only be used if the sample time t
is already known to lie within the curve’s domain. Read moreSource§fn sample(&self, t: f32) -> Option<T>
fn sample(&self, t: f32) -> Option<T>
Sample a point on this curve at the parameter value
t
, returning None
if the point is
outside of the curve’s domain.Source§fn sample_clamped(&self, t: f32) -> T
fn sample_clamped(&self, t: f32) -> T
Sample a point on this curve at the parameter value
t
, clamping t
to lie inside the
domain of the curve.Source§fn sample_iter(
&self,
iter: impl IntoIterator<Item = f32>,
) -> impl Iterator<Item = Option<T>>where
Self: Sized,
fn sample_iter(
&self,
iter: impl IntoIterator<Item = f32>,
) -> impl Iterator<Item = Option<T>>where
Self: Sized,
Sample a collection of
n >= 0
points on this curve at the parameter values t_n
,
returning None
if the point is outside of the curve’s domain. Read moreSource§fn sample_iter_unchecked(
&self,
iter: impl IntoIterator<Item = f32>,
) -> impl Iterator<Item = T>where
Self: Sized,
fn sample_iter_unchecked(
&self,
iter: impl IntoIterator<Item = f32>,
) -> impl Iterator<Item = T>where
Self: Sized,
Sample a collection of
n >= 0
points on this curve at the parameter values t_n
,
extracting the associated values. This is the unchecked version of sampling, which should
only be used if the sample times t_n
are already known to lie within the curve’s domain. Read moreSource§fn sample_iter_clamped(
&self,
iter: impl IntoIterator<Item = f32>,
) -> impl Iterator<Item = T>where
Self: Sized,
fn sample_iter_clamped(
&self,
iter: impl IntoIterator<Item = f32>,
) -> impl Iterator<Item = T>where
Self: Sized,
Sample a collection of
n >= 0
points on this curve at the parameter values t_n
,
clamping t_n
to lie inside the domain of the curve. Read moreSource§fn map<S, F>(self, f: F) -> MapCurve<T, S, Self, F>
fn map<S, F>(self, f: F) -> MapCurve<T, S, Self, F>
Create a new curve by mapping the values of this curve via a function
f
; i.e., if the
sample at time t
for this curve is x
, the value at time t
on the new curve will be
f(x)
.Source§fn reparametrize<F>(self, domain: Interval, f: F) -> ReparamCurve<T, Self, F>
fn reparametrize<F>(self, domain: Interval, f: F) -> ReparamCurve<T, Self, F>
Create a new
Curve
whose parameter space is related to the parameter space of this curve
by f
. For each time t
, the sample from the new curve at time t
is the sample from
this curve at time f(t)
. The given domain
will be the domain of the new curve. The
function f
is expected to take domain
into self.domain()
. Read moreSource§fn reparametrize_linear(
self,
domain: Interval,
) -> Result<LinearReparamCurve<T, Self>, LinearReparamError>where
Self: Sized,
fn reparametrize_linear(
self,
domain: Interval,
) -> Result<LinearReparamCurve<T, Self>, LinearReparamError>where
Self: Sized,
Linearly reparametrize this
Curve
, producing a new curve whose domain is the given
domain
instead of the current one. This operation is only valid for curves with bounded
domains; if either this curve’s domain or the given domain
is unbounded, an error is
returned.Source§fn reparametrize_by_curve<C>(self, other: C) -> CurveReparamCurve<T, Self, C>
fn reparametrize_by_curve<C>(self, other: C) -> CurveReparamCurve<T, Self, C>
Source§fn graph(self) -> GraphCurve<T, Self>where
Self: Sized,
fn graph(self) -> GraphCurve<T, Self>where
Self: Sized,
Source§fn chain<C>(self, other: C) -> Result<ChainCurve<T, Self, C>, ChainError>
fn chain<C>(self, other: C) -> Result<ChainCurve<T, Self, C>, ChainError>
Source§fn reverse(self) -> Result<ReverseCurve<T, Self>, ReverseError>where
Self: Sized,
fn reverse(self) -> Result<ReverseCurve<T, Self>, ReverseError>where
Self: Sized,
Source§fn repeat(self, count: usize) -> Result<RepeatCurve<T, Self>, RepeatError>where
Self: Sized,
fn repeat(self, count: usize) -> Result<RepeatCurve<T, Self>, RepeatError>where
Self: Sized,
Source§fn forever(self) -> Result<ForeverCurve<T, Self>, RepeatError>where
Self: Sized,
fn forever(self) -> Result<ForeverCurve<T, Self>, RepeatError>where
Self: Sized,
Source§fn ping_pong(self) -> Result<PingPongCurve<T, Self>, PingPongError>where
Self: Sized,
fn ping_pong(self) -> Result<PingPongCurve<T, Self>, PingPongError>where
Self: Sized,
Source§fn chain_continue<C>(
self,
other: C,
) -> Result<ContinuationCurve<T, Self, C>, ChainError>
fn chain_continue<C>( self, other: C, ) -> Result<ContinuationCurve<T, Self, C>, ChainError>
Source§fn resample<I>(
&self,
segments: usize,
interpolation: I,
) -> Result<SampleCurve<T, I>, ResamplingError>
fn resample<I>( &self, segments: usize, interpolation: I, ) -> Result<SampleCurve<T, I>, ResamplingError>
Resample this
Curve
to produce a new one that is defined by interpolation over equally
spaced sample values, using the provided interpolation
to interpolate between adjacent samples.
The curve is interpolated on segments
segments between samples. For example, if segments
is 1,
only the start and end points of the curve are used as samples; if segments
is 2, a sample at
the midpoint is taken as well, and so on. If segments
is zero, or if this curve has an unbounded
domain, then a ResamplingError
is returned. Read moreSource§fn resample_auto(
&self,
segments: usize,
) -> Result<SampleAutoCurve<T>, ResamplingError>where
Self: Sized,
T: StableInterpolate,
fn resample_auto(
&self,
segments: usize,
) -> Result<SampleAutoCurve<T>, ResamplingError>where
Self: Sized,
T: StableInterpolate,
Resample this
Curve
to produce a new one that is defined by interpolation over equally
spaced sample values, using automatic interpolation to interpolate between adjacent samples.
The curve is interpolated on segments
segments between samples. For example, if segments
is 1,
only the start and end points of the curve are used as samples; if segments
is 2, a sample at
the midpoint is taken as well, and so on. If segments
is zero, or if this curve has an unbounded
domain, then a ResamplingError
is returned.Source§fn samples(
&self,
samples: usize,
) -> Result<impl Iterator<Item = T>, ResamplingError>where
Self: Sized,
fn samples(
&self,
samples: usize,
) -> Result<impl Iterator<Item = T>, ResamplingError>where
Self: Sized,
Extract an iterator over evenly-spaced samples from this curve. If
samples
is less than 2
or if this curve has unbounded domain, then an error is returned instead.Source§fn resample_uneven<I>(
&self,
sample_times: impl IntoIterator<Item = f32>,
interpolation: I,
) -> Result<UnevenSampleCurve<T, I>, ResamplingError>
fn resample_uneven<I>( &self, sample_times: impl IntoIterator<Item = f32>, interpolation: I, ) -> Result<UnevenSampleCurve<T, I>, ResamplingError>
Source§fn resample_uneven_auto(
&self,
sample_times: impl IntoIterator<Item = f32>,
) -> Result<UnevenSampleAutoCurve<T>, ResamplingError>where
Self: Sized,
T: StableInterpolate,
fn resample_uneven_auto(
&self,
sample_times: impl IntoIterator<Item = f32>,
) -> Result<UnevenSampleAutoCurve<T>, ResamplingError>where
Self: Sized,
T: StableInterpolate,
Resample this
Curve
to produce a new one that is defined by automatic interpolation over
samples taken at the given set of times. The given sample_times
are expected to contain at least
two valid times within the curve’s domain interval. Read moreSource§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more