Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Events

cinnabar:extension/events@0.1.0

Local presentation cues shared by loaded mods; they carry no authority.

Grants: None; cues carry no game authority.

Types

cue

A presentation-only signal with bounded scalar values, shared on the following frame.

record cue {
    name: string,
    values: list<f32>,
}
MemberTypeDescription
namestring
valueslist<f32>

Functions

emit

emit: func(name: string, values: list<f32>) -> result<_, string>;

Published to the host and every loaded mod after frame returns.

poll

poll: func() -> list<cue>;

Cues loaded mods committed last frame; the same bounded list for every call in a callback.

Types: cue.