309
edits
Changes
Jump to navigation
Jump to search
First draft.
The '''sound_engine_data''' unit class is used to define engine sounds. This unit is typically used in an array, with ''min_rpm'' and ''max_rpm'' ranges overlapping between members to allow crossfading.
== Uses ==
*[[Documentation/Engine/Units/accessory_sound_data|accessory_sound_data]] (engine, engine_load, engine_nofuel, engine_exhaust, engine_brake)
== 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/default/int/unloaded_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 true for engine 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 engine rpm of the recording.
|-
|min_rpm
|float
|
|The lowest rpm the clip will be played at.
|-
|max_rpm
|float
|
|The highest rpm the clip will be played at.
|}
== Uses ==
*[[Documentation/Engine/Units/accessory_sound_data|accessory_sound_data]] (engine, engine_load, engine_nofuel, engine_exhaust, engine_brake)
== 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/default/int/unloaded_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 true for engine 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 engine rpm of the recording.
|-
|min_rpm
|float
|
|The lowest rpm the clip will be played at.
|-
|max_rpm
|float
|
|The highest rpm the clip will be played at.
|}
