Expand description
Event
functionality.
Structs§
- Entity
Components Trigger - An
EntityEvent
Trigger
that, in addition to behaving like a normalEntityTrigger
, also runs observers that watch for components that match the slice ofComponentId
s referenced inEntityComponentsTrigger
. This includes both global observers of those components and “entity scoped” observers that watch theEntityEvent::event_target
. - Entity
Trigger - An
EntityEvent
Trigger
that does two things: - Event
Key - A unique identifier for an
Event
, used by observers. - Global
Trigger - A
Trigger
that runs every “global”Observer
(ex: registered viaWorld::add_observer
) that matches the givenEvent
. - Propagate
Entity Trigger - An
EntityEvent
Trigger
that behaves likeEntityTrigger
, but “propagates” the event using anEntity
Traversal
. At each step in the propagation, theEntityTrigger
logic will be run, untilPropagateEntityTrigger::propagate
is false, or there are no entities left to traverse.
Traits§
- Entity
Event - An
EntityEvent
is anEvent
that is triggered for a specificEntityEvent::event_target
entity: - Event
- An
Event
is something that “happens” at a given moment. - Trigger
Trigger
determines how anEvent
is triggered whenWorld::trigger
is called. This decides whichObserver
s will run, what data gets passed to them, and the order they will be executed in.
Functions§
- trigger_
entity_ ⚠internal - Trigger observers watching for the given entity event.
The
target_entity
should match theEntityEvent::event_target
onevent
for logical correctness.
Type Aliases§
- Event
Cursor Deprecated - This is deprecated. See
MessageCursor
- Event
Iterator Deprecated - This is deprecated. See
MessageIterator
- Event
MutIterator Deprecated - This is deprecated. See
MessageMutIterator
- Event
Mutator Deprecated - This is deprecated. See
MessageMutator
- Event
Reader Deprecated - This is deprecated. See
MessageReader
- Event
Writer Deprecated - This is deprecated. See
MessageWriter
- Events
Deprecated - This is deprecated. See
Messages
Derive Macros§
- Entity
Event - Cheat sheet for derive syntax,
see full explanation on
EntityEvent
trait docs. - Event
- Implement the
Event
trait.