summaryrefslogtreecommitdiff
path: root/doc/client_lua_api.txt
diff options
context:
space:
mode:
authorAFCMS <afcm.contact@gmail.com>2022-08-02 11:58:08 +0200
committerGitHub <noreply@github.com>2022-08-02 11:58:08 +0200
commit6ec6acc539321709ed8517f1a571777a04f5c24c (patch)
tree7b63437670a07e218e4af5ebe942e0e3130ec629 /doc/client_lua_api.txt
parent839600ed703ccffbdb71bd2f04fb379d0920da95 (diff)
downloadminetest-6ec6acc539321709ed8517f1a571777a04f5c24c.tar.gz
minetest-6ec6acc539321709ed8517f1a571777a04f5c24c.tar.bz2
minetest-6ec6acc539321709ed8517f1a571777a04f5c24c.zip
Add `minetest.settings` to CSM API and allow CSMs to provide `settingtypes.txt` (#12131)
Co-authored-by: sfan5 <sfan5@live.de> Co-authored-by: SmallJoker <SmallJoker@users.noreply.github.com>
Diffstat (limited to 'doc/client_lua_api.txt')
-rw-r--r--doc/client_lua_api.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/client_lua_api.txt b/doc/client_lua_api.txt
index d08cd9b5e..8a450ba13 100644
--- a/doc/client_lua_api.txt
+++ b/doc/client_lua_api.txt
@@ -938,6 +938,14 @@ Call these functions only at load time!
* `minetest.display_chat_message(message)` returns true on success
* Shows a chat message to the current player.
+Setting-related
+---------------
+
+* `minetest.settings`: Settings object containing all of the settings from the
+ main config file (`minetest.conf`). Check lua_api.txt for class reference.
+* `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
+ parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
+
Class reference
---------------