EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Definitions

audio_cue

A sound: weighted recordings, bus, volume, cooldown and reach.

Feature
presentation
Rights
none
Errors
invalid_type faultmissing_reference faultout_of_range faultunknown_field fault

Signature

{ bus: AudioBus, cooldown_ms: Milliseconds, gain_permille: Permille, id: ContentId, kind: "audio_cue", looped: boolean, radius_mm: PositiveDistance, variants: {AudioVariant} }

Fields

NameTypeMeaning
busAudioBusMixer bus; every variant plays on it.
cooldown_msMillisecondsLeast time between two plays.
Range: 0…2147483647; Unit: ms
gain_permillePermilleLoudest volume of the cue, in thousandths.
Range: 0…1000; Unit: permille
idContentIdPackage-qualified identity; unique within its declaring namespace.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$
kind"audio_cue"Discriminant
loopedbooleanPlays as a loop (ambience, music) instead of once.
radius_mmPositiveDistanceDistance a world sound is heard at; it fades out towards it.
Range: 1…2147483647; Unit: mm
variants{AudioVariant}Recordings; cues sharing their first recording share the cooldown.
Items: 1…16

Validated example

{
  "bus": "effects",
  "cooldown_ms": 1500,
  "gain_permille": 1000,
  "id": "core:hill_golem_roar_sound",
  "kind": "audio_cue",
  "looped": false,
  "radius_mm": 30000,
  "variants": [
    {
      "asset": "core:audio_enemy_brute_1",
      "duration_ms": 1480,
      "weight": 1
    },
    {
      "asset": "core:audio_enemy_brute_2",
      "duration_ms": 1480,
      "weight": 1
    },
    {
      "asset": "core:audio_enemy_brute_3",
      "duration_ms": 1480,
      "weight": 1
    }
  ]
}