Sound - Prototype Docs

Home / Types / Sound <>

Sound :: struct or array[SoundDefinition] Example code

Properties

default

sorted

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	:: FileName	Supported sound file formats are `.ogg`, `.wav` and `.voc`.
Supported sound file formats are `.ogg`, `.wav` and `.voc`.
volume optional	:: float	Only loaded if `variations` is not defined.
Only loaded if `variations` is not defined.
preload optional	:: bool	Only loaded if `variations` is not defined.
Only loaded if `variations` is not defined.
speed optional	:: float	Speed must be `>= 1 / 64`.
Speed must be `>= 1 / 64`.
min_speed optional	:: float	Must be `>= 1 / 64`.
Must be `>= 1 / 64`.
max_speed optional	:: float	Must be `>= min_speed`.
Must be `>= min_speed`.

Properties

aggregation :: AggregationSpecification optional

allow_random_repeat :: bool optional

Default: false

audible_distance_modifier :: double optional

Default: 1.0

Modifies how far a sound can be heard. Must be between 0 and 1 inclusive.

game_controller_vibration_data :: GameControllerVibrationData optional

variations :: array[SoundDefinition] optional

filename :: FileName

Supported sound file formats are .ogg, .wav and .voc.

Only loaded if variations is not defined.

volume :: float optional

Default: 1.0

Only loaded if variations is not defined.

preload :: bool optional

Only loaded if variations is not defined.

speed :: float optional

Default: 1.0

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

Only loaded if variations is not defined.

min_speed :: float optional

Default: 1.0

Must be >= 1 / 64.

Only loaded if both variations and speed are not defined.

max_speed :: float optional

Default: 1.0

Must be >= min_speed.

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

Example

{
  filename = "__base__/sound/ambient/world-ambience-3.ogg",
  volume = 1.2
}

Type used in

Factorio Prototype Docs Version 1.1.91

Sound :: struct or array[SoundDefinition] Example code

Properties

Properties

aggregation :: AggregationSpecification optional

allow_random_repeat :: bool optional

audible_distance_modifier :: double optional

game_controller_vibration_data :: GameControllerVibrationData optional

variations :: array[SoundDefinition] optional

filename :: FileName

volume :: float optional

preload :: bool optional

speed :: float optional

min_speed :: float optional

max_speed :: float optional

Example

Prototypes

Types