Types/WorkingSound - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:39Z

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 used to produce sound from in-game entities when they are working/idle.~~
	~~== Mandatory properties ==~~
	~~===sound===~~
	~~'''Type''': [[Types/Sound]]~~

	~~The sound to be played when the entity is working. If sound is not present, the entire WorkingSound is loaded as a [[Types/Sound]].~~

	~~== Optional properties ==~~
	~~=== apparent_volume ===~~
	~~'''Type''': [[Types/float]]~~

	~~'''Default''': 1~~

	~~=== max_sounds_per_type ===~~
	~~'''Type''': [[Types/uint8]]~~

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

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

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

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

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

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

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

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

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

	~~'''Default''': true~~

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

	~~'''Default''': 1~~

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

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

	~~'''Default''': 1~~

	~~Modifies how often the sound is played. Example:~~
	~~<syntaxhighlight lang="lua">probability = 1 / (3 * 60) -- average pause between the sound is 3 seconds</syntaxhighlight>~~

	~~=== fade_in_ticks ===~~
	~~'''Type''': [[Types/uint32]]~~

	~~'''Default''': 0~~

	~~Can't be used when match_progress_to_activity is true.~~

	~~=== fade_out_ticks ===~~
	~~'''Type''': [[Types/uint32]]~~

	~~'''Default''': 0~~

	~~Can't be used when match_progress_to_activity is true.~~

	~~=== idle_sound ===~~
	~~'''Type''': [[Types/Sound]]~~

	~~The sound to be played when the entity is idle. Might not work with all entities that use working_sound.~~

	~~=== activate_sound ===~~
	~~'''Type''': [[Types/Sound]]~~

	~~Might not work with all entities that use working_sound.~~

	~~=== deactivate_sound ===~~
	~~'''Type''': [[Types/Sound]]~~

	~~Might not work with all entities that use working_sound.~~

	~~==Example==~~

	~~Refinery:~~
	~~<syntaxhighlight lang="lua">~~
	~~working_sound =~~
	{
	~~sound = { filename = "__base__/sound/oil-refinery.ogg" },~~
	~~idle_sound = { filename = "__base__/sound/idle1.ogg", volume = 0.6 },~~
	~~apparent_volume = 2.5,~~
	~~},</syntaxhighlight>~~

	~~Roboport:~~
	~~<syntaxhighlight lang="lua">~~
	~~working_sound =~~
	{
	~~sound = { filename = "__base__/sound/roboport-working.ogg", volume = 0.6 },~~
	~~max_sounds_per_type = 3,~~
	~~audible_distance_modifier = 0.5,~~
	~~probability = 1 / (5 * 60) -- average pause between the sound is 5 seconds~~
	},
	~~</syntaxhighlight>~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:42Z

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/WorkingSound.html https://lua-api.factorio.com/latest/types/WorkingSound.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/WorkingSound.html https://lua-api.factorio.com/latest/types/WorkingSound.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/WorkingSound": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:51:53Z

Protected "Types/WorkingSound": 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:53Z

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/WorkingSound.html https://lua-api.factorio.com/latest/types/WorkingSound.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 used to produce sound from in-game entities when they are working/idle.		This type is used to produce sound from in-game entities when they are working/idle.

Bilka: 0.18.17

2020-04-06T11:48:27Z

0.18.17

← Older revision		Revision as of 11:48, 6 April 2020
Line 5:		Line 5:
	'''Type''': [[Types/Sound]]		'''Type''': [[Types/Sound]]

	The sound to be played when the entity is working.		The sound to be played when the entity is working. If sound is not present, the entire WorkingSound is loaded as a [[Types/Sound]].

	== Optional properties ==		== Optional properties ==
Line 30:		Line 30:

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

			=== persistent ===
			'''Type''': [[Types/bool]]

			'''Default''': false

			=== use_doppler_shift ===
			'''Type''': [[Types/bool]]

			'''Default''': true

	=== audible_distance_modifier ===		=== audible_distance_modifier ===
Line 36:		Line 46:
	'''Default''': 1		'''Default''': 1

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

	=== probability ===		=== probability ===
	'''Type''': [[Types/double]]		'''Type''': [[Types/double]]
Line 45:		Line 56:
	<syntaxhighlight lang="lua">probability = 1 / (3 * 60) -- average pause between the sound is 3 seconds</syntaxhighlight>		<syntaxhighlight lang="lua">probability = 1 / (3 * 60) -- average pause between the sound is 3 seconds</syntaxhighlight>

	=== ~~persistent~~ ===		=== fade_in_ticks ===
	'''Type''': [[Types/~~bool~~]]		'''Type''': [[Types/uint32]]

			'''Default''': 0

			Can't be used when match_progress_to_activity is true.

			=== fade_out_ticks ===
			'''Type''': [[Types/uint32]]

			'''Default''': 0

	'~~''Default''': false~~		Can't be used when match_progress_to_activity is true.

	=== idle_sound ===		=== idle_sound ===
	'''Type''': [[Types/Sound]]		'''Type''': [[Types/Sound]]

	The sound to be played when the entity is idle. Might not work with all entities that use working_sound~~. Used by accumulator, assembling-machine, electric-energy-interface~~.		The sound to be played when the entity is idle. Might not work with all entities that use working_sound.

	=== activate_sound ===		=== activate_sound ===
	'''Type''': [[Types/Sound]]		'''Type''': [[Types/Sound]]

	Might not work with all entities that use working_sound~~. Used by car~~.		Might not work with all entities that use working_sound.

	=== deactivate_sound ===		=== deactivate_sound ===
	'''Type''': [[Types/Sound]]		'''Type''': [[Types/Sound]]

	Might not work with all entities that use working_sound~~. Used by car~~.		Might not work with all entities that use working_sound.

	==Example==		==Example==

Bilka: 0.17

2019-08-07T18:56:27Z

0.17

@@ Line 10: / Line 10: @@
 === apparent_volume ===
 '''Type''': [[Types/float]]
 === audible_distance_modifier ===
 '''Type''': [[Types/double]]
-Modifies how far a sound can be heard. Default is ? which means that the sound can be heard up to ? tiles away from the entity.
+'''Default''': 1
 === probability ===
 '''Type''': [[Types/double]]
 Modifies how often the sound is played. Example:
 <syntaxhighlight lang="lua">probability = 1 / (3 * 60) -- average pause between the sound is 3 seconds</syntaxhighlight>
 === idle_sound ===
@@ Line 35: / Line 64: @@
 Might not work with all entities that use working_sound. Used by car.
 ==Example==

Bilka: added activate_sound, deactivate_sound

2017-09-09T19:06:23Z

added activate_sound, deactivate_sound

← Older revision		Revision as of 19:06, 9 September 2017
Line 25:		Line 25:

	The sound to be played when the entity is idle. Might not work with all entities that use working_sound. Used by accumulator, assembling-machine, electric-energy-interface.		The sound to be played when the entity is idle. Might not work with all entities that use working_sound. Used by accumulator, assembling-machine, electric-energy-interface.

			=== activate_sound ===
			'''Type''': [[Types/Sound]]

			Might not work with all entities that use working_sound. Used by car.

			=== deactivate_sound ===
			'''Type''': [[Types/Sound]]

			Might not work with all entities that use working_sound. Used by car.

	=== max_sounds_per_type ===		=== max_sounds_per_type ===

Bilka: /* idle_sound */ added whcih entities use it

2017-09-09T19:04:44Z

idle_sound: added whcih entities use it

← Older revision		Revision as of 19:04, 9 September 2017
Line 24:		Line 24:
	'''Type''': [[Types/Sound]]		'''Type''': [[Types/Sound]]

	The sound to be played when the entity is idle. Might not work with all entities that use working_sound.		The sound to be played when the entity is idle. Might not work with all entities that use working_sound. Used by accumulator, assembling-machine, electric-energy-interface.

	=== max_sounds_per_type ===		=== max_sounds_per_type ===

Bilka: Created page with "==Basics== This type is used to produce sound from in-game entities when they are working/idle. == Mandatory properties == ===sound=== '''Type''': Types/Sound The sound t..."

2017-09-06T18:42:18Z

Created page with "==Basics== This type is used to produce sound from in-game entities when they are working/idle. == Mandatory properties == ===sound=== '''Type''': Types/Sound The sound t..."

New page

==Basics==
This type is used to produce sound from in-game entities when they are working/idle.
== Mandatory properties ==
===sound===
'''Type''': [[Types/Sound]]

The sound to be played when the entity is working.

== Optional properties ==
=== apparent_volume ===
'''Type''': [[Types/float]]

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

Modifies how far a sound can be heard. Default is ? which means that the sound can be heard up to ? tiles away from the entity.
=== probability ===
'''Type''': [[Types/double]]

Modifies how often the sound is played. Example:
<syntaxhighlight lang="lua">probability = 1 / (3 * 60) -- average pause between the sound is 3 seconds</syntaxhighlight>

=== idle_sound ===
'''Type''': [[Types/Sound]]

The sound to be played when the entity is idle. Might not work with all entities that use working_sound.

=== max_sounds_per_type ===
'''Type''': [[Types/uint8]]

=== match_progress_to_activity ===
'''Type''': [[Types/bool]]

=== match_volume_to_activity ===
'''Type''': [[Types/bool]]

=== match_speed_to_activity ===
'''Type''': [[Types/bool]]

==Example==

Refinery:
<syntaxhighlight lang="lua">
working_sound =
{
sound = { filename = "__base__/sound/oil-refinery.ogg" },
idle_sound = { filename = "__base__/sound/idle1.ogg", volume = 0.6 },
apparent_volume = 2.5,
},</syntaxhighlight>

Roboport:
<syntaxhighlight lang="lua">
working_sound =
{
sound = { filename = "__base__/sound/roboport-working.ogg", volume = 0.6 },
max_sounds_per_type = 3,
audible_distance_modifier = 0.5,
probability = 1 / (5 * 60) -- average pause between the sound is 5 seconds
},
</syntaxhighlight>