EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

AudioCueDefinition

A sound: recordings one of which plays (weighted, presentation randomness only), its bus, volume, cooldown and reach.

Signature

{ bus: AudioBus, cooldown_ms: Milliseconds, gain_permille: Permille, id: ContentId, 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}$
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