doc/menu_lua_api.txt

   1 Minetest Lua Mainmenu API Reference 5.6.0
   2 =========================================
   3
   4 Introduction
   5 -------------
   6
   7 The main menu is defined as a formspec by Lua in builtin/mainmenu/
   8 Description of formspec language to show your menu is in lua_api.txt
   9
  10
  11 Callbacks
  12 ---------
  13
  14 core.button_handler(fields): called when a button is pressed.
  15 ^ fields = {name1 = value1, name2 = value2, ...}
  16 core.event_handler(event)
  17 ^ event: "MenuQuit", "KeyEnter", "ExitButton" or "EditBoxEnter"
  18
  19
  20 Gamedata
  21 --------
  22
  23 The "gamedata" table is read when calling core.start(). It should contain:
  24 {
  25     playername     = <name>,
  26     password       = <password>,
  27     address        = <IP/adress>,
  28     port           = <port>,
  29     selected_world = <index>, -- 0 for client mode
  30     singleplayer   = <true/false>,
  31 }
  32
  33
  34 Functions
  35 ---------
  36
  37 core.start()
  38 core.close()
  39 core.get_min_supp_proto()
  40 ^ returns the minimum supported network protocol version
  41 core.get_max_supp_proto()
  42 ^ returns the maximum supported network protocol version
  43 core.open_url(url)
  44 ^ opens the URL in a web browser, returns false on failure.
  45 ^ Must begin with http:// or https://
  46 core.open_dir(path)
  47 ^ opens the path in the system file browser/explorer, returns false on failure.
  48 ^ Must be an existing directory.
  49 core.get_version() (possible in async calls)
  50 ^ returns current core version
  51
  52
  53
  54 Filesystem
  55 ----------
  56
  57 core.get_builtin_path()
  58 ^ returns path to builtin root
  59 core.create_dir(absolute_path) (possible in async calls)
  60 ^ absolute_path to directory to create (needs to be absolute)
  61 ^ returns true/false
  62 core.delete_dir(absolute_path) (possible in async calls)
  63 ^ absolute_path to directory to delete (needs to be absolute)
  64 ^ returns true/false
  65 core.copy_dir(source,destination,keep_soure) (possible in async calls)
  66 ^ source folder
  67 ^ destination folder
  68 ^ keep_source DEFAULT true --> if set to false source is deleted after copying
  69 ^ returns true/false
  70 core.is_dir(path) (possible in async calls)
  71 ^ returns true if path is a valid dir
  72 core.extract_zip(zipfile,destination) [unzip within path required]
  73 ^ zipfile to extract
  74 ^ destination folder to extract to
  75 ^ returns true/false
  76 core.sound_play(spec, looped) -> handle
  77 ^ spec = SimpleSoundSpec (see lua-api.txt)
  78 ^ looped = bool
  79 core.sound_stop(handle)
  80 core.get_video_drivers()
  81 ^ get list of video drivers supported by engine (not all modes are guaranteed to work)
  82 ^ returns list of available video drivers' settings name and 'friendly' display name
  83 ^ e.g. { {name="opengl", friendly_name="OpenGL"}, {name="software", friendly_name="Software Renderer"} }
  84 ^ first element of returned list is guaranteed to be the NULL driver
  85 core.get_mapgen_names([include_hidden=false]) -> table of map generator algorithms
  86     registered in the core (possible in async calls)
  87 core.get_cache_path() -> path of cache
  88 core.get_temp_path([param]) (possible in async calls)
  89 ^ param=true: returns path to a temporary file
  90 ^ otherwise: returns path to the temporary folder
  91
  92
  93 HTTP Requests
  94 -------------
  95
  96 * core.download_file(url, target) (possible in async calls)
  97     * url to download, and target to store to
  98     * returns true/false
  99 * `minetest.get_http_api()` (possible in async calls)
 100     * returns `HTTPApiTable` containing http functions.
 101     * The returned table contains the functions `fetch_sync`, `fetch_async` and
 102       `fetch_async_get` described below.
 103     * Function only exists if minetest server was built with cURL support.
 104 * `HTTPApiTable.fetch_sync(HTTPRequest req)`: returns HTTPRequestResult
 105     * Performs given request synchronously
 106 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
 107     * Performs given request asynchronously and returns handle for
 108       `HTTPApiTable.fetch_async_get`
 109 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
 110     * Return response data for given asynchronous HTTP request
 111
 112 ### `HTTPRequest` definition
 113
 114 Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
 115
 116     {
 117         url = "http://example.org",
 118
 119         timeout = 10,
 120         -- Timeout for connection in seconds. Default is 3 seconds.
 121
 122         post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
 123         -- Optional, if specified a POST request with post_data is performed.
 124         -- Accepts both a string and a table. If a table is specified, encodes
 125         -- table as x-www-form-urlencoded key-value pairs.
 126         -- If post_data is not specified, a GET request is performed instead.
 127
 128         user_agent = "ExampleUserAgent",
 129         -- Optional, if specified replaces the default minetest user agent with
 130         -- given string
 131
 132         extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
 133         -- Optional, if specified adds additional headers to the HTTP request.
 134         -- You must make sure that the header strings follow HTTP specification
 135         -- ("Key: Value").
 136
 137         multipart = boolean
 138         -- Optional, if true performs a multipart HTTP request.
 139         -- Default is false.
 140     }
 141
 142 ### `HTTPRequestResult` definition
 143
 144 Passed to `HTTPApiTable.fetch` callback. Returned by
 145 `HTTPApiTable.fetch_async_get`.
 146
 147     {
 148         completed = true,
 149         -- If true, the request has finished (either succeeded, failed or timed
 150         -- out)
 151
 152         succeeded = true,
 153         -- If true, the request was successful
 154
 155         timeout = false,
 156         -- If true, the request timed out
 157
 158         code = 200,
 159         -- HTTP status code
 160
 161         data = "response"
 162     }
 163
 164
 165 Formspec
 166 --------
 167
 168 core.update_formspec(formspec)
 169 core.get_table_index(tablename) -> index
 170 ^ can also handle textlists
 171 core.formspec_escape(string) -> string
 172 ^ escapes characters [ ] \ , ; that can not be used in formspecs
 173 core.explode_table_event(string) -> table
 174 ^ returns e.g. {type="CHG", row=1, column=2}
 175 ^ type: "INV" (no row selected), "CHG" (selected) or "DCL" (double-click)
 176 core.explode_textlist_event(string) -> table
 177 ^ returns e.g. {type="CHG", index=1}
 178 ^ type: "INV" (no row selected), "CHG" (selected) or "DCL" (double-click)
 179 core.set_formspec_prepend(formspec)
 180 ^ string to be added to every mainmenu formspec, to be used for theming.
 181
 182
 183 GUI
 184 ---
 185
 186 core.set_background(type, texturepath,[tile],[minsize])
 187 ^ type: "background", "overlay", "header" or "footer"
 188 ^ tile: tile the image instead of scaling (background only)
 189 ^ minsize: minimum tile size, images are scaled to at least this size prior
 190 ^   doing tiling (background only)
 191 core.set_clouds(<true/false>)
 192 core.set_topleft_text(text)
 193 core.show_keys_menu()
 194 core.show_path_select_dialog(formname, caption, is_file_select)
 195 ^ shows a path select dialog
 196 ^ formname is base name of dialog response returned in fields
 197 ^     -if dialog was accepted "_accepted"
 198 ^        will be added to fieldname containing the path
 199 ^     -if dialog was canceled "_cancelled"
 200 ^        will be added to fieldname value is set to formname itself
 201 ^ if `is_file_select` is `true`, a file and not a folder will be selected
 202 ^ returns nil or selected file/folder
 203 core.get_screen_info()
 204 ^ returns {
 205     density         = <screen density 0.75,1.0,2.0,3.0 ... (dpi)>,
 206     display_width   = <width of display>,
 207     display_height  = <height of display>,
 208     window_width    = <current window width>,
 209     window_height   = <current window height>,
 210     render_info     = <active render information>
 211     }
 212
 213
 214 Content and Packages
 215 --------------------
 216
 217 Content - an installed mod, modpack, game, or texture pack (txt)
 218 Package - content which is downloadable from the content db, may or may not be installed.
 219
 220 * core.get_user_path() (possible in async calls)
 221     * returns path to global user data,
 222       the directory that contains user-provided mods, worlds, games, and texture packs.
 223 * core.get_modpath() (possible in async calls)
 224     * returns path to global modpath in the user path, where mods can be installed
 225 * core.get_modpaths() (possible in async calls)
 226     * returns table of virtual path to global modpaths, where mods have been installed
 227       The difference with "core.get_modpath" is that no mods should be installed in these
 228       directories by Minetest -- they might be read-only.
 229
 230       Ex:
 231
 232       ```
 233       {
 234           mods = "/home/user/.minetest/mods",
 235           share = "/usr/share/minetest/mods",
 236
 237           -- Custom dirs can be specified by the MINETEST_MOD_DIR env variable
 238           ["/path/to/custom/dir"] = "/path/to/custom/dir",
 239       }
 240       ```
 241
 242 * core.get_clientmodpath() (possible in async calls)
 243     * returns path to global client-side modpath
 244 * core.get_gamepath() (possible in async calls)
 245     * returns path to global gamepath
 246 * core.get_texturepath() (possible in async calls)
 247     * returns path to default textures
 248 * core.get_game(index)
 249     * `name` in return value is deprecated, use `title` instead.
 250     * returns:
 251
 252         {
 253             id               = <id>,
 254             path             = <full path to game>,
 255             gamemods_path    = <path>,
 256             title            = <title of game>,
 257             menuicon_path    = <full path to menuicon>,
 258             author           = "author",
 259             DEPRECATED:
 260             addon_mods_paths = {[1] = <path>,},
 261         }
 262
 263 * core.get_games() -> table of all games in upper format (possible in async calls)
 264 * core.get_content_info(path)
 265     * returns
 266
 267         {
 268             name             = "technical_id",
 269             type             = "mod" or "modpack" or "game" or "txp",
 270             title            = "Human readable title",
 271             description      = "description",
 272             author           = "author",
 273             path             = "path/to/content",
 274             depends          = {"mod", "names"}, -- mods only
 275             optional_depends = {"mod", "names"}, -- mods only
 276         }
 277
 278
 279 Logging
 280 -------
 281
 282 core.debug(line) (possible in async calls)
 283 ^ Always printed to stderr and logfile (print() is redirected here)
 284 core.log(line) (possible in async calls)
 285 core.log(loglevel, line) (possible in async calls)
 286 ^ loglevel one of "error", "action", "info", "verbose"
 287
 288
 289 Settings
 290 --------
 291
 292 core.settings:set(name, value)
 293 core.settings:get(name) -> string or nil (possible in async calls)
 294 core.settings:set_bool(name, value)
 295 core.settings:get_bool(name) -> bool or nil (possible in async calls)
 296 core.settings:save() -> nil, save all settings to config file
 297
 298 For a complete list of methods of the Settings object see
 299 [lua_api.txt](https://github.com/minetest/minetest/blob/master/doc/lua_api.txt)
 300
 301
 302 Worlds
 303 ------
 304
 305 core.get_worlds() -> list of worlds (possible in async calls)
 306 ^ returns {
 307     [1] = {
 308     path   = <full path to world>,
 309     name   = <name of world>,
 310     gameid = <gameid of world>,
 311     },
 312 }
 313 core.create_world(worldname, gameid)
 314 core.delete_world(index)
 315
 316
 317 Helpers
 318 -------
 319
 320 core.get_us_time()
 321 ^ returns time with microsecond precision
 322 core.gettext(string) -> string
 323 ^ look up the translation of a string in the gettext message catalog
 324 fgettext_ne(string, ...)
 325 ^ call core.gettext(string), replace "$1"..."$9" with the given
 326 ^ extra arguments and return the result
 327 fgettext(string, ...) -> string
 328 ^ same as fgettext_ne(), but calls core.formspec_escape before returning result
 329 core.parse_json(string[, nullvalue]) -> something (possible in async calls)
 330 ^ see core.parse_json (lua_api.txt)
 331 dump(obj, dumped={})
 332 ^ Return object serialized as a string
 333 string:split(separator)
 334 ^ eg. string:split("a,b", ",") == {"a","b"}
 335 string:trim()
 336 ^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
 337 core.is_yes(arg) (possible in async calls)
 338 ^ returns whether arg can be interpreted as yes
 339 minetest.encode_base64(string) (possible in async calls)
 340 ^ Encodes a string in base64.
 341 minetest.decode_base64(string) (possible in async calls)
 342 ^ Decodes a string encoded in base64.
 343
 344
 345 Async
 346 -----
 347
 348 core.handle_async(async_job,parameters,finished)
 349 ^ execute a function asynchronously
 350 ^ async_job is a function receiving one parameter and returning one parameter
 351 ^ parameters parameter table passed to async_job
 352 ^ finished function to be called once async_job has finished
 353 ^    the result of async_job is passed to this function
 354
 355 Limitations of Async operations
 356  -No access to global lua variables, don't even try
 357  -Limited set of available functions
 358     e.g. No access to functions modifying menu like core.start,core.close,
 359     core.show_path_select_dialog
 360
 361
 362 Background music
 363 ----------------
 364
 365 The main menu supports background music.
 366 It looks for a `main_menu` sound in `$USER_PATH/sounds`. The same naming
 367 conventions as for normal sounds apply.
 368 This means the player can add a custom sound.
 369 It will be played in the main menu (gain = 1.0), looped.