Prototype/Sound: Difference between revisions

Revision as of 22:13, 27 July 2019

Specifies a sound that can be used with https://lua-api.factorio.com/latest/Concepts.html#SoundPath during runtime.

Prototype/Sound — `sound`
name	::	string
type	::	string
aggregation	::	table (optional)
allow_random_repeat	::	bool (optional)
audible_distance_modifier	::	double (optional)
category	::	string (optional)
filename	::	FileName (optional)
max_speed	::	float (optional)
min_speed	::	float (optional)
preload	::	bool (optional)
speed	::	float (optional)
variations	::	table (array) of tables (optional)
volume	::	float (optional)

Mandatory properties

type

Type: string
Must be "sound".

name

Type: string
Name of the sound. Must be unique. Used in https://lua-api.factorio.com/latest/Concepts.html#SoundPath.

Optional properties

aggregation

Type: table
Table with the following members:

max_count - uint32 - Mandatory.
progress_threshold - float - Optional. - Default: 1.0 - If count already playing is true, this will determine maximum progress when instance is counted toward playing sounds.
remove - bool - Mandatory.
count_already_playing - bool - Optional. - Default: false - If true already playing sounds are taken into account when checking maxCount.

audible_distance_modifier

Type: double
Default: 1.0

variations

Type: table of tables
Array of tables with the following members:

filename - FileName - Mandatory.
volume - float - Optional. - Default: 1.0
preload - bool - Optional.

filename

Type: FileName
Mandatory if variations is not given.

volume

Type: float
Default: 1.0
Only loaded if variations is not given.

preload

Type: bool
Only loaded if variations is not given.

@@ Line 1: / Line 1: @@
 {{Prototype parent}}
+Specifies a sound that can be used with https://lua-api.factorio.com/latest/Concepts.html#SoundPath during runtime.
-== Basics ==
+{{Prototype TOC|sound}}
-Prototype type: '''sound'''
-Specifies a sound that can be used with https://lua-api.factorio.com/latest/Concepts.html#SoundPath during runtime.
 == Mandatory properties ==
-=== type ===
+{{Prototype property|type|[[Types/string|string]]}}
-'''Type''': [[Types/string]]
 Must be "sound".
-=== name ===
+{{Prototype property|name|[[Types/string|string]]}}
-'''Type''': [[Types/string]]
 Name of the sound. Must be unique. Used in https://lua-api.factorio.com/latest/Concepts.html#SoundPath.
 == Optional properties ==
-=== category ===
+{{Prototype property|category|[[Types/string|string]]|"game-effect"|optional=true}}
-'''Type''': [[Types/string]]
-'''Default''': "game-effect"
 One of "game-effect", "gui-effect", "environment", "walking" and "alert".
-=== aggregation ===
+{{Prototype property|aggregation|[[Types/table|table]]|optional=true}}
-'''Type''': [[Types/table]]
 Table with the following members:
-* max_count - [[Types/uint32]] - Mandatory.
+* max_count - [[Types/uint32|uint32]] - Mandatory.
-* progress_threshold - [[Types/float]] - Optional. - Default: 1.0 - If count already playing is true, this will determine maximum progress when instance is counted toward playing sounds.
+* progress_threshold - [[Types/float|float]] - Optional. - Default: 1.0 - If count already playing is true, this will determine maximum progress when instance is counted toward playing sounds.
-* remove - [[Types/bool]] - Mandatory.
+* remove - [[Types/bool|bool]] - Mandatory.
-* count_already_playing - [[Types/bool]] - Optional. - Default: false - If true already playing sounds are taken into account when checking maxCount.
+* count_already_playing - [[Types/bool|bool]] - Optional. - Default: false - If true already playing sounds are taken into account when checking maxCount.
-=== audible_distance_modifier ===
-'''Type''': [[Types/double]]
-'''Default''': 1.0
-=== variations ===
+{{Prototype property|audible_distance_modifier|[[Types/double|double]]|1.0|optional=true}}
-'''Type''': [[Types/table]] of [[Types/table]]s
+{{Prototype property|variations|[[Types/table|table]] of [[Types/table|table]]s|optional=true}}
 Array of tables with the following members:
-* filename - [[Types/FileName]] - Mandatory.
+* filename - [[Types/FileName|FileName]] - Mandatory.
-* volume - [[Types/float]] - Optional. - Default: 1.0
+* volume - [[Types/float|float]] - Optional. - Default: 1.0
-* preload - [[Types/bool]] - Optional.
+* preload - [[Types/bool|bool]] - Optional.
-=== filename ===
-'''Type''': [[Types/FileName]]
+{{Prototype property|filename|[[Types/FileName|FileName]]|optional=true}}
 Mandatory if <code>variations</code> is not given.
-=== volume ===
+{{Prototype property|volume|[[Types/float|float]]|1.0|optional=true}}
-'''Type''': [[Types/float]]
-'''Default''': 1.0
 Only loaded if <code>variations</code> is not given.
-=== preload ===
+{{Prototype property|preload|[[Types/bool|bool]]|optional=true}}
-'''Type''': [[Types/bool]]
 Only loaded if <code>variations</code> is not given.