Struct Sender

pub struct Sender<'a, T>
where
    T: EventSet,
{ /* private fields */ }

A HandlerParam for sending events from the set T.

For more information, see the relevant tutorial chapter.

Implementations

impl<T> Sender<'_, T>

where T: EventSet,

pub fn send<E>(&mut self, event: E)

where E: GlobalEvent + 'static,

Add a GlobalEvent to the queue of events to send.

The queue is flushed once all handlers for the current event have run.

Panics

• Panics if E is not in the EventSet of this sender.

pub fn send_to<E>(&mut self, target: EntityId, event: E)

where E: TargetedEvent + 'static,

Add a TargetedEvent to the queue of events to send.

The queue is flushed once all handlers for the current event have run.

pub fn spawn(&mut self) -> EntityId

Queue the creation of a new entity.

This returns the EntityId of the to-be-spawned entity and queues the Spawn event. Note that the returned EntityId may not be valid until after the Spawn event has finished broadcasting.

The new entity will be spawned without any components attached, and the returned EntityId will not have been used by any previous entities.

Panics

Panics if Spawn is not in the EventSet of this sender.

pub fn insert<C>(&mut self, target: EntityId, component: C)

where C: Component,

Queue an Insert event.

This is equivalent to:

sender.send_to(target, Insert(component));

Panics

Panics if Insert<C> is not in the EventSet of this sender.

pub fn remove<C>(&mut self, target: EntityId)

where C: Component,

Queue a Remove event.

This is equivalent to:

sender.send_to(target, Remove::<C>);

Panics

Panics if Remove<C> is not in the EventSet of this sender.

pub fn despawn(&mut self, target: EntityId)

Queue a Despawn event.

This is equivalent to:

sender.send_to(target, Despawn);

Panics

Panics if Despawn is not in the EventSet of this sender.

Trait Implementations

impl<'a, T> Clone for Sender<'a, T>

where T: Clone + EventSet, <T as EventSet>::Indices: Clone,

fn clone(&self) -> Sender<'a, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Sender<'_, T>

where T: EventSet, <T as EventSet>::Indices: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> HandlerParam for Sender<'_, T>

where T: EventSet,

type State = <T as EventSet>::Indices

Persistent data stored in the handler.

type This<'a> = Sender<'a, T>

The type produced by this handler param. This must be the type of Self but with the lifetime of 'a.

fn init( world: &mut World, config: &mut HandlerConfig, ) -> Result<<Sender<'_, T> as HandlerParam>::State, InitError>

Initializes the handler using the input World and HandlerConfig.

unsafe fn get<'a>( state: &'a mut <Sender<'_, T> as HandlerParam>::State, _info: &'a HandlerInfo, _event_ptr: EventPtr<'a>, _target_location: EntityLocation, world: UnsafeWorldCell<'a>, ) -> <Sender<'_, T> as HandlerParam>::This<'a>

Obtains a new instance of the handler parameter.

fn refresh_archetype( _state: &mut <Sender<'_, T> as HandlerParam>::State, _arch: &Archetype, )

Refresh an archetype for this handler param. Called whenever Handler::refresh_archetype is called.

fn remove_archetype( _state: &mut <Sender<'_, T> as HandlerParam>::State, _arch: &Archetype, )

Remove the given archetype for this handler param. Called whenever Handler::remove_archetype is called.

impl<'a, T> Copy for Sender<'a, T>

where T: Copy + EventSet, <T as EventSet>::Indices: Copy,