Struct Events 

pub struct Events<E: Hash + Copy + Eq + Sync + Send> { /* private fields */ }

All events produced in one frame: connections, entity lifecycle, component changes, messages, and errors.

Implementations

impl<E: Hash + Copy + Eq + Sync + Send> Events<E>

pub fn is_empty(&self) -> bool

Returns true if no events were queued this frame.

pub fn read<V: WorldEvent<E>>(&mut self) -> V::Iter

Drains and returns an iterator over events of type V.

pub fn has<V: WorldEvent<E>>(&self) -> bool

Returns true if at least one event of type V is queued.

pub fn has_messages(&self) -> bool

Returns true if any messages are queued; prefer read::<MessageEvent<C, M>>() in application code.

pub fn take_messages( &mut self, ) -> HashMap<ChannelKind, HashMap<MessageKind, Vec<MessageContainer>>>

Takes all queued messages, leaving the internal buffer empty; prefer read::<MessageEvent<C, M>>() in application code.

pub fn has_requests(&self) -> bool

Returns true if any requests are queued; prefer read::<RequestEvent<C, Q>>() in application code.

pub fn take_requests( &mut self, ) -> HashMap<ChannelKind, HashMap<MessageKind, Vec<(GlobalResponseId, MessageContainer)>>>

Takes all queued requests, leaving the internal buffer empty; prefer read::<RequestEvent<C, Q>>() in application code.

pub fn has_inserts(&self) -> bool

Returns true if any component-insert events are queued; prefer read::<InsertComponentEvent<C>>() in application code.

pub fn take_inserts(&mut self) -> Option<HashMap<ComponentKind, Vec<E>>>

Takes all queued component-insert events; prefer read::<InsertComponentEvent<C>>() in application code.

pub fn has_updates(&self) -> bool

Returns true if any component-update events are queued; prefer read::<UpdateComponentEvent<C>>() in application code.

pub fn take_updates(&mut self) -> Option<HashMap<ComponentKind, Vec<(Tick, E)>>>

Takes all queued component-update events; prefer read::<UpdateComponentEvent<C>>() in application code.

pub fn has_removes(&self) -> bool

Returns true if any component-remove events are queued; prefer read::<RemoveComponentEvent<C>>() in application code.

pub fn take_removes( &mut self, ) -> Option<HashMap<ComponentKind, Vec<(E, Box<dyn Replicate>)>>>

Takes all queued component-remove events; prefer read::<RemoveComponentEvent<C>>() in application code.

Trait Implementations

impl<E: Hash + Copy + Eq + Sync + Send> Default for Events<E>

fn default() -> Self

Returns the “default value” for a type.