Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Prototype Docs Version 2.0.77

# SoundDefinition - Prototype Docs

## SoundDefinition :: struct or FileName

## Properties

- default
- sorted

filename | :: FileName | Supported sound file formats are `.ogg` (Vorbis and Opus) and `.wav`.
Supported sound file formats are `.ogg` (Vorbis and Opus) and `.wav`.
volume optional | :: float | This sets both min and max volumes. [...]
This sets both min and max volumes. [...]
min_volume optional | :: float | Only loaded if `volume` is not defined. [...]
Only loaded if `volume` is not defined. [...]
max_volume optional | :: float | Only loaded if `min_volume` is defined. [...]
Only loaded if `min_volume` is defined. [...]
preload optional | :: boolean |
speed optional | :: float | Speed must be `>= 1 / 64`. [...]
Speed must be `>= 1 / 64`. [...]
min_speed optional | :: float | Only loaded if `speed` is not defined. [...]
Only loaded if `speed` is not defined. [...]
max_speed optional | :: float | Only loaded, and mandatory, if `min_speed` is defined. [...]
Only loaded, and mandatory, if `min_speed` is defined. [...]
modifiers optional | :: SoundModifier or array[SoundModifier] |

filename | :: FileName | Supported sound file formats are `.ogg` (Vorbis and Opus) and `.wav`.
Supported sound file formats are `.ogg` (Vorbis and Opus) and `.wav`.
max_speed optional | :: float | Only loaded, and mandatory, if `min_speed` is defined. [...]
Only loaded, and mandatory, if `min_speed` is defined. [...]
max_volume optional | :: float | Only loaded if `min_volume` is defined. [...]
Only loaded if `min_volume` is defined. [...]
min_speed optional | :: float | Only loaded if `speed` is not defined. [...]
Only loaded if `speed` is not defined. [...]
min_volume optional | :: float | Only loaded if `volume` is not defined. [...]
Only loaded if `volume` is not defined. [...]
modifiers optional | :: SoundModifier or array[SoundModifier] |
preload optional | :: boolean |
speed optional | :: float | Speed must be `>= 1 / 64`. [...]
Speed must be `>= 1 / 64`. [...]
volume optional | :: float | This sets both min and max volumes. [...]
This sets both min and max volumes. [...]

## Properties

### filename :: FileName

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

### volume :: float optional

Default: `1.0`

This sets both min and max volumes.

Must be `>= 0`.

### min_volume :: float optional

Default: `1.0`

Only loaded if `volume` is not defined.

Must be `>= 0`.

### max_volume :: float optional

Default: `1.0`

Only loaded if `min_volume` is defined.

Must be `>= min_volume`.

### preload :: boolean optional

### speed :: float optional

Default: `1.0`

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

### min_speed :: float optional

Default: `1.0`

Only loaded if `speed` is not defined.

Must be `>= 1 / 64`.

### max_speed :: float optional

Default: `1.0`

Only loaded, and mandatory, if `min_speed` is defined.

Must be `>= min_speed`.

### modifiers :: SoundModifier or array[SoundModifier] optional

Type used in

- Sound::variations
- Sound
- SoundPrototype::variations