309
edits
Changes
First draft.
The '''sound_noise_data''' unit class is used to define speed-dependent sounds. This unit is typically used in an array, with ''min_speed'' and ''max_speed'' ranges overlapping between members to allow crossfading.
== Uses ==
*[[Documentation/Engine/Units/accessory_sound_data|accessory_sound_data]] (wheel_*, aero_noise, gear_noise)
== 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/truck/noises/wind_inside_int_1.ogg"</code>)
|-
|looped
|bool
|false
|When true, the sound clip will be looped while active. When false, it will play once when triggered. Should always be true for noise sounds.
|-
|is_2d
|bool
|false
|
<!-- 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)
|-
|pitch_reference
|float
|
|The reference vehicle speed of the recording.
|-
|min_rpm
|float
|
|The lowest vehicle speed the clip will be played at.
|-
|max_rpm
|float
|
|The highest vehicle speed the clip will be played at.
|}
== Uses ==
*[[Documentation/Engine/Units/accessory_sound_data|accessory_sound_data]] (wheel_*, aero_noise, gear_noise)
== 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/truck/noises/wind_inside_int_1.ogg"</code>)
|-
|looped
|bool
|false
|When true, the sound clip will be looped while active. When false, it will play once when triggered. Should always be true for noise sounds.
|-
|is_2d
|bool
|false
|
<!-- 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)
|-
|pitch_reference
|float
|
|The reference vehicle speed of the recording.
|-
|min_rpm
|float
|
|The lowest vehicle speed the clip will be played at.
|-
|max_rpm
|float
|
|The highest vehicle speed the clip will be played at.
|}