Trait bevy::ecs::system::SystemParam

pub trait SystemParam {
    type Fetch: for<'s, 'w> SystemParamFetch<'w, 's>;
}

A parameter that can be used in a System.

Derive

This trait can be derived with the super::SystemParam macro. The only requirement is that every struct field must also implement SystemParam.

use std::marker::PhantomData;
use bevy_ecs::system::SystemParam;

#[derive(SystemParam)]
struct MyParam<'w, 's> {
    foo: Res<'w, usize>,
    #[system_param(ignore)]
    marker: PhantomData<&'s usize>,
}

fn my_system(param: MyParam) {
    // Access the resource through `param.foo`
}

Associated Types

type Fetch: for<'s, 'w> SystemParamFetch<'w, 's>

Implementations on Foreign Types

impl<P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam,
    P3: SystemParam,
    P4: SystemParam,
    P5: SystemParam,
    P6: SystemParam,
    P7: SystemParam,
    P8: SystemParam,
    P9: SystemParam,
    P10: SystemParam,
    P11: SystemParam,
    P12: SystemParam,
    P13: SystemParam,
    P14: SystemParam,
    P15: SystemParam, 

type Fetch = (<P0 as SystemParam>::Fetch, <P1 as SystemParam>::Fetch, <P2 as SystemParam>::Fetch, <P3 as SystemParam>::Fetch, <P4 as SystemParam>::Fetch, <P5 as SystemParam>::Fetch, <P6 as SystemParam>::Fetch, <P7 as SystemParam>::Fetch, <P8 as SystemParam>::Fetch, <P9 as SystemParam>::Fetch, <P10 as SystemParam>::Fetch, <P11 as SystemParam>::Fetch, <P12 as SystemParam>::Fetch, <P13 as SystemParam>::Fetch, <P14 as SystemParam>::Fetch, <P15 as SystemParam>::Fetch)

impl SystemParam for ()

type Fetch = ()

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

type Fetch = (<P0 as SystemParam>::Fetch, <P1 as SystemParam>::Fetch, <P2 as SystemParam>::Fetch, <P3 as SystemParam>::Fetch, <P4 as SystemParam>::Fetch, <P5 as SystemParam>::Fetch, <P6 as SystemParam>::Fetch)

impl<P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam,
    P3: SystemParam,
    P4: SystemParam,
    P5: SystemParam,
    P6: SystemParam,
    P7: SystemParam,
    P8: SystemParam,
    P9: SystemParam,
    P10: SystemParam,
    P11: SystemParam,
    P12: SystemParam,
    P13: SystemParam, 

type Fetch = (<P0 as SystemParam>::Fetch, <P1 as SystemParam>::Fetch, <P2 as SystemParam>::Fetch, <P3 as SystemParam>::Fetch, <P4 as SystemParam>::Fetch, <P5 as SystemParam>::Fetch, <P6 as SystemParam>::Fetch, <P7 as SystemParam>::Fetch, <P8 as SystemParam>::Fetch, <P9 as SystemParam>::Fetch, <P10 as SystemParam>::Fetch, <P11 as SystemParam>::Fetch, <P12 as SystemParam>::Fetch, <P13 as SystemParam>::Fetch)

impl<P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam,
    P3: SystemParam,
    P4: SystemParam,
    P5: SystemParam,
    P6: SystemParam,
    P7: SystemParam,
    P8: SystemParam,
    P9: SystemParam,
    P10: SystemParam,
    P11: SystemParam,
    P12: SystemParam,
    P13: SystemParam,
    P14: SystemParam, 

type Fetch = (<P0 as SystemParam>::Fetch, <P1 as SystemParam>::Fetch, <P2 as SystemParam>::Fetch, <P3 as SystemParam>::Fetch, <P4 as SystemParam>::Fetch, <P5 as SystemParam>::Fetch, <P6 as SystemParam>::Fetch, <P7 as SystemParam>::Fetch, <P8 as SystemParam>::Fetch, <P9 as SystemParam>::Fetch, <P10 as SystemParam>::Fetch, <P11 as SystemParam>::Fetch, <P12 as SystemParam>::Fetch, <P13 as SystemParam>::Fetch, <P14 as SystemParam>::Fetch)

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

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

impl<P0, P1, P2, P3, P4, P5, P6, P7, P8> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam,
    P3: SystemParam,
    P4: SystemParam,
    P5: SystemParam,
    P6: SystemParam,
    P7: SystemParam,
    P8: SystemParam, 

type Fetch = (<P0 as SystemParam>::Fetch, <P1 as SystemParam>::Fetch, <P2 as SystemParam>::Fetch, <P3 as SystemParam>::Fetch, <P4 as SystemParam>::Fetch, <P5 as SystemParam>::Fetch, <P6 as SystemParam>::Fetch, <P7 as SystemParam>::Fetch, <P8 as SystemParam>::Fetch)

impl<'a, T> SystemParam for Option<NonSendMut<'a, T>> where
    T: 'static, 

type Fetch = OptionNonSendMutState<T>

impl<P0, P1> SystemParam for (P0, P1) where
    P0: SystemParam,
    P1: SystemParam, 

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

impl<P0, P1, P2, P3> SystemParam for (P0, P1, P2, P3) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam,
    P3: SystemParam, 

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

impl<P0, P1, P2> SystemParam for (P0, P1, P2) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam, 

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

impl<P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam,
    P3: SystemParam,
    P4: SystemParam,
    P5: SystemParam,
    P6: SystemParam,
    P7: SystemParam,
    P8: SystemParam,
    P9: SystemParam,
    P10: SystemParam, 

type Fetch = (<P0 as SystemParam>::Fetch, <P1 as SystemParam>::Fetch, <P2 as SystemParam>::Fetch, <P3 as SystemParam>::Fetch, <P4 as SystemParam>::Fetch, <P5 as SystemParam>::Fetch, <P6 as SystemParam>::Fetch, <P7 as SystemParam>::Fetch, <P8 as SystemParam>::Fetch, <P9 as SystemParam>::Fetch, <P10 as SystemParam>::Fetch)

impl<P0, P1, P2, P3, P4, P5, P6, P7, P8, P9> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam,
    P3: SystemParam,
    P4: SystemParam,
    P5: SystemParam,
    P6: SystemParam,
    P7: SystemParam,
    P8: SystemParam,
    P9: SystemParam, 

type Fetch = (<P0 as SystemParam>::Fetch, <P1 as SystemParam>::Fetch, <P2 as SystemParam>::Fetch, <P3 as SystemParam>::Fetch, <P4 as SystemParam>::Fetch, <P5 as SystemParam>::Fetch, <P6 as SystemParam>::Fetch, <P7 as SystemParam>::Fetch, <P8 as SystemParam>::Fetch, <P9 as SystemParam>::Fetch)

impl<P0, P1, P2, P3, P4, P5, P6, P7> SystemParam for (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 Fetch = (<P0 as SystemParam>::Fetch, <P1 as SystemParam>::Fetch, <P2 as SystemParam>::Fetch, <P3 as SystemParam>::Fetch, <P4 as SystemParam>::Fetch, <P5 as SystemParam>::Fetch, <P6 as SystemParam>::Fetch, <P7 as SystemParam>::Fetch)

impl<P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam,
    P3: SystemParam,
    P4: SystemParam,
    P5: SystemParam,
    P6: SystemParam,
    P7: SystemParam,
    P8: SystemParam,
    P9: SystemParam,
    P10: SystemParam,
    P11: SystemParam, 

type Fetch = (<P0 as SystemParam>::Fetch, <P1 as SystemParam>::Fetch, <P2 as SystemParam>::Fetch, <P3 as SystemParam>::Fetch, <P4 as SystemParam>::Fetch, <P5 as SystemParam>::Fetch, <P6 as SystemParam>::Fetch, <P7 as SystemParam>::Fetch, <P8 as SystemParam>::Fetch, <P9 as SystemParam>::Fetch, <P10 as SystemParam>::Fetch, <P11 as SystemParam>::Fetch)

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

type Fetch = OptionResMutState<T>

impl<P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam,
    P3: SystemParam,
    P4: SystemParam,
    P5: SystemParam,
    P6: SystemParam,
    P7: SystemParam,
    P8: SystemParam,
    P9: SystemParam,
    P10: SystemParam,
    P11: SystemParam,
    P12: SystemParam, 

type Fetch = (<P0 as SystemParam>::Fetch, <P1 as SystemParam>::Fetch, <P2 as SystemParam>::Fetch, <P3 as SystemParam>::Fetch, <P4 as SystemParam>::Fetch, <P5 as SystemParam>::Fetch, <P6 as SystemParam>::Fetch, <P7 as SystemParam>::Fetch, <P8 as SystemParam>::Fetch, <P9 as SystemParam>::Fetch, <P10 as SystemParam>::Fetch, <P11 as SystemParam>::Fetch, <P12 as SystemParam>::Fetch)

impl<P0> SystemParam for (P0,) where
    P0: SystemParam, 

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

impl<'a, T> SystemParam for Option<Res<'a, T>> where
    T: Resource, 

type Fetch = OptionResState<T>

impl<P0, P1, P2, P3, P4> SystemParam for (P0, P1, P2, P3, P4) where
    P0: SystemParam,
    P1: SystemParam,
    P2: SystemParam,
    P3: SystemParam,
    P4: SystemParam, 

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

impl<'w, T> SystemParam for Option<NonSend<'w, T>> where
    T: 'static, 

type Fetch = OptionNonSendState<T>

Implementors

impl SystemParam for SystemChangeTick

type Fetch = SystemChangeTickState

impl<'a> SystemParam for &'a Archetypes

type Fetch = ArchetypesState

impl<'a> SystemParam for &'a Bundles

type Fetch = BundlesState

impl<'a> SystemParam for &'a Components

type Fetch = ComponentsState

impl<'a> SystemParam for &'a Entities

type Fetch = EntitiesState

impl<'a, T> SystemParam for Local<'a, T> where
    T: Resource + FromWorld, 

type Fetch = LocalState<T>

impl<'a, T> SystemParam for NonSend<'a, T> where
    T: 'static, 

type Fetch = NonSendState<T>

impl<'a, T> SystemParam for NonSendMut<'a, T> where
    T: 'static, 

type Fetch = NonSendMutState<T>

impl<'a, T> SystemParam for RemovedComponents<'a, T> where
    T: Component, 

type Fetch = RemovedComponentsState<T>

impl<'a, T> SystemParam for Res<'a, T> where
    T: Resource, 

type Fetch = ResState<T>

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

type Fetch = ResMutState<T>

impl<'w, 's> SystemParam for Commands<'w, 's>

type Fetch = CommandQueue

impl<'w, 's, Q0, F0> SystemParam for QuerySet<'w, 's, (QueryState<Q0, F0>,)> where
    Q0: 'static + WorldQuery,
    F0: 'static + WorldQuery,
    <F0 as WorldQuery>::Fetch: FilterFetch, 

type Fetch = QuerySetState<(QueryState<Q0, F0>,)>

impl<'w, 's, Q0, Q1, F0, F1> SystemParam for QuerySet<'w, 's, (QueryState<Q0, F0>, QueryState<Q1, F1>)> where
    Q0: 'static + WorldQuery,
    Q1: 'static + WorldQuery,
    F0: 'static + WorldQuery,
    F1: 'static + WorldQuery,
    <F0 as WorldQuery>::Fetch: FilterFetch,
    <F1 as WorldQuery>::Fetch: FilterFetch, 

type Fetch = QuerySetState<(QueryState<Q0, F0>, QueryState<Q1, F1>)>

impl<'w, 's, Q0, Q1, Q2, F0, F1, F2> SystemParam for QuerySet<'w, 's, (QueryState<Q0, F0>, QueryState<Q1, F1>, QueryState<Q2, F2>)> where
    Q0: 'static + WorldQuery,
    Q1: 'static + WorldQuery,
    Q2: 'static + WorldQuery,
    F0: 'static + WorldQuery,
    F1: 'static + WorldQuery,
    F2: 'static + WorldQuery,
    <F0 as WorldQuery>::Fetch: FilterFetch,
    <F1 as WorldQuery>::Fetch: FilterFetch,
    <F2 as WorldQuery>::Fetch: FilterFetch, 

type Fetch = QuerySetState<(QueryState<Q0, F0>, QueryState<Q1, F1>, QueryState<Q2, F2>)>

impl<'w, 's, Q0, Q1, Q2, Q3, F0, F1, F2, F3> SystemParam for QuerySet<'w, 's, (QueryState<Q0, F0>, QueryState<Q1, F1>, QueryState<Q2, F2>, QueryState<Q3, F3>)> where
    Q0: 'static + WorldQuery,
    Q1: 'static + WorldQuery,
    Q2: 'static + WorldQuery,
    Q3: 'static + WorldQuery,
    F0: 'static + WorldQuery,
    F1: 'static + WorldQuery,
    F2: 'static + WorldQuery,
    F3: 'static + WorldQuery,
    <F0 as WorldQuery>::Fetch: FilterFetch,
    <F1 as WorldQuery>::Fetch: FilterFetch,
    <F2 as WorldQuery>::Fetch: FilterFetch,
    <F3 as WorldQuery>::Fetch: FilterFetch, 

type Fetch = QuerySetState<(QueryState<Q0, F0>, QueryState<Q1, F1>, QueryState<Q2, F2>, QueryState<Q3, F3>)>

impl<'w, 's, Q, F> SystemParam for Query<'w, 's, Q, F> where
    Q: 'static + WorldQuery,
    F: 'static + WorldQuery,
    <F as WorldQuery>::Fetch: FilterFetch, 

type Fetch = QueryState<Q, F>

impl<'w, 's, T> SystemParam for EventReader<'w, 's, T> where
    T: Resource, 

type Fetch = EventReaderState<(<Local<'s, (usize, PhantomData<T>)> as SystemParam>::Fetch, <Res<'w, Events<T>> as SystemParam>::Fetch), T>

impl<'w, 's, T> SystemParam for EventWriter<'w, 's, T> where
    T: Resource, 

type Fetch = EventWriterState<(<ResMut<'w, Events<T>> as SystemParam>::Fetch,), T>