EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Effects

play_cutscene

Start a player's personal cutscene; one cutscene per player at a time.

Feature
presentation
Rights
player_session
Debits
none
Conflict
guarded
Errors
invalid_type faultmissing_reference faultout_of_range faultprecondition_failed rejectionscope_denied faultstale_reference rejectionunknown_field fault

Signature

{ cutscene: CutsceneId, kind: "play_cutscene", player: PlayerRef }

Fields

NameTypeMeaning
cutsceneCutsceneIdCutscene to play.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: cutscene
kind"play_cutscene"Discriminant
playerPlayerRefPlayer the cutscene plays for.
Length: 1…256; Pattern: ^[\s\S]+$

Validated example

{
  "cutscene": "core:hill_golem_omen",
  "kind": "play_cutscene",
  "player": "player/1"
}