Struct YoleckKnobs

pub struct YoleckKnobs<'w, 's> { /* private fields */ }

Implementations

impl YoleckKnobs<'_, '_>

pub fn knob<K>(&mut self, key: K) -> YoleckKnobHandle<'_>

where K: 'static + Send + Sync + Hash + Eq,

Trait Implementations

impl SystemParam for YoleckKnobs<'_, '_>

type State = FetchState

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

type Item<'w, 's> = YoleckKnobs<'w, 's>

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

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.

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

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

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.

unsafe fn validate_param<'w, 's>( state: &'s Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

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.

impl<'w, 's> ReadOnlySystemParam for YoleckKnobs<'w, 's>

where ResMut<'w, YoleckKnobsCache>: ReadOnlySystemParam, Commands<'w, 's>: ReadOnlySystemParam, Res<'w, YoleckPassedData>: ReadOnlySystemParam,