1 Minetest Lua Client Modding API Reference 5.6.0
2 ================================================
3 * More information at <http://www.minetest.net/>
4 * Developer Wiki: <http://dev.minetest.net/>
9 ** WARNING: The client API is currently unstable, and may break/change without warning. **
11 Content and functionality can be added to Minetest 0.4.15-dev+ by using Lua
12 scripting in run-time loaded mods.
14 A mod is a self-contained bunch of scripts, textures and other related
15 things that is loaded by and interfaces with Minetest.
17 Transferring client-sided mods from the server to the client is planned, but not implemented yet.
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).
25 If you have any difficulty in understanding this, please read
26 [Programming in Lua](http://www.lua.org/pil/).
30 Mods are loaded during client startup from the mod load paths by running
31 the `init.lua` scripts in a shared environment.
33 In order to load client-side mods, the following conditions need to be satisfied:
35 1) `$path_user/minetest.conf` contains the setting `enable_client_modding = true`
37 2) The client-side mod located in `$path_user/clientmods/<modname>` is added to
38 `$path_user/clientmods/mods.conf` as `load_mod_<modname> = true`.
40 Note: Depending on the remote server's settings, client-side mods might not
41 be loaded or have limited functionality. See setting `csm_restriction_flags` for reference.
45 * `RUN_IN_PLACE=1` (Windows release, local build)
46 * `$path_user`: `<build directory>`
47 * `$path_share`: `<build directory>`
48 * `RUN_IN_PLACE=0`: (Linux release)
50 * Linux: `/usr/share/minetest`
51 * Windows: `<install directory>/minetest-0.4.x`
53 * Linux: `$HOME/.minetest`
54 * Windows: `C:/users/<user>/AppData/minetest` (maybe)
60 * `$path_share/clientmods/`
61 * `$path_user/clientmods/` (User-installed mods)
63 In a run-in-place version (e.g. the distributed windows version):
65 * `minetest-0.4.x/clientmods/` (User-installed mods)
67 On an installed version on Linux:
69 * `/usr/share/minetest/clientmods/`
70 * `$HOME/.minetest/clientmods/` (User-installed mods)
75 Mods can be put in a subdirectory, if the parent directory, which otherwise
76 should be a mod, contains a file named `modpack.conf`.
77 The file is a key-value store of modpack details.
79 * `name`: The modpack name.
80 * `description`: Description of mod to be shown in the Mods tab of the main
83 Mod directory structure
84 ------------------------
94 The location of this directory.
98 An (optional) settings file that provides meta information about the mod.
100 * `name`: The mod name. Allows Minetest to determine the mod name even if the
101 folder is wrongly named.
102 * `description`: Description of mod to be shown in the Mods tab of the main
104 * `depends`: A comma separated list of dependencies. These are mods that must be
105 loaded before this mod.
106 * `optional_depends`: A comma separated list of optional dependencies.
107 Like a dependency, but no error if the mod doesn't exist.
111 The main Lua script. Running this script should register everything it
112 wants to register. Subsequent execution depends on minetest calling the
113 registered callbacks.
115 **NOTE**: Client mods currently can't provide textures, sounds, or models by
116 themselves. Any media referenced in function calls must already be loaded
117 (provided by mods that exist on the server).
119 Naming convention for registered textual names
120 ----------------------------------------------
121 Registered names should generally be in this format:
123 "modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
125 This is to prevent conflicting names from corrupting maps and is
126 enforced by the mod loader.
129 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
130 So the name should be `experimental:tnt`.
132 Enforcement can be overridden by prefixing the name with `:`. This can
133 be used for overriding the registrations of some other mod.
135 Example: Any mod can redefine `experimental:tnt` by using the name
140 (also that mod is required to have `experimental` as a dependency)
142 The `:` prefix can also be used for maintaining backwards compatibility.
146 **NOTE: Connecting sounds to objects is not implemented.**
148 Only Ogg Vorbis files are supported.
150 For positional playing of sounds, only single-channel (mono) files are
151 supported. Otherwise OpenAL will play them non-positionally.
153 Mods should generally prefix their sounds with `modname_`, e.g. given
154 the mod name "`foomod`", a sound could be called:
158 Sounds are referred to by their name with a dot, a single digit and the
159 file extension stripped out. When a sound is played, the actual sound file
160 is chosen randomly from the matching sounds.
162 When playing the sound `foomod_foosound`, the sound is chosen randomly
163 from the available ones of the following files:
165 * `foomod_foosound.ogg`
166 * `foomod_foosound.0.ogg`
167 * `foomod_foosound.1.ogg`
169 * `foomod_foosound.9.ogg`
171 Examples of sound parameter tables:
175 gain = 1.0, -- default
177 -- Play locationless, looped
179 gain = 1.0, -- default
182 -- Play in a location
184 pos = {x = 1, y = 2, z = 3},
185 gain = 1.0, -- default
187 -- Play connected to an object, looped
189 object = <an ObjectRef>,
190 gain = 1.0, -- default
194 Looped sounds must either be connected to an object or played locationless.
198 * e.g. `"default_place_node"`
200 * e.g. `{name = "default_place_node"}`
201 * e.g. `{name = "default_place_node", gain = 1.0}`
203 Representations of simple things
204 --------------------------------
208 {x=num, y=num, z=num}
210 For helper functions see "Vector helpers".
214 * `{type="node", under=pos, above=pos}`
215 * `{type="object", id=ObjectID}`
217 Flag Specifier Format
218 ---------------------
219 Flags using the standardized flag specifier format can be specified in either of
220 two ways, by string or table.
222 The string format is a comma-delimited set of flag names; whitespace and
223 unrecognized flag fields are ignored. Specifying a flag in the string sets the
224 flag, and specifying a flag prefixed by the string `"no"` explicitly
225 clears the flag from whatever the default may be.
227 In addition to the standard string flag format, the schematic flags field can
228 also be a table of flag names to boolean values representing whether or not the
229 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
230 is present, mapped to a boolean of any value, the specified flag is unset.
232 E.g. A flag field of value
234 {place_center_x = true, place_center_y=false, place_center_z=true}
238 {place_center_x = true, noplace_center_y=true, place_center_z=true}
240 which is equivalent to
242 "place_center_x, noplace_center_y, place_center_z"
246 "place_center_x, place_center_z"
248 since, by default, no schematic attributes are set.
252 Formspec defines a menu. It is a string, with a somewhat strange format.
254 Spaces and newlines can be inserted between the blocks, as is used in the
262 list[context;main;0,0;8,4;]
263 list[current_player;main;0,5;8,4;]
268 list[context;fuel;2,3;1,1;]
269 list[context;src;2,1;1,1;]
270 list[context;dst;5,1;2,2;]
271 list[current_player;main;0,5;8,4;]
273 #### Minecraft-like player inventory
276 image[1,0.6;1,2;player.png]
277 list[current_player;main;0,3.5;8,4;]
278 list[current_player;craft;3,0;3,3;]
279 list[current_player;craftpreview;7,1;1,1;]
283 #### `size[<W>,<H>,<fixed_size>]`
284 * Define the size of the menu in inventory slots
285 * `fixed_size`: `true`/`false` (optional)
286 * deprecated: `invsize[<W>,<H>;]`
288 #### `container[<X>,<Y>]`
289 * Start of a container block, moves all physical elements in the container by (X, Y)
290 * Must have matching container_end
291 * Containers can be nested, in which case the offsets are added
292 (child containers are relative to parent containers)
294 #### `container_end[]`
295 * End of a container, following elements are no longer relative to this container
297 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
298 * Show an inventory list
300 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
301 * Show an inventory list
303 #### `listring[<inventory location>;<list name>]`
304 * Allows to create a ring of inventory lists
305 * Shift-clicking on items in one element of the ring
306 will send them to the next inventory list inside the ring
307 * The first occurrence of an element inside the ring will
308 determine the inventory where items will be sent to
311 * Shorthand for doing `listring[<inventory location>;<list name>]`
312 for the last two inventory lists added by list[...]
314 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
315 * Sets background color of slots as `ColorString`
316 * Sets background color of slots on mouse hovering
318 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
319 * Sets background color of slots as `ColorString`
320 * Sets background color of slots on mouse hovering
321 * Sets color of slots border
323 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
324 * Sets background color of slots as `ColorString`
325 * Sets background color of slots on mouse hovering
326 * Sets color of slots border
327 * Sets default background color of tooltips
328 * Sets default font color of tooltips
330 #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>,<fontcolor>]`
331 * Adds tooltip for an element
332 * `<bgcolor>` tooltip background color as `ColorString` (optional)
333 * `<fontcolor>` tooltip font color as `ColorString` (optional)
335 #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
337 * Position and size units are inventory slots
339 #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
340 * Show an inventory image of registered item/node
341 * Position and size units are inventory slots
343 #### `bgcolor[<color>;<fullscreen>]`
344 * Sets background color of formspec as `ColorString`
345 * If `true`, the background color is drawn fullscreen (does not effect the size of the formspec)
347 #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
348 * Use a background. Inventory rectangles are not drawn then.
349 * Position and size units are inventory slots
350 * Example for formspec 8x4 in 16x resolution: image shall be sized
351 8 times 16px times 4 times 16px.
353 #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
354 * Use a background. Inventory rectangles are not drawn then.
355 * Position and size units are inventory slots
356 * Example for formspec 8x4 in 16x resolution:
357 image shall be sized 8 times 16px times 4 times 16px
358 * If `true` the background is clipped to formspec size
359 (`x` and `y` are used as offset values, `w` and `h` are ignored)
361 #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
362 * Textual password style field; will be sent to server when a button is clicked
363 * When enter is pressed in field, fields.key_enter_field will be sent with the name
365 * `x` and `y` position the field relative to the top left of the menu
366 * `w` and `h` are the size of the field
367 * Fields are a set height, but will be vertically centred on `h`
368 * Position and size units are inventory slots
369 * `name` is the name of the field as returned in fields to `on_receive_fields`
370 * `label`, if not blank, will be text printed on the top left above the field
371 * See field_close_on_enter to stop enter closing the formspec
373 #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
374 * Textual field; will be sent to server when a button is clicked
375 * When enter is pressed in field, fields.key_enter_field will be sent with the name
377 * `x` and `y` position the field relative to the top left of the menu
378 * `w` and `h` are the size of the field
379 * Fields are a set height, but will be vertically centred on `h`
380 * Position and size units are inventory slots
381 * `name` is the name of the field as returned in fields to `on_receive_fields`
382 * `label`, if not blank, will be text printed on the top left above the field
383 * `default` is the default value of the field
384 * `default` may contain variable references such as `${text}'` which
385 will fill the value from the metadata value `text`
386 * **Note**: no extra text or more than a single variable is supported ATM.
387 * See field_close_on_enter to stop enter closing the formspec
389 #### `field[<name>;<label>;<default>]`
390 * As above, but without position/size units
391 * When enter is pressed in field, fields.key_enter_field will be sent with the name
393 * Special field for creating simple forms, such as sign text input
394 * Must be used without a `size[]` element
395 * A "Proceed" button will be added automatically
396 * See field_close_on_enter to stop enter closing the formspec
398 #### `field_close_on_enter[<name>;<close_on_enter>]`
399 * <name> is the name of the field
400 * if <close_on_enter> is false, pressing enter in the field will submit the form but not close it
401 * defaults to true when not specified (ie: no tag for a field)
403 #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
404 * Same as fields above, but with multi-line input
406 #### `label[<X>,<Y>;<label>]`
407 * `x` and `y` work as per field
408 * `label` is the text on the label
409 * Position and size units are inventory slots
411 #### `vertlabel[<X>,<Y>;<label>]`
412 * Textual label drawn vertically
413 * `x` and `y` work as per field
414 * `label` is the text on the label
415 * Position and size units are inventory slots
417 #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
418 * Clickable button. When clicked, fields will be sent.
419 * `x`, `y` and `name` work as per field
420 * `w` and `h` are the size of the button
421 * Fixed button height. It will be vertically centred on `h`
422 * `label` is the text on the button
423 * Position and size units are inventory slots
425 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
426 * `x`, `y`, `w`, `h`, and `name` work as per button
427 * `texture name` is the filename of an image
428 * Position and size units are inventory slots
430 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
431 * `x`, `y`, `w`, `h`, and `name` work as per button
432 * `texture name` is the filename of an image
433 * Position and size units are inventory slots
434 * `noclip=true` means the image button doesn't need to be within specified formsize
435 * `drawborder`: draw button border or not
436 * `pressed texture name` is the filename of an image on pressed state
438 #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
439 * `x`, `y`, `w`, `h`, `name` and `label` work as per button
440 * `item name` is the registered name of an item/node,
441 tooltip will be made out of its description
442 to override it use tooltip element
443 * Position and size units are inventory slots
445 #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
446 * When clicked, fields will be sent and the form will quit.
448 #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
449 * When clicked, fields will be sent and the form will quit.
451 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
452 * Scrollable item list showing arbitrary text elements
453 * `x` and `y` position the itemlist relative to the top left of the menu
454 * `w` and `h` are the size of the itemlist
455 * `name` fieldname sent to server on doubleclick value is current selected element
456 * `listelements` can be prepended by #color in hexadecimal format RRGGBB (only),
457 * if you want a listelement to start with "#" write "##".
459 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
460 * Scrollable itemlist showing arbitrary text elements
461 * `x` and `y` position the item list relative to the top left of the menu
462 * `w` and `h` are the size of the item list
463 * `name` fieldname sent to server on doubleclick value is current selected element
464 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
465 * if you want a listelement to start with "#" write "##"
466 * Index to be selected within textlist
467 * `true`/`false`: draw transparent background
468 * See also `minetest.explode_textlist_event` (main menu: `engine.explode_textlist_event`)
470 #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
471 * Show a tab**header** at specific position (ignores formsize)
472 * `x` and `y` position the itemlist relative to the top left of the menu
473 * `name` fieldname data is transferred to Lua
474 * `caption 1`...: name shown on top of tab
475 * `current_tab`: index of selected tab 1...
476 * `transparent` (optional): show transparent
477 * `draw_border` (optional): draw border
479 #### `box[<X>,<Y>;<W>,<H>;<color>]`
480 * Simple colored semitransparent box
481 * `x` and `y` position the box relative to the top left of the menu
482 * `w` and `h` are the size of box
483 * `color` is color specified as a `ColorString`
485 #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
486 * Show a dropdown field
487 * **Important note**: There are two different operation modes:
488 1. handle directly on change (only changed dropdown is submitted)
489 2. read the value on pressing a button (all dropdown values are available)
490 * `x` and `y` position of dropdown
492 * Fieldname data is transferred to Lua
493 * Items to be shown in dropdown
494 * Index of currently selected dropdown item
496 #### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
498 * `x` and `y`: position of checkbox
499 * `name` fieldname data is transferred to Lua
500 * `label` to be shown left of checkbox
501 * `selected` (optional): `true`/`false`
503 #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
505 * There are two ways to use it:
506 1. handle the changed event (only changed scrollbar is available)
507 2. read the value on pressing a button (all scrollbars are available)
508 * `x` and `y`: position of trackbar
509 * `w` and `h`: width and height
510 * `orientation`: `vertical`/`horizontal`
511 * Fieldname data is transferred to Lua
512 * Value this trackbar is set to (`0`-`1000`)
513 * See also `minetest.explode_scrollbar_event` (main menu: `engine.explode_scrollbar_event`)
515 #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
516 * Show scrollable table using options defined by the previous `tableoptions[]`
517 * Displays cells as defined by the previous `tablecolumns[]`
518 * `x` and `y`: position the itemlist relative to the top left of the menu
519 * `w` and `h` are the size of the itemlist
520 * `name`: fieldname sent to server on row select or doubleclick
521 * `cell 1`...`cell n`: cell contents given in row-major order
522 * `selected idx`: index of row to be selected within table (first row = `1`)
523 * See also `minetest.explode_table_event` (main menu: `engine.explode_table_event`)
525 #### `tableoptions[<opt 1>;<opt 2>;...]`
526 * Sets options for `table[]`
528 * default text color (`ColorString`), defaults to `#FFFFFF`
529 * `background=#RRGGBB`
530 * table background color (`ColorString`), defaults to `#000000`
531 * `border=<true/false>`
532 * should the table be drawn with a border? (default: `true`)
533 * `highlight=#RRGGBB`
534 * highlight background color (`ColorString`), defaults to `#466432`
535 * `highlight_text=#RRGGBB`
536 * highlight text color (`ColorString`), defaults to `#FFFFFF`
537 * `opendepth=<value>`
538 * all subtrees up to `depth < value` are open (default value = `0`)
539 * only useful when there is a column of type "tree"
541 #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
542 * Sets columns for `table[]`
543 * Types: `text`, `image`, `color`, `indent`, `tree`
544 * `text`: show cell contents as text
545 * `image`: cell contents are an image index, use column options to define images
546 * `color`: cell contents are a ColorString and define color of following cell
547 * `indent`: cell contents are a number and define indentation of following cell
548 * `tree`: same as indent, but user can open and close subtrees (treeview-like)
551 * for `text` and `image`: content alignment within cells.
552 Available values: `left` (default), `center`, `right`, `inline`
554 * for `text` and `image`: minimum width in em (default: `0`)
555 * for `indent` and `tree`: indent width in em (default: `1.5`)
556 * `padding=<value>`: padding left of the column, in em (default `0.5`).
557 Exception: defaults to 0 for indent columns
558 * `tooltip=<value>`: tooltip text (default: empty)
559 * `image` column options:
560 * `0=<value>` sets image for image index 0
561 * `1=<value>` sets image for image index 1
562 * `2=<value>` sets image for image index 2
563 * and so on; defined indices need not be contiguous empty or
564 non-numeric cells are treated as `0`.
565 * `color` column options:
566 * `span=<value>`: number of following columns to affect (default: infinite)
568 **Note**: do _not_ use a element name starting with `key_`; those names are reserved to
569 pass key press events to formspec!
573 * `vector.new(a[, b, c])`: returns a vector:
574 * A copy of `a` if `a` is a vector.
575 * `{x = a, y = b, z = c}`, if all `a, b, c` are defined
576 * `vector.direction(p1, p2)`: returns a vector
577 * `vector.distance(p1, p2)`: returns a number
578 * `vector.length(v)`: returns a number
579 * `vector.normalize(v)`: returns a vector
580 * `vector.floor(v)`: returns a vector, each dimension rounded down
581 * `vector.round(v)`: returns a vector, each dimension rounded to nearest int
582 * `vector.apply(v, func)`: returns a vector
583 * `vector.combine(v, w, func)`: returns a vector
584 * `vector.equals(v1, v2)`: returns a boolean
586 For the following functions `x` can be either a vector or a number:
588 * `vector.add(v, x)`: returns a vector
589 * `vector.subtract(v, x)`: returns a vector
590 * `vector.multiply(v, x)`: returns a scaled vector or Schur product
591 * `vector.divide(v, x)`: returns a scaled vector or Schur quotient
595 * `dump2(obj, name="_", dumped={})`
596 * Return object serialized as a string, handles reference loops
597 * `dump(obj, dumped={})`
598 * Return object serialized as a string
600 * Get the hypotenuse of a triangle with legs x and y.
601 Useful for distance calculation.
602 * `math.sign(x, tolerance)`
603 * Get the sign of a number.
604 Optional: Also returns `0` when the absolute value is within the tolerance (default: `0`)
605 * `string.split(str, separator=",", include_empty=false, max_splits=-1, sep_is_pattern=false)`
606 * If `max_splits` is negative, do not limit splits.
607 * `sep_is_pattern` specifies if separator is a plain string or a pattern (regex).
608 * e.g. `string:split("a,b", ",") == {"a","b"}`
610 * e.g. `string.trim("\n \t\tfoo bar\t ") == "foo bar"`
611 * `minetest.wrap_text(str, limit)`: returns a string
612 * Adds new lines to the string to keep it within the specified character limit
613 * limit: Maximal amount of characters in one line
614 * `minetest.pos_to_string({x=X,y=Y,z=Z}, decimal_places))`: returns string `"(X,Y,Z)"`
615 * Convert position to a printable string
616 Optional: 'decimal_places' will round the x, y and z of the pos to the given decimal place.
617 * `minetest.string_to_pos(string)`: returns a position
618 * Same but in reverse. Returns `nil` if the string can't be parsed to a position.
619 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
620 * Converts a string representing an area box into two positions
621 * `minetest.is_yes(arg)`
622 * returns whether `arg` can be interpreted as yes
623 * `minetest.is_nan(arg)`
624 * returns true when the passed number represents NaN.
625 * `table.copy(table)`: returns a table
626 * returns a deep copy of `table`
628 Minetest namespace reference
629 ------------------------------
633 * `minetest.get_current_modname()`: returns the currently loading mod's name, when we are loading a mod
634 * `minetest.get_modpath(modname)`: returns virtual path of given mod including
635 the trailing separator. This is useful to load additional Lua files
636 contained in your mod:
637 e.g. `dofile(minetest.get_modpath(minetest.get_current_modname()) .. "stuff.lua")`
638 * `minetest.get_language()`: returns two strings
639 * the current gettext locale
640 * the current language code (the same as used for client-side translations)
641 * `minetest.get_version()`: returns a table containing components of the
642 engine version. Components:
643 * `project`: Name of the project, eg, "Minetest"
644 * `string`: Simple version, eg, "1.2.3-dev"
645 * `hash`: Full git version (only set if available), eg, "1.2.3-dev-01234567-dirty"
646 Use this for informational purposes only. The information in the returned
647 table does not represent the capabilities of the engine, nor is it
648 reliable or verifiable. Compatible forks will have a different name and
649 version entirely. To check for the presence of engine features, test
650 whether the functions exported by the wanted features exist. For example:
651 `if minetest.check_for_falling then ... end`.
652 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
653 * `data`: string of data to hash
654 * `raw`: return raw bytes instead of hex digits, default: false
655 * `minetest.colorspec_to_colorstring(colorspec)`: Converts a ColorSpec to a
656 ColorString. If the ColorSpec is invalid, returns `nil`.
657 * `colorspec`: The ColorSpec to convert
658 * `minetest.get_csm_restrictions()`: returns a table of `Flags` indicating the
659 restrictions applied to the current mod.
660 * If a flag in this table is set to true, the feature is RESTRICTED.
661 * Possible flags: `load_client_mods`, `chat_messages`, `read_itemdefs`,
662 `read_nodedefs`, `lookup_nodes`, `read_playerinfo`
665 * `minetest.debug(...)`
666 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
667 * `minetest.log([level,] text)`
668 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
669 `"info"`, or `"verbose"`. Default is `"none"`.
671 ### Global callback registration functions
672 Call these functions only at load time!
674 * `minetest.register_globalstep(function(dtime))`
675 * Called every client environment step, usually interval of 0.1s
676 * `minetest.register_on_mods_loaded(function())`
677 * Called just after mods have finished loading.
678 * `minetest.register_on_shutdown(function())`
679 * Called before client shutdown
680 * **Warning**: If the client terminates abnormally (i.e. crashes), the registered
681 callbacks **will likely not be run**. Data should be saved at
682 semi-frequent intervals as well as on server shutdown.
683 * `minetest.register_on_receiving_chat_message(function(message))`
684 * Called always when a client receive a message
685 * Return `true` to mark the message as handled, which means that it will not be shown to chat
686 * `minetest.register_on_sending_chat_message(function(message))`
687 * Called always when a client send a message from chat
688 * Return `true` to mark the message as handled, which means that it will not be sent to server
689 * `minetest.register_chatcommand(cmd, chatcommand definition)`
690 * Adds definition to minetest.registered_chatcommands
691 * `minetest.unregister_chatcommand(name)`
692 * Unregisters a chatcommands registered with register_chatcommand.
693 * `minetest.register_on_chatcommand(function(command, params))`
694 * Called always when a chatcommand is triggered, before `minetest.registered_chatcommands`
695 is checked to see if that the command exists, but after the input is parsed.
696 * Return `true` to mark the command as handled, which means that the default
697 handlers will be prevented.
698 * `minetest.register_on_death(function())`
699 * Called when the local player dies
700 * `minetest.register_on_hp_modification(function(hp))`
701 * Called when server modified player's HP
702 * `minetest.register_on_damage_taken(function(hp))`
703 * Called when the local player take damages
704 * `minetest.register_on_formspec_input(function(formname, fields))`
705 * Called when a button is pressed in the local player's inventory form
706 * Newest functions are called first
707 * If function returns `true`, remaining functions are not called
708 * `minetest.register_on_dignode(function(pos, node))`
709 * Called when the local player digs a node
710 * Newest functions are called first
711 * If any function returns true, the node isn't dug
712 * `minetest.register_on_punchnode(function(pos, node))`
713 * Called when the local player punches a node
714 * Newest functions are called first
715 * If any function returns true, the punch is ignored
716 * `minetest.register_on_placenode(function(pointed_thing, node))`
717 * Called when a node has been placed
718 * `minetest.register_on_item_use(function(item, pointed_thing))`
719 * Called when the local player uses an item.
720 * Newest functions are called first.
721 * If any function returns true, the item use is not sent to server.
722 * `minetest.register_on_modchannel_message(function(channel_name, sender, message))`
723 * Called when an incoming mod channel message is received
724 * You must have joined some channels before, and server must acknowledge the
726 * If message comes from a server mod, `sender` field is an empty string.
727 * `minetest.register_on_modchannel_signal(function(channel_name, signal))`
728 * Called when a valid incoming mod channel signal is received
729 * Signal id permit to react to server mod channel events
730 * Possible values are:
735 4: event_on_not_joined_channel
737 * `minetest.register_on_inventory_open(function(inventory))`
738 * Called when the local player open inventory
739 * Newest functions are called first
740 * If any function returns true, inventory doesn't open
742 * `minetest.sound_play(spec, parameters)`: returns a handle
743 * `spec` is a `SimpleSoundSpec`
744 * `parameters` is a sound parameter table
745 * `minetest.sound_stop(handle)`
746 * `handle` is a handle returned by `minetest.sound_play`
747 * `minetest.sound_fade(handle, step, gain)`
748 * `handle` is a handle returned by `minetest.sound_play`
749 * `step` determines how fast a sound will fade.
750 Negative step will lower the sound volume, positive step will increase
752 * `gain` the target gain for the fade.
755 * `minetest.after(time, func, ...)`
756 * Call the function `func` after `time` seconds, may be fractional
757 * Optional: Variable number of arguments that are passed to `func`
758 * `minetest.get_us_time()`
759 * Returns time with microsecond precision. May not return wall time.
760 * `minetest.get_timeofday()`
761 * Returns the time of day: `0` for midnight, `0.5` for midday
764 * `minetest.get_node_or_nil(pos)`
765 * Returns the node at the given position as table in the format
766 `{name="node_name", param1=0, param2=0}`, returns `nil`
767 for unloaded areas or flavor limited areas.
768 * `minetest.get_node_light(pos, timeofday)`
769 * Gets the light value at the given position. Note that the light value
770 "inside" the node at the given position is returned, so you usually want
771 to get the light value of a neighbor.
772 * `pos`: The position where to measure the light.
773 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
774 * Returns a number between `0` and `15` or `nil`
775 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns pos or `nil`
776 * `radius`: using a maximum metric
777 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
778 * `search_center` is an optional boolean (default: `false`)
779 If true `pos` is also checked for the nodes
780 * `minetest.find_nodes_in_area(pos1, pos2, nodenames, [grouped])`
781 * `pos1` and `pos2` are the min and max positions of the area to search.
782 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
783 * If `grouped` is true the return value is a table indexed by node name
784 which contains lists of positions.
785 * If `grouped` is false or absent the return values are as follows:
786 first value: Table with all node positions
787 second value: Table with the count of each node with the node name
789 * Area volume is limited to 4,096,000 nodes
790 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
792 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
793 * Return value: Table with all node positions with a node air above
794 * Area volume is limited to 4,096,000 nodes
795 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
796 * Checks if there is anything other than air between pos1 and pos2.
797 * Returns false if something is blocking the sight.
798 * Returns the position of the blocking node when `false`
799 * `pos1`: First position
800 * `pos2`: Second position
801 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
802 * Creates a `Raycast` object.
803 * `pos1`: start of the ray
804 * `pos2`: end of the ray
805 * `objects`: if false, only nodes will be returned. Default is `true`.
806 * `liquids`: if false, liquid nodes won't be returned. Default is `false`.
808 * `minetest.find_nodes_with_meta(pos1, pos2)`
809 * Get a table of positions of nodes that have metadata within a region
811 * `minetest.get_meta(pos)`
812 * Get a `NodeMetaRef` at that position
813 * `minetest.get_node_level(pos)`
814 * get level of leveled node (water, snow)
815 * `minetest.get_node_max_level(pos)`
816 * get max available level for leveled node
819 * `minetest.send_chat_message(message)`
820 * Act as if `message` was typed by the player into the terminal.
821 * `minetest.run_server_chatcommand(cmd, param)`
822 * Alias for `minetest.send_chat_message("/" .. cmd .. " " .. param)`
823 * `minetest.clear_out_chat_queue()`
824 * Clears the out chat queue
825 * `minetest.localplayer`
826 * Reference to the LocalPlayer object. See [`LocalPlayer`](#localplayer) class reference for methods.
829 * `minetest.get_privilege_list()`
830 * Returns a list of privileges the current player has in the format `{priv1=true,...}`
831 * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
832 * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
833 * Convert between two privilege representations
835 ### Client Environment
836 * `minetest.get_player_names()`
837 * Returns list of player names on server (nil if CSM_RF_READ_PLAYERINFO is enabled by server)
838 * `minetest.disconnect()`
839 * Disconnect from the server and exit to main menu.
840 * Returns `false` if the client is already disconnecting otherwise returns `true`.
841 * `minetest.get_server_info()`
842 * Returns [server info](#server-info).
843 * `minetest.send_respawn()`
844 * Sends a respawn request to the server.
847 * `minetest.get_mod_storage()`:
848 * returns reference to mod private `StorageRef`
849 * must be called during mod load time
852 ![Mod channels communication scheme](docs/mod channels.png)
854 * `minetest.mod_channel_join(channel_name)`
855 * Client joins channel `channel_name`, and creates it, if necessary. You
856 should listen from incoming messages with `minetest.register_on_modchannel_message`
857 call to receive incoming messages. Warning, this function is asynchronous.
860 * `minetest.add_particle(particle definition)`
862 * `minetest.add_particlespawner(particlespawner definition)`
863 * Add a `ParticleSpawner`, an object that spawns an amount of particles over `time` seconds
864 * Returns an `id`, and -1 if adding didn't succeed
866 * `minetest.delete_particlespawner(id)`
867 * Delete `ParticleSpawner` with `id` (return value from `minetest.add_particlespawner`)
870 * `minetest.parse_json(string[, nullvalue])`: returns something
871 * Convert a string containing JSON data into the Lua equivalent
872 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
873 * On success returns a table, a string, a number, a boolean or `nullvalue`
874 * On failure outputs an error message and returns `nil`
875 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
876 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
877 * Convert a Lua table into a JSON string
878 * styled: Outputs in a human-readable format if this is set, defaults to false
879 * Unserializable things like functions and userdata are saved as null.
880 * **Warning**: JSON is more strict than the Lua table format.
881 1. You can only use strings and positive integers of at least one as keys.
882 2. You can not mix string and integer keys.
883 This is due to the fact that JSON has two distinct array and object values.
884 * Example: `write_json({10, {a = false}})`, returns `"[10, {\"a\": false}]"`
885 * `minetest.serialize(table)`: returns a string
886 * Convert a table containing tables, strings, numbers, booleans and `nil`s
887 into string form readable by `minetest.deserialize`
888 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
889 * `minetest.deserialize(string)`: returns a table
890 * Convert a string returned by `minetest.deserialize` into a table
891 * `string` is loaded in an empty sandbox environment.
892 * Will load functions, but they cannot access the global environment.
893 * Example: `deserialize('return { ["foo"] = "bar" }')`, returns `{foo='bar'}`
894 * Example: `deserialize('print("foo")')`, returns `nil` (function call fails)
895 * `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
896 * `minetest.compress(data, method, ...)`: returns `compressed_data`
897 * Compress a string of data.
898 * `method` is a string identifying the compression method to be used.
899 * Supported compression methods:
900 * Deflate (zlib): `"deflate"`
901 * `...` indicates method-specific arguments. Currently defined arguments are:
902 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
903 * `minetest.decompress(compressed_data, method, ...)`: returns data
904 * Decompress a string of data (using ZLib).
905 * See documentation on `minetest.compress()` for supported compression methods.
906 * currently supported.
907 * `...` indicates method-specific arguments. Currently, no methods use this.
908 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
909 * Each argument is a 8 Bit unsigned integer
910 * Returns the ColorString from rgb or rgba values
911 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
912 * `minetest.encode_base64(string)`: returns string encoded in base64
913 * Encodes a string in base64.
914 * `minetest.decode_base64(string)`: returns string or nil on failure
915 * Padding characters are only supported starting at version 5.4.0, where
916 5.5.0 and newer perform proper checks.
917 * Decodes a string encoded in base64.
918 * `minetest.gettext(string)` : returns string
919 * look up the translation of a string in the gettext message catalog
920 * `fgettext_ne(string, ...)`
921 * call minetest.gettext(string), replace "$1"..."$9" with the given
922 extra arguments and return the result
923 * `fgettext(string, ...)` : returns string
924 * same as fgettext_ne(), but calls minetest.formspec_escape before returning result
925 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a position
926 * returns the exact position on the surface of a pointed node
927 * `minetest.global_exists(name)`
928 * Checks if a global variable has been set, without triggering a warning.
931 * `minetest.ui.minimap`
932 * Reference to the minimap object. See [`Minimap`](#minimap) class reference for methods.
933 * If client disabled minimap (using enable_minimap setting) this reference will be nil.
935 * Reference to the camera object. See [`Camera`](#camera) class reference for methods.
936 * `minetest.show_formspec(formname, formspec)` : returns true on success
937 * Shows a formspec to the player
938 * `minetest.display_chat_message(message)` returns true on success
939 * Shows a chat message to the current player.
946 An interface to use mod channels on client and server
949 * `leave()`: leave the mod channel.
950 * Client leaves channel `channel_name`.
951 * No more incoming or outgoing messages can be sent to this channel from client mods.
952 * This invalidate all future object usage
953 * Ensure your set mod_channel to nil after that to free Lua resources
954 * `is_writeable()`: returns true if channel is writable and mod can send over it.
955 * `send_all(message)`: Send `message` though the mod channel.
956 * If mod channel is not writable or invalid, message will be dropped.
957 * Message size is limited to 65535 characters by protocol.
960 An interface to manipulate minimap on client UI
963 * `show()`: shows the minimap (if not disabled by server)
964 * `hide()`: hides the minimap
965 * `set_pos(pos)`: sets the minimap position on screen
966 * `get_pos()`: returns the minimap current position
967 * `set_angle(deg)`: sets the minimap angle in degrees
968 * `get_angle()`: returns the current minimap angle in degrees
969 * `set_mode(mode)`: sets the minimap mode (0 to 6)
970 * `get_mode()`: returns the current minimap mode
971 * `set_shape(shape)`: Sets the minimap shape. (0 = square, 1 = round)
972 * `get_shape()`: Gets the minimap shape. (0 = square, 1 = round)
975 An interface to get or set information about the camera and camera-node.
976 Please do not try to access the reference until the camera is initialized, otherwise the reference will be nil.
979 * `set_camera_mode(mode)`
980 * Pass `0` for first-person, `1` for third person, and `2` for third person front
981 * `get_camera_mode()`
982 * Returns 0, 1, or 2 as described above
984 * Returns a table with X, Y, maximum and actual FOV in degrees:
996 * Returns position of camera with view bobbing
998 * Returns eye offset vector
1000 * Returns eye direction unit vector
1001 * `get_look_vertical()`
1002 * Returns pitch in radians
1003 * `get_look_horizontal()`
1004 * Returns yaw in radians
1005 * `get_aspect_ratio()`
1006 * Returns aspect ratio of screen
1009 An interface to retrieve information about the player.
1010 This object will only be available after the client is initialized. Earlier accesses will yield a `nil` value.
1015 * returns current player current position
1017 * returns player speed vector
1021 * returns player name
1022 * `get_wield_index()`
1023 * returns the index of the wielded item
1024 * `get_wielded_item()`
1025 * returns the itemstack the player is holding
1027 * returns true if player is attached
1028 * `is_touching_ground()`
1029 * returns true if player touching ground
1031 * returns true if player is in a liquid (This oscillates so that the player jumps a bit above the surface)
1032 * `is_in_liquid_stable()`
1033 * returns true if player is in a stable liquid (This is more stable and defines the maximum speed of the player)
1034 * `get_move_resistance()`
1035 * returns move resistance of current node, the higher the slower the player moves
1037 * returns true if player is climbing
1038 * `swimming_vertical()`
1039 * returns true if player is swimming in vertical
1040 * `get_physics_override()`
1049 sneak_glitch = boolean,
1054 * `get_override_pos()`
1055 * returns override position
1057 * returns last player position before the current client step
1058 * `get_last_velocity()`
1059 * returns last player speed
1061 * returns the player's breath
1062 * `get_movement_acceleration()`
1063 * returns acceleration of the player in different environments:
1073 * `get_movement_speed()`
1074 * returns player's speed in different environments:
1087 * returns player's movement in different environments:
1091 liquid_fluidity = float,
1092 liquid_sink = float,
1093 liquid_fluidity_smooth = float,
1098 * `get_last_look_horizontal()`:
1099 * returns last look horizontal angle
1100 * `get_last_look_vertical()`:
1101 * returns last look vertical angle
1103 * returns pressed player controls
1120 * `get_armor_groups()`
1121 * returns a table with the armor group ratings
1122 * `hud_add(definition)`
1123 * add a HUD element described by HUD def, returns ID number on success and `nil` on failure.
1124 * See [`HUD definition`](#hud-definition-hud_add-hud_get)
1126 * returns the [`definition`](#hud-definition-hud_add-hud_get) of the HUD with that ID number or `nil`, if non-existent.
1128 * remove the HUD element of the specified id, returns `true` on success
1129 * `hud_change(id, stat, value)`
1130 * change a value of a previously added HUD element
1131 * element `stat` values: `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
1132 * Returns `true` on success, otherwise returns `nil`
1135 An interface to read config files in the format of `minetest.conf`.
1137 It can be created via `Settings(filename)`.
1140 * `get(key)`: returns a value
1141 * `get_bool(key)`: returns a boolean
1143 * `remove(key)`: returns a boolean (`true` for success)
1144 * `get_names()`: returns `{key1,...}`
1145 * `write()`: returns a boolean (`true` for success)
1146 * write changes to file
1147 * `to_table()`: returns `{[key1]=value1,...}`
1150 Node metadata: reference extra data and functionality stored in a node.
1151 Can be obtained via `minetest.get_meta(pos)`.
1154 * `get_string(name)`
1157 * `to_table()`: returns `nil` or a table with keys:
1158 * `fields`: key-value storage
1159 * `inventory`: `{list1 = {}, ...}}`
1163 A raycast on the map. It works with selection boxes.
1164 Can be used as an iterator in a for loop as:
1166 local ray = Raycast(...)
1167 for pointed_thing in ray do
1171 The map is loaded as the ray advances. If the map is modified after the
1172 `Raycast` is created, the changes may or may not have an effect on the object.
1174 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
1175 `minetest.raycast(pos1, pos2, objects, liquids)` where:
1177 * `pos1`: start of the ray
1178 * `pos2`: end of the ray
1179 * `objects`: if false, only nodes will be returned. Default is true.
1180 * `liquids`: if false, liquid nodes won't be returned. Default is false.
1184 * `next()`: returns a `pointed_thing` with exact pointing location
1185 * Returns the next thing pointed by the ray or nil.
1189 * `minetest.get_node_def(nodename)`
1190 * Returns [node definition](#node-definition) table of `nodename`
1191 * `minetest.get_item_def(itemstring)`
1192 * Returns item definition table of `itemstring`
1194 #### Node Definition
1198 has_on_construct = bool, -- Whether the node has the on_construct callback defined
1199 has_on_destruct = bool, -- Whether the node has the on_destruct callback defined
1200 has_after_destruct = bool, -- Whether the node has the after_destruct callback defined
1201 name = string, -- The name of the node e.g. "air", "default:dirt"
1202 groups = table, -- The groups of the node
1203 paramtype = string, -- Paramtype of the node
1204 paramtype2 = string, -- ParamType2 of the node
1205 drawtype = string, -- Drawtype of the node
1206 mesh = <string>, -- Mesh name if existant
1207 minimap_color = <Color>, -- Color of node on minimap *May not exist*
1208 visual_scale = number, -- Visual scale of node
1209 alpha = number, -- Alpha of the node. Only used for liquids
1210 color = <Color>, -- Color of node *May not exist*
1211 palette_name = <string>, -- Filename of palette *May not exist*
1212 palette = <{ -- List of colors
1216 waving = number, -- 0 of not waving, 1 if waving
1217 connect_sides = number, -- Used for connected nodes
1218 connects_to = { -- List of nodes to connect to
1222 post_effect_color = Color, -- Color overlayed on the screen when the player is in the node
1223 leveled = number, -- Max level for node
1224 sunlight_propogates = bool, -- Whether light passes through the block
1225 light_source = number, -- Light emitted by the block
1226 is_ground_content = bool, -- Whether caves should cut through the node
1227 walkable = bool, -- Whether the player collides with the node
1228 pointable = bool, -- Whether the player can select the node
1229 diggable = bool, -- Whether the player can dig the node
1230 climbable = bool, -- Whether the player can climb up the node
1231 buildable_to = bool, -- Whether the player can replace the node by placing a node on it
1232 rightclickable = bool, -- Whether the player can place nodes pointing at this node
1233 damage_per_second = number, -- HP of damage per second when the player is in the node
1234 liquid_type = <string>, -- A string containing "none", "flowing", or "source" *May not exist*
1235 liquid_alternative_flowing = <string>, -- Alternative node for liquid *May not exist*
1236 liquid_alternative_source = <string>, -- Alternative node for liquid *May not exist*
1237 liquid_viscosity = <number>, -- How slow the liquid flows *May not exist*
1238 liquid_renewable = <boolean>, -- Whether the liquid makes an infinite source *May not exist*
1239 liquid_range = <number>, -- How far the liquid flows *May not exist*
1240 drowning = bool, -- Whether the player will drown in the node
1241 floodable = bool, -- Whether nodes will be replaced by liquids (flooded)
1242 node_box = table, -- Nodebox to draw the node with
1243 collision_box = table, -- Nodebox to set the collision area
1244 selection_box = table, -- Nodebox to set the area selected by the player
1245 sounds = { -- Table of sounds that the block makes
1246 sound_footstep = SimpleSoundSpec,
1247 sound_dig = SimpleSoundSpec,
1248 sound_dug = SimpleSoundSpec
1250 legacy_facedir_simple = bool, -- Whether to use old facedir
1251 legacy_wallmounted = bool -- Whether to use old wallmounted
1252 move_resistance = <number>, -- How slow players can move through the node *May not exist*
1256 #### Item Definition
1260 name = string, -- Name of the item e.g. "default:stone"
1261 description = string, -- Description of the item e.g. "Stone"
1262 type = string, -- Item type: "none", "node", "craftitem", "tool"
1263 inventory_image = string, -- Image in the inventory
1264 wield_image = string, -- Image in wieldmesh
1265 palette_image = string, -- Image for palette
1266 color = Color, -- Color for item
1267 wield_scale = Vector, -- Wieldmesh scale
1268 stack_max = number, -- Number of items stackable together
1269 usable = bool, -- Has on_use callback defined
1270 liquids_pointable = bool, -- Whether you can point at liquids with the item
1271 tool_capabilities = <table>, -- If the item is a tool, tool capabilities of the item
1272 groups = table, -- Groups of the item
1273 sound_place = SimpleSoundSpec, -- Sound played when placed
1274 sound_place_failed = SimpleSoundSpec, -- Sound played when placement failed
1275 node_placement_prediction = string -- Node placed in client until server catches up
1280 ### Chat command definition (`register_chatcommand`)
1283 params = "<name> <privilege>", -- Short parameter description
1284 description = "Remove privilege from player", -- Full description
1285 func = function(param), -- Called when command is run.
1286 -- Returns boolean success and text output.
1291 address = "minetest.example.org", -- The domain name/IP address of a remote server or "" for a local server.
1292 ip = "203.0.113.156", -- The IP address of the server.
1293 port = 30000, -- The port the client is connected to.
1294 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.
1298 ### HUD Definition (`hud_add`, `hud_get`)
1301 hud_elem_type = "image", -- see HUD element types, default "text"
1302 -- ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
1303 position = {x=0.5, y=0.5},
1304 -- ^ Left corner position of element, default `{x=0,y=0}`.
1305 name = "<name>", -- default ""
1306 scale = {x=2, y=2}, -- default {x=0,y=0}
1307 text = "<text>", -- default ""
1308 number = 2, -- default 0
1309 item = 3, -- default 0
1310 -- ^ Selected item in inventory. 0 for no item selected.
1311 direction = 0, -- default 0
1312 -- ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
1313 alignment = {x=0, y=0}, -- default {x=0, y=0}
1314 -- ^ See "HUD Element Types"
1315 offset = {x=0, y=0}, -- default {x=0, y=0}
1316 -- ^ See "HUD Element Types"
1317 size = { x=100, y=100 }, -- default {x=0, y=0}
1318 -- ^ Size of element in pixels
1320 -- ^ For "text" elements sets font style: bitfield with 1 = bold, 2 = italic, 4 = monospace
1326 Most text can contain escape sequences, that can for example color the text.
1327 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
1328 The following functions provide escape sequences:
1329 * `minetest.get_color_escape_sequence(color)`:
1330 * `color` is a [ColorString](#colorstring)
1331 * The escape sequence sets the text color to `color`
1332 * `minetest.colorize(color, message)`:
1334 `minetest.get_color_escape_sequence(color) ..
1336 minetest.get_color_escape_sequence("#ffffff")`
1337 * `minetest.get_background_escape_sequence(color)`
1338 * `color` is a [ColorString](#colorstring)
1339 * The escape sequence sets the background of the whole text element to
1340 `color`. Only defined for item descriptions and tooltips.
1341 * `minetest.strip_foreground_colors(str)`
1342 * Removes foreground colors added by `get_color_escape_sequence`.
1343 * `minetest.strip_background_colors(str)`
1344 * Removes background colors added by `get_background_escape_sequence`.
1345 * `minetest.strip_colors(str)`
1346 * Removes all color escape sequences.
1350 `#RGB` defines a color in hexadecimal format.
1352 `#RGBA` defines a color in hexadecimal format and alpha channel.
1354 `#RRGGBB` defines a color in hexadecimal format.
1356 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
1358 Named colors are also supported and are equivalent to
1359 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
1360 To specify the value of the alpha channel, append `#A` or `#AA` to the end of
1361 the color name (e.g. `colorname#08`).
1365 `{a = alpha, r = red, g = green, b = blue}` defines an ARGB8 color.
1369 The position field is used for all element types.
1371 To account for differing resolutions, the position coordinates are the percentage
1372 of the screen, ranging in value from `0` to `1`.
1374 The name field is not yet used, but should contain a description of what the
1375 HUD element represents. The direction field is the direction in which something
1378 `0` draws from left to right, `1` draws from right to left, `2` draws from
1379 top to bottom, and `3` draws from bottom to top.
1381 The `alignment` field specifies how the item will be aligned. It ranges from `-1` to `1`,
1382 with `0` being the center, `-1` is moved to the left/up, and `1` is to the right/down.
1383 Fractional values can be used.
1385 The `offset` field specifies a pixel offset from the position. Contrary to position,
1386 the offset is not scaled to screen size. This allows for some precisely-positioned
1389 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling factor!
1391 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
1393 **Note**: Future revisions to the HUD API may be incompatible; the HUD API is still
1394 in the experimental stages.
1397 Displays an image on the HUD.
1399 * `scale`: The scale of the image, with 1 being the original texture size.
1400 Only the X coordinate scale is used (positive values).
1401 Negative values represent that percentage of the screen it
1402 should take; e.g. `x=-100` means 100% (width).
1403 * `text`: The name of the texture that is displayed.
1404 * `alignment`: The alignment of the image.
1405 * `offset`: offset in pixels from position.
1408 Displays text on the HUD.
1410 * `scale`: Defines the bounding rectangle of the text.
1411 A value such as `{x=100, y=100}` should work.
1412 * `text`: The text to be displayed in the HUD element.
1413 * `number`: An integer containing the RGB value of the color used to draw the text.
1414 Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1415 * `alignment`: The alignment of the text.
1416 * `offset`: offset in pixels from position.
1419 Displays a horizontal bar made up of half-images.
1421 * `text`: The name of the texture that is used.
1422 * `number`: The number of half-textures that are displayed.
1423 If odd, will end with a vertically center-split texture.
1425 * `offset`: offset in pixels from position.
1426 * `size`: If used, will force full-image size to this value (override texture pack image size)
1429 * `text`: The name of the inventory list to be displayed.
1430 * `number`: Number of items in the inventory to be displayed.
1431 * `item`: Position of item that is selected.
1433 * `offset`: offset in pixels from position.
1437 Displays distance to selected world position.
1439 * `name`: The name of the waypoint.
1440 * `text`: Distance suffix. Can be blank.
1441 * `precision`: Waypoint precision, integer >= 0. Defaults to 10.
1442 If set to 0, distance is not shown. Shown value is `floor(distance*precision)/precision`.
1443 When the precision is an integer multiple of 10, there will be `log_10(precision)` digits after the decimal point.
1444 `precision = 1000`, for example, will show 3 decimal places (eg: `0.999`).
1445 `precision = 2` will show multiples of `0.5`; precision = 5 will show multiples of `0.2` and so on:
1446 `precision = n` will show multiples of `1/n`
1447 * `number:` An integer containing the RGB value of the color used to draw the
1449 * `world_pos`: World position of the waypoint.
1450 * `offset`: offset in pixels from position.
1451 * `alignment`: The alignment of the waypoint.
1453 ### `image_waypoint`
1455 Same as `image`, but does not accept a `position`; the position is instead determined by `world_pos`, the world position of the waypoint.
1457 * `scale`: The scale of the image, with 1 being the original texture size.
1458 Only the X coordinate scale is used (positive values).
1459 Negative values represent that percentage of the screen it
1460 should take; e.g. `x=-100` means 100% (width).
1461 * `text`: The name of the texture that is displayed.
1462 * `alignment`: The alignment of the image.
1463 * `world_pos`: World position of the waypoint.
1464 * `offset`: offset in pixels from position.
1466 ### Particle definition (`add_particle`)
1469 pos = {x=0, y=0, z=0},
1470 velocity = {x=0, y=0, z=0},
1471 acceleration = {x=0, y=0, z=0},
1472 -- ^ Spawn particle at pos with velocity and acceleration
1474 -- ^ Disappears after expirationtime seconds
1476 collisiondetection = false,
1477 -- ^ collisiondetection: if true collides with physical objects
1478 collision_removal = false,
1479 -- ^ collision_removal: if true then particle is removed when it collides,
1480 -- ^ requires collisiondetection = true to have any effect
1482 -- ^ vertical: if true faces player using y axis only
1483 texture = "image.png",
1484 -- ^ Uses texture (string)
1485 animation = {Tile Animation definition},
1486 -- ^ optional, specifies how to animate the particle texture
1488 -- ^ optional, specify particle self-luminescence in darkness
1491 ### `ParticleSpawner` definition (`add_particlespawner`)
1496 -- ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
1497 minpos = {x=0, y=0, z=0},
1498 maxpos = {x=0, y=0, z=0},
1499 minvel = {x=0, y=0, z=0},
1500 maxvel = {x=0, y=0, z=0},
1501 minacc = {x=0, y=0, z=0},
1502 maxacc = {x=0, y=0, z=0},
1507 -- ^ The particle's properties are random values in between the bounds:
1508 -- ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
1509 -- ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
1510 collisiondetection = false,
1511 -- ^ collisiondetection: if true uses collision detection
1512 collision_removal = false,
1513 -- ^ collision_removal: if true then particle is removed when it collides,
1514 -- ^ requires collisiondetection = true to have any effect
1516 -- ^ vertical: if true faces player using y axis only
1517 texture = "image.png",
1518 -- ^ Uses texture (string)