sound_looping

This page needs help! Please submit any missing information via GitHub issues or pull requests.

...

Structure and fields

Field Type Comments
flags bitfield
Flag Mask Comments
deafening to ais 0x1
not a loop 0x2

Prevents the sound from looping. When played with sound_looping_start, it will play only once.

stops music 0x4
zero detail sound period float
zero detail unknown floats float[2]
one detail sound period float
one detail unknown floats float[2]
unknown int uint32
  • Cache only
maximum distance float
  • Cache only
continuous damage effect

TagDependency: continuous_damage_effect

tracks Block
  • HEK max count: 4

Tracks can be considered the "layers" of the sound_looping. Although many tracks can be added, the engine is not be capable of playing more than 4 of each sound class simultaneously when on high sound quality setting (2 on low or in Sapien). Extra tracks past these limits will not be played.

Field Type Comments
flags bitfield
Flag Mask Comments
fade in at start 0x1
fade out at stop 0x2
fade in alternate 0x4
gain float
  • Min: 0
  • Max: 1
  • Default: 1
fade in duration float
  • Unit: seconds

How many seconds it takes for this track to fade in, such as when entering a cluster with a background sound.

fade out duration float
  • Unit: seconds

How many seconds it takes for this track to fade out.

start

TagDependency: sound

The sound that will play for this track when this sound_looping begins playing. This field is optional.

loop

TagDependency: sound

A sound to loop indefinitely while the sound_looping is playing.

end

TagDependency: sound

The sound that will play for this track when fading out.

alternate loop

TagDependency: sound

alternate end

TagDependency: sound

detail sounds Block
  • HEK max count: 32
Field Type Comments
sound

TagDependency: sound

random period bounds Bounds
  • Unit: seconds
Field Type Comments
min float
max float
gain float
  • Min: 0
  • Max: 1
  • Default: 1
flags bitfield
Flag Mask Comments
don't play with alternate 0x1
don't play without alternate 0x2
yaw bounds Bounds
  • Default: -3.14159265359,3.14159265359
Field Type Comments
min float
max float
pitch bounds Bounds?
  • Default: -1.57079632679,1.57079632679
distance bounds Bounds?
  • Unit: world units

Acknowledgements

Thanks to the following individuals for their research or contributions to this topic:

  • Kavawuvi (Invader tag definitions)
  • MosesOfEgypt (Tag structure research)