From 18b921015a33c6e597f480bccc7e2974af33c4ea Mon Sep 17 00:00:00 2001 From: Jordan Irwin Date: Sun, 17 Dec 2017 07:27:37 -0800 Subject: 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 --- doc/lua_api.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/lua_api.txt b/doc/lua_api.txt index aba01fa1d..7d568b6e1 100644 --- 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 `="{}#`. -- cgit v1.2.3