Allow 'default' parameter in 'settings:get_bool' function

Default value is used when the setting key is not found in the config file. If default value is not set, 'nil' is returned. #6188
minetest · Dec 17, 2017 · 18b9210 · 18b9210
1 parent 26c7e98
commit 18b9210
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
@@ -4131,7 +4131,9 @@ It can be created via `Settings(filename)`.
 
 #### Methods
 * `get(key)`: returns a value
-* `get_bool(key)`: returns a boolean
+* `get_bool(key, [default])`: returns a boolean
+    * `default` is the value returned if `key` is not found.
+    * Returns `nil` if `key` is not found and `default` not specified.
 * `get_np_group(key)`: returns a NoiseParams table
 * `set(key, value)`
     * Setting names can't contain whitespace or any of `="{}#`.

diff --git a/src/script/lua_api/l_settings.cpp b/src/script/lua_api/l_settings.cpp
@@ -100,7 +100,11 @@ int LuaSettings::l_get_bool(lua_State* L)
 		bool value = o->m_settings->getBool(key);
 		lua_pushboolean(L, value);
 	} else {
-		lua_pushnil(L);
+		// Push default value
+		if (lua_isboolean(L, 3))
+			lua_pushboolean(L, lua_toboolean(L, 3));
+		else
+			lua_pushnil(L);
 	}
 
 	return 1;