Prototype/Sound: Difference between revisions
(Updated styling of prototype doc migration note) |
|||
| (6 intermediate revisions by 2 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/SoundPrototype.html https://lua-api.factorio.com/latest/prototypes/SoundPrototype.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}} | {{Prototype parent}} | ||
Specifies a sound that can be used with https://lua-api.factorio.com/latest/Concepts.html#SoundPath during runtime. | Specifies a sound that can be used with https://lua-api.factorio.com/latest/Concepts.html#SoundPath during runtime. | ||
| Line 16: | Line 22: | ||
{{Prototype property|category|[[Types/string|string]]|"game-effect"|optional=true}} | {{Prototype property|category|[[Types/string|string]]|"game-effect"|optional=true}} | ||
One of "game-effect", "gui-effect", "ambient", "environment", "walking", "alert" and "wind". | One of "game-effect", "gui-effect", "ambient", "environment", "walking", "alert" and "wind". | ||
This defines which slider in the sound settings affects the volume of this sound. Furthermore, some sound types are mixed differently than others, e.g. zoom level effects are applied.[https://forums.factorio.com/viewtopic.php?p=527778#p527778] | |||
{{Prototype property|aggregation|[[Types/table|table]]|optional=true}} | {{Prototype property|aggregation|[[Types/table|table]]|optional=true}} | ||
| Line 27: | Line 35: | ||
{{Prototype property|audible_distance_modifier|[[Types/double|double]]|1.0|optional=true}} | {{Prototype property|audible_distance_modifier|[[Types/double|double]]|1.0|optional=true}} | ||
{{Prototype property|variations|[[Types/table|table]] (array) of [[Types/table|table]]s|optional=true}} | {{Prototype property|variations|[[Types/table|table]] (array) of [[Types/table|table]]s|optional=true}} | ||
Array of tables with the following members: | Array of tables with the following members: | ||
* filename - [[Types/FileName|FileName]] - Mandatory. | * filename - [[Types/FileName|FileName]] - Mandatory. Supported sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>. | ||
* volume - [[Types/float|float]] - Optional. - Default: 1.0 | * volume - [[Types/float|float]] - Optional. - Default: 1.0 | ||
* preload - [[Types/bool|bool]] - Optional. | * preload - [[Types/bool|bool]] - Optional. | ||
| Line 41: | Line 47: | ||
{{Prototype property|filename|[[Types/FileName|FileName]]|optional=true}} | {{Prototype property|filename|[[Types/FileName|FileName]]|optional=true}} | ||
Mandatory if <code>variations</code> is not given. | Mandatory if <code>variations</code> is not given. | ||
Support sound file formats are <code>.ogg</code>, <code>.wav</code> and <code>.voc</code>. | |||
{{Prototype property|volume|[[Types/float|float]]|1.0|optional=true}} | {{Prototype property|volume|[[Types/float|float]]|1.0|optional=true}} | ||
Revision as of 10:43, 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/SoundPrototype.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 Specifies a sound that can be used with https://lua-api.factorio.com/latest/Concepts.html#SoundPath during runtime.
Mandatory properties
Template:Prototype property Must be "sound".
Template:Prototype property Name of the sound. Must be unique. Used as a https://lua-api.factorio.com/latest/Concepts.html#SoundPath.
Optional properties
Template:Prototype property One of "game-effect", "gui-effect", "ambient", "environment", "walking", "alert" and "wind".
This defines which slider in the sound settings affects the volume of this sound. Furthermore, some sound types are mixed differently than others, e.g. zoom level effects are applied.[1]
Template:Prototype property Table with the following members:
- max_count - uint32 - Mandatory.
- progress_threshold - float - Optional. - Default: 1.0 - If count already playing is true, this will determine maximum progress when instance is counted toward playing sounds.
- remove - bool - Mandatory.
- count_already_playing - bool - Optional. - Default: false - If true already playing sounds are taken into account when checking maxCount.
Template:Prototype property Array of tables with the following members:
- filename - FileName - Mandatory. Supported sound file formats are
.ogg,.wavand.voc. - volume - float - Optional. - Default: 1.0
- preload - bool - Optional.
- speed - float - Optional. - Default: 1.0 - Speed must be >= 1 / 64. This sets both min and max speed.
- min_speed - float - Optional. Not loaded if speed is present. - Default: 1.0 - Speed must be >= 1 / 64.
- max_speed - float - Mandatory if min_speed is present, otherwise not loaded. - Default: 1.0 - Must be >= min_speed.
Template:Prototype property
Mandatory if variations is not given.
Support sound file formats are .ogg, .wav and .voc.
Template:Prototype property
Only loaded if variations is not given.
Template:Prototype property
Only loaded if variations is not given.
Template:Prototype property
Only loaded if variations is not given. Speed must be >= 1 / 64. This sets both min and max speed.
Template:Prototype property
Only loaded if variations is not given. Not loaded if speed is present. Speed must be >= 1 / 64.
Template:Prototype property
Only loaded if variations is not given. Mandatory if min_speed is present, otherwise not loaded. Must be >= min_speed.