Prototype/AmbientSound: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Added prototype type to page)
(Removed old prototype docs)
 
(10 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/prototypes/AmbientSound.html https://lua-api.factorio.com/latest/prototypes/AmbientSound.html]
Prototype type: '''ambient-sound'''


This prototype is used to make sound, while playing the game. This includes background noise, such as trees and wind, or the in-game's music, composed by Daniel James Taylor.
</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>
==Properties==
=== type ===
'''Type''': [[Types/string]]
 
Specification of the type of the prototype. Must be "ambient-sound".
 
=== name ===
'''Type''': [[Types/string]]
 
Unique textual identification of the prototype.
 
===track_type===
'''Type''': [[Types/string]]
 
This lets the game know in what instances the audio file is played.
 
The following types are recognized:
 
  "early-game"
  "main-track"
  "interlude"
  "late-game"
===sound===
'''Type''': [[Types/Sound]]
 
The sound file and volume.
 
=== weight ===
'''Type''': [[Types/double]]
 
'''Default''': 1
 
==Example==
  {
    type = "ambient-sound",
    name = "world-ambience-4",
    track_type = "interlude",
    sound =
    {
      filename = "__base__/sound/ambient/world-ambience-4.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/prototypes/AmbientSound.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.