Lua_api.txt: Clarify arguments of functions, plus some cleanup

[oweals/minetest.git] / doc / menu_lua_api.txt

diff --git a/doc/menu_lua_api.txt b/doc/menu_lua_api.txt
index 5c0f90df65bdbbfd9c05a29f242cc71d912791f8..1d158f3049fcfb6d94432d4c10455ebf4549b240 100644 (file)
--- a/doc/menu_lua_api.txt
+++ b/doc/menu_lua_api.txt
@@ -1,4 +1,4 @@
-Minetest Lua Mainmenu API Reference 0.4.11
+Minetest Lua Mainmenu API Reference 0.5.0
 ========================================
 
 Introduction
@@ -31,38 +31,16 @@ core.start()
 core.close()
 
 Filesystem:
-core.get_scriptdir()
-^ returns directory of script
+core.get_builtin_path()
+^ returns path to builtin root
 core.get_modpath() (possible in async calls)
 ^ returns path to global modpath
-core.get_modstore_details(modid) (possible in async calls)
-^ modid numeric id of mod in modstore
-^ returns {
-       id                      = <numeric id of mod in modstore>,
-       title           = <human readable title>,
-       basename        = <basename for mod>,
-       description = <description of mod>,
-       author          = <author of mod>,
-       download_url= <best match download url>,
-       license         = <short description of license>,
-       rating          = <float value of current rating>
-}
-core.get_modstore_list() (possible in async calls)
-^ returns {
-       [1] = {
-               id               = <numeric id of mod in modstore>,
-               title    = <human readable title>,
-               basename = <basename for mod>
-       }
-}
+core.get_clientmodpath() (possible in async calls)
+^ returns path to global client-side modpath
 core.get_gamepath() (possible in async calls)
 ^ returns path to global gamepath
 core.get_texturepath() (possible in async calls)
 ^ returns path to default textures
-core.get_dirlist(path,onlydirs) (possible in async calls)
-^ path to get subdirs from
-^ onlydirs should result contain only dirs?
-^ returns list of folders within path
 core.create_dir(absolute_path) (possible in async calls)
 ^ absolute_path to directory to create (needs to be absolute)
 ^ returns true/false
@@ -145,8 +123,8 @@ core.get_game(index)
        addon_mods_paths = {[1] = <path>,},
 }
 core.get_games() -> table of all games in upper format (possible in async calls)
-core.get_mapgen_names() -> table of all map generator algorithms registered in
-                           the core (possible in async calls)
+core.get_mapgen_names([include_hidden=false]) -> table of map generator algorithms
+    registered in the core (possible in async calls)
 
 Favorites:
 core.get_favorites(location) -> list of favorites (possible in async calls)
@@ -195,11 +173,15 @@ core.create_world(worldname, gameid)
 core.delete_world(index)
 
 Helpers:
+core.get_us_time()
+^ returns time with microsecond precision
 core.gettext(string) -> string
 ^ look up the translation of a string in the gettext message catalog
-fgettext(string, ...) -> string
+fgettext_ne(string, ...)
 ^ call core.gettext(string), replace "$1"..."$9" with the given
-^ extra arguments, call core.formspec_escape and return the result
+^ extra arguments and return the result
+fgettext(string, ...) -> string
+^ same as fgettext_ne(), but calls core.formspec_escape before returning result
 core.parse_json(string[, nullvalue]) -> something (possible in async calls)
 ^ see core.parse_json (lua_api.txt)
 dump(obj, dumped={})
@@ -210,6 +192,16 @@ string:trim()
 ^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
 core.is_yes(arg) (possible in async calls)
 ^ returns whether arg can be interpreted as yes
+minetest.encode_base64(string) (possible in async calls)
+^ Encodes a string in base64.
+minetest.decode_base64(string) (possible in async calls)
+^ Decodes a string encoded in base64.
+
+Version compat:
+core.get_min_supp_proto()
+^ returns the minimum supported network protocol version
+core.get_max_supp_proto()
+^ returns the maximum supported network protocol version
 
 Async:
 core.handle_async(async_job,parameters,finished)
@@ -224,7 +216,7 @@ Limitations of Async operations
  -Limited set of available functions
        e.g. No access to functions modifying menu like core.start,core.close,
        core.file_open_dialog
-                       
+
 
 Class reference
 ----------------