Events
-
ActivityEndedAnchor
Anchor to the end of a specific ActivityEvent (after Complete()).
-
ActivityEvent
Fired when an authored `activity` event executes. The activity is a writer-defined mini-form (questions, sliders,…
-
ActivityField
One field on an ActivityEvent. Read-only or writable; numeric fields can carry min/max validation.
-
ActivityStartedAnchor
Anchor to the start of a specific ActivityEvent.
-
AdvanceTimeEvent
Fired when AdvanceTime or SetBucket events execute. Carries the post-advance time view for rendering clock UI.
-
AudioCueEvent
Playback cue for an authored `audioCue` event — a structured audio program (music / ambience / sfx / voice) of one or…
-
BackgroundAudioResult
One audio media asset flagged as eligible to play as a background / menu loop track. Returned by…
-
BackgroundClipResult
One background clip — a media segment authored as ambient B-roll. Returned by GetAllBackgroundClips() and…
-
ChoiceSelectedAnchor
Anchor to the moment the player commits a choice (the SelectChoice call).
-
ChoicesPresentedAnchor
Anchor to the moment the runtime presents choices (the GetChoices return).
-
CueAudioRef
One audio asset a CueSegment can select. The runtime carries metadata; the bytes live in the host's asset pipeline.
-
CueSegment
One playback segment within a cue — a clip selection, loop policy, and scope rule that decides when the segment ends.
-
CueSegmentScope
How long a CueSegment plays before ceding to the next.
-
DiagnosticEvent
Transient runtime diagnostic — reports a recoverable problem (ICU template parse/format failures, scene-stall codes,…
-
DialogueEvent
Text-first narrative line — the lightweight sibling of SequenceEvent for spoken/narrated lines with no video track. Text…
-
EnterSceneEvent
Runtime event fired when an enterScene Event executes. Read from GetEventQueue() and react to scene transitions.
-
EventBase
Base class for everything drained from GetEventQueue(). Dispatch on the concrete subclass (HookEvent, SequenceEvent,…
-
EventTiming
Authored timing annotation on an event — fires Timecode seconds relative to RelativeTo's anchor moment.
-
HookEvent
Host-dispatchable hook fired by an authored `Hook` event. Name is the hook id the writer chose; Params are the named…
-
IEventQueueVisitor
Visitor over runtime-queued events. Every subclass of EventBase declares an `Accept` override that dispatches to the…
-
LocationChangedEvent
v4 location-transition event. Carries the new location's ID and a hydrated LocationView for richer metadata access.
-
ModifierBreakdown
One modifier in a SkillCheckResolvedEvent's breakdown — its label, the expression that gated it, whether it applied, and…
-
NoopEventQueueVisitor
Empty defaults so consumers override only the branches they care about.
-
ProjectCompletedEvent
Runtime event queued once per run when a completeProject event has executed and any project outro has drained. Empty…
-
ProjectCompletingErrorEvent
2026-06-03 per-scene visit-state spec §5 — emitted when SelectChoice fires during the completeProject drain (between…
-
SceneBoundaryReachedEvent
Runtime event fired in Isolated mode when execution would leave the named scene. Emitted alongside `IsComplete = true` —…
-
SceneBoundaryReason
How a SceneBoundaryReachedEvent was triggered.
-
SequenceAnchor
Anchor to a specific SequenceEvent's playback timeline.
-
SequenceCaption
One caption line within a SequenceEvent's playback timeline. Text is locale-resolved + variable-interpolated at…
-
SequenceEvent
Playback cue for an authored `playSequence` event — a video / image / audio asset bundle plus pre-interpolated captions…
-
SkillCheckResolvedEvent
Always fires when a SkillCheck event executes — independent of success/failure outcome events. Carries roll metadata for…
-
StopAudioEvent
Command to stop in-progress audio on a specific layer. Issued by authored `stopAudio` events.
-
StoryBeatResult
One story beat — a recap-worthy moment authored on a media item. Returned by GetStoryBeats() with importance decayed by…
-
TimingAnchor
Base class for the closed set of timing anchors. Pattern-match on the concrete subtype.
-
VariableChangedEvent
Fired after an authored `setVariable` / `setVariableText` event commits a variable mutation. Drives HUD updates without…