add missing documentation to config set function

This commit is contained in:
Dirk Sohler 2020-08-17 16:46:50 +02:00
parent 15ded5a0b2
commit 663ba84961
No known key found for this signature in database
GPG Key ID: B9751241BD7D4E1A

@ -25,6 +25,11 @@ local worldconfig = Settings(worldpath..DIR_DELIM..'_mtimer.conf')
-- 1. Standard `minetest.conf` file that is used for the server
-- 2. `_mtimer.conf` in the loaded worlds directory
-- 3. Provided default value when calling the function
--
-- @param key_name The unprefixed name of the key to get
-- @param default_value What to return when the configuration option is missing
-- @param changeable If the option is changeable via the config files
-- @return string Either the configuration options value or an empty string
local set = function (key_name, default_value, changeable)
local meta_key = 'mtimer:'..key_name
local config_option = 'mtimer_'..key_name