Struct ComponentIdFor

pub struct ComponentIdFor<'s, T: Component>(/* private fields */);

A SystemParam that provides access to the ComponentId for a specific component type.

Example

#[derive(Component)]
struct Player;
fn my_system(component_id: ComponentIdFor<Player>) {
    let component_id: ComponentId = component_id.get();
    // ...
}

Implementations

impl<T: Component> ComponentIdFor<'_, T>

pub fn get(&self) -> ComponentId

Gets the ComponentId for the type T.

Trait Implementations

impl<T: Component> Deref for ComponentIdFor<'_, T>

type Target = ComponentId

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Component> From<ComponentIdFor<'_, T>> for ComponentId

fn from(to_component_id: ComponentIdFor<'_, T>) -> ComponentId

Converts to this type from the input type.

impl<T: Component> SystemParam for ComponentIdFor<'_, T>

type State = FetchState<T>

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

type Item<'w, 's> = ComponentIdFor<'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 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: Component> ReadOnlySystemParam for ComponentIdFor<'s, T>

where Local<'s, InitComponentId<T>>: ReadOnlySystemParam,