EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Effects

play_audio

Play a positioned audio cue after commit; audio failures change no state.

Feature
presentation
Rights
player_notification
Debits
none
Conflict
accumulating
Errors
invalid_type faultmissing_reference faultout_of_range faultscope_denied faultunknown_field fault

Signature

{ cue: AudioCueId, kind: "play_audio", position: Position }

Fields

NameTypeMeaning
cueAudioCueIdAudio cue to play.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: audio_cue
kind"play_audio"Discriminant
positionPositionWhere the cue sounds.

Validated example

{
  "cue": "core:hill_golem_roar_sound",
  "kind": "play_audio",
  "position": {
    "map": "m1",
    "x_mm": 226000,
    "y_mm": 0,
    "z_mm": -175000
  }
}