Types/Sound: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(added some more properties)
(Removed old prototype docs)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==Basics==
<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 type is used to produce sound from in-game entities, ambient sound, and music.
== Mandatory properties ==
===filename===
'''Type''': [[Types/FileName]]


Used to let the game know what audio file you want it to use.
</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>
===sound===
'''Type''': ???
 
Can be used instead of "filename".
 
Example:
    "sound": {"filename": "__base__/sound/substation.ogg"},
 
===volume===
'''Type''': [[Types/unsigned]]
 
Decides how loud the audio is.
=== apparent_volume ===
'''Type''': [[Types/double]]
 
Can be used instead of "volume".
== Optional properties ==
=== 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==
    {
      filename = "__base__/sound/ambient/world-ambience-3.ogg",
      volume = 1.2
    }

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"