309
edits
Changes
Jump to navigation
Jump to search
First draft.
The '''sound_data''' unit class is used to define sounds.
== Attributes ==
{|class="wikitable"
!Name
![[Documentation/Engine/Units#Attribute_types|Type]]
!Default Value
!Description
|-
|name
|string
|
|Path to the sound clip (e.g. <code>name: "/sound/environment/timmys_ducks.ogg"</code>)
|-
|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.
<!-- Hide until we have a description
|-
|stream
|bool
|
|
-->
|-
|volume
|float
|
|Playback volume relative to recorded level (0.0 is full attenuation, 1.0 is straight through, 2.0 is twice as loud)
|}
== Attributes ==
{|class="wikitable"
!Name
![[Documentation/Engine/Units#Attribute_types|Type]]
!Default Value
!Description
|-
|name
|string
|
|Path to the sound clip (e.g. <code>name: "/sound/environment/timmys_ducks.ogg"</code>)
|-
|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.
<!-- Hide until we have a description
|-
|stream
|bool
|
|
-->
|-
|volume
|float
|
|Playback volume relative to recorded level (0.0 is full attenuation, 1.0 is straight through, 2.0 is twice as loud)
|}
