Struct bevy::ecs::system::ParamSet

pub struct ParamSet<'w, 's, T>where
    T: SystemParam,{ /* private fields */ }
Expand description

A collection of potentially conflicting SystemParams allowed by disjoint access.

Allows systems to safely access and interact with up to 8 mutually exclusive SystemParams, 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 SystemParams 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, ParamSets 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().iter() {
        // ...
    }
    set.p1().send(MyEvent::new());
     
    let entities = set.p2().entities();
    // ...
}

Implementations§

§

impl<'w, 's, P0> ParamSet<'w, 's, (P0,)>where P0: SystemParam,

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 0th parameter in this ParamSet. No other parameters may be accessed while this one is active.

§

impl<'w, 's, P0, P1> ParamSet<'w, 's, (P0, P1)>where P0: SystemParam, P1: SystemParam,

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 0th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 1st parameter in this ParamSet. No other parameters may be accessed while this one is active.

§

impl<'w, 's, P0, P1, P2> ParamSet<'w, 's, (P0, P1, P2)>where P0: SystemParam, P1: SystemParam, P2: SystemParam,

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 0th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 1st parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 2nd parameter in this ParamSet. No other parameters may be accessed while this one is active.

§

impl<'w, 's, P0, P1, P2, P3> ParamSet<'w, 's, (P0, P1, P2, P3)>where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam,

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 0th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 1st parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 2nd parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p3<'a>(&'a mut self) -> <P3 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 3rd parameter in this ParamSet. No other parameters may be accessed while this one is active.

§

impl<'w, 's, P0, P1, P2, P3, P4> ParamSet<'w, 's, (P0, P1, P2, P3, P4)>where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam,

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 0th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 1st parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 2nd parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p3<'a>(&'a mut self) -> <P3 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 3rd parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p4<'a>(&'a mut self) -> <P4 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 4th parameter in this ParamSet. No other parameters may be accessed while this one is active.

§

impl<'w, 's, P0, P1, P2, P3, P4, P5> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam,

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 0th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 1st parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 2nd parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p3<'a>(&'a mut self) -> <P3 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 3rd parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p4<'a>(&'a mut self) -> <P4 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 4th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p5<'a>(&'a mut self) -> <P5 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 5th parameter in this ParamSet. No other parameters may be accessed while this one is active.

§

impl<'w, 's, P0, P1, P2, P3, P4, P5, P6> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam,

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 0th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 1st parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 2nd parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p3<'a>(&'a mut self) -> <P3 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 3rd parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p4<'a>(&'a mut self) -> <P4 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 4th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p5<'a>(&'a mut self) -> <P5 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 5th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p6<'a>(&'a mut self) -> <P6 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 6th parameter in this ParamSet. No other parameters may be accessed while this one is active.

§

impl<'w, 's, P0, P1, P2, P3, P4, P5, P6, P7> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam,

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 0th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 1st parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 2nd parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p3<'a>(&'a mut self) -> <P3 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 3rd parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p4<'a>(&'a mut self) -> <P4 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 4th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p5<'a>(&'a mut self) -> <P5 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 5th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p6<'a>(&'a mut self) -> <P6 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 6th parameter in this ParamSet. No other parameters may be accessed while this one is active.

pub fn p7<'a>(&'a mut self) -> <P7 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the 7th parameter in this ParamSet. No other parameters may be accessed while this one is active.

Trait Implementations§

§

impl<'_w, '_s, P0> SystemParam for ParamSet<'_w, '_s, (P0,)>where P0: SystemParam,

§

type State = (<P0 as SystemParam>::State,)

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

type Item = ParamSet<'w, 's, (P0,)>

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

fn init_state( world: &mut World, system_meta: &mut SystemMeta ) -> <ParamSet<'_w, '_s, (P0,)> as SystemParam>::State

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

fn new_archetype( state: &mut <ParamSet<'_w, '_s, (P0,)> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta )

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

fn apply( state: &mut <ParamSet<'_w, '_s, (P0,)> as SystemParam>::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_system_buffers.
§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0,)> as SystemParam>::State, system_meta: &SystemMeta, world: &'w World, change_tick: u32 ) -> <ParamSet<'_w, '_s, (P0,)> as SystemParam>::Item<'w, 's>

Safety Read more
§

impl<'_w, '_s, P0, P1> SystemParam for ParamSet<'_w, '_s, (P0, P1)>where P0: SystemParam, P1: SystemParam,

§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State)

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

type Item = ParamSet<'w, 's, (P0, P1)>

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

fn init_state( world: &mut World, system_meta: &mut SystemMeta ) -> <ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::State

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

fn new_archetype( state: &mut <ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta )

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

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::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_system_buffers.
§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::State, system_meta: &SystemMeta, world: &'w World, change_tick: u32 ) -> <ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::Item<'w, 's>

Safety Read more
§

impl<'_w, '_s, P0, P1, P2> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2)>where P0: SystemParam, P1: SystemParam, P2: SystemParam,

§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State)

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

type Item = ParamSet<'w, 's, (P0, P1, P2)>

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

fn init_state( world: &mut World, system_meta: &mut SystemMeta ) -> <ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::State

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

fn new_archetype( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta )

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

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::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_system_buffers.
§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::State, system_meta: &SystemMeta, world: &'w World, change_tick: u32 ) -> <ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::Item<'w, 's>

Safety Read more
§

impl<'_w, '_s, P0, P1, P2, P3> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3)>where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam,

§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State)

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

type Item = ParamSet<'w, 's, (P0, P1, P2, P3)>

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

fn init_state( world: &mut World, system_meta: &mut SystemMeta ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::State

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

fn new_archetype( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta )

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

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::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_system_buffers.
§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::State, system_meta: &SystemMeta, world: &'w World, change_tick: u32 ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::Item<'w, 's>

Safety Read more
§

impl<'_w, '_s, P0, P1, P2, P3, P4> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)>where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam,

§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State)

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

type Item = ParamSet<'w, 's, (P0, P1, P2, P3, P4)>

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

fn init_state( world: &mut World, system_meta: &mut SystemMeta ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::State

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

fn new_archetype( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta )

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

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::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_system_buffers.
§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::State, system_meta: &SystemMeta, world: &'w World, change_tick: u32 ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::Item<'w, 's>

Safety Read more
§

impl<'_w, '_s, P0, P1, P2, P3, P4, P5> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)>where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam,

§

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)

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

type Item = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>

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

fn init_state( world: &mut World, system_meta: &mut SystemMeta ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::State

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

fn new_archetype( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta )

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

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::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_system_buffers.
§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::State, system_meta: &SystemMeta, world: &'w World, change_tick: u32 ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::Item<'w, 's>

Safety Read more
§

impl<'_w, '_s, P0, P1, P2, P3, P4, P5, P6> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)>where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam,

§

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)

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

type Item = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>

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

fn init_state( world: &mut World, system_meta: &mut SystemMeta ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::State

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

fn new_archetype( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta )

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

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::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_system_buffers.
§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::State, system_meta: &SystemMeta, world: &'w World, change_tick: u32 ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::Item<'w, 's>

Safety Read more
§

impl<'_w, '_s, P0, P1, P2, P3, P4, P5, P6, P7> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)>where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam,

§

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)

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

type Item = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>

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

fn init_state( world: &mut World, system_meta: &mut SystemMeta ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::State

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

fn new_archetype( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta )

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

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::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_system_buffers.
§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::State, system_meta: &SystemMeta, world: &'w World, change_tick: u32 ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::Item<'w, 's>

Safety Read more
§

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)>where P0: ReadOnlySystemParam, P1: ReadOnlySystemParam, P2: ReadOnlySystemParam,

§

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> !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> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,

§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

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.
§

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.
§

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T, U> ToSample<U> for Twhere U: FromSample<T>,

§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<S, T> Duplex<S> for Twhere T: FromSample<S> + ToSample<S>,

§

impl<T> Event for Twhere T: Send + Sync + 'static,