Expand description
Types for creating and storing Observer
s
Structs§
- Cached
Component Observers - Collection of
ObserverRunner
forObserver
registered to a particular trigger targeted at a specific component. - Cached
Observers - Collection of
ObserverRunner
forObserver
registered to a particular trigger. - Emit
Dynamic Trigger - Emit a trigger for a dynamic component id. This is unsafe and must be verified manually.
- Observer
- An
Observer
system. Add thisComponent
to anEntity
to turn it into an “observer”. - Observer
Descriptor - A description of what an
Observer
observes. - Observer
State - Contains
Observer
information. This defines how a given observer behaves. It is the “source of truth” for a given observer entity’s behavior. - Observer
Trigger - Event trigger metadata for a given
Observer
, - Observers
- Metadata for observers. Stores a cache mapping trigger ids to the registered observers.
- Trigger
- Type containing triggered
Event
information for a given run of anObserver
. This contains theEvent
data itself. If it was triggered for a specificEntity
, it includes that as well. - Trigger
Event - A
Command
that emits a given trigger for a given set of targets.
Traits§
- Trigger
Targets - Represents a collection of targets for a specific
Trigger
of anEvent
. Targets can be of typeEntity
orComponentId
. When a trigger occurs for a given event andTriggerTargets
, anyObserver
that watches for that specific event-target combination will run.
Type Aliases§
- Boxed
Observer System - Equivalent to
BoxedSystem
forObserverSystem
. - Observer
Runner - Type for function that is run when an observer is triggered.
Typically refers to the default runner that runs the system stored in the associated [
ObserverSystemComponent
], but can be overridden for custom behaviour.