Struct ImmCtx 

pub struct ImmCtx<'w, 's, Caps>
where
    Caps: CapSet,
{
    pub cap_entities: ImmCapQueryParam<'w, 's, Caps>,
    pub cap_resources: ImmCapResourcesParam<'w, 's, Caps>,
    pub commands: Commands<'w, 's>,
    pub system_change_tick: SystemChangeTick,
    /* private fields */
}

Immediate mode ctx

Fields

cap_entities: ImmCapQueryParam<'w, 's, Caps>

Access data from entities for components that were requested by capabilities

In case of collision. Use super::ImmQuery or bevy_ecs::prelude::Without<ImmMarker<()>> (replace () with your used `Cap``)

cap_resources: ImmCapResourcesParam<'w, 's, Caps>

Access requested resources that were requested by capabilities

commands: Commands<'w, 's>

World commands

system_change_tick: SystemChangeTick

System execution ticks

Useful for state change detection

Implementations

impl<'w, 's, Caps> ImmCtx<'w, 's, Caps>

where Caps: CapSet,

pub fn build_immediate_root<T>(self, root_id: T) -> Imm<'w, 's, Caps>

where T: Hash,

Initialize entity hierarchy managed by immediate mode

When hotpatching feature is enabled. Will combine id with last time when hotpatching was triggered

pub fn build_immediate_from<T>( self, root_id: T, entity: Entity, ) -> Imm<'w, 's, Caps>

where T: Hash,

Initialize entity hierarchy managed by immediate mode starting from given existing entity

When hotpatching feature is enabled. Will combine id with last time when hotpatching was triggered

pub fn commands_mut(&mut self) -> &mut Commands<'w, 's>

Access commands

Trait Implementations

impl<Caps> SystemParam for ImmCtx<'_, '_, Caps>

where Caps: CapSet,

type State = FetchState<Caps>

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

type Item<'w, 's> = ImmCtx<'w, 's, Caps>

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) -> <ImmCtx<'_, '_, Caps> as SystemParam>::State

Creates a new instance of this param’s State.

fn init_access( state: &<ImmCtx<'_, '_, Caps> as SystemParam>::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )

Registers any World access used by this SystemParam

fn apply( state: &mut <ImmCtx<'_, '_, Caps> 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 ApplyDeferred.

fn queue( state: &mut <ImmCtx<'_, '_, Caps> as SystemParam>::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 mut <ImmCtx<'_, '_, Caps> as SystemParam>::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 <ImmCtx<'_, '_, Caps> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> <ImmCtx<'_, '_, Caps> as SystemParam>::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's, Caps> ReadOnlySystemParam for ImmCtx<'w, 's, Caps>

where Caps: CapSet, ImmCapQueryParam<'w, 's, Caps>: ReadOnlySystemParam, ImmCapResourcesParam<'w, 's, Caps>: ReadOnlySystemParam, Commands<'w, 's>: ReadOnlySystemParam, SystemChangeTick: ReadOnlySystemParam, Res<'w, ImmCapAccessRequestsResource<Caps>>: ReadOnlySystemParam, Res<'w, ImmediateModeStateResource<Caps>>: ReadOnlySystemParam, Res<'w, ImmediateModeEntityMapping<Caps>>: ReadOnlySystemParam, Query<'w, 's, ImmEntityQuery<Caps>, (With<ImmMarker<Caps>>, ())>: ReadOnlySystemParam, ResMut<'w, CachedHash<Caps>>: ReadOnlySystemParam,