Prototype/Sound - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:33:03Z

Removed old prototype docs

← Older revision		Revision as of 14:33, 25 October 2024
Line 2:		Line 2:

	</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>



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

	~~{{Prototype TOC\|sound}}~~

	~~== Mandatory properties ==~~

	~~{{Prototype property\|type\|[[Types/string\|string]]}}~~
	~~Must be "sound".~~

	~~{{Prototype property\|name\|[[Types/string\|string]]}}~~
	~~Name of the sound. Must be unique. Used as a https://lua-api.factorio.com/latest/Concepts.html#SoundPath.~~

	~~== Optional properties ==~~

	~~{{Prototype property\|category\|[[Types/string\|string]]\|"game-effect"\|optional=true}}~~
	~~One of "game-effect", "gui-effect", "ambient", "environment", "walking", "alert" and "wind".~~

	This defines which slider in the sound settings affects the volume of this sound. Furthermore, some sound types are mixed differently than others, e.g. zoom level effects are applied.[https://forums.factorio.com/viewtopic.php?p=527778#p527778]

	~~{{Prototype property\|aggregation\|[[Types/table\|table]]\|optional=true}}~~
	~~Table with the following members:~~
	* max_count - [[Types/uint32\|uint32]] - Mandatory.
	* 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\|bool]] - Mandatory.
	* count_already_playing - [[Types/bool\|bool]] - Optional. - Default: false - If true already playing sounds are taken into account when checking maxCount.

	~~{{Prototype property\|allow_random_repeat\|[[Types/bool\|bool]]\|false\|optional=true}}~~

	~~{{Prototype property\|audible_distance_modifier\|[[Types/double\|double]]\|1.0\|optional=true}}~~

	~~{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}~~
	~~Array of tables with the following members:~~
	* filename - [[Types/FileName\|FileName]] - Mandatory. Supported sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.
	* volume - [[Types/float\|float]] - Optional. - Default: 1.0
	* preload - [[Types/bool\|bool]] - Optional.
	* speed - [[Types/float\|float]] - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.
	* min_speed - [[Types/float\|float]] - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.
	* max_speed - [[Types/float\|float]] - Mandatory if min_speed is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.

	~~{{Prototype property\|filename\|[[Types/FileName\|FileName]]\|optional=true}}~~
	~~Mandatory if <code>variations</code> is not given.~~

	~~Support sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.~~

	~~{{Prototype property\|volume\|[[Types/float\|float]]\|1.0\|optional=true}}~~
	~~Only loaded if <code>variations</code> is not given.~~

	~~{{Prototype property\|preload\|[[Types/bool\|bool]]\|optional=true}}~~
	~~Only loaded if <code>variations</code> is not given.~~

	~~{{Prototype property\|speed\|[[Types/float\|float]]\|1.0\|optional=true}}~~
	~~Only loaded if <code>variations</code> is not given. Speed must be >= 1 / 64. This sets both min and max speed.~~

	~~{{Prototype property\|min_speed\|[[Types/float\|float]]\|1.0\|optional=true}}~~
	~~Only loaded if <code>variations</code> is not given. Not loaded if speed is present. Speed must be >= 1 / 64.~~

	~~{{Prototype property\|max_speed\|[[Types/float\|float]]\|1.0\|optional=true}}~~
	~~Only loaded if <code>variations</code> is not given. Mandatory if min_speed is present, otherwise not loaded. Must be >= min_speed.~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:30Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:43, 21 September 2023
Line 1:		Line 1:
	'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/SoundPrototype.html https://lua-api.factorio.com/latest/prototypes/SoundPrototype.html]		<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/SoundPrototype.html https://lua-api.factorio.com/latest/prototypes/SoundPrototype.html]

	This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>

BilkaBot: Protected "Prototype/Sound": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:53:14Z

Protected "Prototype/Sound": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:53, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:53:14Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:53, 16 August 2023
Line 1:		Line 1:
			'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/SoundPrototype.html https://lua-api.factorio.com/latest/prototypes/SoundPrototype.html]

			This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].



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

Bilka: typo

2021-10-20T19:06:00Z

typo

← Older revision		Revision as of 19:06, 20 October 2021
Line 32:		Line 32:
	{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}		{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}
	Array of tables with the following members:		Array of tables with the following members:
	* filename - [[Types/FileName\|FileName]] - Mandatory. ~~Support~~ sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.		* filename - [[Types/FileName\|FileName]] - Mandatory. Supported sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.
	* volume - [[Types/float\|float]] - Optional. - Default: 1.0		* volume - [[Types/float\|float]] - Optional. - Default: 1.0
	* preload - [[Types/bool\|bool]] - Optional.		* preload - [[Types/bool\|bool]] - Optional.

Bilka: /* Optional properties */ category explanation

2021-10-08T18:51:51Z

Optional properties: category explanation

← Older revision		Revision as of 18:51, 8 October 2021
Line 16:		Line 16:
	{{Prototype property\|category\|[[Types/string\|string]]\|"game-effect"\|optional=true}}		{{Prototype property\|category\|[[Types/string\|string]]\|"game-effect"\|optional=true}}
	One of "game-effect", "gui-effect", "ambient", "environment", "walking", "alert" and "wind".		One of "game-effect", "gui-effect", "ambient", "environment", "walking", "alert" and "wind".

			This defines which slider in the sound settings affects the volume of this sound. Furthermore, some sound types are mixed differently than others, e.g. zoom level effects are applied.[https://forums.factorio.com/viewtopic.php?p=527778#p527778]

	{{Prototype property\|aggregation\|[[Types/table\|table]]\|optional=true}}		{{Prototype property\|aggregation\|[[Types/table\|table]]\|optional=true}}

Bilka: Documented support sound file formats

2021-10-08T18:30:21Z

Documented support sound file formats

← Older revision		Revision as of 18:30, 8 October 2021
Line 30:		Line 30:
	{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}		{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}
	Array of tables with the following members:		Array of tables with the following members:
	* filename - [[Types/FileName\|FileName]] - Mandatory.		* filename - [[Types/FileName\|FileName]] - Mandatory. Support sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.
	* volume - [[Types/float\|float]] - Optional. - Default: 1.0		* volume - [[Types/float\|float]] - Optional. - Default: 1.0
	* preload - [[Types/bool\|bool]] - Optional.		* preload - [[Types/bool\|bool]] - Optional.
Line 39:		Line 39:
	{{Prototype property\|filename\|[[Types/FileName\|FileName]]\|optional=true}}		{{Prototype property\|filename\|[[Types/FileName\|FileName]]\|optional=true}}
	Mandatory if <code>variations</code> is not given.		Mandatory if <code>variations</code> is not given.

			Support sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.

	{{Prototype property\|volume\|[[Types/float\|float]]\|1.0\|optional=true}}		{{Prototype property\|volume\|[[Types/float\|float]]\|1.0\|optional=true}}

Bilka: Removed information that conflicts with info on Types/Sound (which is based on the errors that the game throws)

2021-08-06T17:09:18Z

Removed information that conflicts with info on Types/Sound (which is based on the errors that the game throws)

← Older revision		Revision as of 17:09, 6 August 2021
Line 27:		Line 27:

	{{Prototype property\|audible_distance_modifier\|[[Types/double\|double]]\|1.0\|optional=true}}		{{Prototype property\|audible_distance_modifier\|[[Types/double\|double]]\|1.0\|optional=true}}

	~~Set to 9999999 for global sound.~~

	{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}		{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}

Darkfrei: /* Optional properties */

2021-07-20T11:45:31Z

Optional properties

← Older revision		Revision as of 11:45, 20 July 2021
Line 27:		Line 27:

	{{Prototype property\|audible_distance_modifier\|[[Types/double\|double]]\|1.0\|optional=true}}		{{Prototype property\|audible_distance_modifier\|[[Types/double\|double]]\|1.0\|optional=true}}

			Set to 9999999 for global sound.

	{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}		{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}

Bilka: typos

2020-05-25T10:49:29Z

typos

← Older revision		Revision as of 10:49, 25 May 2020
Line 35:		Line 35:
	* speed - [[Types/float\|float]] - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.		* speed - [[Types/float\|float]] - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.
	* min_speed - [[Types/float\|float]] - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.		* min_speed - [[Types/float\|float]] - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.
	* max_speed - [[Types/float\|float]] - Mandatory if ~~max_speed~~ is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.		* max_speed - [[Types/float\|float]] - Mandatory if min_speed is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.

	{{Prototype property\|filename\|[[Types/FileName\|FileName]]\|optional=true}}		{{Prototype property\|filename\|[[Types/FileName\|FileName]]\|optional=true}}
Line 53:		Line 53:

	{{Prototype property\|max_speed\|[[Types/float\|float]]\|1.0\|optional=true}}		{{Prototype property\|max_speed\|[[Types/float\|float]]\|1.0\|optional=true}}
	Only loaded if <code>variations</code> is not given. Mandatory if ~~max_speed~~ is present, otherwise not loaded. Must be >= min_speed.		Only loaded if <code>variations</code> is not given. Mandatory if min_speed is present, otherwise not loaded. Must be >= min_speed.

← Older revision		Revision as of 14:33, 25 October 2024
Line 2:		Line 2:

	</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>



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

	~~{{Prototype TOC\|sound}}~~

	~~== Mandatory properties ==~~

	~~{{Prototype property\|type\|[[Types/string\|string]]}}~~
	~~Must be "sound".~~

	~~{{Prototype property\|name\|[[Types/string\|string]]}}~~
	~~Name of the sound. Must be unique. Used as a https://lua-api.factorio.com/latest/Concepts.html#SoundPath.~~

	~~== Optional properties ==~~

	~~{{Prototype property\|category\|[[Types/string\|string]]\|"game-effect"\|optional=true}}~~
	~~One of "game-effect", "gui-effect", "ambient", "environment", "walking", "alert" and "wind".~~

	This defines which slider in the sound settings affects the volume of this sound. Furthermore, some sound types are mixed differently than others, e.g. zoom level effects are applied.[https://forums.factorio.com/viewtopic.php?p=527778#p527778]

	~~{{Prototype property\|aggregation\|[[Types/table\|table]]\|optional=true}}~~
	~~Table with the following members:~~
	* max_count - [[Types/uint32\|uint32]] - Mandatory.
	* 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\|bool]] - Mandatory.
	* count_already_playing - [[Types/bool\|bool]] - Optional. - Default: false - If true already playing sounds are taken into account when checking maxCount.

	~~{{Prototype property\|allow_random_repeat\|[[Types/bool\|bool]]\|false\|optional=true}}~~

	~~{{Prototype property\|audible_distance_modifier\|[[Types/double\|double]]\|1.0\|optional=true}}~~

	~~{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}~~
	~~Array of tables with the following members:~~
	* filename - [[Types/FileName\|FileName]] - Mandatory. Supported sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.
	* volume - [[Types/float\|float]] - Optional. - Default: 1.0
	* preload - [[Types/bool\|bool]] - Optional.
	* speed - [[Types/float\|float]] - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.
	* min_speed - [[Types/float\|float]] - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.
	* max_speed - [[Types/float\|float]] - Mandatory if min_speed is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.

	~~{{Prototype property\|filename\|[[Types/FileName\|FileName]]\|optional=true}}~~
	~~Mandatory if <code>variations</code> is not given.~~

	~~Support sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.~~

	~~{{Prototype property\|volume\|[[Types/float\|float]]\|1.0\|optional=true}}~~
	~~Only loaded if <code>variations</code> is not given.~~

	~~{{Prototype property\|preload\|[[Types/bool\|bool]]\|optional=true}}~~
	~~Only loaded if <code>variations</code> is not given.~~

	~~{{Prototype property\|speed\|[[Types/float\|float]]\|1.0\|optional=true}}~~
	~~Only loaded if <code>variations</code> is not given. Speed must be >= 1 / 64. This sets both min and max speed.~~

	~~{{Prototype property\|min_speed\|[[Types/float\|float]]\|1.0\|optional=true}}~~
	~~Only loaded if <code>variations</code> is not given. Not loaded if speed is present. Speed must be >= 1 / 64.~~

	~~{{Prototype property\|max_speed\|[[Types/float\|float]]\|1.0\|optional=true}}~~
	~~Only loaded if <code>variations</code> is not given. Mandatory if min_speed is present, otherwise not loaded. Must be >= min_speed.~~

← Older revision		Revision as of 19:06, 20 October 2021
Line 32:		Line 32:
	{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}		{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}
	Array of tables with the following members:		Array of tables with the following members:
	* filename - [[Types/FileName\|FileName]] - Mandatory. ~~Support~~ sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.		* filename - [[Types/FileName\|FileName]] - Mandatory. Supported sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.
	* volume - [[Types/float\|float]] - Optional. - Default: 1.0		* volume - [[Types/float\|float]] - Optional. - Default: 1.0
	* preload - [[Types/bool\|bool]] - Optional.		* preload - [[Types/bool\|bool]] - Optional.

← Older revision		Revision as of 18:30, 8 October 2021
Line 30:		Line 30:
	{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}		{{Prototype property\|variations\|[[Types/table\|table]] (array) of [[Types/table\|table]]s\|optional=true}}
	Array of tables with the following members:		Array of tables with the following members:
	* filename - [[Types/FileName\|FileName]] - Mandatory.		* filename - [[Types/FileName\|FileName]] - Mandatory. Support sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.
	* volume - [[Types/float\|float]] - Optional. - Default: 1.0		* volume - [[Types/float\|float]] - Optional. - Default: 1.0
	* preload - [[Types/bool\|bool]] - Optional.		* preload - [[Types/bool\|bool]] - Optional.
Line 39:		Line 39:
	{{Prototype property\|filename\|[[Types/FileName\|FileName]]\|optional=true}}		{{Prototype property\|filename\|[[Types/FileName\|FileName]]\|optional=true}}
	Mandatory if <code>variations</code> is not given.		Mandatory if <code>variations</code> is not given.

			Support sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.

	{{Prototype property\|volume\|[[Types/float\|float]]\|1.0\|optional=true}}		{{Prototype property\|volume\|[[Types/float\|float]]\|1.0\|optional=true}}

← Older revision		Revision as of 10:49, 25 May 2020
Line 35:		Line 35:
	* speed - [[Types/float\|float]] - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.		* speed - [[Types/float\|float]] - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.
	* min_speed - [[Types/float\|float]] - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.		* min_speed - [[Types/float\|float]] - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.
	* max_speed - [[Types/float\|float]] - Mandatory if ~~max_speed~~ is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.		* max_speed - [[Types/float\|float]] - Mandatory if min_speed is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.

	{{Prototype property\|filename\|[[Types/FileName\|FileName]]\|optional=true}}		{{Prototype property\|filename\|[[Types/FileName\|FileName]]\|optional=true}}
Line 53:		Line 53:

	{{Prototype property\|max_speed\|[[Types/float\|float]]\|1.0\|optional=true}}		{{Prototype property\|max_speed\|[[Types/float\|float]]\|1.0\|optional=true}}
	Only loaded if <code>variations</code> is not given. Mandatory if ~~max_speed~~ is present, otherwise not loaded. Must be >= min_speed.		Only loaded if <code>variations</code> is not given. Mandatory if min_speed is present, otherwise not loaded. Must be >= min_speed.