Specifies a sound that can be used with SoundPath at runtime.
type | :: "sound" | |
name | :: string | Name of the sound. [...] |
Name of the sound. [...] | ||
category optional | :: SoundType | |
aggregation optional | :: AggregationSpecification | |
allow_random_repeat optional | :: bool | |
audible_distance_modifier optional | :: double | Modifies how far a sound can be heard. [...] |
Modifies how far a sound can be heard. [...] | ||
game_controller_vibration_data optional | :: GameControllerVibrationData | |
variations optional | :: array[SoundDefinition] | |
filename optional | :: FileName | Supported sound file formats are |
Supported sound file formats are | ||
volume optional | :: float | Only loaded if |
Only loaded if | ||
preload optional | :: bool | Only loaded if |
Only loaded if | ||
speed optional | :: float | Speed must be |
Speed must be | ||
min_speed optional | :: float | Must be |
Must be | ||
max_speed optional | :: float | Must be |
Must be |
name | :: string | Name of the sound. [...] |
Name of the sound. [...] | ||
type | :: "sound" | |
aggregation optional | :: AggregationSpecification | |
allow_random_repeat optional | :: bool | |
audible_distance_modifier optional | :: double | Modifies how far a sound can be heard. [...] |
Modifies how far a sound can be heard. [...] | ||
category optional | :: SoundType | |
filename optional | :: FileName | Supported sound file formats are |
Supported sound file formats are | ||
game_controller_vibration_data optional | :: GameControllerVibrationData | |
max_speed optional | :: float | Must be |
Must be | ||
min_speed optional | :: float | Must be |
Must be | ||
preload optional | :: bool | Only loaded if |
Only loaded if | ||
speed optional | :: float | Speed must be |
Speed must be | ||
variations optional | :: array[SoundDefinition] | |
volume optional | :: float | Only loaded if |
Only loaded if |
Default: "game-effect"
Default: 1.0
Modifies how far a sound can be heard. Must be between 0
and 1
inclusive.
Supported sound file formats are .ogg
(Vorbis) and .wav
.
Only loaded, and mandatory if variations
is not defined.
Default: 1.0
Only loaded if variations
is not defined.
Only loaded if variations
is not defined.
Default: 1.0
Speed must be >= 1 / 64
. This sets both min and max speeds.
Only loaded if variations
is not defined.
Default: 1.0
Must be >= 1 / 64
.
Only loaded if both variations
and speed
are not defined.
Default: 1.0
Must be >= min_speed
.
Only loaded if variations
is not defined. Only loaded, and mandatory if min_speed
is defined.