EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

VisualFrame

Input of one stateless presentation evaluation: one viewer's view of a cutscene at an absolute time. Frames may be dropped or repeated.

Signature

{ anchors: {VisualAnchor}, aspect_permille: PositiveCount, cutscene: CutsceneId, duration_ms: Milliseconds, elapsed_ms: Milliseconds, timeline: VisualTimeline, viewer: PlayerRef }

Fields

NameTypeMeaning
anchors{VisualAnchor}Every map anchor the timeline names, with its position.
Items: 0…64
aspect_permillePositiveCountWidth to height of the viewer's viewport.
Range: 1…2147483647; Unit: permille
cutsceneCutsceneIdThe cutscene being shown.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: cutscene
duration_msMillisecondsLength of the cutscene.
Range: 0…2147483647; Unit: ms
elapsed_msMillisecondsTime since the cutscene started.
Range: 0…2147483647; Unit: ms
timelineVisualTimelineThe declarative timeline at this time; the fallback and base of the result.
viewerPlayerRefThe player whose view evaluates the frame.
Length: 1…256; Pattern: ^[\s\S]+$