Event
Events are sent by the game to StoryEngine to indicate that something has happened that has narrative impact. Each event has an EventType, which tells StoryEngine what the event is about.
See EventType for details about EventTypes.
Every event has one actor as its single owner. Events can also contain additional data to describe the event.
Targets
Events can target StoryEngine entities to indicate what the event’s owner is targeting with their action. The following entities are targetable:
- Actors
- Items
- Locations
Subjects
Events also can reference StoryEngine entities as subjects to indicate the topic the event’s owner is referencing. The following entities can be subjects:
- Actors
- Items
- Locations
- Facts
- Memories
Typically subjects describe the “about”. For example, if a “SpeakTo” event exists, the event’s owner would be speaking to a TargetActor and could be speaking about a SubjectLocation.
For more details about Targets and Subjects, see MutationActionDefinition and RenderActionDefinition.
Context
Games also can provide their own context data that is relevant for an event. Games optionally set a JSON dictionary on the event that stores structured, game specific data for use in RenderActions. Context is not usable in MutationActions.