Home

Sound

Type

struct | SoundDefinition | Array<SoundDefinition>

Properties

category

priority

Sounds with higher priority will replace a sound with lower priority if the maximum sounds limit is reached.

0 is the highest priority, 255 is the lowest priority.

aggregation

allow_random_repeat

audible_distance_modifier

Modifies how far a sound can be heard. Cannot be less than zero.

game_controller_vibration_data

advanced_volume_control

speed_smoothing_window_size

variations

filename

Supported sound file formats are .ogg (Vorbis and Opus) and .wav.

Only loaded, and mandatory if variations is not defined.

volume

Only loaded if variations is not defined.

This sets both min and max volumes.

Must be >= 0.

min_volume

Only loaded if variations and volume are not defined.

Must be >= 0.

max_volume

Only loaded if variations is not defined.

Only loaded if min_volume is defined.

Must be >= min_volume.

preload

Only loaded if variations is not defined.

speed

Speed must be >= 1 / 64. This sets both min and max speeds.

Only loaded if variations is not defined.

min_speed

Must be >= 1 / 64.

Only loaded if both variations and speed are not defined.

max_speed

Must be >= min_speed.

Only loaded if variations is not defined. Only loaded, and mandatory if min_speed is defined.

modifiers

Only loaded if variations is not defined.