Difference between revisions of "Documentation/Engine/Units/sound engine data"
< Documentation | Engine | Units
Jump to navigation
Jump to search
(First draft.) |
(→Attributes) |
||
| Line 35: | Line 35: | ||
|volume | |volume | ||
|float | |float | ||
| − | | | + | |0.0 |
|Playback volume relative to recorded level (0.0 is full attenuation, 1.0 is straight through, 2.0 is twice as loud) | |Playback volume relative to recorded level (0.0 is full attenuation, 1.0 is straight through, 2.0 is twice as loud) | ||
|- | |- | ||
|pitch_reference | |pitch_reference | ||
|float | |float | ||
| − | | | + | |0.0 |
|The reference engine rpm of the recording. | |The reference engine rpm of the recording. | ||
|- | |- | ||
|min_rpm | |min_rpm | ||
|float | |float | ||
| − | | | + | |0.0 |
|The lowest rpm the clip will be played at. | |The lowest rpm the clip will be played at. | ||
|- | |- | ||
|max_rpm | |max_rpm | ||
|float | |float | ||
| − | | | + | |0.0 |
|The highest rpm the clip will be played at. | |The highest rpm the clip will be played at. | ||
|} | |} | ||
Latest revision as of 14:06, 20 June 2017
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
- accessory_sound_data (engine, engine_load, engine_nofuel, engine_exhaust, engine_brake)
Attributes
| Name | Type | Default Value | Description |
|---|---|---|---|
| name | string | Path to the sound clip (e.g. name: "/sound/truck/default/int/unloaded_1.ogg")
| |
| 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 | |
| volume | float | 0.0 | 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 | 0.0 | The reference engine rpm of the recording. |
| min_rpm | float | 0.0 | The lowest rpm the clip will be played at. |
| max_rpm | float | 0.0 | The highest rpm the clip will be played at. |
