Struct bevy_cobweb::react::EntityReactor

pub struct EntityReactor<'w, T: EntityWorldReactor> { /* private fields */ }

System parameter for accessing and updating an EntityWorldReactor.

Implementations

impl<'w, T: EntityWorldReactor> EntityReactor<'w, T>

pub fn add( &self, c: &mut Commands<'_, '_>, trigger_entity: Entity, data: T::Local, ) -> bool

Adds a listener to the reactor.

Returns false if:

• The reactor doesn’t exist.
• The trigger entity doesn’t exist.

pub fn remove( &self, c: &mut Commands<'_, '_>, triggers: impl ReactionTriggerBundle, ) -> bool

Removes triggers from the reactor.

Note that registered data will be removed from an entity when all its entity-specific triggers for this reactor have been removed. It is possible for this method to race with parallel systems that re-add entities referenced by the removal bundle.

Returns false if the reactor doesn’t exist.

Trait Implementations

impl<T: EntityWorldReactor> SystemParam for EntityReactor<'_, T>

type State = FetchState<T>

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

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

where Option<ResMut<'w, EntityWorldReactorRes<T>>>: ReadOnlySystemParam,