SoundPrototype - Prototype Docs

SoundPrototype - 'sound'

Specifies a sound that can be used with SoundPath at runtime.

Properties

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 `.ogg (Vorbis)` and `.wav`.
Supported sound file formats are `.ogg (Vorbis)` and `.wav`.
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

type :: `"sound"`

name :: string

Name of the sound. Can be used as a SoundPath at runtime.

category :: SoundType optional

Default: "game-effect"

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 optional

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

Only loaded, and mandatory 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.

Factorio Prototype Docs Version 1.1.100

SoundPrototype - 'sound'

Properties

Properties

type :: `"sound"`

name :: string

category :: SoundType optional

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 optional

volume :: float optional

preload :: bool optional

speed :: float optional

min_speed :: float optional

max_speed :: float optional

Prototypes

Types

Factorio Prototype DocsVersion 1.1.100

SoundPrototype - 'sound'

Properties

Properties

type :: "sound"

name :: string

category :: SoundType optional

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 optional

volume :: float optional

preload :: bool optional

speed :: float optional

min_speed :: float optional

max_speed :: float optional

Prototypes

Types

Factorio Prototype Docs Version 1.1.100

type :: `"sound"`