Trait bevy_ecs::system::SystemParam

pub trait SystemParam: Sized {
    type Fetch: for<'a> SystemParamFetch<'a>;
}

A parameter that can be used in a system function

Derive

This trait can be derived.

use bevy_ecs::system::SystemParam;

#[derive(SystemParam)]
pub struct MyParam<'a> {
    foo: Res<'a, usize>,
}

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

Associated Types

type Fetch: for<'a> SystemParamFetch<'a>

Loading content...

Implementations on Foreign Types

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

type Fetch = OptionResState<T>

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

type Fetch = OptionResMutState<T>

impl SystemParam for ()

type Fetch = ()

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

type Fetch = (P0::Fetch,)

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

type Fetch = (P0::Fetch, P1::Fetch)

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

type Fetch = (P0::Fetch, P1::Fetch, P2::Fetch)

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

type Fetch = (P0::Fetch, P1::Fetch, P2::Fetch, P3::Fetch)

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

type Fetch = (P0::Fetch, P1::Fetch, P2::Fetch, P3::Fetch, P4::Fetch)

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

type Fetch = (P0::Fetch, P1::Fetch, P2::Fetch, P3::Fetch, P4::Fetch, P5::Fetch)

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

type Fetch = (P0::Fetch, P1::Fetch, P2::Fetch, P3::Fetch, P4::Fetch, P5::Fetch, P6::Fetch)

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

type Fetch = (P0::Fetch, P1::Fetch, P2::Fetch, P3::Fetch, P4::Fetch, P5::Fetch, P6::Fetch, P7::Fetch)

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

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

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

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

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

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

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

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

impl<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> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12)

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

impl<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> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13)

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

impl<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> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14)

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

impl<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> SystemParam for (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15)

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

Loading content...

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> SystemParam for Commands<'a>

type Fetch = CommandQueue

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

type Fetch = QueryState<Q, F>

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

type Fetch = NonSendState<T>

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

type Fetch = NonSendMutState<T>

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

type Fetch = LocalState<T>

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

type Fetch = RemovedComponentsState<T>

impl<'a, T: Component> SystemParam for Res<'a, T>

type Fetch = ResState<T>

impl<'a, T: Component> SystemParam for ResMut<'a, T>

type Fetch = ResMutState<T>

impl<'q0, 'q1, 'q2, 'q3, Q0: WorldQuery + 'static, Q1: WorldQuery + 'static, Q2: WorldQuery + 'static, Q3: WorldQuery + 'static, F0: WorldQuery + 'static, F1: WorldQuery + 'static, F2: WorldQuery + 'static, F3: WorldQuery + 'static> SystemParam for QuerySet<(Query<'q0, Q0, F0>, Query<'q1, Q1, F1>, Query<'q2, Q2, F2>, Query<'q3, Q3, F3>)> where
    F0::Fetch: FilterFetch,
    F1::Fetch: FilterFetch,
    F2::Fetch: FilterFetch,
    F3::Fetch: FilterFetch, 

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

impl<'q0, 'q1, 'q2, Q0: WorldQuery + 'static, Q1: WorldQuery + 'static, Q2: WorldQuery + 'static, F0: WorldQuery + 'static, F1: WorldQuery + 'static, F2: WorldQuery + 'static> SystemParam for QuerySet<(Query<'q0, Q0, F0>, Query<'q1, Q1, F1>, Query<'q2, Q2, F2>)> where
    F0::Fetch: FilterFetch,
    F1::Fetch: FilterFetch,
    F2::Fetch: FilterFetch, 

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

impl<'q0, 'q1, Q0: WorldQuery + 'static, Q1: WorldQuery + 'static, F0: WorldQuery + 'static, F1: WorldQuery + 'static> SystemParam for QuerySet<(Query<'q0, Q0, F0>, Query<'q1, Q1, F1>)> where
    F0::Fetch: FilterFetch,
    F1::Fetch: FilterFetch, 

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

impl<'q0, Q0: WorldQuery + 'static, F0: WorldQuery + 'static> SystemParam for QuerySet<(Query<'q0, Q0, F0>,)> where
    F0::Fetch: FilterFetch, 

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

Loading content...