Types/Sound: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (Protected "Types/Sound": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
(Removed old prototype docs)
 
(One intermediate revision by the same user not shown)
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>
 
 
 
==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}}}}

Latest revision as of 14:32, 25 October 2024

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

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 on the forums.

Retrieved from "https://wiki.factorio.com/index.php?title=Types/Sound&oldid=202751"