Module event

Event handling types.

Re-exports

pub use update::EventUpdates;

Structs

EventCursor

Stores the state for an EventReader or EventMutator.

EventId

An EventId uniquely identifies an event stored in a specific World.

EventIterator

An iterator that yields any unread events from an EventReader or EventCursor.

EventIteratorWithId

An iterator that yields any unread events (and their IDs) from an EventReader or EventCursor.

EventMutIterator

An iterator that yields any unread events from an EventMutator or EventCursor.

EventMutIteratorWithId

An iterator that yields any unread events (and their IDs) from an EventMutator or EventCursor.

EventMutator

Mutably reads events of type T keeping track of which events have already been read by each system allowing multiple systems to read the same events. Ideal for chains of systems that all want to modify the same events.

EventReader

Reads events of type T in order and tracks which events have already been read.

EventRegistry

A registry of all of the Events in the World, used by event_update_system to update all of the events.

EventWriter

Sends events of type T.

Events

An event collection that represents the events that occurred within the last two Events::update calls. Events can be written to using an EventWriter and are typically cheaply read using an EventReader.

SendBatchIds

Iterator over sent EventIds from a batch.

SendEvent

A command to send an arbitrary Event, used by Commands::send_event.

Enums

ShouldUpdateEvents

Controls whether or not the events in an EventRegistry should be updated.

Traits

Event

Something that “happens” and might be read / observed by app logic.

Functions

event_update_condition

A run condition for event_update_system.

event_update_system

A system that calls Events::update on all registered Events in the world.

signal_event_update_system

Signals the event_update_system to run after FixedUpdate systems.

Derive Macros

Event