Tweak world cycle, add documentation

This commit is contained in:
Till Affeldt
2020-04-26 18:11:38 +02:00
parent bff54bfb74
commit 9e0ed0c256
10 changed files with 114 additions and 15 deletions

View File

@ -1,3 +1,12 @@
--[[
# Sound Loop Effect
Use this effect to loop an ambient sound effect
Expects a table as the parameter containing the following values:
- ``name <string>``: Name of the played sound effect (without .ogg file ending)
- ``gain <number>`` (optional): Volume of the sound (defaults to 1.0)
- ``pitch <number>`` (optional): Pitch of the sound (defaults to 1.0)
]]
if not climate_mod.settings.sound then return end
local EFFECT_NAME = "climate_api:sound"