Struct ReadRapierContext

pub struct ReadRapierContext<'w, 's, T: QueryFilter + 'static = With<DefaultRapierContext>> {
    pub rapier_context: Query<'w, 's, (&'static RapierContextSimulation, &'static RapierContextColliders, &'static RapierContextJoints, &'static RapierQueryPipeline, &'static RapierRigidBodySet), T>,
}

Utility SystemParam to easily access every required components of a RapierContext immutably.

This uses the DefaultRapierContext filter by default, but you can use a custom query filter with the T type parameter.

Fields

rapier_context: Query<'w, 's, (&'static RapierContextSimulation, &'static RapierContextColliders, &'static RapierContextJoints, &'static RapierQueryPipeline, &'static RapierRigidBodySet), T>

The query used to feed components into RapierContext struct through ReadRapierContext::single.

Implementations

impl<'w, 's, T: QueryFilter + 'static> ReadRapierContext<'w, 's, T>

pub fn single(&self) -> RapierContext<'_>

Use this method if you only have one RapierContext.

SAFETY: This method will panic if its underlying query fails.

Use the underlying query ReadRapierContext::rapier_context for safer alternatives.

Trait Implementations

impl<T: QueryFilter + 'static> SystemParam for ReadRapierContext<'_, '_, T>

type State = FetchState<T>

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

type Item<'w, 's> = ReadRapierContext<'w, 's, T>

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

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

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

unsafe fn validate_param<'w, 's>( state: &'s Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, ) -> bool

Validates that the param can be acquired by the get_param. Built-in executors use this to prevent systems with invalid params from running. For nested SystemParams validation will fail if any delegated validation fails.

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, T: QueryFilter + 'static> ReadOnlySystemParam for ReadRapierContext<'w, 's, T>

where Query<'w, 's, (&'static RapierContextSimulation, &'static RapierContextColliders, &'static RapierContextJoints, &'static RapierQueryPipeline, &'static RapierRigidBodySet), T>: ReadOnlySystemParam,