Prototype/AmbientSound: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎Mandatory properties: 1.1 "menu-track" type)
(Removed old prototype docs)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Prototype parent}}
<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]
This prototype is used to make sound, while playing the game. This includes the in-game's music, composed by Daniel James Taylor.


{{Prototype TOC|ambient-sound}}
</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>
 
==Mandatory properties==
 
{{Prototype property|type|[[Types/string|string]]}}
Specification of the type of the prototype. Must be "ambient-sound".
 
{{Prototype property|name|[[Types/string|string]]}}
Unique textual identification of the prototype.
 
{{Prototype property|sound|[[Types/Sound|Sound]]}}
The sound file and volume.
 
{{Prototype property|track_type|[[Types/string|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"
* "menu-track"
 
== Optional properties ==
 
{{Prototype property|weight|[[Types/double|double]]|1|optional=true}}
 
== 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.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/AmbientSound&oldid=202827"