Module evenio::event

Types for sending and receiving Events.

Structs

• AddGlobalEvent
  An Event sent immediately after a new global event is added to the world.
• AddTargetedEvent
  An Event sent immediately after a new targeted event is added to the world.
• Despawn
  A TargetedEvent which removes an entity from the World when sent. All components of the target entity are dropped.
• EventDescriptor
  Data needed to create a new event.
• EventMut
  Mutable reference to an instance of event E.
• EventPtr
  Type-erased pointer to an event. Passed to handlers in Handler::run.
• GlobalEventId
  Lightweight identifier for a global event type.
• GlobalEventIdx
  A GlobalEventId with the generation count stripped out.
• GlobalEventInfo
  Contains all the metadata for an added GlobalEvent.
• GlobalEvents
  Stores metadata for all GlobalEvents in the world.
• Insert
  A TargetedEvent which adds component C on an entity when sent. If the entity already has the component, then the component is replaced.
• Receiver
  A HandlerParam which listens for events of type E.
• ReceiverMut
  Like Receiver, but provides mutable access to the received event. Prefer Receiver if mutable access is not needed.
• RemoveGlobalEvent
  An Event sent immediately before a global event is removed from the world.
• RemoveTargetedEvent
  An Event sent immediately before a targeted event is removed from the world.
• Sender
  A HandlerParam for sending events from the set T.
• Spawn
  A GlobalEvent which signals the creation of an entity. Contains the EntityId of the new entity, which may or may not exist by the time this event is observed.
• TargetedEventId
  Lightweight identifier for a targeted event type.
• TargetedEventIdx
  A TargetedEventId with the generation count stripped out.
• TargetedEventInfo
  Contains all the metadata for an added TargetedEvent.
• TargetedEvents
  Stores metadata for all Events in the world.

Enums

• EventId
  An enum of either GlobalEventId or TargetedEventId.
• EventKind
  Additional behaviors for an event. This is used to distinguish normal user events from special built-in events.
• NullReceiverQuery
  Indicates the absence of a ReceiverQuery.
• Remove
  A TargetedEvent which removes component C from an entity when sent. The component is dropped and cannot be recovered.

Traits

• Event
  Messages which event handlers listen for. This is the base trait of GlobalEvent and TargetedEvent.
• EventIdxMarker
  Sealed marker trait implemented for GlobalEventIdx and TargetedEventIdx.
• EventSet
  A set of Event types.
• GlobalEvent
  An event which has no target entity.
• ReceiverQuery
  Targeted event queries used in Receiver and ReceiverMut. This trait is implemented for all types which implement Query.
• TargetedEvent
  An event which is directed at a particular entity.

Derive Macros

• GlobalEvent
  Derive macro for Event. See Event and GlobalEvent’s documentation for more information.
• TargetedEvent
  Derive macro for Event. See Event and TargetedEvent’s documentation for more information.