Difference between revisions of "Documentation/Engine/Units/sound data"

From SCS Modding Wiki
Jump to navigation Jump to search
(First draft.)
 
Line 15: Line 15:
 
|looped
 
|looped
 
|bool
 
|bool
|
+
|false
 
|When true, the sound clip will be looped while active. When false, it will play once when triggered.
 
|When true, the sound clip will be looped while active. When false, it will play once when triggered.
 
|-
 
|-
 
|is_2d
 
|is_2d
 
|bool
 
|bool
 +
|false
 
|
 
|
|True indicates a mono sound source. False indicates stereo.
 
 
<!-- Hide until we have a description
 
<!-- Hide until we have a description
 
|-
 
|-

Revision as of 17:50, 30 May 2017

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 false When true, the sound clip will be looped while active. When false, it will play once when triggered.
is_2d bool false
volume float Playback volume relative to recorded level (0.0 is full attenuation, 1.0 is straight through, 2.0 is twice as loud)