Open main menu

Documentation/Engine/Units/sound data

< Documentation‎ | Engine‎ | Units
Revision as of 17:33, 30 May 2017 by Smarty (talk | contribs) (First draft.)

(diff) ← Older revision | Approved revision (diff) | Latest revision (diff) | Newer revision → (diff)

The sound_data unit class is used to define sounds.

Attributes

Name Type Default Value Description
name string Path to the sound clip (e.g. name: "/sound/environment/timmys_ducks.ogg")
looped bool When true, the sound clip will be looped while active. When false, it will play once when triggered.
is_2d bool True indicates a mono sound source. False indicates stereo.
volume float Playback volume relative to recorded level (0.0 is full attenuation, 1.0 is straight through, 2.0 is twice as loud)