sound_looping

This page is incomplete! You can contribute information using GitHub issues or pull requests.

...

Structure and fields

FieldTypeComments
flagsbitfield
FlagMaskComments
deafening to ais0x1
not a loop0x2

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

stops music0x4
zero detail sound periodfloat
zero detail unknown floatsfloat[2]
one detail sound periodfloat
one detail unknown floatsfloat[2]
runtime scripting sounduint32
  • Cache only
maximum distancefloat
  • Cache only
continuous damage effectTagDependency: continuous_damage_effect
tracksBlock
  • 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.

FieldTypeComments
flagsbitfield
FlagMaskComments
fade in at start0x1
fade out at stop0x2
fade in alternate0x4
gainfloat
  • Min: 0
  • Max: 1
  • Default: 1
fade in durationfloat
  • 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 durationfloat
  • Unit: seconds

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

startTagDependency: sound

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

loopTagDependency: sound

A sound to loop indefinitely while the sound_looping is playing.

endTagDependency: sound

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

alternate loopTagDependency: sound
alternate endTagDependency: sound
detail soundsBlock
  • HEK max count: 32
FieldTypeComments
soundTagDependency: sound
random period boundsBounds
  • Unit: seconds
FieldTypeComments
minfloat
maxfloat
gainfloat
  • Min: 0
  • Max: 1
  • Default: 1
flagsbitfield
FlagMaskComments
don't play with alternate0x1
don't play without alternate0x2
yaw boundsBounds
  • Default: -3.14159265359,3.14159265359
FieldTypeComments
minfloat
maxfloat
pitch boundsBounds?
  • Default: -1.57079632679,1.57079632679
distance boundsBounds?
  • 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)
  • smx (Tip on internal fields)