pub struct ParamSet<'w, 's, T: SystemParam> { /* private fields */ }
Expand description
A collection of potentially conflicting SystemParam
s allowed by disjoint access.
Allows systems to safely access and interact with up to 8 mutually exclusive SystemParam
s, such as
two queries that reference the same mutable data or an event reader and writer of the same type.
Each individual SystemParam
can be accessed by using the functions p0()
, p1()
, …, p7()
,
according to the order they are defined in the ParamSet
. This ensures that there’s either
only one mutable reference to a parameter at a time or any number of immutable references.
§Examples
The following system mutably accesses the same component two times, which is not allowed due to rust’s mutability rules.
// This will panic at runtime when the system gets initialized.
fn bad_system(
mut enemies: Query<&mut Health, With<Enemy>>,
mut allies: Query<&mut Health, With<Ally>>,
) {
// ...
}
Conflicting SystemParam
s like these can be placed in a ParamSet
,
which leverages the borrow checker to ensure that only one of the contained parameters are accessed at a given time.
// Given the following system
fn fancy_system(
mut set: ParamSet<(
Query<&mut Health, With<Enemy>>,
Query<&mut Health, With<Ally>>,
)>
) {
// This will access the first `SystemParam`.
for mut health in set.p0().iter_mut() {
// Do your fancy stuff here...
}
// The second `SystemParam`.
// This would fail to compile if the previous parameter was still borrowed.
for mut health in set.p1().iter_mut() {
// Do even fancier stuff here...
}
}
Of course, ParamSet
s can be used with any kind of SystemParam
, not just queries.
fn event_system(
mut set: ParamSet<(
// `EventReader`s and `EventWriter`s conflict with each other,
// since they both access the event queue resource for `MyEvent`.
EventReader<MyEvent>,
EventWriter<MyEvent>,
// `&World` reads the entire world, so a `ParamSet` is the only way
// that it can be used in the same system as any mutable accesses.
&World,
)>,
) {
for event in set.p0().read() {
// ...
}
set.p1().send(MyEvent::new());
let entities = set.p2().entities();
// ...
}
Implementations§
source§impl<'w, 's, P0: SystemParam> ParamSet<'w, 's, (P0,)>
impl<'w, 's, P0: SystemParam> ParamSet<'w, 's, (P0,)>
sourcepub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
pub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
Gets exclusive access to the 0th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
source§impl<'w, 's, P0: SystemParam, P1: SystemParam> ParamSet<'w, 's, (P0, P1)>
impl<'w, 's, P0: SystemParam, P1: SystemParam> ParamSet<'w, 's, (P0, P1)>
sourcepub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
pub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
Gets exclusive access to the 0th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
pub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
Gets exclusive access to the 1st parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
source§impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam> ParamSet<'w, 's, (P0, P1, P2)>
impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam> ParamSet<'w, 's, (P0, P1, P2)>
sourcepub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
pub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
Gets exclusive access to the 0th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
pub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
Gets exclusive access to the 1st parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
pub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
Gets exclusive access to the 2nd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
source§impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam> ParamSet<'w, 's, (P0, P1, P2, P3)>
impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam> ParamSet<'w, 's, (P0, P1, P2, P3)>
sourcepub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
pub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
Gets exclusive access to the 0th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
pub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
Gets exclusive access to the 1st parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
pub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
Gets exclusive access to the 2nd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p3<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P3>
pub fn p3<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P3>
Gets exclusive access to the 3rd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
source§impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam> ParamSet<'w, 's, (P0, P1, P2, P3, P4)>
impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam> ParamSet<'w, 's, (P0, P1, P2, P3, P4)>
sourcepub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
pub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
Gets exclusive access to the 0th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
pub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
Gets exclusive access to the 1st parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
pub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
Gets exclusive access to the 2nd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p3<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P3>
pub fn p3<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P3>
Gets exclusive access to the 3rd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p4<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P4>
pub fn p4<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P4>
Gets exclusive access to the 4th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
source§impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>
impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>
sourcepub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
pub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
Gets exclusive access to the 0th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
pub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
Gets exclusive access to the 1st parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
pub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
Gets exclusive access to the 2nd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p3<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P3>
pub fn p3<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P3>
Gets exclusive access to the 3rd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p4<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P4>
pub fn p4<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P4>
Gets exclusive access to the 4th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p5<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P5>
pub fn p5<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P5>
Gets exclusive access to the 5th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
source§impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>
impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>
sourcepub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
pub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
Gets exclusive access to the 0th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
pub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
Gets exclusive access to the 1st parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
pub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
Gets exclusive access to the 2nd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p3<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P3>
pub fn p3<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P3>
Gets exclusive access to the 3rd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p4<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P4>
pub fn p4<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P4>
Gets exclusive access to the 4th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p5<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P5>
pub fn p5<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P5>
Gets exclusive access to the 5th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p6<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P6>
pub fn p6<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P6>
Gets exclusive access to the 6th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
source§impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>
impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>
sourcepub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
pub fn p0<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P0>
Gets exclusive access to the 0th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
pub fn p1<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P1>
Gets exclusive access to the 1st parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
pub fn p2<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P2>
Gets exclusive access to the 2nd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p3<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P3>
pub fn p3<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P3>
Gets exclusive access to the 3rd parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p4<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P4>
pub fn p4<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P4>
Gets exclusive access to the 4th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p5<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P5>
pub fn p5<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P5>
Gets exclusive access to the 5th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p6<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P6>
pub fn p6<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P6>
Gets exclusive access to the 6th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
sourcepub fn p7<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P7>
pub fn p7<'a>(&'a mut self) -> SystemParamItem<'a, 'a, P7>
Gets exclusive access to the 7th parameter in this ParamSet
.
No other parameters may be accessed while this one is active.
Trait Implementations§
source§impl<'_w, '_s, P0: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0,)>
impl<'_w, '_s, P0: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0,)>
§type State = (<P0 as SystemParam>::State,)
type State = (<P0 as SystemParam>::State,)
§type Item<'w, 's> = ParamSet<'w, 's, (P0,)>
type Item<'w, 's> = ParamSet<'w, 's, (P0,)>
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
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 )
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)
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.source§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>
SystemParamFunction
. Read moresource§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
apply_deferred
.source§impl<'_w, '_s, P0: SystemParam, P1: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1)>
impl<'_w, '_s, P0: SystemParam, P1: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1)>
§type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State)
type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State)
§type Item<'w, 's> = ParamSet<'w, 's, (P0, P1)>
type Item<'w, 's> = ParamSet<'w, 's, (P0, P1)>
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
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 )
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)
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.source§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>
SystemParamFunction
. Read moresource§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
apply_deferred
.source§impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2)>
impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2)>
§type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State)
type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State)
§type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2)>
type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2)>
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
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 )
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)
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.source§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>
SystemParamFunction
. Read moresource§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
apply_deferred
.source§impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3)>
impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3)>
§type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State)
type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State)
§type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3)>
type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3)>
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
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 )
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)
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.source§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>
SystemParamFunction
. Read moresource§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
apply_deferred
.source§impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)>
impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)>
§type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State)
type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State)
§type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4)>
type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4)>
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
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 )
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)
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.source§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>
SystemParamFunction
. Read moresource§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
apply_deferred
.source§impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)>
impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)>
§type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State, <P5 as SystemParam>::State)
type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State, <P5 as SystemParam>::State)
§type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>
type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>
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
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 )
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)
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.source§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>
SystemParamFunction
. Read moresource§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
apply_deferred
.source§impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)>
impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)>
§type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State, <P5 as SystemParam>::State, <P6 as SystemParam>::State)
type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State, <P5 as SystemParam>::State, <P6 as SystemParam>::State)
§type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>
type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>
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
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 )
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)
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.source§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>
SystemParamFunction
. Read moresource§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
apply_deferred
.source§impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)>
impl<'_w, '_s, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)>
§type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State, <P5 as SystemParam>::State, <P6 as SystemParam>::State, <P7 as SystemParam>::State)
type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State, <P5 as SystemParam>::State, <P6 as SystemParam>::State, <P7 as SystemParam>::State)
§type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>
type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>
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
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 )
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)
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.source§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>
SystemParamFunction
. Read moresource§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
apply_deferred
.impl<'w, 's, P0> ReadOnlySystemParam for ParamSet<'w, 's, (P0,)>where
P0: ReadOnlySystemParam,
impl<'w, 's, P0, P1> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1)>where
P0: ReadOnlySystemParam,
P1: ReadOnlySystemParam,
impl<'w, 's, P0, P1, P2> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2)>
impl<'w, 's, P0, P1, P2, P3> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2, P3)>where
P0: ReadOnlySystemParam,
P1: ReadOnlySystemParam,
P2: ReadOnlySystemParam,
P3: ReadOnlySystemParam,
impl<'w, 's, P0, P1, P2, P3, P4> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2, P3, P4)>where
P0: ReadOnlySystemParam,
P1: ReadOnlySystemParam,
P2: ReadOnlySystemParam,
P3: ReadOnlySystemParam,
P4: ReadOnlySystemParam,
impl<'w, 's, P0, P1, P2, P3, P4, P5> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>where
P0: ReadOnlySystemParam,
P1: ReadOnlySystemParam,
P2: ReadOnlySystemParam,
P3: ReadOnlySystemParam,
P4: ReadOnlySystemParam,
P5: ReadOnlySystemParam,
impl<'w, 's, P0, P1, P2, P3, P4, P5, P6> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>where
P0: ReadOnlySystemParam,
P1: ReadOnlySystemParam,
P2: ReadOnlySystemParam,
P3: ReadOnlySystemParam,
P4: ReadOnlySystemParam,
P5: ReadOnlySystemParam,
P6: ReadOnlySystemParam,
impl<'w, 's, P0, P1, P2, P3, P4, P5, P6, P7> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>where
P0: ReadOnlySystemParam,
P1: ReadOnlySystemParam,
P2: ReadOnlySystemParam,
P3: ReadOnlySystemParam,
P4: ReadOnlySystemParam,
P5: ReadOnlySystemParam,
P6: ReadOnlySystemParam,
P7: ReadOnlySystemParam,
Auto Trait Implementations§
impl<'w, 's, T> Freeze for ParamSet<'w, 's, T>
impl<'w, 's, T> !RefUnwindSafe for ParamSet<'w, 's, T>
impl<'w, 's, T> Send for ParamSet<'w, 's, T>
impl<'w, 's, T> Sync for ParamSet<'w, 's, T>
impl<'w, 's, T> Unpin for ParamSet<'w, 's, T>
impl<'w, 's, T> !UnwindSafe for ParamSet<'w, 's, T>
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
source§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>
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>
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)
&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)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.