X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=doc%2Fmenu_lua_api.txt;h=f6b2ffbd28ccfd3a6b955212cc6f62cde9c7458d;hb=a6f784835244111c90c05b6aae47092c2c5763a7;hp=423b8bb9c90555260f3b541576f7952cd34ebdbe;hpb=231ac33d34dfaaddf292c5f31b1eae43eeefba2d;p=dragonfireclient.git diff --git a/doc/menu_lua_api.txt b/doc/menu_lua_api.txt index 423b8bb9c..f6b2ffbd2 100644 --- a/doc/menu_lua_api.txt +++ b/doc/menu_lua_api.txt @@ -1,5 +1,5 @@ -Minetest Lua Mainmenu API Reference 0.4.15 -======================================== +Minetest Lua Mainmenu API Reference 5.1.0 +========================================= Introduction ------------- @@ -33,32 +33,6 @@ core.close() Filesystem: 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 = , - title = , - basename = , - description = , - author = , - download_url= , - license = , - rating = -} -core.get_modstore_list() (possible in async calls) -^ returns { - [1] = { - id = , - title = , - basename = - } -} -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.create_dir(absolute_path) (possible in async calls) ^ absolute_path to directory to create (needs to be absolute) ^ returns true/false @@ -89,6 +63,9 @@ core.get_video_drivers() ^ returns list of available video drivers' settings name and 'friendly' display name ^ e.g. { {name="opengl", friendly_name="OpenGL"}, {name="software", friendly_name="Software Renderer"} } ^ first element of returned list is guaranteed to be the NULL driver +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 Formspec: core.update_formspec(formspec) @@ -112,13 +89,14 @@ core.set_background(type, texturepath,[tile],[minsize]) core.set_clouds() core.set_topleft_text(text) core.show_keys_menu() -core.file_open_dialog(formname,caption) -^ shows a file open dialog +core.show_path_select_dialog(formname, caption, is_file_select) +^ shows a path select dialog ^ formname is base name of dialog response returned in fields ^ -if dialog was accepted "_accepted" -^^ will be added to fieldname containing the path +^ will be added to fieldname containing the path ^ -if dialog was canceled "_cancelled" ^ will be added to fieldname value is set to formname itself +^ if `is_file_select` is `true`, a file and not a folder will be selected ^ returns nil or selected file/folder core.get_screen_info() ^ returns { @@ -129,20 +107,47 @@ core.get_screen_info() window_height = } -Games: -core.get_game(index) -^ returns { - id = , - path = , - gamemods_path = , - name = , - menuicon_path = , - DEPRECATED: - addon_mods_paths = {[1] = ,}, -} -core.get_games() -> table of all games in upper format (possible in async calls) -core.get_mapgen_names([include_hidden=false]) -> table of map generator algorithms - registered in the core (possible in async calls) +### Content and Packages + +Content - an installed mod, modpack, game, or texture pack (txt) +Package - content which is downloadable from the content db, may or may not be installed. + +* core.get_modpath() (possible in async calls) + * returns path to global modpath +* 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_game(index) + * returns: + + { + id = , + path = , + gamemods_path = , + name = , + menuicon_path = , + author = "author", + DEPRECATED: + addon_mods_paths = {[1] = ,}, + } + +* core.get_games() -> table of all games in upper format (possible in async calls) +* core.get_content_info(path) + * returns + + { + name = "name of content", + type = "mod" or "modpack" or "game" or "txp", + description = "description", + author = "author", + path = "path/to/content", + depends = {"mod", "names"}, -- mods only + optional_depends = {"mod", "names"}, -- mods only + } + Favorites: core.get_favorites(location) -> list of favorites (possible in async calls) @@ -172,11 +177,14 @@ core.log(loglevel, line) (possible in async calls) ^ loglevel one of "error", "action", "info", "verbose" Settings: -core.setting_set(name, value) -core.setting_get(name) -> string or nil (possible in async calls) -core.setting_setbool(name, value) -core.setting_getbool(name) -> bool or nil (possible in async calls) -core.setting_save() -> nil, save all settings to config file +core.settings:set(name, value) +core.settings:get(name) -> string or nil (possible in async calls) +core.settings:set_bool(name, value) +core.settings:get_bool(name) -> bool or nil (possible in async calls) +core.settings:save() -> nil, save all settings to config file + +For a complete list of methods of the Settings object see +[lua_api.txt](https://github.com/minetest/minetest/blob/master/doc/lua_api.txt) Worlds: core.get_worlds() -> list of worlds (possible in async calls) @@ -233,9 +241,4 @@ Limitations of Async operations -No access to global lua variables, don't even try -Limited set of available functions e.g. No access to functions modifying menu like core.start,core.close, - core.file_open_dialog - - -Class reference ----------------- -Settings: see lua_api.txt + core.show_path_select_dialog