Docs: Recommend `self.name` (#12239)

[dragonfireclient.git] / doc / menu_lua_api.txt

diff --git a/doc/menu_lua_api.txt b/doc/menu_lua_api.txt
index b3975bc1d86ba240f3a7b49c61b1e7fbae5b6faa..c2931af310f6a45aec6d43de75577aaf7a214432 100644 (file)
--- a/doc/menu_lua_api.txt
+++ b/doc/menu_lua_api.txt
@@ -1,4 +1,4 @@
-Minetest Lua Mainmenu API Reference 5.4.0
+Minetest Lua Mainmenu API Reference 5.6.0
 =========================================
 
 Introduction
@@ -85,7 +85,9 @@ core.get_video_drivers()
 core.get_mapgen_names([include_hidden=false]) -> table of map generator algorithms
     registered in the core (possible in async calls)
 core.get_cache_path() -> path of cache
-core.get_temp_path() -> path of temp folder
+core.get_temp_path([param]) (possible in async calls)
+^ param=true: returns path to a temporary file
+^ otherwise: returns path to the temporary folder
 
 
 HTTP Requests
@@ -204,7 +206,8 @@ core.get_screen_info()
     display_width   = <width of display>,
     display_height  = <height of display>,
     window_width    = <current window width>,
-    window_height   = <current window height>
+    window_height   = <current window height>,
+    render_info     = <active render information>
     }
 
 
@@ -218,7 +221,24 @@ Package - content which is downloadable from the content db, may or may not be i
     * returns path to global user data,
       the directory that contains user-provided mods, worlds, games, and texture packs.
 * core.get_modpath() (possible in async calls)
-    * returns path to global modpath
+    * returns path to global modpath in the user path, where mods can be installed
+* core.get_modpaths() (possible in async calls)
+    * returns table of virtual path to global modpaths, where mods have been installed
+      The difference with "core.get_modpath" is that no mods should be installed in these
+      directories by Minetest -- they might be read-only.
+
+      Ex:
+
+      ```
+      {
+          mods = "/home/user/.minetest/mods",
+          share = "/usr/share/minetest/mods",
+
+          -- Custom dirs can be specified by the MINETEST_MOD_DIR env variable
+          ["/path/to/custom/dir"] = "/path/to/custom/dir",
+      }
+      ```
+
 * core.get_clientmodpath() (possible in async calls)
     * returns path to global client-side modpath
 * core.get_gamepath() (possible in async calls)