doc/client_lua_api.md

   1 Minetest Lua Client Modding API Reference 0.4.16
   2 ================================================
   3 * More information at <http://www.minetest.net/>
   4 * Developer Wiki: <http://dev.minetest.net/>
   5
   6 Introduction
   7 ------------
   8
   9 **WARNING: The client API is currently unstable, and may break/change without warning.**
  10
  11 Content and functionality can be added to Minetest 0.4.15-dev+ by using Lua
  12 scripting in run-time loaded mods.
  13
  14 A mod is a self-contained bunch of scripts, textures and other related
  15 things that is loaded by and interfaces with Minetest.
  16
  17 Transfering client-sided mods form the server to the client is planned, but not implemented yet.
  18
  19 If you see a deficiency in the API, feel free to attempt to add the
  20 functionality in the engine and API. You can send such improvements as
  21 source code patches on GitHub (https://github.com/minetest/minetest).
  22
  23 Programming in Lua
  24 ------------------
  25 If you have any difficulty in understanding this, please read
  26 [Programming in Lua](http://www.lua.org/pil/).
  27
  28 Startup
  29 -------
  30 Mods are loaded during client startup from the mod load paths by running
  31 the `init.lua` scripts in a shared environment.
  32
  33 Paths
  34 -----
  35 * `RUN_IN_PLACE=1` (Windows release, local build)
  36     *  `$path_user`:
  37         * Linux: `<build directory>`
  38         * Windows: `<build directory>`
  39     * `$path_share`
  40         * Linux: `<build directory>`
  41         * Windows:  `<build directory>`
  42 * `RUN_IN_PLACE=0`: (Linux release)
  43     * `$path_share`
  44         * Linux: `/usr/share/minetest`
  45         * Windows: `<install directory>/minetest-0.4.x`
  46     * `$path_user`:
  47         * Linux: `$HOME/.minetest`
  48         * Windows: `C:/users/<user>/AppData/minetest` (maybe)
  49
  50 Mod load path
  51 -------------
  52 Generic:
  53
  54 * `$path_share/clientmods/`
  55 * `$path_user/clientmods/` (User-installed mods)
  56
  57 In a run-in-place version (e.g. the distributed windows version):
  58
  59 * `minetest-0.4.x/clientmods/` (User-installed mods)
  60
  61 On an installed version on Linux:
  62
  63 * `/usr/share/minetest/clientmods/`
  64 * `$HOME/.minetest/clientmods/` (User-installed mods)
  65
  66 Modpack support
  67 ----------------
  68 **NOTE: Not implemented yet.**
  69
  70 Mods can be put in a subdirectory, if the parent directory, which otherwise
  71 should be a mod, contains a file named `modpack.txt`. This file shall be
  72 empty, except for lines starting with `#`, which are comments.
  73
  74 Mod directory structure
  75 ------------------------
  76
  77     clientmods
  78     ├── modname
  79     |   ├── depends.txt
  80     |   ├── init.lua
  81     └── another
  82
  83 ### modname
  84 The location of this directory.
  85
  86 ### depends.txt
  87 List of mods that have to be loaded before loading this mod.
  88
  89 A single line contains a single modname.
  90
  91 Optional dependencies can be defined by appending a question mark
  92 to a single modname. Their meaning is that if the specified mod
  93 is missing, that does not prevent this mod from being loaded.
  94
  95 ### init.lua
  96 The main Lua script. Running this script should register everything it
  97 wants to register. Subsequent execution depends on minetest calling the
  98 registered callbacks.
  99
 100 `minetest.setting_get(name)` and `minetest.setting_getbool(name)` can be used
 101 to read custom or existing settings at load time, if necessary.
 102
 103 ### `sounds`
 104 Media files (sounds) that will be transferred to the
 105 client and will be available for use by the mod.
 106
 107 Naming convention for registered textual names
 108 ----------------------------------------------
 109 Registered names should generally be in this format:
 110
 111     "modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
 112
 113 This is to prevent conflicting names from corrupting maps and is
 114 enforced by the mod loader.
 115
 116 ### Example
 117 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
 118 So the name should be `experimental:tnt`.
 119
 120 Enforcement can be overridden by prefixing the name with `:`. This can
 121 be used for overriding the registrations of some other mod.
 122
 123 Example: Any mod can redefine `experimental:tnt` by using the name
 124
 125     :experimental:tnt
 126
 127 when registering it.
 128 (also that mod is required to have `experimental` as a dependency)
 129
 130 The `:` prefix can also be used for maintaining backwards compatibility.
 131
 132 Sounds
 133 ------
 134 **NOTE: max_hear_distance and connecting to objects is not implemented.**
 135
 136 Only Ogg Vorbis files are supported.
 137
 138 For positional playing of sounds, only single-channel (mono) files are
 139 supported. Otherwise OpenAL will play them non-positionally.
 140
 141 Mods should generally prefix their sounds with `modname_`, e.g. given
 142 the mod name "`foomod`", a sound could be called:
 143
 144     foomod_foosound.ogg
 145
 146 Sounds are referred to by their name with a dot, a single digit and the
 147 file extension stripped out. When a sound is played, the actual sound file
 148 is chosen randomly from the matching sounds.
 149
 150 When playing the sound `foomod_foosound`, the sound is chosen randomly
 151 from the available ones of the following files:
 152
 153 * `foomod_foosound.ogg`
 154 * `foomod_foosound.0.ogg`
 155 * `foomod_foosound.1.ogg`
 156 * (...)
 157 * `foomod_foosound.9.ogg`
 158
 159 Examples of sound parameter tables:
 160
 161     -- Play locationless
 162     {
 163         gain = 1.0, -- default
 164     }
 165     -- Play locationless, looped
 166     {
 167         gain = 1.0, -- default
 168         loop = true,
 169     }
 170     -- Play in a location
 171     {
 172         pos = {x = 1, y = 2, z = 3},
 173         gain = 1.0, -- default
 174         max_hear_distance = 32, -- default, uses an euclidean metric
 175     }
 176     -- Play connected to an object, looped
 177     {
 178         object = <an ObjectRef>,
 179         gain = 1.0, -- default
 180         max_hear_distance = 32, -- default, uses an euclidean metric
 181         loop = true,
 182     }
 183
 184 Looped sounds must either be connected to an object or played locationless.
 185
 186 ### SimpleSoundSpec
 187 * e.g. `""`
 188 * e.g. `"default_place_node"`
 189 * e.g. `{}`
 190 * e.g. `{name = "default_place_node"}`
 191 * e.g. `{name = "default_place_node", gain = 1.0}`
 192
 193 Representations of simple things
 194 --------------------------------
 195
 196 ### Position/vector
 197
 198     {x=num, y=num, z=num}
 199
 200 For helper functions see "Vector helpers".
 201
 202 ### pointed_thing
 203 * `{type="nothing"}`
 204 * `{type="node", under=pos, above=pos}`
 205 * `{type="object", id=ObjectID}`
 206
 207 Flag Specifier Format
 208 ---------------------
 209 Flags using the standardized flag specifier format can be specified in either of
 210 two ways, by string or table.
 211
 212 The string format is a comma-delimited set of flag names; whitespace and
 213 unrecognized flag fields are ignored. Specifying a flag in the string sets the
 214 flag, and specifying a flag prefixed by the string `"no"` explicitly
 215 clears the flag from whatever the default may be.
 216
 217 In addition to the standard string flag format, the schematic flags field can
 218 also be a table of flag names to boolean values representing whether or not the
 219 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
 220 is present, mapped to a boolean of any value, the specified flag is unset.
 221
 222 E.g. A flag field of value
 223
 224     {place_center_x = true, place_center_y=false, place_center_z=true}
 225
 226 is equivalent to
 227
 228     {place_center_x = true, noplace_center_y=true, place_center_z=true}
 229
 230 which is equivalent to
 231
 232     "place_center_x, noplace_center_y, place_center_z"
 233
 234 or even
 235
 236     "place_center_x, place_center_z"
 237
 238 since, by default, no schematic attributes are set.
 239
 240 Formspec
 241 --------
 242 Formspec defines a menu. It is a string, with a somewhat strange format.
 243
 244 Spaces and newlines can be inserted between the blocks, as is used in the
 245 examples.
 246
 247 ### Examples
 248
 249 #### Chest
 250
 251     size[8,9]
 252     list[context;main;0,0;8,4;]
 253     list[current_player;main;0,5;8,4;]
 254
 255 #### Furnace
 256
 257     size[8,9]
 258     list[context;fuel;2,3;1,1;]
 259     list[context;src;2,1;1,1;]
 260     list[context;dst;5,1;2,2;]
 261     list[current_player;main;0,5;8,4;]
 262
 263 #### Minecraft-like player inventory
 264
 265     size[8,7.5]
 266     image[1,0.6;1,2;player.png]
 267     list[current_player;main;0,3.5;8,4;]
 268     list[current_player;craft;3,0;3,3;]
 269     list[current_player;craftpreview;7,1;1,1;]
 270
 271 ### Elements
 272
 273 #### `size[<W>,<H>,<fixed_size>]`
 274 * Define the size of the menu in inventory slots
 275 * `fixed_size`: `true`/`false` (optional)
 276 * deprecated: `invsize[<W>,<H>;]`
 277
 278 #### `container[<X>,<Y>]`
 279 * Start of a container block, moves all physical elements in the container by (X, Y)
 280 * Must have matching container_end
 281 * Containers can be nested, in which case the offsets are added
 282   (child containers are relative to parent containers)
 283
 284 #### `container_end[]`
 285 * End of a container, following elements are no longer relative to this container
 286
 287 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
 288 * Show an inventory list
 289
 290 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
 291 * Show an inventory list
 292
 293 #### `listring[<inventory location>;<list name>]`
 294 * Allows to create a ring of inventory lists
 295 * Shift-clicking on items in one element of the ring
 296   will send them to the next inventory list inside the ring
 297 * The first occurrence of an element inside the ring will
 298   determine the inventory where items will be sent to
 299
 300 #### `listring[]`
 301 * Shorthand for doing `listring[<inventory location>;<list name>]`
 302   for the last two inventory lists added by list[...]
 303
 304 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
 305 * Sets background color of slots as `ColorString`
 306 * Sets background color of slots on mouse hovering
 307
 308 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
 309 * Sets background color of slots as `ColorString`
 310 * Sets background color of slots on mouse hovering
 311 * Sets color of slots border
 312
 313 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
 314 * Sets background color of slots as `ColorString`
 315 * Sets background color of slots on mouse hovering
 316 * Sets color of slots border
 317 * Sets default background color of tooltips
 318 * Sets default font color of tooltips
 319
 320 #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>,<fontcolor>]`
 321 * Adds tooltip for an element
 322 * `<bgcolor>` tooltip background color as `ColorString` (optional)
 323 * `<fontcolor>` tooltip font color as `ColorString` (optional)
 324
 325 #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
 326 * Show an image
 327 * Position and size units are inventory slots
 328
 329 #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
 330 * Show an inventory image of registered item/node
 331 * Position and size units are inventory slots
 332
 333 #### `bgcolor[<color>;<fullscreen>]`
 334 * Sets background color of formspec as `ColorString`
 335 * If `true`, the background color is drawn fullscreen (does not effect the size of the formspec)
 336
 337 #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
 338 * Use a background. Inventory rectangles are not drawn then.
 339 * Position and size units are inventory slots
 340 * Example for formspec 8x4 in 16x resolution: image shall be sized
 341   8 times 16px  times  4 times 16px.
 342
 343 #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
 344 * Use a background. Inventory rectangles are not drawn then.
 345 * Position and size units are inventory slots
 346 * Example for formspec 8x4 in 16x resolution:
 347   image shall be sized 8 times 16px  times  4 times 16px
 348 * If `true` the background is clipped to formspec size
 349   (`x` and `y` are used as offset values, `w` and `h` are ignored)
 350
 351 #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
 352 * Textual password style field; will be sent to server when a button is clicked
 353 * When enter is pressed in field, fields.key_enter_field will be sent with the name
 354   of this field.
 355 * `x` and `y` position the field relative to the top left of the menu
 356 * `w` and `h` are the size of the field
 357 * Fields are a set height, but will be vertically centred on `h`
 358 * Position and size units are inventory slots
 359 * `name` is the name of the field as returned in fields to `on_receive_fields`
 360 * `label`, if not blank, will be text printed on the top left above the field
 361 * See field_close_on_enter to stop enter closing the formspec
 362
 363 #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
 364 * Textual field; will be sent to server when a button is clicked
 365 * When enter is pressed in field, fields.key_enter_field will be sent with the name
 366   of this field.
 367 * `x` and `y` position the field relative to the top left of the menu
 368 * `w` and `h` are the size of the field
 369 * Fields are a set height, but will be vertically centred on `h`
 370 * Position and size units are inventory slots
 371 * `name` is the name of the field as returned in fields to `on_receive_fields`
 372 * `label`, if not blank, will be text printed on the top left above the field
 373 * `default` is the default value of the field
 374     * `default` may contain variable references such as `${text}'` which
 375       will fill the value from the metadata value `text`
 376     * **Note**: no extra text or more than a single variable is supported ATM.
 377 * See field_close_on_enter to stop enter closing the formspec
 378
 379 #### `field[<name>;<label>;<default>]`
 380 * As above, but without position/size units
 381 * When enter is pressed in field, fields.key_enter_field will be sent with the name
 382   of this field.
 383 * Special field for creating simple forms, such as sign text input
 384 * Must be used without a `size[]` element
 385 * A "Proceed" button will be added automatically
 386 * See field_close_on_enter to stop enter closing the formspec
 387
 388 #### `field_close_on_enter[<name>;<close_on_enter>]`
 389 * <name> is the name of the field
 390 * if <close_on_enter> is false, pressing enter in the field will submit the form but not close it
 391 * defaults to true when not specified (ie: no tag for a field)
 392
 393 #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
 394 * Same as fields above, but with multi-line input
 395
 396 #### `label[<X>,<Y>;<label>]`
 397 * `x` and `y` work as per field
 398 * `label` is the text on the label
 399 * Position and size units are inventory slots
 400
 401 #### `vertlabel[<X>,<Y>;<label>]`
 402 * Textual label drawn vertically
 403 * `x` and `y` work as per field
 404 * `label` is the text on the label
 405 * Position and size units are inventory slots
 406
 407 #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
 408 * Clickable button. When clicked, fields will be sent.
 409 * `x`, `y` and `name` work as per field
 410 * `w` and `h` are the size of the button
 411 * `label` is the text on the button
 412 * Position and size units are inventory slots
 413
 414 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
 415 * `x`, `y`, `w`, `h`, and `name` work as per button
 416 * `texture name` is the filename of an image
 417 * Position and size units are inventory slots
 418
 419 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
 420 * `x`, `y`, `w`, `h`, and `name` work as per button
 421 * `texture name` is the filename of an image
 422 * Position and size units are inventory slots
 423 * `noclip=true` means the image button doesn't need to be within specified formsize
 424 * `drawborder`: draw button border or not
 425 * `pressed texture name` is the filename of an image on pressed state
 426
 427 #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
 428 * `x`, `y`, `w`, `h`, `name` and `label` work as per button
 429 * `item name` is the registered name of an item/node,
 430    tooltip will be made out of its description
 431    to override it use tooltip element
 432 * Position and size units are inventory slots
 433
 434 #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
 435 * When clicked, fields will be sent and the form will quit.
 436
 437 #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
 438 * When clicked, fields will be sent and the form will quit.
 439
 440 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
 441 * Scrollable item list showing arbitrary text elements
 442 * `x` and `y` position the itemlist relative to the top left of the menu
 443 * `w` and `h` are the size of the itemlist
 444 * `name` fieldname sent to server on doubleclick value is current selected element
 445 * `listelements` can be prepended by #color in hexadecimal format RRGGBB (only),
 446      * if you want a listelement to start with "#" write "##".
 447
 448 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
 449 * Scrollable itemlist showing arbitrary text elements
 450 * `x` and `y` position the item list relative to the top left of the menu
 451 * `w` and `h` are the size of the item list
 452 * `name` fieldname sent to server on doubleclick value is current selected element
 453 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
 454      * if you want a listelement to start with "#" write "##"
 455 * Index to be selected within textlist
 456 * `true`/`false`: draw transparent background
 457 * See also `minetest.explode_textlist_event` (main menu: `engine.explode_textlist_event`)
 458
 459 #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
 460 * Show a tab**header** at specific position (ignores formsize)
 461 * `x` and `y` position the itemlist relative to the top left of the menu
 462 * `name` fieldname data is transferred to Lua
 463 * `caption 1`...: name shown on top of tab
 464 * `current_tab`: index of selected tab 1...
 465 * `transparent` (optional): show transparent
 466 * `draw_border` (optional): draw border
 467
 468 #### `box[<X>,<Y>;<W>,<H>;<color>]`
 469 * Simple colored semitransparent box
 470 * `x` and `y` position the box relative to the top left of the menu
 471 * `w` and `h` are the size of box
 472 * `color` is color specified as a `ColorString`
 473
 474 #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
 475 * Show a dropdown field
 476 * **Important note**: There are two different operation modes:
 477      1. handle directly on change (only changed dropdown is submitted)
 478      2. read the value on pressing a button (all dropdown values are available)
 479 * `x` and `y` position of dropdown
 480 * Width of dropdown
 481 * Fieldname data is transferred to Lua
 482 * Items to be shown in dropdown
 483 * Index of currently selected dropdown item
 484
 485 #### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
 486 * Show a checkbox
 487 * `x` and `y`: position of checkbox
 488 * `name` fieldname data is transferred to Lua
 489 * `label` to be shown left of checkbox
 490 * `selected` (optional): `true`/`false`
 491
 492 #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
 493 * Show a scrollbar
 494 * There are two ways to use it:
 495      1. handle the changed event (only changed scrollbar is available)
 496      2. read the value on pressing a button (all scrollbars are available)
 497 * `x` and `y`: position of trackbar
 498 * `w` and `h`: width and height
 499 * `orientation`:  `vertical`/`horizontal`
 500 * Fieldname data is transferred to Lua
 501 * Value this trackbar is set to (`0`-`1000`)
 502 * See also `minetest.explode_scrollbar_event` (main menu: `engine.explode_scrollbar_event`)
 503
 504 #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
 505 * Show scrollable table using options defined by the previous `tableoptions[]`
 506 * Displays cells as defined by the previous `tablecolumns[]`
 507 * `x` and `y`: position the itemlist relative to the top left of the menu
 508 * `w` and `h` are the size of the itemlist
 509 * `name`: fieldname sent to server on row select or doubleclick
 510 * `cell 1`...`cell n`: cell contents given in row-major order
 511 * `selected idx`: index of row to be selected within table (first row = `1`)
 512 * See also `minetest.explode_table_event` (main menu: `engine.explode_table_event`)
 513
 514 #### `tableoptions[<opt 1>;<opt 2>;...]`
 515 * Sets options for `table[]`
 516 * `color=#RRGGBB`
 517      * default text color (`ColorString`), defaults to `#FFFFFF`
 518 * `background=#RRGGBB`
 519      * table background color (`ColorString`), defaults to `#000000`
 520 * `border=<true/false>`
 521      * should the table be drawn with a border? (default: `true`)
 522 * `highlight=#RRGGBB`
 523      * highlight background color (`ColorString`), defaults to `#466432`
 524 * `highlight_text=#RRGGBB`
 525      * highlight text color (`ColorString`), defaults to `#FFFFFF`
 526 * `opendepth=<value>`
 527      * all subtrees up to `depth < value` are open (default value = `0`)
 528      * only useful when there is a column of type "tree"
 529
 530 #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
 531 * Sets columns for `table[]`
 532 * Types: `text`, `image`, `color`, `indent`, `tree`
 533     * `text`:   show cell contents as text
 534     * `image`:  cell contents are an image index, use column options to define images
 535     * `color`:   cell contents are a ColorString and define color of following cell
 536     * `indent`: cell contents are a number and define indentation of following cell
 537     * `tree`:   same as indent, but user can open and close subtrees (treeview-like)
 538 * Column options:
 539     * `align=<value>`
 540         * for `text` and `image`: content alignment within cells.
 541           Available values: `left` (default), `center`, `right`, `inline`
 542     * `width=<value>`
 543         * for `text` and `image`: minimum width in em (default: `0`)
 544         * for `indent` and `tree`: indent width in em (default: `1.5`)
 545     * `padding=<value>`: padding left of the column, in em (default `0.5`).
 546       Exception: defaults to 0 for indent columns
 547     * `tooltip=<value>`: tooltip text (default: empty)
 548     * `image` column options:
 549         * `0=<value>` sets image for image index 0
 550         * `1=<value>` sets image for image index 1
 551         * `2=<value>` sets image for image index 2
 552         * and so on; defined indices need not be contiguous empty or
 553           non-numeric cells are treated as `0`.
 554     * `color` column options:
 555         * `span=<value>`: number of following columns to affect (default: infinite)
 556
 557 **Note**: do _not_ use a element name starting with `key_`; those names are reserved to
 558 pass key press events to formspec!
 559
 560 Spatial Vectors
 561 ---------------
 562 * `vector.new(a[, b, c])`: returns a vector:
 563     * A copy of `a` if `a` is a vector.
 564     * `{x = a, y = b, z = c}`, if all `a, b, c` are defined
 565 * `vector.direction(p1, p2)`: returns a vector
 566 * `vector.distance(p1, p2)`: returns a number
 567 * `vector.length(v)`: returns a number
 568 * `vector.normalize(v)`: returns a vector
 569 * `vector.floor(v)`: returns a vector, each dimension rounded down
 570 * `vector.round(v)`: returns a vector, each dimension rounded to nearest int
 571 * `vector.apply(v, func)`: returns a vector
 572 * `vector.equals(v1, v2)`: returns a boolean
 573
 574 For the following functions `x` can be either a vector or a number:
 575
 576 * `vector.add(v, x)`: returns a vector
 577 * `vector.subtract(v, x)`: returns a vector
 578 * `vector.multiply(v, x)`: returns a scaled vector or Schur product
 579 * `vector.divide(v, x)`: returns a scaled vector or Schur quotient
 580
 581 Helper functions
 582 ----------------
 583 * `dump2(obj, name="_", dumped={})`
 584      * Return object serialized as a string, handles reference loops
 585 * `dump(obj, dumped={})`
 586     * Return object serialized as a string
 587 * `math.hypot(x, y)`
 588     * Get the hypotenuse of a triangle with legs x and y.
 589       Useful for distance calculation.
 590 * `math.sign(x, tolerance)`
 591     * Get the sign of a number.
 592       Optional: Also returns `0` when the absolute value is within the tolerance (default: `0`)
 593 * `string.split(str, separator=",", include_empty=false, max_splits=-1, sep_is_pattern=false)`
 594     * If `max_splits` is negative, do not limit splits.
 595     * `sep_is_pattern` specifies if separator is a plain string or a pattern (regex).
 596     * e.g. `string:split("a,b", ",") == {"a","b"}`
 597 * `string:trim()`
 598     * e.g. `string.trim("\n \t\tfoo bar\t ") == "foo bar"`
 599 * `minetest.wrap_text(str, limit)`: returns a string
 600     * Adds new lines to the string to keep it within the specified character limit
 601     * limit: Maximal amount of characters in one line
 602 * `minetest.pos_to_string({x=X,y=Y,z=Z}, decimal_places))`: returns string `"(X,Y,Z)"`
 603     * Convert position to a printable string
 604       Optional: 'decimal_places' will round the x, y and z of the pos to the given decimal place.
 605 * `minetest.string_to_pos(string)`: returns a position
 606     * Same but in reverse. Returns `nil` if the string can't be parsed to a position.
 607 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
 608     * Converts a string representing an area box into two positions
 609 * `minetest.is_yes(arg)`
 610     * returns whether `arg` can be interpreted as yes
 611 * `table.copy(table)`: returns a table
 612     * returns a deep copy of `table`
 613
 614 Minetest namespace reference
 615 ------------------------------
 616
 617 ### Utilities
 618
 619 * `minetest.get_current_modname()`: returns the currently loading mod's name, when we are loading a mod
 620 * `minetest.get_version()`: returns a table containing components of the
 621    engine version.  Components:
 622     * `project`: Name of the project, eg, "Minetest"
 623     * `string`: Simple version, eg, "1.2.3-dev"
 624     * `hash`: Full git version (only set if available), eg, "1.2.3-dev-01234567-dirty"
 625   Use this for informational purposes only. The information in the returned
 626   table does not represent the capabilities of the engine, nor is it
 627   reliable or verifyable. Compatible forks will have a different name and
 628   version entirely. To check for the presence of engine features, test
 629   whether the functions exported by the wanted features exist. For example:
 630   `if minetest.nodeupdate then ... end`.
 631
 632 ### Logging
 633 * `minetest.debug(...)`
 634     * Equivalent to `minetest.log(table.concat({...}, "\t"))`
 635 * `minetest.log([level,] text)`
 636     * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
 637       `"info"`, or `"verbose"`.  Default is `"none"`.
 638
 639 ### Global callback registration functions
 640 Call these functions only at load time!
 641
 642 * `minetest.register_globalstep(func(dtime))`
 643     * Called every client environment step, usually interval of 0.1s
 644 * `minetest.register_on_shutdown(func())`
 645     * Called before client shutdown
 646     * **Warning**: If the client terminates abnormally (i.e. crashes), the registered
 647       callbacks **will likely not be run**. Data should be saved at
 648       semi-frequent intervals as well as on server shutdown.
 649 * `minetest.register_on_connect(func())`
 650     * Called at the end of client connection (when player is loaded onto map)
 651 * `minetest.register_on_receiving_chat_message(func(message))`
 652     * Called always when a client receive a message
 653     * Return `true` to mark the message as handled, which means that it will not be shown to chat
 654 * `minetest.register_on_sending_chat_message(func(message))`
 655     * Called always when a client send a message from chat
 656     * Return `true` to mark the message as handled, which means that it will not be sent to server
 657 * `minetest.register_chatcommand(cmd, chatcommand definition)`
 658     * Adds definition to minetest.registered_chatcommands
 659 * `minetest.unregister_chatcommand(name)`
 660     * Unregisters a chatcommands registered with register_chatcommand.
 661 * `minetest.register_on_death(func())`
 662     * Called when the local player dies
 663 * `minetest.register_on_hp_modification(func(hp))`
 664     * Called when server modified player's HP
 665 * `minetest.register_on_damage_taken(func(hp))`
 666     * Called when the local player take damages
 667 * `minetest.register_on_formspec_input(func(formname, fields))`
 668     * Called when a button is pressed in the local player's inventory form
 669     * Newest functions are called first
 670     * If function returns `true`, remaining functions are not called
 671 * `minetest.register_on_dignode(func(pos, node))`
 672     * Called when the local player digs a node
 673     * Newest functions are called first
 674     * If any function returns true, the node isn't dug
 675 * `minetest.register_on_punchnode(func(pos, node))`
 676     * Called when the local player punches a node
 677     * Newest functions are called first
 678     * If any function returns true, the punch is ignored
 679 * `minetest.register_on_placenode(function(pointed_thing, node))`
 680     * Called when a node has been placed
 681 * `minetest.register_on_item_use(func(item, pointed_thing))`
 682     * Called when the local player uses an item.
 683     * Newest functions are called first.
 684     * If any function returns true, the item use is not sent to server.
 685 ### Sounds
 686 * `minetest.sound_play(spec, parameters)`: returns a handle
 687     * `spec` is a `SimpleSoundSpec`
 688     * `parameters` is a sound parameter table
 689 * `minetest.sound_stop(handle)`
 690
 691 ### Timing
 692 * `minetest.after(time, func, ...)`
 693     * Call the function `func` after `time` seconds, may be fractional
 694     * Optional: Variable number of arguments that are passed to `func`
 695 * `minetest.get_us_time()`
 696     * Returns time with microsecond precision. May not return wall time.
 697 * `minetest.get_day_count()`
 698     * Returns number days elapsed since world was created, accounting for time changes.
 699 * `minetest.get_timeofday()`
 700     * Returns the time of day: `0` for midnight, `0.5` for midday
 701
 702 ### Map
 703 * `minetest.get_node(pos)`
 704     * Returns the node at the given position as table in the format
 705       `{name="node_name", param1=0, param2=0}`, returns `{name="ignore", param1=0, param2=0}`
 706       for unloaded areas.
 707 * `minetest.get_node_or_nil(pos)`
 708     * Same as `get_node` but returns `nil` for unloaded areas.
 709 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns pos or `nil`
 710     * `radius`: using a maximum metric
 711     * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
 712     * `search_center` is an optional boolean (default: `false`)
 713       If true `pos` is also checked for the nodes
 714 * `minetest.get_meta(pos)`
 715     * Get a `NodeMetaRef` at that position
 716 * `minetest.get_node_level(pos)`
 717     * get level of leveled node (water, snow)
 718 * `minetest.get_node_max_level(pos)`
 719     * get max available level for leveled node
 720
 721 ### Player
 722 * `minetest.get_wielded_item()`
 723     * Returns the itemstack the local player is holding
 724 * `minetest.send_chat_message(message)`
 725     * Act as if `message` was typed by the player into the terminal.
 726 * `minetest.run_server_chatcommand(cmd, param)`
 727     * Alias for `minetest.send_chat_message("/" .. cmd .. " " .. param)`
 728 * `minetest.clear_out_chat_queue()`
 729     * Clears the out chat queue
 730 * `minetest.localplayer`
 731     * Reference to the LocalPlayer object. See [`LocalPlayer`](#localplayer) class reference for methods.
 732
 733 ### Privileges
 734 * `minetest.get_privilege_list()`
 735     * Returns a list of privileges the currect player has in the format `{priv1=true,...}`
 736 * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
 737 * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
 738     * Convert between two privilege representations
 739
 740 ### Client Environment
 741 * `minetest.get_player_names()`
 742     * Returns list of player names on server
 743 * `minetest.disconnect()`
 744     * Disconnect from the server and exit to main menu.
 745     * Returns `false` if the client is already disconnecting otherwise returns `true`.
 746 * `minetest.take_screenshot()`
 747     * Take a screenshot.
 748 * `minetest.get_server_info()`
 749     * Returns [server info](#server-info).
 750 * `minetest.send_respawn()`
 751     * Sends a respawn request to the server.
 752
 753 ### Storage API
 754 * `minetest.get_mod_storage()`:
 755     * returns reference to mod private `StorageRef`
 756     * must be called during mod load time
 757
 758 ### Misc.
 759 * `minetest.parse_json(string[, nullvalue])`: returns something
 760     * Convert a string containing JSON data into the Lua equivalent
 761     * `nullvalue`: returned in place of the JSON null; defaults to `nil`
 762     * On success returns a table, a string, a number, a boolean or `nullvalue`
 763     * On failure outputs an error message and returns `nil`
 764     * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
 765 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
 766     * Convert a Lua table into a JSON string
 767     * styled: Outputs in a human-readable format if this is set, defaults to false
 768     * Unserializable things like functions and userdata are saved as null.
 769     * **Warning**: JSON is more strict than the Lua table format.
 770         1. You can only use strings and positive integers of at least one as keys.
 771         2. You can not mix string and integer keys.
 772            This is due to the fact that JSON has two distinct array and object values.
 773     * Example: `write_json({10, {a = false}})`, returns `"[10, {\"a\": false}]"`
 774 * `minetest.serialize(table)`: returns a string
 775     * Convert a table containing tables, strings, numbers, booleans and `nil`s
 776       into string form readable by `minetest.deserialize`
 777     * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
 778 * `minetest.deserialize(string)`: returns a table
 779     * Convert a string returned by `minetest.deserialize` into a table
 780     * `string` is loaded in an empty sandbox environment.
 781     * Will load functions, but they cannot access the global environment.
 782     * Example: `deserialize('return { ["foo"] = "bar" }')`, returns `{foo='bar'}`
 783     * Example: `deserialize('print("foo")')`, returns `nil` (function call fails)
 784         * `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
 785 * `minetest.compress(data, method, ...)`: returns `compressed_data`
 786     * Compress a string of data.
 787     * `method` is a string identifying the compression method to be used.
 788     * Supported compression methods:
 789     *     Deflate (zlib): `"deflate"`
 790     * `...` indicates method-specific arguments.  Currently defined arguments are:
 791     *     Deflate: `level` - Compression level, `0`-`9` or `nil`.
 792 * `minetest.decompress(compressed_data, method, ...)`: returns data
 793     * Decompress a string of data (using ZLib).
 794     * See documentation on `minetest.compress()` for supported compression methods.
 795     * currently supported.
 796     * `...` indicates method-specific arguments. Currently, no methods use this.
 797 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
 798     * Each argument is a 8 Bit unsigned integer
 799     * Returns the ColorString from rgb or rgba values
 800     * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
 801 * `minetest.encode_base64(string)`: returns string encoded in base64
 802     * Encodes a string in base64.
 803 * `minetest.decode_base64(string)`: returns string
 804     * Decodes a string encoded in base64.
 805 * `minetest.gettext(string)` : returns string
 806     * look up the translation of a string in the gettext message catalog
 807 * `fgettext_ne(string, ...)`
 808     * call minetest.gettext(string), replace "$1"..."$9" with the given
 809       extra arguments and return the result
 810 * `fgettext(string, ...)` : returns string
 811     * same as fgettext_ne(), but calls minetest.formspec_escape before returning result
 812 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a position
 813     * returns the exact position on the surface of a pointed node
 814 * `minetest.global_exists(name)`
 815     * Checks if a global variable has been set, without triggering a warning.
 816
 817 ### UI
 818 * `minetest.ui.minimap`
 819     * Reference to the minimap object. See [`Minimap`](#minimap) class reference for methods.
 820     * If client disabled minimap (using enable_minimap setting) this reference will be nil.
 821 * `minetest.camera`
 822     * Reference to the camera object. See [`Camera`](#camera) class reference for methods.
 823 * `minetest.show_formspec(formname, formspec)` : returns true on success
 824         * Shows a formspec to the player
 825 * `minetest.display_chat_message(message)` returns true on success
 826         * Shows a chat message to the current player.
 827
 828 Class reference
 829 ---------------
 830
 831 ### Minimap
 832 An interface to manipulate minimap on client UI
 833
 834 * `show()`: shows the minimap (if not disabled by server)
 835 * `hide()`: hides the minimap
 836 * `set_pos(pos)`: sets the minimap position on screen
 837 * `get_pos()`: returns the minimap current position
 838 * `set_angle(deg)`: sets the minimap angle in degrees
 839 * `get_angle()`: returns the current minimap angle in degrees
 840 * `set_mode(mode)`: sets the minimap mode (0 to 6)
 841 * `get_mode()`: returns the current minimap mode
 842 * `set_shape(shape)`: Sets the minimap shape. (0 = square, 1 = round)
 843 * `get_shape()`: Gets the minimap shape. (0 = square, 1 = round)
 844
 845 ### Camera
 846 An interface to get or set information about the camera and cameranode.
 847 Please do not try to access the reference until the camera is initialized, otherwise the reference will be nil.
 848
 849 #### Methods
 850 * `set_camera_mode(mode)`
 851     * Pass `0` for first-person, `1` for third person, and `2` for third person front
 852 * `get_camera_mode()`
 853     * Returns with same syntax as above
 854 * `get_fov()`
 855     * Returns:
 856
 857 ```lua
 858      {
 859          x = number,
 860          y = number,
 861          max = number,
 862          actual = number
 863      }
 864 ```
 865
 866 * `get_pos()`
 867     * Returns position of camera with view bobbing
 868 * `get_offset()`
 869     * Returns eye offset vector
 870 * `get_look_dir()`
 871     * Returns eye direction unit vector
 872 * `get_look_vertical()`
 873     * Returns pitch in radians
 874 * `get_look_horizontal()`
 875     * Returns yaw in radians
 876 * `get_aspect_ratio()`
 877     * Returns aspect ratio of screen
 878
 879 ### LocalPlayer
 880 An interface to retrieve information about the player. The player is
 881 not accessible until the client is fully done loading and therefore
 882 not at module init time.
 883
 884 To get the localplayer handle correctly, use `on_connect()` as follows:
 885
 886 ```lua
 887 local localplayer
 888 minetest.register_on_connect(function()
 889         localplayer = minetest.localplayer
 890 end)
 891 ```
 892
 893 Methods:
 894
 895 * `get_pos()`
 896     * returns current player current position
 897 * `get_velocity()`
 898     * returns player speed vector
 899 * `get_hp()`
 900     * returns player HP
 901 * `get_name()`
 902     * returns player name
 903 * `is_attached()`
 904     * returns true if player is attached
 905 * `is_touching_ground()`
 906     * returns true if player touching ground
 907 * `is_in_liquid()`
 908     * returns true if player is in a liquid (This oscillates so that the player jumps a bit above the surface)
 909 * `is_in_liquid_stable()`
 910     * returns true if player is in a stable liquid (This is more stable and defines the maximum speed of the player)
 911 * `get_liquid_viscosity()`
 912     * returns liquid viscosity (Gets the viscosity of liquid to calculate friction)
 913 * `is_climbing()`
 914     * returns true if player is climbing
 915 * `swimming_vertical()`
 916     * returns true if player is swimming in vertical
 917 * `get_physics_override()`
 918     * returns:
 919
 920 ```lua
 921     {
 922         speed = float,
 923         jump = float,
 924         gravity = float,
 925         sneak = boolean,
 926         sneak_glitch = boolean
 927     }
 928 ```
 929
 930 * `get_override_pos()`
 931     * returns override position
 932 * `get_last_pos()`
 933     * returns last player position before the current client step
 934 * `get_last_velocity()`
 935     * returns last player speed
 936 * `get_breath()`
 937     * returns the player's breath
 938 * `get_movement_acceleration()`
 939     * returns acceleration of the player in different environments:
 940
 941 ```lua
 942     {
 943        fast = float,
 944        air = float,
 945        default = float,
 946     }
 947 ```
 948
 949 * `get_movement_speed()`
 950     * returns player's speed in different environments:
 951
 952 ```lua
 953     {
 954        walk = float,
 955        jump = float,
 956        crouch = float,
 957        fast = float,
 958        climb = float,
 959     }
 960 ```
 961
 962 * `get_movement()`
 963     * returns player's movement in different environments:
 964
 965 ```lua
 966     {
 967        liquid_fluidity = float,
 968        liquid_sink = float,
 969        liquid_fluidity_smooth = float,
 970        gravity = float,
 971     }
 972 ```
 973
 974 * `get_last_look_horizontal()`:
 975     * returns last look horizontal angle
 976 * `get_last_look_vertical()`:
 977     * returns last look vertical angle
 978 * `get_key_pressed()`:
 979     * returns last key typed by the player
 980
 981 ### Settings
 982 An interface to read config files in the format of `minetest.conf`.
 983
 984 It can be created via `Settings(filename)`.
 985
 986 #### Methods
 987 * `get(key)`: returns a value
 988 * `get_bool(key)`: returns a boolean
 989 * `set(key, value)`
 990 * `remove(key)`: returns a boolean (`true` for success)
 991 * `get_names()`: returns `{key1,...}`
 992 * `write()`: returns a boolean (`true` for success)
 993     * write changes to file
 994 * `to_table()`: returns `{[key1]=value1,...}`
 995
 996 ### NodeMetaRef
 997 Node metadata: reference extra data and functionality stored in a node.
 998 Can be obtained via `minetest.get_meta(pos)`.
 999
1000 #### Methods
1001 * `get_string(name)`
1002 * `get_int(name)`
1003 * `get_float(name)`
1004 * `to_table()`: returns `nil` or a table with keys:
1005     * `fields`: key-value storage
1006     * `inventory`: `{list1 = {}, ...}}`
1007
1008 -----------------
1009 ### Definitions
1010 * `minetest.get_node_def(nodename)`
1011         * Returns [node definition](#node-definition) table of `nodename`
1012 * `minetest.get_item_def(itemstring)`
1013         * Returns item definition table of `itemstring`
1014
1015 #### Node Definition
1016
1017 ```lua
1018         {
1019                 has_on_construct = bool,        -- Whether the node has the on_construct callback defined
1020                 has_on_destruct = bool,         -- Whether the node has the on_destruct callback defined
1021                 has_after_destruct = bool,      -- Whether the node has the after_destruct callback defined
1022                 name = string,                  -- The name of the node e.g. "air", "default:dirt"
1023                 groups = table,                 -- The groups of the node
1024                 paramtype = string,             -- Paramtype of the node
1025                 paramtype2 = string,            -- ParamType2 of the node
1026                 drawtype = string,              -- Drawtype of the node
1027                 mesh = <string>,                -- Mesh name if existant
1028                 minimap_color = <Color>,        -- Color of node on minimap *May not exist*
1029                 visual_scale = number,          -- Visual scale of node
1030                 alpha = number,                 -- Alpha of the node. Only used for liquids
1031                 color = <Color>,                -- Color of node *May not exist*
1032                 palette_name = <string>,        -- Filename of palette *May not exist*
1033                 palette = <{                    -- List of colors
1034                         Color,
1035                         Color
1036                 }>,
1037                 waving = number,                -- 0 of not waving, 1 if waving
1038                 connect_sides = number,         -- Used for connected nodes
1039                 connects_to = {                 -- List of nodes to connect to
1040                         "node1",
1041                         "node2"
1042                 },
1043                 post_effect_color = Color,      -- Color overlayed on the screen when the player is in the node
1044                 leveled = number,               -- Max level for node
1045                 sunlight_propogates = bool,     -- Whether light passes through the block
1046                 light_source = number,          -- Light emitted by the block
1047                 is_ground_content = bool,       -- Whether caves should cut through the node
1048                 walkable = bool,                -- Whether the player collides with the node
1049                 pointable = bool,               -- Whether the player can select the node
1050                 diggable = bool,                -- Whether the player can dig the node
1051                 climbable = bool,               -- Whether the player can climb up the node
1052                 buildable_to = bool,            -- Whether the player can replace the node by placing a node on it
1053                 rightclickable = bool,          -- Whether the player can place nodes pointing at this node
1054                 damage_per_second = number,     -- HP of damage per second when the player is in the node
1055                 liquid_type = <string>,         -- A string containing "none", "flowing", or "source" *May not exist*
1056                 liquid_alternative_flowing = <string>, -- Alternative node for liquid *May not exist*
1057                 liquid_alternative_source = <string>, -- Alternative node for liquid *May not exist*
1058                 liquid_viscosity = <number>,    -- How fast the liquid flows *May not exist*
1059                 liquid_renewable = <boolean>,   -- Whether the liquid makes an infinite source *May not exist*
1060                 liquid_range = <number>,        -- How far the liquid flows *May not exist*
1061                 drowning = bool,                -- Whether the player will drown in the node
1062                 floodable = bool,               -- Whether nodes will be replaced by liquids (flooded)
1063                 node_box = table,               -- Nodebox to draw the node with
1064                 collision_box = table,          -- Nodebox to set the collision area
1065                 selection_box = table,          -- Nodebox to set the area selected by the player
1066                 sounds = {                      -- Table of sounds that the block makes
1067                         sound_footstep = SimpleSoundSpec,
1068                         sound_dig = SimpleSoundSpec,
1069                         sound_dug = SimpleSoundSpec
1070                 },
1071                 legacy_facedir_simple = bool,   -- Whether to use old facedir
1072                 legacy_wallmounted = bool       -- Whether to use old wallmounted
1073         }
1074 ```
1075
1076 #### Item Definition
1077
1078 ```lua
1079         {
1080                 name = string,                  -- Name of the item e.g. "default:stone"
1081                 description = string,           -- Description of the item e.g. "Stone"
1082                 type = string,                  -- Item type: "none", "node", "craftitem", "tool"
1083                 inventory_image = string,       -- Image in the inventory
1084                 wield_image = string,           -- Image in wieldmesh
1085                 palette_image = string,         -- Image for palette
1086                 color = Color,                  -- Color for item
1087                 wield_scale = Vector,           -- Wieldmesh scale
1088                 stack_max = number,             -- Number of items stackable together
1089                 usable = bool,                  -- Has on_use callback defined
1090                 liquids_pointable = bool,       -- Whether you can point at liquids with the item
1091                 tool_capabilities = <table>,    -- If the item is a tool, tool capabiltites of the item
1092                 groups = table,                 -- Groups of the item
1093                 sound_place = SimpleSoundSpec,  -- Sound played when placed
1094                 sound_place_failed = SimpleSoundSpec, -- Sound played when placement failed
1095                 node_placement_prediction = string -- Node placed in client until server catches up
1096         }
1097 ```
1098 -----------------
1099
1100 ### Chat command definition (`register_chatcommand`)
1101
1102     {
1103         params = "<name> <privilege>", -- Short parameter description
1104         description = "Remove privilege from player", -- Full description
1105         func = function(param),        -- Called when command is run.
1106                                        -- Returns boolean success and text output.
1107     }
1108 ### Server info
1109 ```lua
1110 {
1111         address = "minetest.example.org", -- The domain name/IP address of a remote server or "" for a local server.
1112         ip = "203.0.113.156",             -- The IP address of the server.
1113         port = 30000,                     -- The port the client is connected to.
1114         protocol_version = 30             -- Will not be accurate at start up as the client might not be connected to the server yet, in that case it will be 0.
1115 }
1116 ```
1117
1118 Escape sequences
1119 ----------------
1120 Most text can contain escape sequences, that can for example color the text.
1121 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
1122 The following functions provide escape sequences:
1123 * `minetest.get_color_escape_sequence(color)`:
1124     * `color` is a [ColorString](#colorstring)
1125     * The escape sequence sets the text color to `color`
1126 * `minetest.colorize(color, message)`:
1127     * Equivalent to:
1128       `minetest.get_color_escape_sequence(color) ..
1129        message ..
1130        minetest.get_color_escape_sequence("#ffffff")`
1131 * `minetest.get_background_escape_sequence(color)`
1132     * `color` is a [ColorString](#colorstring)
1133     * The escape sequence sets the background of the whole text element to
1134       `color`. Only defined for item descriptions and tooltips.
1135 * `minetest.strip_foreground_colors(str)`
1136     * Removes foreground colors added by `get_color_escape_sequence`.
1137 * `minetest.strip_background_colors(str)`
1138     * Removes background colors added by `get_background_escape_sequence`.
1139 * `minetest.strip_colors(str)`
1140     * Removes all color escape sequences.
1141
1142 `ColorString`
1143 -------------
1144 `#RGB` defines a color in hexadecimal format.
1145
1146 `#RGBA` defines a color in hexadecimal format and alpha channel.
1147
1148 `#RRGGBB` defines a color in hexadecimal format.
1149
1150 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
1151
1152 Named colors are also supported and are equivalent to
1153 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
1154 To specify the value of the alpha channel, append `#AA` to the end of the color name
1155 (e.g. `colorname#08`). For named colors the hexadecimal string representing the alpha
1156 value must (always) be two hexadecimal digits.
1157
1158 `Color`
1159 -------------
1160 `{a = alpha, r = red, g = green, b = blue}` defines an ARGB8 color.