Prototype/AmbientSound: Difference between revisions
(overhaul to include Prototype) |
(Updated styling of prototype doc migration note) |
||
(12 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
= | <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] | ||
</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> | |||
{{Prototype parent}} | |||
This prototype is used to make sound while playing the game. This includes the game's [https://store.steampowered.com/app/436090 music], composed by Daniel James Taylor. | |||
{{Prototype TOC|ambient-sound}} | |||
==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. | This lets the game know in what instances the audio file is played. | ||
The | The following types are recognized: | ||
* "early-game" | |||
* "main-track" | |||
* "interlude" | |||
* "late-game" | |||
* "menu-track" | |||
"menu-track" is only played in the main menu. "early-game", "late-game" and "main-track" are all considered main tracks and played interleaved (alternating) with "interlude" tracks. "early-game" and "late-game" have no special effects compared to "main-track" meaning that are functionally the same. | |||
== Optional properties == | |||
{{Prototype property|weight|[[Types/double|double]]|1|optional=true}} | |||
== Example == | |||
==Example== | |||
{ | { | ||
type = "ambient-sound", | type = "ambient-sound", |
Revision as of 10:42, 21 September 2023
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.
Template:Prototype parent This prototype is used to make sound while playing the game. This includes the game's music, composed by Daniel James Taylor.
Mandatory properties
Template:Prototype property Specification of the type of the prototype. Must be "ambient-sound".
Template:Prototype property Unique textual identification of the prototype.
Template:Prototype property The sound file and volume.
Template:Prototype property 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"
"menu-track" is only played in the main menu. "early-game", "late-game" and "main-track" are all considered main tracks and played interleaved (alternating) with "interlude" tracks. "early-game" and "late-game" have no special effects compared to "main-track" meaning that are functionally the same.
Optional properties
Example
{ type = "ambient-sound", name = "world-ambience-4", track_type = "interlude", sound = { filename = "__base__/sound/ambient/world-ambience-4.ogg", volume = 1.2 } },