Struct bevy_ecs::component::ComponentIdFor
source · pub struct ComponentIdFor<'s, T: Component>(/* private fields */);
Expand description
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§
source§impl<T: Component> ComponentIdFor<'_, T>
impl<T: Component> ComponentIdFor<'_, T>
sourcepub fn get(&self) -> ComponentId
pub fn get(&self) -> ComponentId
Gets the ComponentId
for the type T
.
Trait Implementations§
source§impl<T: Component> Deref for ComponentIdFor<'_, T>
impl<T: Component> Deref for ComponentIdFor<'_, T>
source§impl<T: Component> From<ComponentIdFor<'_, T>> for ComponentId
impl<T: Component> From<ComponentIdFor<'_, T>> for ComponentId
source§fn from(to_component_id: ComponentIdFor<'_, T>) -> ComponentId
fn from(to_component_id: ComponentIdFor<'_, T>) -> ComponentId
Converts to this type from the input type.
source§impl<T: Component> SystemParam for ComponentIdFor<'_, T>
impl<T: Component> SystemParam for ComponentIdFor<'_, T>
§type Item<'w, 's> = ComponentIdFor<'s, T>
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. Read moresource§fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State
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
.source§unsafe fn new_archetype(
state: &mut Self::State,
archetype: &Archetype,
system_meta: &mut SystemMeta
)
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 Read moresource§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
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
.source§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
Queues any deferred mutations to be applied at the next
apply_deferred
.source§unsafe fn get_param<'w, 's>(
state: &'s mut Self::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
change_tick: Tick
) -> Self::Item<'w, 's>
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
. Read moreimpl<'w, 's, T: Component> ReadOnlySystemParam for ComponentIdFor<'s, T>where
Local<'s, InitComponentId<T>>: ReadOnlySystemParam,
Auto Trait Implementations§
impl<'s, T> Freeze for ComponentIdFor<'s, T>
impl<'s, T> RefUnwindSafe for ComponentIdFor<'s, T>where
T: RefUnwindSafe,
impl<'s, T> Send for ComponentIdFor<'s, T>
impl<'s, T> Sync for ComponentIdFor<'s, T>
impl<'s, T> Unpin for ComponentIdFor<'s, T>
impl<'s, T> !UnwindSafe for ComponentIdFor<'s, T>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.