InsaneProtestor/mods/sounds/settings.lua

54 lines
1.4 KiB
Lua

--- Sounds Settings
--
-- @topic settings
--- Disables individual built-in sound groups categories.
--
-- Category names that can be disabled are the filenames in the
-- "groups" directory without the ".lua" suffix. Use "all" to
-- disable all built-in groups.
--
-- @setting sounds.disabled_groups
-- @settype string (comma-separated list)
-- @default Empty string.
-- @usage # disable animal & weather sound groups
-- sounds.disabled_groups = animal,weather
sounds.disabled_groups = {}
for _, d in ipairs(string.split(core.settings:get("sounds.disabled_groups") or "", ",")) do
d = d:trim()
if d ~= "" then
sounds.disabled_groups[d] = true
end
end
--- Enables/Disables ambiance sounds for biomes.
--
-- @setting sounds.enable_biome_sounds
-- @settype bool
-- @default false
sounds.enable_biome_sounds = core.settings:get_bool("sounds.enable_biome_sounds", false)
--- Interval between playing biome sounds.
--
-- @setting sounds.biome_interval
-- @settype int
-- @min 5
-- @default 30
--- Chance that sound will be played at interval.
--
-- @setting sounds.biome_chance
-- @settype int
-- @min 0
-- @max 100
-- @default 20
--- Enables sounds testing with [sounds_tests](tests.html#sounds_tests) chat command.
--
-- @setting sounds.enable_tests
-- @settype bool
-- @default false
sounds.enable_tests = core.settings:get_bool("sounds.enable_tests", false)