Types/Sound - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:33Z

Removed old prototype docs

← Older revision		Revision as of 14:32, 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>



	~~==Basics==~~
	~~This type is either a table with the properties listed in [[#Optional properties]], or an array of tables with the following members:~~
	* filename - [[Types/FileName]] - Mandatory. Supported sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.
	* volume - [[Types/float]] - Optional. - Default: 1.0
	* preload - [[Types/bool]] - Optional.
	* speed - [[Types/float]] - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.
	* min_speed - [[Types/float]] - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.
	* max_speed - [[Types/float]] - Mandatory if min_speed is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.

	~~== Optional properties ==~~
	~~=== aggregation ===~~
	~~'''Type''': [[Types/table]]~~

	~~Table with the following members:~~
	* max_count - [[Types/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.
	* remove - [[Types/bool]] - Mandatory.
	* count_already_playing - [[Types/bool]] - Optional. - Default: false - If true already playing sounds are taken into account when checking maxCount.

	~~=== allow_random_repeat ===~~
	~~'''Type''': [[Types/bool]]~~

	~~'''Default''': false~~

	~~=== audible_distance_modifier ===~~
	~~'''Type''': [[Types/double]]~~

	~~'''Default''': 1.0~~

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

	~~=== variations ===~~
	~~'''Type''': [[Types/table]] (array) of [[Types/table]]s~~

	~~Array of tables with the following members:~~
	* filename - [[Types/FileName]] - Mandatory.
	* volume - [[Types/float]] - Optional. - Default: 1.0
	* preload - [[Types/bool]] - Optional.
	* speed - [[Types/float]] - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.
	* min_speed - [[Types/float]] - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.
	* max_speed - [[Types/float]] - Mandatory if min_speed is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.

	~~=== filename ===~~
	~~'''Type''': [[Types/FileName]]~~

	~~Mandatory if <code>variations</code> is not given.~~

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

	~~=== volume ===~~
	~~'''Type''': [[Types/float]]~~

	~~'''Default''': 1.0~~

	~~Only loaded if <code>variations</code> is not given.~~

	~~=== preload ===~~
	~~'''Type''': [[Types/bool]]~~

	~~Only loaded if <code>variations</code> is not given.~~

	~~=== speed ===~~
	~~'''Type''': [[Types/float]]~~

	~~'''Default''': 1.0~~

	~~Only loaded if <code>variations</code> is not given. Speed must be >= 1 / 64. This sets both min and max speed.~~

	~~=== min_speed ===~~
	~~'''Type''': [[Types/float]]~~

	~~'''Default''': 1.0~~

	~~Only loaded if <code>variations</code> is not given. Not loaded if speed is present. Speed must be >= 1 / 64.~~

	~~=== max_speed ===~~
	~~'''Type''': [[Types/float]]~~

	~~'''Default''': 1.0~~

	~~Only loaded if <code>variations</code> is not given. Mandatory if min_speed is present, otherwise not loaded. Must be >= min_speed.~~

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

	~~{{Prototype property type usage\|{{FULLPAGENAME}}}}~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:36Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:42, 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/types/Sound.html https://lua-api.factorio.com/latest/types/Sound.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/types/Sound.html https://lua-api.factorio.com/latest/types/Sound.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 "Types/Sound": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:51:46Z

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

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

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:51:46Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:51, 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/types/Sound.html https://lua-api.factorio.com/latest/types/Sound.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].



	==Basics==		==Basics==
	This type is either a table with the properties listed in [[#Optional properties]], or an array of tables with the following members:		This type is either a table with the properties listed in [[#Optional properties]], or an array of tables with the following members:

Bilka: /* variations */ last max_speed -> min_speed typo

2022-04-29T13:53:26Z

variations: last max_speed -> min_speed typo

← Older revision		Revision as of 13:53, 29 April 2022
Line 39:		Line 39:
	* speed - [[Types/float]] - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.		* speed - [[Types/float]] - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.
	* min_speed - [[Types/float]] - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.		* min_speed - [[Types/float]] - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.
	* max_speed - [[Types/float]] - Mandatory if ~~max_speed~~ is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.		* max_speed - [[Types/float]] - Mandatory if min_speed is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.

	=== filename ===		=== filename ===

Bilka: typo

2021-10-20T19:06:03Z

typo

← Older revision		Revision as of 19:06, 20 October 2021
Line 1:		Line 1:
	==Basics==		==Basics==
	This type is either a table with the properties listed in [[#Optional properties]], or an array of tables with the following members:		This type is either a table with the properties listed in [[#Optional properties]], or an array of tables with the following members:
	* filename - [[Types/FileName]] - Mandatory. ~~Support~~ sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.		* filename - [[Types/FileName]] - Mandatory. Supported sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.
	* volume - [[Types/float]] - Optional. - Default: 1.0		* volume - [[Types/float]] - Optional. - Default: 1.0
	* preload - [[Types/bool]] - Optional.		* preload - [[Types/bool]] - Optional.

Bilka: Documented support sound file formats

2021-10-08T18:30:24Z

Documented support sound file formats

← Older revision		Revision as of 18:30, 8 October 2021
Line 1:		Line 1:
	==Basics==		==Basics==
	This type is either a table with the properties listed in [[#Optional properties]], or an array of tables with the following members:		This type is either a table with the properties listed in [[#Optional properties]], or an array of tables with the following members:
	* filename - [[Types/FileName]] - Mandatory.		* filename - [[Types/FileName]] - Mandatory. Support sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>.
	* volume - [[Types/float]] - Optional. - Default: 1.0		* volume - [[Types/float]] - Optional. - Default: 1.0
	* preload - [[Types/bool]] - Optional.		* preload - [[Types/bool]] - Optional.
Line 45:		Line 45:

	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>.

	=== volume ===		=== volume ===

Bilka: Formatting changes

2021-08-06T17:09:38Z

Formatting changes

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

	'''Default''': 1.0		'''Default''': 1.0
	~~Modifies how far a sound can be heard. Can only be 1 or lower, has to be a positive number.~~


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

	=== variations ===		=== variations ===

Darkfrei at 09:47, 20 July 2021

2021-07-20T09:47:13Z

← Older revision		Revision as of 09:47, 20 July 2021
Line 27:		Line 27:

	'''Default''': 1.0		'''Default''': 1.0
			Modifies how far a sound can be heard. Can only be 1 or lower, has to be a positive number.



	=== variations ===		=== variations ===

Bilka: typos

2020-05-25T10:49:30Z

typos

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

	== Optional properties ==		== Optional properties ==
Line 75:		Line 75:
	'''Default''': 1.0		'''Default''': 1.0

	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.

	==Example==		==Example==