1 Minetest Lua Modding API Reference
2 ==================================
4 * More information at <http://www.minetest.net/>
5 * Developer Wiki: <http://dev.minetest.net/>
6 * (Unofficial) Minetest Modding Book by rubenwardy: <https://rubenwardy.com/minetest_modding_book/>
11 Content and functionality can be added to Minetest using Lua scripting
12 in run-time loaded mods.
14 A mod is a self-contained bunch of scripts, textures and other related
15 things, which is loaded by and interfaces with Minetest.
17 Mods are contained and ran solely on the server side. Definitions and media
18 files are automatically transferred to the client.
20 If you see a deficiency in the API, feel free to attempt to add the
21 functionality in the engine and API, and to document it here.
26 If you have any difficulty in understanding this, please read
27 [Programming in Lua](http://www.lua.org/pil/).
32 Mods are loaded during server startup from the mod load paths by running
33 the `init.lua` scripts in a shared environment.
38 * `RUN_IN_PLACE=1` (Windows release, local build)
39 * `$path_user`: `<build directory>`
40 * `$path_share`: `<build directory>`
41 * `RUN_IN_PLACE=0`: (Linux release)
43 * Linux: `/usr/share/minetest`
44 * Windows: `<install directory>/minetest-0.4.x`
46 * Linux: `$HOME/.minetest`
47 * Windows: `C:/users/<user>/AppData/minetest` (maybe)
55 Games are looked up from:
57 * `$path_share/games/<gameid>/`
58 * `$path_user/games/<gameid>/`
60 Where `<gameid>` is unique to each game.
62 The game directory can contain the following files:
64 * `game.conf`, with the following keys:
65 * `title`: Required, a human-readable title to address the game, e.g. `title = Minetest Game`.
66 * `name`: (Deprecated) same as title.
67 * `description`: Short description to be shown in the content tab
68 * `allowed_mapgens = <comma-separated mapgens>`
69 e.g. `allowed_mapgens = v5,v6,flat`
70 Mapgens not in this list are removed from the list of mapgens for the
72 If not specified, all mapgens are allowed.
73 * `disallowed_mapgens = <comma-separated mapgens>`
74 e.g. `disallowed_mapgens = v5,v6,flat`
75 These mapgens are removed from the list of mapgens for the game.
76 When both `allowed_mapgens` and `disallowed_mapgens` are
77 specified, `allowed_mapgens` is applied before
79 * `disallowed_mapgen_settings= <comma-separated mapgen settings>`
80 e.g. `disallowed_mapgen_settings = mgv5_spflags`
81 These mapgen settings are hidden for this game in the world creation
82 dialog and game start menu. Add `seed` to hide the seed input field.
83 * `disabled_settings = <comma-separated settings>`
84 e.g. `disabled_settings = enable_damage, creative_mode`
85 These settings are hidden for this game in the "Start game" tab
86 and will be initialized as `false` when the game is started.
87 Prepend a setting name with an exclamation mark to initialize it to `true`
88 (this does not work for `enable_server`).
89 Only these settings are supported:
90 `enable_damage`, `creative_mode`, `enable_server`.
91 * `author`: The author of the game. It only appears when downloaded from
93 * `release`: Ignore this: Should only ever be set by ContentDB, as it is
94 an internal ID used to track versions.
96 Used to set default settings when running this game.
98 In the same format as the one in builtin.
99 This settingtypes.txt will be parsed by the menu and the settings will be
100 displayed in the "Games" category in the advanced settings tab.
101 * If the game contains a folder called `textures` the server will load it as a
102 texturepack, overriding mod textures.
103 Any server texturepack will override mod textures and the game texturepack.
108 Games can provide custom main menu images. They are put inside a `menu`
109 directory inside the game directory.
111 The images are named `$identifier.png`, where `$identifier` is one of
112 `overlay`, `background`, `footer`, `header`.
113 If you want to specify multiple images for one identifier, add additional
114 images named like `$identifier.$n.png`, with an ascending number $n starting
115 with 1, and a random image will be chosen from the provided ones.
120 Games can provide custom main menu music. They are put inside a `menu`
121 directory inside the game directory.
123 The music files are named `theme.ogg`.
124 If you want to specify multiple music files for one game, add additional
125 images named like `theme.$n.ogg`, with an ascending number $n starting
126 with 1 (max 10), and a random music file will be chosen from the provided ones.
134 Paths are relative to the directories listed in the [Paths] section above.
136 * `games/<gameid>/mods/`
138 * `worlds/<worldname>/worldmods/`
143 It is possible to include a game in a world; in this case, no mods or
144 games are loaded or checked from anywhere else.
146 This is useful for e.g. adventure worlds and happens if the `<worldname>/game/`
149 Mods should then be placed in `<worldname>/game/mods/`.
154 Mods can be put in a subdirectory, if the parent directory, which otherwise
155 should be a mod, contains a file named `modpack.conf`.
156 The file is a key-value store of modpack details.
158 * `name`: The modpack name. Allows Minetest to determine the modpack name even
159 if the folder is wrongly named.
160 * `description`: Description of mod to be shown in the Mods tab of the main
162 * `author`: The author of the modpack. It only appears when downloaded from
164 * `release`: Ignore this: Should only ever be set by ContentDB, as it is an
165 internal ID used to track versions.
166 * `title`: A human-readable title to address the modpack.
168 Note: to support 0.4.x, please also create an empty modpack.txt file.
170 Mod directory structure
171 -----------------------
177 │ ├── settingtypes.txt
181 │ │ ├── modname_stuff.png
182 │ │ ├── modname_stuff_normal.png
183 │ │ ├── modname_something_else.png
184 │ │ ├── subfolder_foo
185 │ │ │ ├── modname_more_stuff.png
186 │ │ │ └── another_subfolder
187 │ │ └── bar_subfolder
196 The location of this directory can be fetched by using
197 `minetest.get_modpath(modname)`.
201 A `Settings` file that provides meta information about the mod.
203 * `name`: The mod name. Allows Minetest to determine the mod name even if the
204 folder is wrongly named.
205 * `description`: Description of mod to be shown in the Mods tab of the main
207 * `depends`: A comma separated list of dependencies. These are mods that must be
208 loaded before this mod.
209 * `optional_depends`: A comma separated list of optional dependencies.
210 Like a dependency, but no error if the mod doesn't exist.
211 * `author`: The author of the mod. It only appears when downloaded from
213 * `release`: Ignore this: Should only ever be set by ContentDB, as it is an
214 internal ID used to track versions.
215 * `title`: A human-readable title to address the mod.
217 Note: to support 0.4.x, please also provide depends.txt.
221 A screenshot shown in the mod manager within the main menu. It should
222 have an aspect ratio of 3:2 and a minimum size of 300×200 pixels.
226 **Deprecated:** you should use mod.conf instead.
228 This file is used if there are no dependencies in mod.conf.
230 List of mods that have to be loaded before loading this mod.
232 A single line contains a single modname.
234 Optional dependencies can be defined by appending a question mark
235 to a single modname. This means that if the specified mod
236 is missing, it does not prevent this mod from being loaded.
238 ### `description.txt`
240 **Deprecated:** you should use mod.conf instead.
242 This file is used if there is no description in mod.conf.
244 A file containing a description to be shown in the Mods tab of the main menu.
246 ### `settingtypes.txt`
248 The format is documented in `builtin/settingtypes.txt`.
249 It is parsed by the main menu settings dialogue to list mod-specific
250 settings in the "Mods" category.
254 The main Lua script. Running this script should register everything it
255 wants to register. Subsequent execution depends on minetest calling the
256 registered callbacks.
258 `minetest.settings` can be used to read custom or existing settings at load
259 time, if necessary. (See [`Settings`])
261 ### `textures`, `sounds`, `media`, `models`, `locale`
263 Media files (textures, sounds, whatever) that will be transferred to the
264 client and will be available for use by the mod and translation files for
265 the clients (see [Translations]).
267 It is suggested to use the folders for the purpose they are thought for,
268 eg. put textures into `textures`, translation files into `locale`,
269 models for entities or meshnodes into `models` et cetera.
271 These folders and subfolders can contain subfolders.
272 Subfolders with names starting with `_` or `.` are ignored.
273 If a subfolder contains a media file with the same name as a media file
274 in one of its parents, the parent's file is used.
276 Although it is discouraged, a mod can overwrite a media file of any mod that it
277 depends on by supplying a file with an equal name.
282 Registered names should generally be in this format:
286 `<whatever>` can have these characters:
290 This is to prevent conflicting names from corrupting maps and is
291 enforced by the mod loader.
293 Registered names can be overridden by prefixing the name with `:`. This can
294 be used for overriding the registrations of some other mod.
296 The `:` prefix can also be used for maintaining backwards compatibility.
300 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
301 So the name should be `experimental:tnt`.
303 Any mod can redefine `experimental:tnt` by using the name
307 when registering it. That mod is required to have `experimental` as a
316 Aliases of itemnames can be added by using
317 `minetest.register_alias(alias, original_name)` or
318 `minetest.register_alias_force(alias, original_name)`.
320 This adds an alias `alias` for the item called `original_name`.
321 From now on, you can use `alias` to refer to the item `original_name`.
323 The only difference between `minetest.register_alias` and
324 `minetest.register_alias_force` is that if an item named `alias` already exists,
325 `minetest.register_alias` will do nothing while
326 `minetest.register_alias_force` will unregister it.
328 This can be used for maintaining backwards compatibility.
330 This can also set quick access names for things, e.g. if
331 you have an item called `epiclylongmodname:stuff`, you could do
333 minetest.register_alias("stuff", "epiclylongmodname:stuff")
335 and be able to use `/giveme stuff`.
340 In a game, a certain number of these must be set to tell core mapgens which
341 of the game's nodes are to be used for core mapgen generation. For example:
343 minetest.register_alias("mapgen_stone", "default:stone")
345 ### Aliases for non-V6 mapgens
347 #### Essential aliases
350 * mapgen_water_source
351 * mapgen_river_water_source
353 `mapgen_river_water_source` is required for mapgens with sloping rivers where
354 it is necessary to have a river liquid node with a short `liquid_range` and
355 `liquid_renewable = false` to avoid flooding.
357 #### Optional aliases
361 Fallback lava node used if cave liquids are not defined in biome definitions.
362 Deprecated for non-V6 mapgens, define cave liquids in biome definitions instead.
366 Fallback node used if dungeon nodes are not defined in biome definitions.
367 Deprecated for non-V6 mapgens, define dungeon nodes in biome definitions instead.
369 ### Aliases needed for Mapgen V6
372 * mapgen_water_source
375 * mapgen_dirt_with_grass
378 * mapgen_desert_stone
380 * mapgen_dirt_with_snow
389 * mapgen_jungleleaves
392 * mapgen_pine_needles
395 * mapgen_stair_cobble
397 * mapgen_stair_desert_stone
399 ### Setting the node used in Mapgen Singlenode
401 By default the world is filled with air nodes. To set a different node use, for
404 minetest.register_alias("mapgen_singlenode", "default:stone")
412 Mods should generally prefix their textures with `modname_`, e.g. given
413 the mod name `foomod`, a texture could be called:
417 Textures are referred to by their complete name, or alternatively by
418 stripping out the file extension:
420 * e.g. `foomod_foothing.png`
421 * e.g. `foomod_foothing`
427 There are various texture modifiers that can be used
428 to let the client generate textures on-the-fly.
429 The modifiers are applied directly in sRGB colorspace,
430 i.e. without gamma-correction.
432 ### Texture overlaying
434 Textures can be overlaid by putting a `^` between them.
438 default_dirt.png^default_grass_side.png
440 `default_grass_side.png` is overlaid over `default_dirt.png`.
441 The texture with the lower resolution will be automatically upscaled to
442 the higher resolution texture.
446 Textures can be grouped together by enclosing them in `(` and `)`.
448 Example: `cobble.png^(thing1.png^thing2.png)`
450 A texture for `thing1.png^thing2.png` is created and the resulting
451 texture is overlaid on top of `cobble.png`.
455 Modifiers that accept texture names (e.g. `[combine`) accept escaping to allow
456 passing complex texture names as arguments. Escaping is done with backslash and
457 is required for `^` and `:`.
459 Example: `cobble.png^[lowpart:50:color.png\^[mask\:trans.png`
461 The lower 50 percent of `color.png^[mask:trans.png` are overlaid
462 on top of `cobble.png`.
464 ### Advanced texture modifiers
470 * `[crack:<t>:<n>:<p>`
471 * `[cracko:<t>:<n>:<p>`
475 * `<t>`: tile count (in each direction)
476 * `<n>`: animation frame count
477 * `<p>`: current animation frame
479 Draw a step of the crack animation on the texture.
480 `crack` draws it normally, while `cracko` lays it over, keeping transparent
485 default_cobble.png^[crack:10:1
487 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
493 * `<file>`: texture to combine
495 Creates a texture of size `<w>` times `<h>` and blits the listed files to their
496 specified coordinates.
500 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
502 #### `[resize:<w>x<h>`
504 Resizes the texture to the given dimensions.
508 default_sandstone.png^[resize:16x16
512 Makes the base image transparent according to the given ratio.
514 `r` must be between 0 (transparent) and 255 (opaque).
518 default_sandstone.png^[opacity:127
520 #### `[invert:<mode>`
522 Inverts the given channels of the base image.
523 Mode may contain the characters "r", "g", "b", "a".
524 Only the channels that are mentioned in the mode string will be inverted.
528 default_apple.png^[invert:rgb
532 Brightens the texture.
536 tnt_tnt_side.png^[brighten
540 Makes the texture completely opaque.
544 default_leaves.png^[noalpha
546 #### `[makealpha:<r>,<g>,<b>`
548 Convert one color to transparency.
552 default_cobble.png^[makealpha:128,128,128
556 * `<t>`: transformation(s) to apply
558 Rotates and/or flips the image.
560 `<t>` can be a number (between 0 and 7) or a transform name.
561 Rotations are counter-clockwise.
564 1 R90 rotate by 90 degrees
565 2 R180 rotate by 180 degrees
566 3 R270 rotate by 270 degrees
568 5 FXR90 flip X then rotate by 90 degrees
570 7 FYR90 flip Y then rotate by 90 degrees
574 default_stone.png^[transformFXR90
576 #### `[inventorycube{<top>{<left>{<right>`
578 Escaping does not apply here and `^` is replaced by `&` in texture names
581 Create an inventory cube texture using the side textures.
585 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
587 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
588 `dirt.png^grass_side.png` textures
590 #### `[lowpart:<percent>:<file>`
592 Blit the lower `<percent>`% part of `<file>` on the texture.
596 base.png^[lowpart:25:overlay.png
598 #### `[verticalframe:<t>:<n>`
600 * `<t>`: animation frame count
601 * `<n>`: current animation frame
603 Crops the texture to a frame of a vertical animation.
607 default_torch_animated.png^[verticalframe:16:8
611 Apply a mask to the base image.
613 The mask is applied using binary AND.
615 #### `[sheet:<w>x<h>:<x>,<y>`
617 Retrieves a tile at position x,y from the base image
618 which it assumes to be a tilesheet with dimensions w,h.
620 #### `[colorize:<color>:<ratio>`
622 Colorize the textures with the given color.
623 `<color>` is specified as a `ColorString`.
624 `<ratio>` is an int ranging from 0 to 255 or the word "`alpha`". If
625 it is an int, then it specifies how far to interpolate between the
626 colors where 0 is only the texture color and 255 is only `<color>`. If
627 omitted, the alpha of `<color>` will be used as the ratio. If it is
628 the word "`alpha`", then each texture pixel will contain the RGB of
629 `<color>` and the alpha of `<color>` multiplied by the alpha of the
632 #### `[multiply:<color>`
634 Multiplies texture colors with the given color.
635 `<color>` is specified as a `ColorString`.
636 Result is more like what you'd expect if you put a color on top of another
637 color, meaning white surfaces get a lot of your new color while black parts
638 don't change very much.
642 Embed a base64 encoded PNG image in the texture string.
643 You can produce a valid string for this by calling
644 `minetest.encode_base64(minetest.encode_png(tex))`,
645 refer to the documentation of these functions for details.
646 You can use this to send disposable images such as captchas
647 to individual clients, or render things that would be too
648 expensive to compose with `[combine:`.
650 IMPORTANT: Avoid sending large images this way.
651 This is not a replacement for asset files, do not use it to do anything
652 that you could instead achieve by just using a file.
653 In particular consider `minetest.dynamic_add_media` and test whether
654 using other texture modifiers could result in a shorter string than
655 embedding a whole image, this may vary by use case.
660 The goal of hardware coloring is to simplify the creation of
661 colorful nodes. If your textures use the same pattern, and they only
662 differ in their color (like colored wool blocks), you can use hardware
663 coloring instead of creating and managing many texture files.
664 All of these methods use color multiplication (so a white-black texture
665 with red coloring will result in red-black color).
669 This method is useful if you wish to create nodes/items with
670 the same texture, in different colors, each in a new node/item definition.
674 When you register an item or node, set its `color` field (which accepts a
675 `ColorSpec`) to the desired color.
677 An `ItemStack`'s static color can be overwritten by the `color` metadata
678 field. If you set that field to a `ColorString`, that color will be used.
682 Each tile may have an individual static color, which overwrites every
683 other coloring method. To disable the coloring of a face,
684 set its color to white (because multiplying with white does nothing).
685 You can set the `color` property of the tiles in the node's definition
686 if the tile is in table format.
690 For nodes and items which can have many colors, a palette is more
691 suitable. A palette is a texture, which can contain up to 256 pixels.
692 Each pixel is one possible color for the node/item.
693 You can register one node/item, which can have up to 256 colors.
695 #### Palette indexing
697 When using palettes, you always provide a pixel index for the given
698 node or `ItemStack`. The palette is read from left to right and from
699 top to bottom. If the palette has less than 256 pixels, then it is
700 stretched to contain exactly 256 pixels (after arranging the pixels
701 to one line). The indexing starts from 0.
705 * 16x16 palette, index = 0: the top left corner
706 * 16x16 palette, index = 4: the fifth pixel in the first row
707 * 16x16 palette, index = 16: the pixel below the top left corner
708 * 16x16 palette, index = 255: the bottom right corner
709 * 2 (width) x 4 (height) palette, index = 31: the top left corner.
710 The palette has 8 pixels, so each pixel is stretched to 32 pixels,
711 to ensure the total 256 pixels.
712 * 2x4 palette, index = 32: the top right corner
713 * 2x4 palette, index = 63: the top right corner
714 * 2x4 palette, index = 64: the pixel below the top left corner
716 #### Using palettes with items
718 When registering an item, set the item definition's `palette` field to
719 a texture. You can also use texture modifiers.
721 The `ItemStack`'s color depends on the `palette_index` field of the
722 stack's metadata. `palette_index` is an integer, which specifies the
723 index of the pixel to use.
725 #### Linking palettes with nodes
727 When registering a node, set the item definition's `palette` field to
728 a texture. You can also use texture modifiers.
729 The node's color depends on its `param2`, so you also must set an
730 appropriate `paramtype2`:
732 * `paramtype2 = "color"` for nodes which use their full `param2` for
733 palette indexing. These nodes can have 256 different colors.
734 The palette should contain 256 pixels.
735 * `paramtype2 = "colorwallmounted"` for nodes which use the first
736 five bits (most significant) of `param2` for palette indexing.
737 The remaining three bits are describing rotation, as in `wallmounted`
738 paramtype2. Division by 8 yields the palette index (without stretching the
739 palette). These nodes can have 32 different colors, and the palette
740 should contain 32 pixels.
742 * `param2 = 17` is 2 * 8 + 1, so the rotation is 1 and the third (= 2 + 1)
743 pixel will be picked from the palette.
744 * `param2 = 35` is 4 * 8 + 3, so the rotation is 3 and the fifth (= 4 + 1)
745 pixel will be picked from the palette.
746 * `paramtype2 = "colorfacedir"` for nodes which use the first
747 three bits of `param2` for palette indexing. The remaining
748 five bits are describing rotation, as in `facedir` paramtype2.
749 Division by 32 yields the palette index (without stretching the
750 palette). These nodes can have 8 different colors, and the
751 palette should contain 8 pixels.
753 * `param2 = 17` is 0 * 32 + 17, so the rotation is 17 and the
754 first (= 0 + 1) pixel will be picked from the palette.
755 * `param2 = 35` is 1 * 32 + 3, so the rotation is 3 and the
756 second (= 1 + 1) pixel will be picked from the palette.
758 To colorize a node on the map, set its `param2` value (according
759 to the node's paramtype2).
761 ### Conversion between nodes in the inventory and on the map
763 Static coloring is the same for both cases, there is no need
766 If the `ItemStack`'s metadata contains the `color` field, it will be
767 lost on placement, because nodes on the map can only use palettes.
769 If the `ItemStack`'s metadata contains the `palette_index` field, it is
770 automatically transferred between node and item forms by the engine,
771 when a player digs or places a colored node.
772 You can disable this feature by setting the `drop` field of the node
773 to itself (without metadata).
774 To transfer the color to a special drop, you need a drop table.
778 minetest.register_node("mod:stone", {
779 description = "Stone",
780 tiles = {"default_stone.png"},
781 paramtype2 = "color",
782 palette = "palette.png",
785 -- assume that mod:cobblestone also has the same palette
786 {items = {"mod:cobblestone"}, inherit_color = true },
791 ### Colored items in craft recipes
793 Craft recipes only support item strings, but fortunately item strings
794 can also contain metadata. Example craft recipe registration:
796 minetest.register_craft({
797 output = minetest.itemstring_with_palette("wool:block", 3),
805 To set the `color` field, you can use `minetest.itemstring_with_color`.
807 Metadata field filtering in the `recipe` field are not supported yet,
808 so the craft output is independent of the color of the ingredients.
813 Sometimes hardware coloring is not enough, because it affects the
814 whole tile. Soft texture overlays were added to Minetest to allow
815 the dynamic coloring of only specific parts of the node's texture.
816 For example a grass block may have colored grass, while keeping the
819 These overlays are 'soft', because unlike texture modifiers, the layers
820 are not merged in the memory, but they are simply drawn on top of each
821 other. This allows different hardware coloring, but also means that
822 tiles with overlays are drawn slower. Using too much overlays might
825 For inventory and wield images you can specify overlays which
826 hardware coloring does not modify. You have to set `inventory_overlay`
827 and `wield_overlay` fields to an image name.
829 To define a node overlay, simply set the `overlay_tiles` field of the node
830 definition. These tiles are defined in the same way as plain tiles:
831 they can have a texture name, color etc.
832 To skip one face, set that overlay tile to an empty string.
834 Example (colored grass block):
836 minetest.register_node("default:dirt_with_grass", {
837 description = "Dirt with Grass",
838 -- Regular tiles, as usual
839 -- The dirt tile disables palette coloring
840 tiles = {{name = "default_grass.png"},
841 {name = "default_dirt.png", color = "white"}},
842 -- Overlay tiles: define them in the same style
843 -- The top and bottom tile does not have overlay
844 overlay_tiles = {"", "",
845 {name = "default_grass_side.png"}},
846 -- Global color, used in inventory
848 -- Palette in the world
849 paramtype2 = "color",
850 palette = "default_foilage.png",
859 Only Ogg Vorbis files are supported.
861 For positional playing of sounds, only single-channel (mono) files are
862 supported. Otherwise OpenAL will play them non-positionally.
864 Mods should generally prefix their sounds with `modname_`, e.g. given
865 the mod name "`foomod`", a sound could be called:
869 Sounds are referred to by their name with a dot, a single digit and the
870 file extension stripped out. When a sound is played, the actual sound file
871 is chosen randomly from the matching sounds.
873 When playing the sound `foomod_foosound`, the sound is chosen randomly
874 from the available ones of the following files:
876 * `foomod_foosound.ogg`
877 * `foomod_foosound.0.ogg`
878 * `foomod_foosound.1.ogg`
880 * `foomod_foosound.9.ogg`
882 Examples of sound parameter tables:
884 -- Play locationless on all clients
886 gain = 1.0, -- default
887 fade = 0.0, -- default, change to a value > 0 to fade the sound in
888 pitch = 1.0, -- default
890 -- Play locationless to one player
893 gain = 1.0, -- default
894 fade = 0.0, -- default, change to a value > 0 to fade the sound in
895 pitch = 1.0, -- default
897 -- Play locationless to one player, looped
900 gain = 1.0, -- default
903 -- Play at a location
905 pos = {x = 1, y = 2, z = 3},
906 gain = 1.0, -- default
907 max_hear_distance = 32, -- default, uses an euclidean metric
909 -- Play connected to an object, looped
911 object = <an ObjectRef>,
912 gain = 1.0, -- default
913 max_hear_distance = 32, -- default, uses an euclidean metric
916 -- Play at a location, heard by anyone *but* the given player
918 pos = {x = 32, y = 0, z = 100},
919 max_hear_distance = 40,
920 exclude_player = name,
923 Looped sounds must either be connected to an object or played locationless to
924 one player using `to_player = name`.
926 A positional sound will only be heard by players that are within
927 `max_hear_distance` of the sound position, at the start of the sound.
929 `exclude_player = name` can be applied to locationless, positional and object-
930 bound sounds to exclude a single player from hearing them.
935 Specifies a sound name, gain (=volume) and pitch.
936 This is either a string or a table.
938 In string form, you just specify the sound name or
939 the empty string for no sound.
941 Table form has the following fields:
944 * `gain`: Volume (`1.0` = 100%)
945 * `pitch`: Pitch (`1.0` = 100%)
947 `gain` and `pitch` are optional and default to `1.0`.
953 * `"default_place_node"`: Play e.g. `default_place_node.ogg`
954 * `{name = "default_place_node"}`: Same as above
955 * `{name = "default_place_node", gain = 0.5}`: 50% volume
956 * `{name = "default_place_node", gain = 0.9, pitch = 1.1}`: 90% volume, 110% pitch
961 These sound files are played back by the engine if provided.
963 * `player_damage`: Played when the local player takes damage (gain = 0.5)
964 * `player_falling_damage`: Played when the local player takes
965 damage by falling (gain = 0.5)
966 * `player_jump`: Played when the local player jumps
967 * `default_dig_<groupname>`: Default node digging sound
968 (see node sound definition for details)
970 Registered definitions
971 ======================
973 Anything added using certain [Registration functions] gets added to one or more
974 of the global [Registered definition tables].
976 Note that in some cases you will stumble upon things that are not contained
977 in these tables (e.g. when a mod has been removed). Always check for
978 existence before trying to access the fields.
982 All nodes register with `minetest.register_node` get added to the table
983 `minetest.registered_nodes`.
985 If you want to check the drawtype of a node, you could do:
987 local function get_nodedef_field(nodename, fieldname)
988 if not minetest.registered_nodes[nodename] then
991 return minetest.registered_nodes[nodename][fieldname]
993 local drawtype = get_nodedef_field(nodename, "drawtype")
1001 Nodes are the bulk data of the world: cubes and other things that take the
1002 space of a cube. Huge amounts of them are handled efficiently, but they
1005 The definition of a node is stored and can be accessed by using
1007 minetest.registered_nodes[node.name]
1009 See [Registered definitions].
1011 Nodes are passed by value between Lua and the engine.
1012 They are represented by a table:
1014 {name="name", param1=num, param2=num}
1016 `param1` and `param2` are 8-bit integers ranging from 0 to 255. The engine uses
1017 them for certain automated functions. If you don't use these functions, you can
1018 use them to store arbitrary values.
1023 The functions of `param1` and `param2` are determined by certain fields in the
1026 The function of `param1` is determined by `paramtype` in node definition.
1027 `param1` is reserved for the engine when `paramtype != "none"`.
1029 * `paramtype = "light"`
1030 * The value stores light with and without sun in its lower and upper 4 bits
1032 * Required by a light source node to enable spreading its light.
1033 * Required by the following drawtypes as they determine their visual
1034 brightness from their internal light value:
1044 * `paramtype = "none"`
1045 * `param1` will not be used by the engine and can be used to store
1048 The function of `param2` is determined by `paramtype2` in node definition.
1049 `param2` is reserved for the engine when `paramtype2 != "none"`.
1051 * `paramtype2 = "flowingliquid"`
1052 * Used by `drawtype = "flowingliquid"` and `liquidtype = "flowing"`
1053 * The liquid level and a flag of the liquid are stored in `param2`
1054 * Bits 0-2: Liquid level (0-7). The higher, the more liquid is in this node;
1055 see `minetest.get_node_level`, `minetest.set_node_level` and `minetest.add_node_level`
1056 to access/manipulate the content of this field
1057 * Bit 3: If set, liquid is flowing downwards (no graphical effect)
1058 * `paramtype2 = "wallmounted"`
1059 * Supported drawtypes: "torchlike", "signlike", "plantlike",
1060 "plantlike_rooted", "normal", "nodebox", "mesh"
1061 * The rotation of the node is stored in `param2`
1062 * You can make this value by using `minetest.dir_to_wallmounted()`
1063 * Values range 0 - 5
1064 * The value denotes at which direction the node is "mounted":
1065 0 = y+, 1 = y-, 2 = x+, 3 = x-, 4 = z+, 5 = z-
1066 * `paramtype2 = "facedir"`
1067 * Supported drawtypes: "normal", "nodebox", "mesh"
1068 * The rotation of the node is stored in `param2`. Furnaces and chests are
1069 rotated this way. Can be made by using `minetest.dir_to_facedir()`.
1070 * Values range 0 - 23
1071 * facedir / 4 = axis direction:
1072 0 = y+, 1 = z+, 2 = z-, 3 = x+, 4 = x-, 5 = y-
1073 * facedir modulo 4 = rotation around that axis
1074 * `paramtype2 = "leveled"`
1075 * Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
1077 * The level of the top face of the nodebox is stored in `param2`.
1078 * The other faces are defined by 'fixed = {}' like 'type = "fixed"'
1080 * The nodebox height is (`param2` / 64) nodes.
1081 * The maximum accepted value of `param2` is 127.
1083 * The height of the 'plantlike' section is stored in `param2`.
1084 * The height is (`param2` / 16) nodes.
1085 * `paramtype2 = "degrotate"`
1086 * Valid for `plantlike` and `mesh` drawtypes. The rotation of the node is
1088 * Values range 0–239. The value stored in `param2` is multiplied by 1.5 to
1089 get the actual rotation in degrees of the node.
1090 * `paramtype2 = "meshoptions"`
1091 * Only valid for "plantlike" drawtype. `param2` encodes the shape and
1092 optional modifiers of the "plant". `param2` is a bitfield.
1093 * Bits 0 to 2 select the shape.
1094 Use only one of the values below:
1095 * 0 = a "x" shaped plant (ordinary plant)
1096 * 1 = a "+" shaped plant (just rotated 45 degrees)
1097 * 2 = a "*" shaped plant with 3 faces instead of 2
1098 * 3 = a "#" shaped plant with 4 faces instead of 2
1099 * 4 = a "#" shaped plant with 4 faces that lean outwards
1100 * 5-7 are unused and reserved for future meshes.
1101 * Bits 3 to 7 are used to enable any number of optional modifiers.
1102 Just add the corresponding value(s) below to `param2`:
1103 * 8 - Makes the plant slightly vary placement horizontally
1104 * 16 - Makes the plant mesh 1.4x larger
1105 * 32 - Moves each face randomly a small bit down (1/8 max)
1106 * values 64 and 128 (bits 6-7) are reserved for future use.
1107 * Example: `param2 = 0` selects a normal "x" shaped plant
1108 * Example: `param2 = 17` selects a "+" shaped plant, 1.4x larger (1+16)
1109 * `paramtype2 = "color"`
1110 * `param2` tells which color is picked from the palette.
1111 The palette should have 256 pixels.
1112 * `paramtype2 = "colorfacedir"`
1113 * Same as `facedir`, but with colors.
1114 * The first three bits of `param2` tells which color is picked from the
1115 palette. The palette should have 8 pixels.
1116 * `paramtype2 = "colorwallmounted"`
1117 * Same as `wallmounted`, but with colors.
1118 * The first five bits of `param2` tells which color is picked from the
1119 palette. The palette should have 32 pixels.
1120 * `paramtype2 = "glasslikeliquidlevel"`
1121 * Only valid for "glasslike_framed" or "glasslike_framed_optional"
1122 drawtypes. "glasslike_framed_optional" nodes are only affected if the
1123 "Connected Glass" setting is enabled.
1124 * Bits 0-5 define 64 levels of internal liquid, 0 being empty and 63 being
1126 * Bits 6 and 7 modify the appearance of the frame and node faces. One or
1127 both of these values may be added to `param2`:
1128 * 64 - Makes the node not connect with neighbors above or below it.
1129 * 128 - Makes the node not connect with neighbors to its sides.
1130 * Liquid texture is defined using `special_tiles = {"modname_tilename.png"}`
1131 * `paramtype2 = "colordegrotate"`
1132 * Same as `degrotate`, but with colors.
1133 * The first (most-significant) three bits of `param2` tells which color
1134 is picked from the palette. The palette should have 8 pixels.
1135 * Remaining 5 bits store rotation in range 0–23 (i.e. in 15° steps)
1136 * `paramtype2 = "none"`
1137 * `param2` will not be used by the engine and can be used to store
1140 Nodes can also contain extra data. See [Node Metadata].
1145 There are a bunch of different looking node types.
1147 Look for examples in `games/devtest` or `games/minetest_game`.
1150 * A node-sized cube.
1152 * Invisible, uses no texture.
1154 * The cubic source node for a liquid.
1155 * Faces bordering to the same node are never rendered.
1156 * Connects to node specified in `liquid_alternative_flowing`.
1157 * Use `backface_culling = false` for the tiles you want to make
1158 visible when inside the node.
1160 * The flowing version of a liquid, appears with various heights and slopes.
1161 * Faces bordering to the same node are never rendered.
1162 * Connects to node specified in `liquid_alternative_source`.
1163 * Node textures are defined with `special_tiles` where the first tile
1164 is for the top and bottom faces and the second tile is for the side
1166 * `tiles` is used for the item/inventory/wield image rendering.
1167 * Use `backface_culling = false` for the special tiles you want to make
1168 visible when inside the node
1170 * Often used for partially-transparent nodes.
1171 * Only external sides of textures are visible.
1172 * `glasslike_framed`
1173 * All face-connected nodes are drawn as one volume within a surrounding
1175 * The frame appearance is generated from the edges of the first texture
1176 specified in `tiles`. The width of the edges used are 1/16th of texture
1177 size: 1 pixel for 16x16, 2 pixels for 32x32 etc.
1178 * The glass 'shine' (or other desired detail) on each node face is supplied
1179 by the second texture specified in `tiles`.
1180 * `glasslike_framed_optional`
1181 * This switches between the above 2 drawtypes according to the menu setting
1184 * Often used for partially-transparent nodes.
1185 * External and internal sides of textures are visible.
1186 * `allfaces_optional`
1187 * Often used for leaves nodes.
1188 * This switches between `normal`, `glasslike` and `allfaces` according to
1189 the menu setting: Opaque Leaves / Simple Leaves / Fancy Leaves.
1190 * With 'Simple Leaves' selected, the texture specified in `special_tiles`
1191 is used instead, if present. This allows a visually thicker texture to be
1192 used to compensate for how `glasslike` reduces visual thickness.
1194 * A single vertical texture.
1195 * If `paramtype2="[color]wallmounted":
1196 * If placed on top of a node, uses the first texture specified in `tiles`.
1197 * If placed against the underside of a node, uses the second texture
1198 specified in `tiles`.
1199 * If placed on the side of a node, uses the third texture specified in
1200 `tiles` and is perpendicular to that node.
1201 * If `paramtype2="none"`:
1202 * Will be rendered as if placed on top of a node (see
1203 above) and only the first texture is used.
1205 * A single texture parallel to, and mounted against, the top, underside or
1207 * If `paramtype2="[color]wallmounted", it rotates according to `param2`
1208 * If `paramtype2="none"`, it will always be on the floor.
1210 * Two vertical and diagonal textures at right-angles to each other.
1211 * See `paramtype2 = "meshoptions"` above for other options.
1213 * When above a flat surface, appears as 6 textures, the central 2 as
1214 `plantlike` plus 4 more surrounding those.
1215 * If not above a surface the central 2 do not appear, but the texture
1216 appears against the faces of surrounding nodes if they are present.
1218 * A 3D model suitable for a wooden fence.
1219 * One placed node appears as a single vertical post.
1220 * Adjacently-placed nodes cause horizontal bars to appear between them.
1222 * Often used for tracks for mining carts.
1223 * Requires 4 textures to be specified in `tiles`, in order: Straight,
1224 curved, t-junction, crossing.
1225 * Each placed node automatically switches to a suitable rotated texture
1226 determined by the adjacent `raillike` nodes, in order to create a
1227 continuous track network.
1228 * Becomes a sloping node if placed against stepped nodes.
1230 * Often used for stairs and slabs.
1231 * Allows defining nodes consisting of an arbitrary number of boxes.
1232 * See [Node boxes] below for more information.
1234 * Uses models for nodes.
1235 * Tiles should hold model materials textures.
1236 * Only static meshes are implemented.
1237 * For supported model formats see Irrlicht engine documentation.
1238 * `plantlike_rooted`
1239 * Enables underwater `plantlike` without air bubbles around the nodes.
1240 * Consists of a base cube at the co-ordinates of the node plus a
1241 `plantlike` extension above
1242 * If `paramtype2="leveled", the `plantlike` extension has a height
1243 of `param2 / 16` nodes, otherwise it's the height of 1 node
1244 * If `paramtype2="wallmounted"`, the `plantlike` extension
1245 will be at one of the corresponding 6 sides of the base cube.
1246 Also, the base cube rotates like a `normal` cube would
1247 * The `plantlike` extension visually passes through any nodes above the
1248 base cube without affecting them.
1249 * The base cube texture tiles are defined as normal, the `plantlike`
1250 extension uses the defined special tile, for example:
1251 `special_tiles = {{name = "default_papyrus.png"}},`
1253 `*_optional` drawtypes need less rendering time if deactivated
1254 (always client-side).
1259 Node selection boxes are defined using "node boxes".
1261 A nodebox is defined as any of:
1264 -- A normal cube; the default in most things
1268 -- A fixed box (or boxes) (facedir param2 is used, if applicable)
1270 fixed = box OR {box1, box2, ...}
1273 -- A variable height box (or boxes) with the top face position defined
1274 -- by the node parameter 'leveled = ', or if 'paramtype2 == "leveled"'
1276 -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
1278 fixed = box OR {box1, box2, ...}
1281 -- A box like the selection box for torches
1282 -- (wallmounted param2 is used, if applicable)
1283 type = "wallmounted",
1289 -- A node that has optional boxes depending on neighbouring nodes'
1290 -- presence and type. See also `connects_to`.
1292 fixed = box OR {box1, box2, ...}
1293 connect_top = box OR {box1, box2, ...}
1294 connect_bottom = box OR {box1, box2, ...}
1295 connect_front = box OR {box1, box2, ...}
1296 connect_left = box OR {box1, box2, ...}
1297 connect_back = box OR {box1, box2, ...}
1298 connect_right = box OR {box1, box2, ...}
1299 -- The following `disconnected_*` boxes are the opposites of the
1300 -- `connect_*` ones above, i.e. when a node has no suitable neighbour
1301 -- on the respective side, the corresponding disconnected box is drawn.
1302 disconnected_top = box OR {box1, box2, ...}
1303 disconnected_bottom = box OR {box1, box2, ...}
1304 disconnected_front = box OR {box1, box2, ...}
1305 disconnected_left = box OR {box1, box2, ...}
1306 disconnected_back = box OR {box1, box2, ...}
1307 disconnected_right = box OR {box1, box2, ...}
1308 disconnected = box OR {box1, box2, ...} -- when there is *no* neighbour
1309 disconnected_sides = box OR {box1, box2, ...} -- when there are *no*
1310 -- neighbours to the sides
1313 A `box` is defined as:
1315 {x1, y1, z1, x2, y2, z2}
1317 A box of a regular node would look like:
1319 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
1321 To avoid collision issues, keep each value within the range of +/- 1.45.
1322 This also applies to leveled nodeboxes, where the final height shall not
1323 exceed this soft limit.
1327 Map terminology and coordinates
1328 ===============================
1330 Nodes, mapblocks, mapchunks
1331 ---------------------------
1333 A 'node' is the fundamental cubic unit of a world and appears to a player as
1334 roughly 1x1x1 meters in size.
1336 A 'mapblock' (often abbreviated to 'block') is 16x16x16 nodes and is the
1337 fundamental region of a world that is stored in the world database, sent to
1338 clients and handled by many parts of the engine.
1339 'mapblock' is preferred terminology to 'block' to help avoid confusion with
1340 'node', however 'block' often appears in the API.
1342 A 'mapchunk' (sometimes abbreviated to 'chunk') is usually 5x5x5 mapblocks
1343 (80x80x80 nodes) and is the volume of world generated in one operation by
1345 The size in mapblocks has been chosen to optimise map generation.
1350 ### Orientation of axes
1352 For node and mapblock coordinates, +X is East, +Y is up, +Z is North.
1354 ### Node coordinates
1356 Almost all positions used in the API use node coordinates.
1358 ### Mapblock coordinates
1360 Occasionally the API uses 'blockpos' which refers to mapblock coordinates that
1361 specify a particular mapblock.
1362 For example blockpos (0,0,0) specifies the mapblock that extends from
1363 node position (0,0,0) to node position (15,15,15).
1365 #### Converting node position to the containing blockpos
1367 To calculate the blockpos of the mapblock that contains the node at 'nodepos',
1370 * blockpos = math.floor(nodepos / 16)
1372 #### Converting blockpos to min/max node positions
1374 To calculate the min/max node positions contained in the mapblock at 'blockpos',
1378 nodepos = blockpos * 16
1380 nodepos = blockpos * 16 + 15
1391 The position field is used for all element types.
1393 To account for differing resolutions, the position coordinates are the
1394 percentage of the screen, ranging in value from `0` to `1`.
1396 The name field is not yet used, but should contain a description of what the
1397 HUD element represents.
1399 The `direction` field is the direction in which something is drawn.
1400 `0` draws from left to right, `1` draws from right to left, `2` draws from
1401 top to bottom, and `3` draws from bottom to top.
1403 The `alignment` field specifies how the item will be aligned. It is a table
1404 where `x` and `y` range from `-1` to `1`, with `0` being central. `-1` is
1405 moved to the left/up, and `1` is to the right/down. Fractional values can be
1408 The `offset` field specifies a pixel offset from the position. Contrary to
1409 position, the offset is not scaled to screen size. This allows for some
1410 precisely positioned items in the HUD.
1412 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
1415 The `z_index` field specifies the order of HUD elements from back to front.
1416 Lower z-index elements are displayed behind higher z-index elements. Elements
1417 with same z-index are displayed in an arbitrary order. Default 0.
1418 Supports negative values. By convention, the following values are recommended:
1420 * -400: Graphical effects, such as vignette
1421 * -300: Name tags, waypoints
1423 * -100: Things that block the player's view, e.g. masks
1424 * 0: Default. For standard in-game HUD elements like crosshair, hotbar,
1425 minimap, builtin statbars, etc.
1426 * 100: Temporary text messages or notification icons
1427 * 1000: Full-screen effects such as full-black screen or credits.
1428 This includes effects that cover the entire screen
1429 * Other: If your HUD element doesn't fit into any category, pick a number
1430 between the suggested values
1434 Below are the specific uses for fields in each type; fields not listed for that
1439 Displays an image on the HUD.
1441 * `scale`: The scale of the image, with 1 being the original texture size.
1442 Only the X coordinate scale is used (positive values).
1443 Negative values represent that percentage of the screen it
1444 should take; e.g. `x=-100` means 100% (width).
1445 * `text`: The name of the texture that is displayed.
1446 * `alignment`: The alignment of the image.
1447 * `offset`: offset in pixels from position.
1451 Displays text on the HUD.
1453 * `scale`: Defines the bounding rectangle of the text.
1454 A value such as `{x=100, y=100}` should work.
1455 * `text`: The text to be displayed in the HUD element.
1456 * `number`: An integer containing the RGB value of the color used to draw the
1457 text. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1458 * `alignment`: The alignment of the text.
1459 * `offset`: offset in pixels from position.
1460 * `size`: size of the text.
1461 The player-set font size is multiplied by size.x (y value isn't used).
1465 Displays a horizontal bar made up of half-images with an optional background.
1467 * `text`: The name of the texture to use.
1468 * `text2`: Optional texture name to enable a background / "off state"
1469 texture (useful to visualize the maximal value). Both textures
1470 must have the same size.
1471 * `number`: The number of half-textures that are displayed.
1472 If odd, will end with a vertically center-split texture.
1473 * `item`: Same as `number` but for the "off state" texture
1474 * `direction`: To which direction the images will extend to
1475 * `offset`: offset in pixels from position.
1476 * `size`: If used, will force full-image size to this value (override texture
1481 * `text`: The name of the inventory list to be displayed.
1482 * `number`: Number of items in the inventory to be displayed.
1483 * `item`: Position of item that is selected.
1485 * `offset`: offset in pixels from position.
1489 Displays distance to selected world position.
1491 * `name`: The name of the waypoint.
1492 * `text`: Distance suffix. Can be blank.
1493 * `precision`: Waypoint precision, integer >= 0. Defaults to 10.
1494 If set to 0, distance is not shown. Shown value is `floor(distance*precision)/precision`.
1495 When the precision is an integer multiple of 10, there will be `log_10(precision)` digits after the decimal point.
1496 `precision = 1000`, for example, will show 3 decimal places (eg: `0.999`).
1497 `precision = 2` will show multiples of `0.5`; precision = 5 will show multiples of `0.2` and so on:
1498 `precision = n` will show multiples of `1/n`
1499 * `number:` An integer containing the RGB value of the color used to draw the
1501 * `world_pos`: World position of the waypoint.
1502 * `offset`: offset in pixels from position.
1503 * `alignment`: The alignment of the waypoint.
1505 ### `image_waypoint`
1507 Same as `image`, but does not accept a `position`; the position is instead determined by `world_pos`, the world position of the waypoint.
1509 * `scale`: The scale of the image, with 1 being the original texture size.
1510 Only the X coordinate scale is used (positive values).
1511 Negative values represent that percentage of the screen it
1512 should take; e.g. `x=-100` means 100% (width).
1513 * `text`: The name of the texture that is displayed.
1514 * `alignment`: The alignment of the image.
1515 * `world_pos`: World position of the waypoint.
1516 * `offset`: offset in pixels from position.
1520 Displays an image oriented or translated according to current heading direction.
1522 * `size`: The size of this element. Negative values represent percentage
1523 of the screen; e.g. `x=-100` means 100% (width).
1524 * `scale`: Scale of the translated image (used only for dir = 2 or dir = 3).
1525 * `text`: The name of the texture to use.
1526 * `alignment`: The alignment of the image.
1527 * `offset`: Offset in pixels from position.
1528 * `dir`: How the image is rotated/translated:
1529 * 0 - Rotate as heading direction
1530 * 1 - Rotate in reverse direction
1531 * 2 - Translate as landscape direction
1532 * 3 - Translate in reverse direction
1534 If translation is chosen, texture is repeated horizontally to fill the whole element.
1538 Displays a minimap on the HUD.
1540 * `size`: Size of the minimap to display. Minimap should be a square to avoid
1542 * `alignment`: The alignment of the minimap.
1543 * `offset`: offset in pixels from position.
1545 Representations of simple things
1546 ================================
1548 Vector (ie. a position)
1549 -----------------------
1553 See [Spatial Vectors] for details.
1558 * `{type="nothing"}`
1559 * `{type="node", under=pos, above=pos}`
1560 * Indicates a pointed node selection box.
1561 * `under` refers to the node position behind the pointed face.
1562 * `above` refers to the node position in front of the pointed face.
1563 * `{type="object", ref=ObjectRef}`
1565 Exact pointing location (currently only `Raycast` supports these fields):
1567 * `pointed_thing.intersection_point`: The absolute world coordinates of the
1568 point on the selection box which is pointed at. May be in the selection box
1569 if the pointer is in the box too.
1570 * `pointed_thing.box_id`: The ID of the pointed selection box (counting starts
1572 * `pointed_thing.intersection_normal`: Unit vector, points outwards of the
1573 selected selection box. This specifies which face is pointed at.
1574 Is a null vector `vector.zero()` when the pointer is inside the selection box.
1579 Flag Specifier Format
1580 =====================
1582 Flags using the standardized flag specifier format can be specified in either
1583 of two ways, by string or table.
1585 The string format is a comma-delimited set of flag names; whitespace and
1586 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1587 flag, and specifying a flag prefixed by the string `"no"` explicitly
1588 clears the flag from whatever the default may be.
1590 In addition to the standard string flag format, the schematic flags field can
1591 also be a table of flag names to boolean values representing whether or not the
1592 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1593 is present, mapped to a boolean of any value, the specified flag is unset.
1595 E.g. A flag field of value
1597 {place_center_x = true, place_center_y=false, place_center_z=true}
1601 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1603 which is equivalent to
1605 "place_center_x, noplace_center_y, place_center_z"
1609 "place_center_x, place_center_z"
1611 since, by default, no schematic attributes are set.
1619 Items are things that can be held by players, dropped in the map and
1620 stored in inventories.
1621 Items come in the form of item stacks, which are collections of equal
1622 items that occupy a single inventory slot.
1627 There are three kinds of items: nodes, tools and craftitems.
1629 * Node: Placeable item form of a node in the world's voxel grid
1630 * Tool: Has a changable wear property but cannot be stacked
1631 * Craftitem: Has no special properties
1633 Every registered node (the voxel in the world) has a corresponding
1634 item form (the thing in your inventory) that comes along with it.
1635 This item form can be placed which will create a node in the
1637 Both the 'actual' node and its item form share the same identifier.
1638 For all practical purposes, you can treat the node and its item form
1639 interchangeably. We usually just say 'node' to the item form of
1642 Note the definition of tools is purely technical. The only really
1643 unique thing about tools is their wear, and that's basically it.
1644 Beyond that, you can't make any gameplay-relevant assumptions
1645 about tools or non-tools. It is perfectly valid to register something
1646 that acts as tool in a gameplay sense as a craftitem, and vice-versa.
1648 Craftitems can be used for items that neither need to be a node
1654 All item stacks have an amount between 0 and 65535. It is 1 by
1655 default. Tool item stacks can not have an amount greater than 1.
1657 Tools use a wear (damage) value ranging from 0 to 65535. The
1658 value 0 is the default and is used for unworn tools. The values
1659 1 to 65535 are used for worn tools, where a higher value stands for
1660 a higher wear. Non-tools technically also have a wear property,
1661 but it is always 0. There is also a special 'toolrepair' crafting
1662 recipe that is only available to tools.
1667 Items and item stacks can exist in three formats: Serializes, table format
1670 When an item must be passed to a function, it can usually be in any of
1675 This is called "stackstring" or "itemstring". It is a simple string with
1676 1-3 components: the full item identifier, an optional amount and an optional
1679 <identifier> [<amount>[ <wear>]]
1683 * `"default:apple"`: 1 apple
1684 * `"default:dirt 5"`: 5 dirt
1685 * `"default:pick_stone"`: a new stone pickaxe
1686 * `"default:pick_wood 1 21323"`: a wooden pickaxe, ca. 1/3 worn out
1694 {name="default:dirt", count=5, wear=0, metadata=""}
1696 A wooden pick about 1/3 worn out:
1698 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1702 {name="default:apple", count=1, wear=0, metadata=""}
1706 A native C++ format with many helper methods. Useful for converting
1707 between formats. See the [Class reference] section for details.
1715 In a number of places, there is a group table. Groups define the
1716 properties of a thing (item, node, armor of entity, tool capabilities)
1717 in such a way that the engine and other mods can can interact with
1718 the thing without actually knowing what the thing is.
1723 Groups are stored in a table, having the group names with keys and the
1724 group ratings as values. Group ratings are integer values within the
1725 range [-32767, 32767]. For example:
1728 groups = {crumbly=3, soil=1}
1730 -- A more special dirt-kind of thing
1731 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1733 Groups always have a rating associated with them. If there is no
1734 useful meaning for a rating for an enabled group, it shall be `1`.
1736 When not defined, the rating of a group defaults to `0`. Thus when you
1737 read groups, you must interpret `nil` and `0` as the same value, `0`.
1739 You can read the rating of a group for an item or a node by using
1741 minetest.get_item_group(itemname, groupname)
1746 Groups of items can define what kind of an item it is (e.g. wool).
1751 In addition to the general item things, groups are used to define whether
1752 a node is destroyable and how long it takes to destroy by a tool.
1757 For entities, groups are, as of now, used only for calculating damage.
1758 The rating is the percentage of damage caused by items with this damage group.
1759 See [Entity damage mechanism].
1761 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1762 object.set_armor_groups({fleshy=30, cracky=80})
1764 Groups of tool capabilities
1765 ---------------------------
1767 Groups in tool capabilities define which groups of nodes and entities they
1768 are effective towards.
1770 Groups in crafting recipes
1771 --------------------------
1773 An example: Make meat soup from any meat, any water and any bowl:
1776 output = "food:meat_soup_raw",
1784 Another example: Make red wool from white wool and red dye:
1788 output = "wool:red",
1789 recipe = {"wool:white", "group:dye,basecolor_red"},
1795 The asterisk `(*)` after a group name describes that there is no engine
1796 functionality bound to it, and implementation is left up as a suggestion
1799 ### Node and item groups
1801 * `not_in_creative_inventory`: (*) Special group for inventory mods to indicate
1802 that the item should be hidden in item lists.
1805 ### Node-only groups
1807 * `attached_node`: if the node under it is not a walkable block the node will be
1808 dropped as an item. If the node is wallmounted the wallmounted direction is
1810 * `bouncy`: value is bounce speed in percent
1811 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1812 connect to each other
1813 * `dig_immediate`: Player can always pick up node without reducing tool wear
1814 * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
1815 * `3`: the node always gets the digging time 0 seconds (torch)
1816 * `disable_jump`: Player (and possibly other things) cannot jump from node
1817 or if their feet are in the node. Note: not supported for `new_move = false`
1818 * `fall_damage_add_percent`: modifies the fall damage suffered when hitting
1819 the top of this node. There's also an armor group with the same name.
1820 The final player damage is determined by the following formula:
1823 * ((node_fall_damage_add_percent + 100) / 100) -- node group
1824 * ((player_fall_damage_add_percent + 100) / 100) -- player armor group
1825 - (14) -- constant tolerance
1826 Negative damage values are discarded as no damage.
1827 * `falling_node`: if there is no walkable block under the node it will fall
1828 * `float`: the node will not fall through liquids (`liquidtype ~= "none"`)
1829 * `level`: Can be used to give an additional sense of progression in the game.
1830 * A larger level will cause e.g. a weapon of a lower level make much less
1831 damage, and get worn out much faster, or not be able to get drops
1832 from destroyed nodes.
1833 * `0` is something that is directly accessible at the start of gameplay
1834 * There is no upper limit
1835 * See also: `leveldiff` in [Tool Capabilities]
1836 * `slippery`: Players and items will slide on the node.
1837 Slipperiness rises steadily with `slippery` value, starting at 1.
1840 ### Tool-only groups
1842 * `disable_repair`: If set to 1 for a tool, it cannot be repaired using the
1843 `"toolrepair"` crafting recipe
1846 ### `ObjectRef` armor groups
1848 * `immortal`: Skips all damage and breath handling for an object. This group
1849 will also hide the integrated HUD status bars for players. It is
1850 automatically set to all players when damage is disabled on the server and
1851 cannot be reset (subject to change).
1852 * `fall_damage_add_percent`: Modifies the fall damage suffered by players
1853 when they hit the ground. It is analog to the node group with the same
1854 name. See the node group above for the exact calculation.
1855 * `punch_operable`: For entities; disables the regular damage mechanism for
1856 players punching it by hand or a non-tool item, so that it can do something
1857 else than take damage.
1861 Known damage and digging time defining groups
1862 ---------------------------------------------
1864 * `crumbly`: dirt, sand
1865 * `cracky`: tough but crackable stuff like stone.
1866 * `snappy`: something that can be cut using things like scissors, shears,
1867 bolt cutters and the like, e.g. leaves, small plants, wire, sheets of metal
1868 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1869 * `fleshy`: Living things like animals and the player. This could imply
1870 some blood effects when hitting.
1871 * `explody`: Especially prone to explosions
1872 * `oddly_breakable_by_hand`:
1873 Can be added to nodes that shouldn't logically be breakable by the
1874 hand but are. Somewhat similar to `dig_immediate`, but times are more
1875 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1876 digging speed of an item if it can dig at a faster speed than this
1877 suggests for the hand.
1879 Examples of custom groups
1880 -------------------------
1882 Item groups are often used for defining, well, _groups of items_.
1884 * `meat`: any meat-kind of a thing (rating might define the size or healing
1885 ability or be irrelevant -- it is not defined as of yet)
1886 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1888 * `flammable`: can be set on fire. Rating might define the intensity of the
1889 fire, affecting e.g. the speed of the spreading of an open fire.
1890 * `wool`: any wool (any origin, any color)
1891 * `metal`: any metal
1892 * `weapon`: any weapon
1893 * `heavy`: anything considerably heavy
1895 Digging time calculation specifics
1896 ----------------------------------
1898 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1899 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1900 faster digging time.
1902 The `level` group is used to limit the toughness of nodes an item capable
1903 of digging can dig and to scale the digging times / damage to a greater extent.
1905 **Please do understand this**, otherwise you cannot use the system to it's
1908 Items define their properties by a list of parameters for groups. They
1909 cannot dig other groups; thus it is important to use a standard bunch of
1910 groups to enable interaction with items.
1918 'Tool capabilities' is a property of items that defines two things:
1920 1) Which nodes it can dig and how fast
1921 2) Which objects it can hurt by punching and by how much
1923 Tool capabilities are available for all items, not just tools.
1924 But only tools can receive wear from digging and punching.
1926 Missing or incomplete tool capabilities will default to the
1929 Tool capabilities definition
1930 ----------------------------
1932 Tool capabilities define:
1934 * Full punch interval
1935 * Maximum drop level
1936 * For an arbitrary list of node groups:
1937 * Uses (until the tool breaks)
1938 * Maximum level (usually `0`, `1`, `2` or `3`)
1941 * Punch attack uses (until the tool breaks)
1943 ### Full punch interval
1945 When used as a weapon, the item will do full damage if this time is spent
1946 between punches. If e.g. half the time is spent, the item will do half
1949 ### Maximum drop level
1951 Suggests the maximum level of node, when dug with the item, that will drop
1952 its useful item. (e.g. iron ore to drop a lump of iron).
1954 This is not automated; it is the responsibility of the node definition
1957 ### Uses (tools only)
1959 Determines how many uses the tool has when it is used for digging a node,
1960 of this group, of the maximum level. The maximum supported number of
1961 uses is 65535. The special number 0 is used for infinite uses.
1962 For lower leveled nodes, the use count is multiplied by `3^leveldiff`.
1963 `leveldiff` is the difference of the tool's `maxlevel` `groupcaps` and the
1964 node's `level` group. The node cannot be dug if `leveldiff` is less than zero.
1966 * `uses=10, leveldiff=0`: actual uses: 10
1967 * `uses=10, leveldiff=1`: actual uses: 30
1968 * `uses=10, leveldiff=2`: actual uses: 90
1970 For non-tools, this has no effect.
1974 Tells what is the maximum level of a node of this group that the item will
1979 List of digging times for different ratings of the group, for nodes of the
1982 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1983 result in the item to be able to dig nodes that have a rating of `2` or `3`
1984 for this group, and unable to dig the rating `1`, which is the toughest.
1985 Unless there is a matching group that enables digging otherwise.
1987 If the result digging time is 0, a delay of 0.15 seconds is added between
1988 digging nodes; If the player releases LMB after digging, this delay is set to 0,
1989 i.e. players can more quickly click the nodes away instead of holding LMB.
1993 List of damage for groups of entities. See [Entity damage mechanism].
1995 ### Punch attack uses (tools only)
1997 Determines how many uses (before breaking) the tool has when dealing damage
1998 to an object, when the full punch interval (see above) was always
2001 Wear received by the tool is proportional to the time spent, scaled by
2002 the full punch interval.
2004 For non-tools, this has no effect.
2006 Example definition of the capabilities of an item
2007 -------------------------------------------------
2009 tool_capabilities = {
2010 full_punch_interval=1.5,
2013 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
2015 damage_groups = {fleshy=2},
2018 This makes the item capable of digging nodes that fulfil both of these:
2020 * Have the `crumbly` group
2021 * Have a `level` group less or equal to `2`
2023 Table of resulting digging times:
2025 crumbly 0 1 2 3 4 <- level
2027 1 0.80 1.60 1.60 - -
2028 2 0.60 1.20 1.20 - -
2029 3 0.40 0.80 0.80 - -
2031 level diff: 2 1 0 -1 -2
2033 Table of resulting tool uses:
2042 * At `crumbly==0`, the node is not diggable.
2043 * At `crumbly==3`, the level difference digging time divider kicks in and makes
2044 easy nodes to be quickly breakable.
2045 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
2050 Entity damage mechanism
2051 =======================
2056 foreach group in cap.damage_groups:
2057 damage += cap.damage_groups[group]
2058 * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
2059 * (object.armor_groups[group] / 100.0)
2060 -- Where object.armor_groups[group] is 0 for inexistent values
2063 Client predicts damage based on damage groups. Because of this, it is able to
2064 give an immediate response when an entity is damaged or dies; the response is
2065 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
2067 Currently a smoke puff will appear when an entity dies.
2069 The group `immortal` completely disables normal damage.
2071 Entities can define a special armor group, which is `punch_operable`. This
2072 group disables the regular damage mechanism for players punching it by hand or
2073 a non-tool item, so that it can do something else than take damage.
2075 On the Lua side, every punch calls:
2077 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction,
2080 This should never be called directly, because damage is usually not handled by
2083 * `puncher` is the object performing the punch. Can be `nil`. Should never be
2084 accessed unless absolutely required, to encourage interoperability.
2085 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
2086 * `tool_capabilities` can be `nil`.
2087 * `direction` is a unit vector, pointing from the source of the punch to
2089 * `damage` damage that will be done to entity
2090 Return value of this function will determine if damage is done by this function
2091 (retval true) or shall be done by engine (retval false)
2093 To punch an entity/object in Lua, call:
2095 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
2097 * Return value is tool wear.
2098 * Parameters are equal to the above callback.
2099 * If `direction` equals `nil` and `puncher` does not equal `nil`, `direction`
2100 will be automatically filled in based on the location of `puncher`.
2111 The instance of a node in the world normally only contains the three values
2112 mentioned in [Nodes]. However, it is possible to insert extra data into a node.
2113 It is called "node metadata"; See `NodeMetaRef`.
2115 Node metadata contains two things:
2120 Some of the values in the key-value store are handled specially:
2122 * `formspec`: Defines an inventory menu that is opened with the
2123 'place/use' key. Only works if no `on_rightclick` was
2124 defined for the node. See also [Formspec].
2125 * `infotext`: Text shown on the screen when the node is pointed at.
2126 Line-breaks will be applied automatically.
2127 If the infotext is very long, it will be truncated.
2131 local meta = minetest.get_meta(pos)
2132 meta:set_string("formspec",
2134 "list[context;main;0,0;8,4;]"..
2135 "list[current_player;main;0,5;8,4;]")
2136 meta:set_string("infotext", "Chest");
2137 local inv = meta:get_inventory()
2138 inv:set_size("main", 8*4)
2139 print(dump(meta:to_table()))
2142 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
2143 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
2144 [10] = "", [11] = "", [12] = "", [13] = "",
2145 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
2146 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
2147 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
2148 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
2152 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
2160 Item stacks can store metadata too. See [`ItemStackMetaRef`].
2162 Item metadata only contains a key-value store.
2164 Some of the values in the key-value store are handled specially:
2166 * `description`: Set the item stack's description.
2167 See also: `get_description` in [`ItemStack`]
2168 * `short_description`: Set the item stack's short description.
2169 See also: `get_short_description` in [`ItemStack`]
2170 * `color`: A `ColorString`, which sets the stack's color.
2171 * `palette_index`: If the item has a palette, this is used to get the
2172 current color from the palette.
2173 * `count_meta`: Replace the displayed count with any string.
2174 * `count_alignment`: Set the alignment of the displayed count value. This is an
2175 int value. The lowest 2 bits specify the alignment in x-direction, the 3rd and
2176 4th bit specify the alignment in y-direction:
2177 0 = default, 1 = left / up, 2 = middle, 3 = right / down
2178 The default currently is the same as right/down.
2179 Example: 6 = 2 + 1*4 = middle,up
2183 local meta = stack:get_meta()
2184 meta:set_string("key", "value")
2185 print(dump(meta:to_table()))
2187 Example manipulations of "description" and expected output behaviors:
2189 print(ItemStack("default:pick_steel"):get_description()) --> Steel Pickaxe
2190 print(ItemStack("foobar"):get_description()) --> Unknown Item
2192 local stack = ItemStack("default:stone")
2193 stack:get_meta():set_string("description", "Custom description\nAnother line")
2194 print(stack:get_description()) --> Custom description\nAnother line
2195 print(stack:get_short_description()) --> Custom description
2197 stack:get_meta():set_string("short_description", "Short")
2198 print(stack:get_description()) --> Custom description\nAnother line
2199 print(stack:get_short_description()) --> Short
2201 print(ItemStack("mod:item_with_no_desc"):get_description()) --> mod:item_with_no_desc
2208 Formspec defines a menu. This supports inventories and some of the
2209 typical widgets like buttons, checkboxes, text input fields, etc.
2210 It is a string, with a somewhat strange format.
2212 A formspec is made out of formspec elements, which includes widgets
2213 like buttons but also can be used to set stuff like background color.
2215 Many formspec elements have a `name`, which is a unique identifier which
2216 is used when the server receives user input. You must not use the name
2217 "quit" for formspec elements.
2219 Spaces and newlines can be inserted between the blocks, as is used in the
2222 Position and size units are inventory slots unless the new coordinate system
2223 is enabled. `X` and `Y` position the formspec element relative to the top left
2224 of the menu or container. `W` and `H` are its width and height values.
2226 If the new system is enabled, all elements have unified coordinates for all
2227 elements with no padding or spacing in between. This is highly recommended
2228 for new forms. See `real_coordinates[<bool>]` and `Migrating to Real
2231 Inventories with a `player:<name>` inventory location are only sent to the
2232 player named `<name>`.
2234 When displaying text which can contain formspec code, e.g. text set by a player,
2235 use `minetest.formspec_escape`.
2236 For coloured text you can use `minetest.colorize`.
2238 Since formspec version 3, elements drawn in the order they are defined. All
2239 background elements are drawn before all other elements.
2241 **WARNING**: do _not_ use a element name starting with `key_`; those names are
2242 reserved to pass key press events to formspec!
2244 **WARNING**: Minetest allows you to add elements to every single formspec instance
2245 using `player:set_formspec_prepend()`, which may be the reason backgrounds are
2246 appearing when you don't expect them to, or why things are styled differently
2247 to normal. See [`no_prepend[]`] and [Styling Formspecs].
2255 list[context;main;0,0;8,4;]
2256 list[current_player;main;0,5;8,4;]
2261 list[context;fuel;2,3;1,1;]
2262 list[context;src;2,1;1,1;]
2263 list[context;dst;5,1;2,2;]
2264 list[current_player;main;0,5;8,4;]
2266 ### Minecraft-like player inventory
2269 image[1,0.6;1,2;player.png]
2270 list[current_player;main;0,3.5;8,4;]
2271 list[current_player;craft;3,0;3,3;]
2272 list[current_player;craftpreview;7,1;1,1;]
2277 * Formspec version 1 (pre-5.1.0):
2279 * Formspec version 2 (5.1.0):
2280 * Forced real coordinates
2281 * background9[]: 9-slice scaling parameters
2282 * Formspec version 3 (5.2.0):
2283 * Formspec elements are drawn in the order of definition
2284 * bgcolor[]: use 3 parameters (bgcolor, formspec (now an enum), fbgcolor)
2285 * box[] and image[] elements enable clipping by default
2286 * new element: scroll_container[]
2287 * Formspec version 4 (5.4.0):
2288 * Allow dropdown indexing events
2289 * Formspec version 5 (5.5.0):
2290 * Added padding[] element
2295 ### `formspec_version[<version>]`
2297 * Set the formspec version to a certain number. If not specified,
2298 version 1 is assumed.
2299 * Must be specified before `size` element.
2300 * Clients older than this version can neither show newer elements nor display
2301 elements with new arguments correctly.
2302 * Available since feature `formspec_version_element`.
2303 * See also: [Version History]
2305 ### `size[<W>,<H>,<fixed_size>]`
2307 * Define the size of the menu in inventory slots
2308 * `fixed_size`: `true`/`false` (optional)
2309 * deprecated: `invsize[<W>,<H>;]`
2311 ### `position[<X>,<Y>]`
2313 * Must be used after `size` element.
2314 * Defines the position on the game window of the formspec's `anchor` point.
2315 * For X and Y, 0.0 and 1.0 represent opposite edges of the game window,
2317 * [0.0, 0.0] sets the position to the top left corner of the game window.
2318 * [1.0, 1.0] sets the position to the bottom right of the game window.
2319 * Defaults to the center of the game window [0.5, 0.5].
2321 ### `anchor[<X>,<Y>]`
2323 * Must be used after both `size` and `position` (if present) elements.
2324 * Defines the location of the anchor point within the formspec.
2325 * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec,
2327 * [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
2328 * [1.0, 0.0] sets the anchor to the top right of the formspec.
2329 * Defaults to the center of the formspec [0.5, 0.5].
2331 * `position` and `anchor` elements need suitable values to avoid a formspec
2332 extending off the game window due to particular game window sizes.
2334 ### `padding[<X>,<Y>]`
2336 * Must be used after the `size`, `position`, and `anchor` elements (if present).
2337 * Defines how much space is padded around the formspec if the formspec tries to
2338 increase past the size of the screen and coordinates have to be shrunk.
2339 * For X and Y, 0.0 represents no padding (the formspec can touch the edge of the
2340 screen), and 0.5 represents half the screen (which forces the coordinate size
2341 to 0). If negative, the formspec can extend off the edge of the screen.
2342 * Defaults to [0.05, 0.05].
2346 * Must be used after the `size`, `position`, `anchor`, and `padding` elements
2348 * Disables player:set_formspec_prepend() from applying to this formspec.
2350 ### `real_coordinates[<bool>]`
2352 * INFORMATION: Enable it automatically using `formspec_version` version 2 or newer.
2353 * When set to true, all following formspec elements will use the new coordinate system.
2354 * If used immediately after `size`, `position`, `anchor`, and `no_prepend` elements
2355 (if present), the form size will use the new coordinate system.
2356 * **Note**: Formspec prepends are not affected by the coordinates in the main form.
2357 They must enable it explicitly.
2358 * For information on converting forms to the new coordinate system, see `Migrating
2359 to Real Coordinates`.
2361 ### `container[<X>,<Y>]`
2363 * Start of a container block, moves all physical elements in the container by
2365 * Must have matching `container_end`
2366 * Containers can be nested, in which case the offsets are added
2367 (child containers are relative to parent containers)
2369 ### `container_end[]`
2371 * End of a container, following elements are no longer relative to this
2374 ### `scroll_container[<X>,<Y>;<W>,<H>;<scrollbar name>;<orientation>;<scroll factor>]`
2376 * Start of a scroll_container block. All contained elements will ...
2377 * take the scroll_container coordinate as position origin,
2378 * be additionally moved by the current value of the scrollbar with the name
2379 `scrollbar name` times `scroll factor` along the orientation `orientation` and
2380 * be clipped to the rectangle defined by `X`, `Y`, `W` and `H`.
2381 * `orientation`: possible values are `vertical` and `horizontal`.
2382 * `scroll factor`: optional, defaults to `0.1`.
2383 * Nesting is possible.
2384 * Some elements might work a little different if they are in a scroll_container.
2385 * Note: If you want the scroll_container to actually work, you also need to add a
2386 scrollbar element with the specified name. Furthermore, it is highly recommended
2387 to use a scrollbaroptions element on this scrollbar.
2389 ### `scroll_container_end[]`
2391 * End of a scroll_container, following elements are no longer bound to this
2394 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
2396 * Show an inventory list if it has been sent to the client.
2397 * If the inventory list changes (eg. it didn't exist before, it's resized, or its items
2398 are moved) while the formspec is open, the formspec element may (but is not guaranteed
2399 to) adapt to the new inventory list.
2400 * Item slots are drawn in a grid from left to right, then up to down, ordered
2401 according to the slot index.
2402 * `W` and `H` are in inventory slots, not in coordinates.
2403 * `starting item index` (Optional): The index of the first (upper-left) item to draw.
2404 Indices start at `0`. Default is `0`.
2405 * The number of shown slots is the minimum of `W*H` and the inventory list's size minus
2406 `starting item index`.
2407 * **Note**: With the new coordinate system, the spacing between inventory
2408 slots is one-fourth the size of an inventory slot by default. Also see
2409 [Styling Formspecs] for changing the size of slots and spacing.
2411 ### `listring[<inventory location>;<list name>]`
2413 * Allows to create a ring of inventory lists
2414 * Shift-clicking on items in one element of the ring
2415 will send them to the next inventory list inside the ring
2416 * The first occurrence of an element inside the ring will
2417 determine the inventory where items will be sent to
2421 * Shorthand for doing `listring[<inventory location>;<list name>]`
2422 for the last two inventory lists added by list[...]
2424 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
2426 * Sets background color of slots as `ColorString`
2427 * Sets background color of slots on mouse hovering
2429 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
2431 * Sets background color of slots as `ColorString`
2432 * Sets background color of slots on mouse hovering
2433 * Sets color of slots border
2435 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
2437 * Sets background color of slots as `ColorString`
2438 * Sets background color of slots on mouse hovering
2439 * Sets color of slots border
2440 * Sets default background color of tooltips
2441 * Sets default font color of tooltips
2443 ### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2445 * Adds tooltip for an element
2446 * `bgcolor` tooltip background color as `ColorString` (optional)
2447 * `fontcolor` tooltip font color as `ColorString` (optional)
2449 ### `tooltip[<X>,<Y>;<W>,<H>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2451 * Adds tooltip for an area. Other tooltips will take priority when present.
2452 * `bgcolor` tooltip background color as `ColorString` (optional)
2453 * `fontcolor` tooltip font color as `ColorString` (optional)
2455 ### `image[<X>,<Y>;<W>,<H>;<texture name>]`
2459 ### `animated_image[<X>,<Y>;<W>,<H>;<name>;<texture name>;<frame count>;<frame duration>;<frame start>]`
2461 * Show an animated image. The image is drawn like a "vertical_frames" tile
2462 animation (See [Tile animation definition]), but uses a frame count/duration
2464 * `name`: Element name to send when an event occurs. The event value is the index of the current frame.
2465 * `texture name`: The image to use.
2466 * `frame count`: The number of frames animating the image.
2467 * `frame duration`: Milliseconds between each frame. `0` means the frames don't advance.
2468 * `frame start` (Optional): The index of the frame to start on. Default `1`.
2470 ### `model[<X>,<Y>;<W>,<H>;<name>;<mesh>;<textures>;<rotation X,Y>;<continuous>;<mouse control>;<frame loop range>;<animation speed>]`
2472 * Show a mesh model.
2473 * `name`: Element name that can be used for styling
2474 * `mesh`: The mesh model to use.
2475 * `textures`: The mesh textures to use according to the mesh materials.
2476 Texture names must be separated by commas.
2477 * `rotation {X,Y}` (Optional): Initial rotation of the camera.
2478 The axes are euler angles in degrees.
2479 * `continuous` (Optional): Whether the rotation is continuous. Default `false`.
2480 * `mouse control` (Optional): Whether the model can be controlled with the mouse. Default `true`.
2481 * `frame loop range` (Optional): Range of the animation frames.
2482 * Defaults to the full range of all available frames.
2483 * Syntax: `<begin>,<end>`
2484 * `animation speed` (Optional): Sets the animation speed. Default 0 FPS.
2486 ### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
2488 * Show an inventory image of registered item/node
2490 ### `bgcolor[<bgcolor>;<fullscreen>;<fbgcolor>]`
2492 * Sets background color of formspec.
2493 * `bgcolor` and `fbgcolor` (optional) are `ColorString`s, they define the color
2494 of the non-fullscreen and the fullscreen background.
2495 * `fullscreen` (optional) can be one of the following:
2496 * `false`: Only the non-fullscreen background color is drawn. (default)
2497 * `true`: Only the fullscreen background color is drawn.
2498 * `both`: The non-fullscreen and the fullscreen background color are drawn.
2499 * `neither`: No background color is drawn.
2500 * Note: Leave a parameter empty to not modify the value.
2501 * Note: `fbgcolor`, leaving parameters empty and values for `fullscreen` that
2502 are not bools are only available since formspec version 3.
2504 ### `background[<X>,<Y>;<W>,<H>;<texture name>]`
2506 * Example for formspec 8x4 in 16x resolution: image shall be sized
2507 8 times 16px times 4 times 16px.
2509 ### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
2511 * Example for formspec 8x4 in 16x resolution:
2512 image shall be sized 8 times 16px times 4 times 16px
2513 * If `auto_clip` is `true`, the background is clipped to the formspec size
2514 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2516 ### `background9[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>;<middle>]`
2518 * 9-sliced background. See https://en.wikipedia.org/wiki/9-slice_scaling
2519 * Middle is a rect which defines the middle of the 9-slice.
2520 * `x` - The middle will be x pixels from all sides.
2521 * `x,y` - The middle will be x pixels from the horizontal and y from the vertical.
2522 * `x,y,x2,y2` - The middle will start at x,y, and end at x2, y2. Negative x2 and y2 values
2523 will be added to the width and height of the texture, allowing it to be used as the
2524 distance from the far end.
2525 * All numbers in middle are integers.
2526 * Example for formspec 8x4 in 16x resolution:
2527 image shall be sized 8 times 16px times 4 times 16px
2528 * If `auto_clip` is `true`, the background is clipped to the formspec size
2529 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2530 * Available since formspec version 2
2532 ### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
2534 * Textual password style field; will be sent to server when a button is clicked
2535 * When enter is pressed in field, fields.key_enter_field will be sent with the
2537 * With the old coordinate system, fields are a set height, but will be vertically
2538 centred on `H`. With the new coordinate system, `H` will modify the height.
2539 * `name` is the name of the field as returned in fields to `on_receive_fields`
2540 * `label`, if not blank, will be text printed on the top left above the field
2541 * See `field_close_on_enter` to stop enter closing the formspec
2543 ### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2545 * Textual field; will be sent to server when a button is clicked
2546 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2547 the name of this field.
2548 * With the old coordinate system, fields are a set height, but will be vertically
2549 centred on `H`. With the new coordinate system, `H` will modify the height.
2550 * `name` is the name of the field as returned in fields to `on_receive_fields`
2551 * `label`, if not blank, will be text printed on the top left above the field
2552 * `default` is the default value of the field
2553 * `default` may contain variable references such as `${text}` which
2554 will fill the value from the metadata value `text`
2555 * **Note**: no extra text or more than a single variable is supported ATM.
2556 * See `field_close_on_enter` to stop enter closing the formspec
2558 ### `field[<name>;<label>;<default>]`
2560 * As above, but without position/size units
2561 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2562 the name of this field.
2563 * Special field for creating simple forms, such as sign text input
2564 * Must be used without a `size[]` element
2565 * A "Proceed" button will be added automatically
2566 * See `field_close_on_enter` to stop enter closing the formspec
2568 ### `field_close_on_enter[<name>;<close_on_enter>]`
2570 * <name> is the name of the field
2571 * if <close_on_enter> is false, pressing enter in the field will submit the
2572 form but not close it.
2573 * defaults to true when not specified (ie: no tag for a field)
2575 ### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2577 * Same as fields above, but with multi-line input
2578 * If the text overflows, a vertical scrollbar is added.
2579 * If the name is empty, the textarea is read-only and
2580 the background is not shown, which corresponds to a multi-line label.
2582 ### `label[<X>,<Y>;<label>]`
2584 * The label formspec element displays the text set in `label`
2585 at the specified position.
2586 * **Note**: If the new coordinate system is enabled, labels are
2587 positioned from the center of the text, not the top.
2588 * The text is displayed directly without automatic line breaking,
2589 so label should not be used for big text chunks. Newlines can be
2590 used to make labels multiline.
2591 * **Note**: With the new coordinate system, newlines are spaced with
2592 half a coordinate. With the old system, newlines are spaced 2/5 of
2595 ### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]`
2596 * Displays a static formatted text with hyperlinks.
2597 * **Note**: This element is currently unstable and subject to change.
2598 * `x`, `y`, `w` and `h` work as per field
2599 * `name` is the name of the field as returned in fields to `on_receive_fields` in case of action in text.
2600 * `text` is the formatted text using `Markup Language` described below.
2602 ### `vertlabel[<X>,<Y>;<label>]`
2603 * Textual label drawn vertically
2604 * `label` is the text on the label
2605 * **Note**: If the new coordinate system is enabled, vertlabels are
2606 positioned from the center of the text, not the left.
2608 ### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
2610 * Clickable button. When clicked, fields will be sent.
2611 * With the old coordinate system, buttons are a set height, but will be vertically
2612 centred on `H`. With the new coordinate system, `H` will modify the height.
2613 * `label` is the text on the button
2615 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2617 * `texture name` is the filename of an image
2618 * **Note**: Height is supported on both the old and new coordinate systems
2621 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
2623 * `texture name` is the filename of an image
2624 * `noclip=true` means the image button doesn't need to be within specified
2626 * `drawborder`: draw button border or not
2627 * `pressed texture name` is the filename of an image on pressed state
2629 ### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
2631 * `item name` is the registered name of an item/node
2632 * The item description will be used as the tooltip. This can be overridden with
2635 ### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
2637 * When clicked, fields will be sent and the form will quit.
2638 * Same as `button` in all other respects.
2640 ### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2642 * When clicked, fields will be sent and the form will quit.
2643 * Same as `image_button` in all other respects.
2645 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
2647 * Scrollable item list showing arbitrary text elements
2648 * `name` fieldname sent to server on doubleclick value is current selected
2650 * `listelements` can be prepended by #color in hexadecimal format RRGGBB
2652 * if you want a listelement to start with "#" write "##".
2654 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
2656 * Scrollable itemlist showing arbitrary text elements
2657 * `name` fieldname sent to server on doubleclick value is current selected
2659 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
2660 * if you want a listelement to start with "#" write "##"
2661 * Index to be selected within textlist
2662 * `true`/`false`: draw transparent background
2663 * See also `minetest.explode_textlist_event`
2664 (main menu: `core.explode_textlist_event`).
2666 ### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2668 * Show a tab**header** at specific position (ignores formsize)
2669 * `X` and `Y`: position of the tabheader
2670 * *Note*: Width and height are automatically chosen with this syntax
2671 * `name` fieldname data is transferred to Lua
2672 * `caption 1`...: name shown on top of tab
2673 * `current_tab`: index of selected tab 1...
2674 * `transparent` (optional): if true, tabs are semi-transparent
2675 * `draw_border` (optional): if true, draw a thin line at tab base
2677 ### `tabheader[<X>,<Y>;<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2679 * Show a tab**header** at specific position (ignores formsize)
2680 * **Important note**: This syntax for tabheaders can only be used with the
2681 new coordinate system.
2682 * `X` and `Y`: position of the tabheader
2683 * `H`: height of the tabheader. Width is automatically determined with this syntax.
2684 * `name` fieldname data is transferred to Lua
2685 * `caption 1`...: name shown on top of tab
2686 * `current_tab`: index of selected tab 1...
2687 * `transparent` (optional): show transparent
2688 * `draw_border` (optional): draw border
2690 ### `tabheader[<X>,<Y>;<W>,<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2692 * Show a tab**header** at specific position (ignores formsize)
2693 * **Important note**: This syntax for tabheaders can only be used with the
2694 new coordinate system.
2695 * `X` and `Y`: position of the tabheader
2696 * `W` and `H`: width and height of the tabheader
2697 * `name` fieldname data is transferred to Lua
2698 * `caption 1`...: name shown on top of tab
2699 * `current_tab`: index of selected tab 1...
2700 * `transparent` (optional): show transparent
2701 * `draw_border` (optional): draw border
2703 ### `box[<X>,<Y>;<W>,<H>;<color>]`
2705 * Simple colored box
2706 * `color` is color specified as a `ColorString`.
2707 If the alpha component is left blank, the box will be semitransparent.
2708 If the color is not specified, the box will use the options specified by
2709 its style. If the color is specified, all styling options will be ignored.
2711 ### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
2713 * Show a dropdown field
2714 * **Important note**: There are two different operation modes:
2715 1. handle directly on change (only changed dropdown is submitted)
2716 2. read the value on pressing a button (all dropdown values are available)
2717 * `X` and `Y`: position of the dropdown
2718 * `W`: width of the dropdown. Height is automatically chosen with this syntax.
2719 * Fieldname data is transferred to Lua
2720 * Items to be shown in dropdown
2721 * Index of currently selected dropdown item
2722 * `index event` (optional, allowed parameter since formspec version 4): Specifies the
2723 event field value for selected items.
2724 * `true`: Selected item index
2725 * `false` (default): Selected item value
2727 ### `dropdown[<X>,<Y>;<W>,<H>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
2729 * Show a dropdown field
2730 * **Important note**: This syntax for dropdowns can only be used with the
2731 new coordinate system.
2732 * **Important note**: There are two different operation modes:
2733 1. handle directly on change (only changed dropdown is submitted)
2734 2. read the value on pressing a button (all dropdown values are available)
2735 * `X` and `Y`: position of the dropdown
2736 * `W` and `H`: width and height of the dropdown
2737 * Fieldname data is transferred to Lua
2738 * Items to be shown in dropdown
2739 * Index of currently selected dropdown item
2740 * `index event` (optional, allowed parameter since formspec version 4): Specifies the
2741 event field value for selected items.
2742 * `true`: Selected item index
2743 * `false` (default): Selected item value
2745 ### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
2748 * `name` fieldname data is transferred to Lua
2749 * `label` to be shown left of checkbox
2750 * `selected` (optional): `true`/`false`
2751 * **Note**: If the new coordinate system is enabled, checkboxes are
2752 positioned from the center of the checkbox, not the top.
2754 ### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
2756 * Show a scrollbar using options defined by the previous `scrollbaroptions[]`
2757 * There are two ways to use it:
2758 1. handle the changed event (only changed scrollbar is available)
2759 2. read the value on pressing a button (all scrollbars are available)
2760 * `orientation`: `vertical`/`horizontal`. Default horizontal.
2761 * Fieldname data is transferred to Lua
2762 * Value of this trackbar is set to (`0`-`1000`) by default
2763 * See also `minetest.explode_scrollbar_event`
2764 (main menu: `core.explode_scrollbar_event`).
2766 ### `scrollbaroptions[opt1;opt2;...]`
2767 * Sets options for all following `scrollbar[]` elements
2769 * Sets scrollbar minimum value, defaults to `0`.
2771 * Sets scrollbar maximum value, defaults to `1000`.
2772 If the max is equal to the min, the scrollbar will be disabled.
2774 * Sets scrollbar step value when the arrows are clicked or the mouse wheel is
2776 * If this is set to a negative number, the value will be reset to `10`.
2778 * Sets scrollbar step value used by page up and page down.
2779 * If this is set to a negative number, the value will be reset to `100`.
2781 * Sets size of the thumb on the scrollbar. Size is calculated in the number of
2782 units the thumb spans out of the range of the scrollbar values.
2783 * Example: If a scrollbar has a `min` of 1 and a `max` of 100, a thumbsize of 10
2784 would span a tenth of the scrollbar space.
2785 * If this is set to zero or less, the value will be reset to `1`.
2786 * `arrows=<show/hide/default>`
2787 * Whether to show the arrow buttons on the scrollbar. `default` hides the arrows
2788 when the scrollbar gets too small, but shows them otherwise.
2790 ### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
2792 * Show scrollable table using options defined by the previous `tableoptions[]`
2793 * Displays cells as defined by the previous `tablecolumns[]`
2794 * `name`: fieldname sent to server on row select or doubleclick
2795 * `cell 1`...`cell n`: cell contents given in row-major order
2796 * `selected idx`: index of row to be selected within table (first row = `1`)
2797 * See also `minetest.explode_table_event`
2798 (main menu: `core.explode_table_event`).
2800 ### `tableoptions[<opt 1>;<opt 2>;...]`
2802 * Sets options for `table[]`
2804 * default text color (`ColorString`), defaults to `#FFFFFF`
2805 * `background=#RRGGBB`
2806 * table background color (`ColorString`), defaults to `#000000`
2807 * `border=<true/false>`
2808 * should the table be drawn with a border? (default: `true`)
2809 * `highlight=#RRGGBB`
2810 * highlight background color (`ColorString`), defaults to `#466432`
2811 * `highlight_text=#RRGGBB`
2812 * highlight text color (`ColorString`), defaults to `#FFFFFF`
2813 * `opendepth=<value>`
2814 * all subtrees up to `depth < value` are open (default value = `0`)
2815 * only useful when there is a column of type "tree"
2817 ### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
2819 * Sets columns for `table[]`
2820 * Types: `text`, `image`, `color`, `indent`, `tree`
2821 * `text`: show cell contents as text
2822 * `image`: cell contents are an image index, use column options to define
2824 * `color`: cell contents are a ColorString and define color of following
2826 * `indent`: cell contents are a number and define indentation of following
2828 * `tree`: same as indent, but user can open and close subtrees
2832 * for `text` and `image`: content alignment within cells.
2833 Available values: `left` (default), `center`, `right`, `inline`
2835 * for `text` and `image`: minimum width in em (default: `0`)
2836 * for `indent` and `tree`: indent width in em (default: `1.5`)
2837 * `padding=<value>`: padding left of the column, in em (default `0.5`).
2838 Exception: defaults to 0 for indent columns
2839 * `tooltip=<value>`: tooltip text (default: empty)
2840 * `image` column options:
2841 * `0=<value>` sets image for image index 0
2842 * `1=<value>` sets image for image index 1
2843 * `2=<value>` sets image for image index 2
2844 * and so on; defined indices need not be contiguous empty or
2845 non-numeric cells are treated as `0`.
2846 * `color` column options:
2847 * `span=<value>`: number of following columns to affect
2848 (default: infinite).
2850 ### `style[<selector 1>,<selector 2>,...;<prop1>;<prop2>;...]`
2852 * Set the style for the element(s) matching `selector` by name.
2853 * `selector` can be one of:
2854 * `<name>` - An element name. Includes `*`, which represents every element.
2855 * `<name>:<state>` - An element name, a colon, and one or more states.
2856 * `state` is a list of states separated by the `+` character.
2857 * If a state is provided, the style will only take effect when the element is in that state.
2858 * All provided states must be active for the style to apply.
2859 * Note: this **must** be before the element is defined.
2860 * See [Styling Formspecs].
2863 ### `style_type[<selector 1>,<selector 2>,...;<prop1>;<prop2>;...]`
2865 * Set the style for the element(s) matching `selector` by type.
2866 * `selector` can be one of:
2867 * `<type>` - An element type. Includes `*`, which represents every element.
2868 * `<type>:<state>` - An element type, a colon, and one or more states.
2869 * `state` is a list of states separated by the `+` character.
2870 * If a state is provided, the style will only take effect when the element is in that state.
2871 * All provided states must be active for the style to apply.
2872 * See [Styling Formspecs].
2874 ### `set_focus[<name>;<force>]`
2876 * Sets the focus to the element with the same `name` parameter.
2877 * **Note**: This element must be placed before the element it focuses.
2878 * `force` (optional, default `false`): By default, focus is not applied for
2879 re-sent formspecs with the same name so that player-set focus is kept.
2880 `true` sets the focus to the specified element for every sent formspec.
2881 * The following elements have the ability to be focused:
2896 Migrating to Real Coordinates
2897 -----------------------------
2899 In the old system, positions included padding and spacing. Padding is a gap between
2900 the formspec window edges and content, and spacing is the gaps between items. For
2901 example, two `1x1` elements at `0,0` and `1,1` would have a spacing of `5/4` between them,
2902 and a padding of `3/8` from the formspec edge. It may be easiest to recreate old layouts
2903 in the new coordinate system from scratch.
2905 To recreate an old layout with padding, you'll need to pass the positions and sizes
2906 through the following formula to re-introduce padding:
2909 pos = (oldpos + 1)*spacing + padding
2915 You'll need to change the `size[]` tag like this:
2918 size = (oldsize-1)*spacing + padding*2 + 1
2921 A few elements had random offsets in the old system. Here is a table which shows these
2922 offsets when migrating:
2924 | Element | Position | Size | Notes
2925 |---------|------------|---------|-------
2926 | box | +0.3, +0.1 | 0, -0.4 |
2927 | button | | | Buttons now support height, so set h = 2 * 15/13 * 0.35, and reposition if h ~= 15/13 * 0.35 before
2928 | list | | | Spacing is now 0.25 for both directions, meaning lists will be taller in height
2929 | label | 0, +0.3 | | The first line of text is now positioned centered exactly at the position specified
2934 Formspec elements can be themed using the style elements:
2936 style[<name 1>,<name 2>,...;<prop1>;<prop2>;...]
2937 style[<name 1>:<state>,<name 2>:<state>,...;<prop1>;<prop2>;...]
2938 style_type[<type 1>,<type 2>,...;<prop1>;<prop2>;...]
2939 style_type[<type 1>:<state>,<type 2>:<state>,...;<prop1>;<prop2>;...]
2943 property_name=property_value
2947 style_type[button;bgcolor=#006699]
2948 style[world_delete;bgcolor=red;textcolor=yellow]
2949 button[4,3.95;2.6,1;world_delete;Delete]
2951 A name/type can optionally be a comma separated list of names/types, like so:
2953 world_delete,world_create,world_configure
2956 A `*` type can be used to select every element in the formspec.
2958 Any name/type in the list can also be accompanied by a `+`-separated list of states, like so:
2960 world_delete:hovered+pressed
2963 States allow you to apply styles in response to changes in the element, instead of applying at all times.
2965 Setting a property to nothing will reset it to the default value. For example:
2967 style_type[button;bgimg=button.png;bgimg_pressed=button_pressed.png;border=false]
2968 style[btn_exit;bgimg=;bgimg_pressed=;border=;bgcolor=red]
2971 ### Supported Element Types
2973 Some types may inherit styles from parent types.
2975 * animated_image, inherits from image
2978 * button_exit, inherits from button
2988 * pwdfield, inherits from field
2994 * vertlabel, inherits from label
2997 ### Valid Properties
3000 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3002 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3003 * Defaults to false in formspec_version version 3 or higher
3004 * **Note**: `colors`, `bordercolors`, and `borderwidths` accept multiple input types:
3005 * Single value (e.g. `#FF0`): All corners/borders.
3006 * Two values (e.g. `red,#FFAAFF`): top-left and bottom-right,top-right and bottom-left/
3007 top and bottom,left and right.
3008 * Four values (e.g. `blue,#A0F,green,#FFFA`): top-left/top and rotates clockwise.
3009 * These work similarly to CSS borders.
3010 * colors - `ColorString`. Sets the color(s) of the box corners. Default `black`.
3011 * bordercolors - `ColorString`. Sets the color(s) of the borders. Default `black`.
3012 * borderwidths - Integer. Sets the width(s) of the borders in pixels. If the width is
3013 negative, the border will extend inside the box, whereas positive extends outside
3014 the box. A width of zero results in no border; this is default.
3015 * button, button_exit, image_button, item_image_button
3016 * alpha - boolean, whether to draw alpha in bgimg. Default true.
3017 * bgcolor - color, sets button tint.
3018 * bgcolor_hovered - color when hovered. Defaults to a lighter bgcolor when not provided.
3019 * This is deprecated, use states instead.
3020 * bgcolor_pressed - color when pressed. Defaults to a darker bgcolor when not provided.
3021 * This is deprecated, use states instead.
3022 * bgimg - standard background image. Defaults to none.
3023 * bgimg_hovered - background image when hovered. Defaults to bgimg when not provided.
3024 * This is deprecated, use states instead.
3025 * bgimg_middle - Makes the bgimg textures render in 9-sliced mode and defines the middle rect.
3026 See background9[] documentation for more details. This property also pads the
3027 button's content when set.
3028 * bgimg_pressed - background image when pressed. Defaults to bgimg when not provided.
3029 * This is deprecated, use states instead.
3030 * font - Sets font type. This is a comma separated list of options. Valid options:
3031 * Main font type options. These cannot be combined with each other:
3032 * `normal`: Default font
3033 * `mono`: Monospaced font
3034 * Font modification options. If used without a main font type, `normal` is used:
3035 * `bold`: Makes font bold.
3036 * `italic`: Makes font italic.
3038 * font_size - Sets font size. Default is user-set. Can have multiple values:
3039 * `<number>`: Sets absolute font size to `number`.
3040 * `+<number>`/`-<number>`: Offsets default font size by `number` points.
3041 * `*<number>`: Multiplies default font size by `number`, similar to CSS `em`.
3042 * border - boolean, draw border. Set to false to hide the bevelled button pane. Default true.
3043 * content_offset - 2d vector, shifts the position of the button's content without resizing it.
3044 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3045 * padding - rect, adds space between the edges of the button and the content. This value is
3046 relative to bgimg_middle.
3047 * sound - a sound to be played when triggered.
3048 * textcolor - color, default white.
3050 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3051 * sound - a sound to be played when triggered.
3053 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3054 * sound - a sound to be played when the entry is changed.
3055 * field, pwdfield, textarea
3056 * border - set to false to hide the textbox background and border. Default true.
3057 * font - Sets font type. See button `font` property for more information.
3058 * font_size - Sets font size. See button `font_size` property for more information.
3059 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3060 * textcolor - color. Default white.
3062 * bgcolor - color, sets background color.
3063 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3064 * Default to false in formspec_version version 3 or higher
3066 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3067 * Default to false in formspec_version version 3 or higher
3069 * noclip - boolean, set to true to allow the element to exceed formspec bounds. Default to false.
3071 * font - Sets font type. See button `font` property for more information.
3072 * font_size - Sets font size. See button `font_size` property for more information.
3073 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3075 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3076 * size - 2d vector, sets the size of inventory slots in coordinates.
3077 * spacing - 2d vector, sets the space between inventory slots in coordinates.
3078 * image_button (additional properties)
3079 * fgimg - standard image. Defaults to none.
3080 * fgimg_hovered - image when hovered. Defaults to fgimg when not provided.
3081 * This is deprecated, use states instead.
3082 * fgimg_pressed - image when pressed. Defaults to fgimg when not provided.
3083 * This is deprecated, use states instead.
3084 * NOTE: The parameters of any given image_button will take precedence over fgimg/fgimg_pressed
3085 * sound - a sound to be played when triggered.
3087 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3089 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3090 * sound - a sound to be played when a different tab is selected.
3091 * textcolor - color. Default white.
3093 * font - Sets font type. See button `font` property for more information.
3094 * font_size - Sets font size. See button `font_size` property for more information.
3095 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
3100 * default - Equivalent to providing no states
3101 * button, button_exit, image_button, item_image_button
3102 * hovered - Active when the mouse is hovering over the element
3103 * pressed - Active when the button is pressed
3108 Markup language used in `hypertext[]` elements uses tags that look like HTML tags.
3109 The markup language is currently unstable and subject to change. Use with caution.
3110 Some tags can enclose text, they open with `<tagname>` and close with `</tagname>`.
3111 Tags can have attributes, in that case, attributes are in the opening tag in
3112 form of a key/value separated with equal signs. Attribute values should not be quoted.
3114 If you want to insert a literal greater-than sign or a backslash into the text,
3115 you must escape it by preceding it with a backslash.
3117 These are the technically basic tags but see below for usual tags. Base tags are:
3119 `<style color=... font=... size=...>...</style>`
3121 Changes the style of the text.
3123 * `color`: Text color. Given color is a `colorspec`.
3124 * `size`: Text size.
3125 * `font`: Text font (`mono` or `normal`).
3127 `<global background=... margin=... valign=... color=... hovercolor=... size=... font=... halign=... >`
3132 * `background`: Text background, a `colorspec` or `none`.
3133 * `margin`: Page margins in pixel.
3134 * `valign`: Text vertical alignment (`top`, `middle`, `bottom`).
3136 Inheriting styles (affects child elements):
3137 * `color`: Default text color. Given color is a `colorspec`.
3138 * `hovercolor`: Color of <action> tags when mouse is over.
3139 * `size`: Default text size.
3140 * `font`: Default text font (`mono` or `normal`).
3141 * `halign`: Default text horizontal alignment (`left`, `right`, `center`, `justify`).
3143 This tag needs to be placed only once as it changes the global settings of the
3144 text. Anyway, if several tags are placed, each changed will be made in the order
3147 `<tag name=... color=... hovercolor=... font=... size=...>`
3149 Defines or redefines tag style. This can be used to define new tags.
3150 * `name`: Name of the tag to define or change.
3151 * `color`: Text color. Given color is a `colorspec`.
3152 * `hovercolor`: Text color when element hovered (only for `action` tags). Given color is a `colorspec`.
3153 * `size`: Text size.
3154 * `font`: Text font (`mono` or `normal`).
3156 Following tags are the usual tags for text layout. They are defined by default.
3157 Other tags can be added using `<tag ...>` tag.
3159 `<normal>...</normal>`: Normal size text
3161 `<big>...</big>`: Big text
3163 `<bigger>...</bigger>`: Bigger text
3165 `<center>...</center>`: Centered text
3167 `<left>...</left>`: Left-aligned text
3169 `<right>...</right>`: Right-aligned text
3171 `<justify>...</justify>`: Justified text
3173 `<mono>...</mono>`: Monospaced font
3175 `<b>...</b>`, `<i>...</i>`, `<u>...</u>`: Bold, italic, underline styles.
3177 `<action name=...>...</action>`
3179 Make that text a clickable text triggering an action.
3181 * `name`: Name of the action (mandatory).
3183 When clicked, the formspec is send to the server. The value of the text field
3184 sent to `on_player_receive_fields` will be "action:" concatenated to the action
3187 `<img name=... float=... width=... height=...>`
3189 Draws an image which is present in the client media cache.
3191 * `name`: Name of the texture (mandatory).
3192 * `float`: If present, makes the image floating (`left` or `right`).
3193 * `width`: Force image width instead of taking texture width.
3194 * `height`: Force image height instead of taking texture height.
3196 If only width or height given, texture aspect is kept.
3198 `<item name=... float=... width=... height=... rotate=...>`
3200 Draws an item image.
3202 * `name`: Item string of the item to draw (mandatory).
3203 * `float`: If present, makes the image floating (`left` or `right`).
3204 * `width`: Item image width.
3205 * `height`: Item image height.
3206 * `rotate`: Rotate item image if set to `yes` or `X,Y,Z`. X, Y and Z being
3207 rotation speeds in percent of standard speed (-1000 to 1000). Works only if
3208 `inventory_items_animations` is set to true.
3209 * `angle`: Angle in which the item image is shown. Value has `X,Y,Z` form.
3210 X, Y and Z being angles around each three axes. Works only if
3211 `inventory_items_animations` is set to true.
3219 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
3220 * `"current_player"`: Player to whom the menu is shown
3221 * `"player:<name>"`: Any player
3222 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
3223 * `"detached:<name>"`: A detached inventory
3225 Player Inventory lists
3226 ----------------------
3228 * `main`: list containing the default inventory
3229 * `craft`: list containing the craft input
3230 * `craftpreview`: list containing the craft prediction
3231 * `craftresult`: list containing the crafted output
3232 * `hand`: list containing an override for the empty hand
3233 * Is not created automatically, use `InvRef:set_size`
3234 * Is only used to enhance the empty hand's tool capabilities
3242 `#RGB` defines a color in hexadecimal format.
3244 `#RGBA` defines a color in hexadecimal format and alpha channel.
3246 `#RRGGBB` defines a color in hexadecimal format.
3248 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
3250 Named colors are also supported and are equivalent to
3251 [CSS Color Module Level 4](https://www.w3.org/TR/css-color-4/#named-color).
3252 To specify the value of the alpha channel, append `#A` or `#AA` to the end of
3253 the color name (e.g. `colorname#08`).
3258 A ColorSpec specifies a 32-bit color. It can be written in any of the following
3261 * table form: Each element ranging from 0..255 (a, if absent, defaults to 255):
3262 * `colorspec = {a=255, r=0, g=255, b=0}`
3263 * numerical form: The raw integer value of an ARGB8 quad:
3264 * `colorspec = 0xFF00FF00`
3265 * string form: A ColorString (defined above):
3266 * `colorspec = "green"`
3274 Most text can contain escape sequences, that can for example color the text.
3275 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
3276 The following functions provide escape sequences:
3278 * `minetest.get_color_escape_sequence(color)`:
3279 * `color` is a ColorString
3280 * The escape sequence sets the text color to `color`
3281 * `minetest.colorize(color, message)`:
3283 `minetest.get_color_escape_sequence(color) ..
3285 minetest.get_color_escape_sequence("#ffffff")`
3286 * `minetest.get_background_escape_sequence(color)`
3287 * `color` is a ColorString
3288 * The escape sequence sets the background of the whole text element to
3289 `color`. Only defined for item descriptions and tooltips.
3290 * `minetest.strip_foreground_colors(str)`
3291 * Removes foreground colors added by `get_color_escape_sequence`.
3292 * `minetest.strip_background_colors(str)`
3293 * Removes background colors added by `get_background_escape_sequence`.
3294 * `minetest.strip_colors(str)`
3295 * Removes all color escape sequences.
3303 Minetest stores 3-dimensional spatial vectors in Lua as tables of 3 coordinates,
3304 and has a class to represent them (`vector.*`), which this chapter is about.
3305 For details on what a spatial vectors is, please refer to Wikipedia:
3306 https://en.wikipedia.org/wiki/Euclidean_vector.
3308 Spatial vectors are used for various things, including, but not limited to:
3310 * any 3D spatial vector (x/y/z-directions)
3311 * Euler angles (pitch/yaw/roll in radians) (Spatial vectors have no real semantic
3312 meaning here. Therefore, most vector operations make no sense in this use case.)
3314 Note that they are *not* used for:
3316 * n-dimensional vectors where n is not 3 (ie. n=2)
3317 * arrays of the form `{num, num, num}`
3319 The API documentation may refer to spatial vectors, as produced by `vector.new`,
3320 by any of the following notations:
3322 * `(x, y, z)` (Used rarely, and only if it's clear that it's a vector.)
3323 * `vector.new(x, y, z)`
3324 * `{x=num, y=num, z=num}` (Even here you are still supposed to use `vector.new`.)
3329 Vectors used to be defined as tables of the form `{x = num, y = num, z = num}`.
3330 Since Minetest 5.5.0, vectors additionally have a metatable to enable easier use.
3331 Note: Those old-style vectors can still be found in old mod code. Hence, mod and
3332 engine APIs still need to be able to cope with them in many places.
3334 Manually constructed tables are deprecated and highly discouraged. This interface
3335 should be used to ensure seamless compatibility between mods and the Minetest API.
3336 This is especially important to callback function parameters and functions overwritten
3338 Also, though not likely, the internal implementation of a vector might change in
3340 In your own code, or if you define your own API, you can, of course, still use
3341 other representations of vectors.
3343 Vectors provided by API functions will provide an instance of this class if not
3344 stated otherwise. Mods should adapt this for convenience reasons.
3346 Special properties of the class
3347 -------------------------------
3349 Vectors can be indexed with numbers and allow method and operator syntax.
3351 All these forms of addressing a vector `v` are valid:
3352 `v[1]`, `v[3]`, `v.x`, `v[1] = 42`, `v.y = 13`
3353 Note: Prefer letter over number indexing for performance and compatibility reasons.
3355 Where `v` is a vector and `foo` stands for any function name, `v:foo(...)` does
3356 the same as `vector.foo(v, ...)`, apart from deprecated functionality.
3358 `tostring` is defined for vectors, see `vector.to_string`.
3360 The metatable that is used for vectors can be accessed via `vector.metatable`.
3363 All `vector.*` functions allow vectors `{x = X, y = Y, z = Z}` without metatables.
3364 Returned vectors always have a metatable set.
3366 Common functions and methods
3367 ----------------------------
3369 For the following functions (and subchapters),
3370 `v`, `v1`, `v2` are vectors,
3371 `p1`, `p2` are position vectors,
3372 `s` is a scalar (a number),
3373 vectors are written like this: `(x, y, z)`:
3375 * `vector.new([a[, b, c]])`:
3376 * Returns a new vector `(a, b, c)`.
3377 * Deprecated: `vector.new()` does the same as `vector.zero()` and
3378 `vector.new(v)` does the same as `vector.copy(v)`
3380 * Returns a new vector `(0, 0, 0)`.
3382 * Returns a copy of the vector `v`.
3383 * `vector.from_string(s[, init])`:
3384 * Returns `v, np`, where `v` is a vector read from the given string `s` and
3385 `np` is the next position in the string after the vector.
3386 * Returns `nil` on failure.
3387 * `s`: Has to begin with a substring of the form `"(x, y, z)"`. Additional
3388 spaces, leaving away commas and adding an additional comma to the end
3390 * `init`: If given starts looking for the vector at this string index.
3391 * `vector.to_string(v)`:
3392 * Returns a string of the form `"(x, y, z)"`.
3393 * `tostring(v)` does the same.
3394 * `vector.direction(p1, p2)`:
3395 * Returns a vector of length 1 with direction `p1` to `p2`.
3396 * If `p1` and `p2` are identical, returns `(0, 0, 0)`.
3397 * `vector.distance(p1, p2)`:
3398 * Returns zero or a positive number, the distance between `p1` and `p2`.
3399 * `vector.length(v)`:
3400 * Returns zero or a positive number, the length of vector `v`.
3401 * `vector.normalize(v)`:
3402 * Returns a vector of length 1 with direction of vector `v`.
3403 * If `v` has zero length, returns `(0, 0, 0)`.
3404 * `vector.floor(v)`:
3405 * Returns a vector, each dimension rounded down.
3406 * `vector.round(v)`:
3407 * Returns a vector, each dimension rounded to nearest integer.
3408 * At a multiple of 0.5, rounds away from zero.
3409 * `vector.apply(v, func)`:
3410 * Returns a vector where the function `func` has been applied to each
3412 * `vector.combine(v, w, func)`:
3413 * Returns a vector where the function `func` has combined both components of `v` and `w`
3415 * `vector.equals(v1, v2)`:
3416 * Returns a boolean, `true` if the vectors are identical.
3417 * `vector.sort(v1, v2)`:
3418 * Returns in order minp, maxp vectors of the cuboid defined by `v1`, `v2`.
3419 * `vector.angle(v1, v2)`:
3420 * Returns the angle between `v1` and `v2` in radians.
3421 * `vector.dot(v1, v2)`:
3422 * Returns the dot product of `v1` and `v2`.
3423 * `vector.cross(v1, v2)`:
3424 * Returns the cross product of `v1` and `v2`.
3425 * `vector.offset(v, x, y, z)`:
3426 * Returns the sum of the vectors `v` and `(x, y, z)`.
3427 * `vector.check(v)`:
3428 * Returns a boolean value indicating whether `v` is a real vector, eg. created
3429 by a `vector.*` function.
3430 * Returns `false` for anything else, including tables like `{x=3,y=1,z=4}`.
3432 For the following functions `x` can be either a vector or a number:
3434 * `vector.add(v, x)`:
3436 * If `x` is a vector: Returns the sum of `v` and `x`.
3437 * If `x` is a number: Adds `x` to each component of `v`.
3438 * `vector.subtract(v, x)`:
3440 * If `x` is a vector: Returns the difference of `v` subtracted by `x`.
3441 * If `x` is a number: Subtracts `x` from each component of `v`.
3442 * `vector.multiply(v, s)`:
3443 * Returns a scaled vector.
3444 * Deprecated: If `s` is a vector: Returns the Schur product.
3445 * `vector.divide(v, s)`:
3446 * Returns a scaled vector.
3447 * Deprecated: If `s` is a vector: Returns the Schur quotient.
3452 Operators can be used if all of the involved vectors have metatables:
3454 * Returns whether `v1` and `v2` are identical.
3456 * Returns the additive inverse of v.
3458 * Returns the sum of both vectors.
3459 * Note: `+` can not be used together with scalars.
3461 * Returns the difference of `v1` subtracted by `v2`.
3462 * Note: `-` can not be used together with scalars.
3463 * `v * s` or `s * v`:
3464 * Returns `v` scaled by `s`.
3466 * Returns `v` scaled by `1 / s`.
3468 Rotation-related functions
3469 --------------------------
3471 For the following functions `a` is an angle in radians and `r` is a rotation
3472 vector (`{x = <pitch>, y = <yaw>, z = <roll>}`) where pitch, yaw and roll are
3475 * `vector.rotate(v, r)`:
3476 * Applies the rotation `r` to `v` and returns the result.
3477 * `vector.rotate(vector.new(0, 0, 1), r)` and
3478 `vector.rotate(vector.new(0, 1, 0), r)` return vectors pointing
3479 forward and up relative to an entity's rotation `r`.
3480 * `vector.rotate_around_axis(v1, v2, a)`:
3481 * Returns `v1` rotated around axis `v2` by `a` radians according to
3482 the right hand rule.
3483 * `vector.dir_to_rotation(direction[, up])`:
3484 * Returns a rotation vector for `direction` pointing forward using `up`
3486 * If `up` is omitted, the roll of the returned vector defaults to zero.
3487 * Otherwise `direction` and `up` need to be vectors in a 90 degree angle to each other.
3492 There are more helper functions involving vectors, but they are listed elsewhere
3493 because they only work on specific sorts of vectors or involve things that are not
3498 * `minetest.hash_node_position` (Only works on node positions.)
3499 * `minetest.dir_to_wallmounted` (Involves wallmounted param2 values.)
3507 * `dump2(obj, name, dumped)`: returns a string which makes `obj`
3508 human-readable, handles reference loops.
3509 * `obj`: arbitrary variable
3510 * `name`: string, default: `"_"`
3511 * `dumped`: table, default: `{}`
3512 * `dump(obj, dumped)`: returns a string which makes `obj` human-readable
3513 * `obj`: arbitrary variable
3514 * `dumped`: table, default: `{}`
3515 * `math.hypot(x, y)`
3516 * Get the hypotenuse of a triangle with legs x and y.
3517 Useful for distance calculation.
3518 * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
3519 * Get the sign of a number.
3520 * tolerance: number, default: `0.0`
3521 * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
3523 * `math.factorial(x)`: returns the factorial of `x`
3524 * `math.round(x)`: Returns `x` rounded to the nearest integer.
3525 * At a multiple of 0.5, rounds away from zero.
3526 * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
3527 * `separator`: string, default: `","`
3528 * `include_empty`: boolean, default: `false`
3529 * `max_splits`: number, if it's negative, splits aren't limited,
3531 * `sep_is_pattern`: boolean, it specifies whether separator is a plain
3532 string or a pattern (regex), default: `false`
3533 * e.g. `"a,b":split","` returns `{"a","b"}`
3534 * `string:trim()`: returns the string without whitespace pre- and suffixes
3535 * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
3536 * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
3537 * Adds newlines to the string to keep it within the specified character
3539 * Note that the returned lines may be longer than the limit since it only
3540 splits at word borders.
3541 * `limit`: number, maximal amount of characters in one line
3542 * `as_table`: boolean, if set to true, a table of lines instead of a string
3543 is returned, default: `false`
3544 * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
3545 * `pos`: table {x=X, y=Y, z=Z}
3546 * Converts the position `pos` to a human-readable, printable string
3547 * `decimal_places`: number, if specified, the x, y and z values of
3548 the position are rounded to the given decimal place.
3549 * `minetest.string_to_pos(string)`: returns a position or `nil`
3550 * Same but in reverse.
3551 * If the string can't be parsed to a position, nothing is returned.
3552 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)", relative_to)`:
3553 * returns two positions
3554 * Converts a string representing an area box into two positions
3555 * X1, Y1, ... Z2 are coordinates
3556 * `relative_to`: Optional. If set to a position, each coordinate
3557 can use the tilde notation for relative positions
3558 * Tilde notation: "~": Relative coordinate
3559 "~<number>": Relative coordinate plus <number>
3560 * Example: `minetest.string_to_area("(1,2,3) (~5,~-5,~)", {x=10,y=10,z=10})`
3561 returns `{x=1,y=2,z=3}, {x=15,y=5,z=10}`
3562 * `minetest.formspec_escape(string)`: returns a string
3563 * escapes the characters "[", "]", "\", "," and ";", which can not be used
3565 * `minetest.is_yes(arg)`
3566 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
3567 * `minetest.is_nan(arg)`
3568 * returns true when the passed number represents NaN.
3569 * `minetest.get_us_time()`
3570 * returns time with microsecond precision. May not return wall time.
3571 * `table.copy(table)`: returns a table
3572 * returns a deep copy of `table`
3573 * `table.indexof(list, val)`: returns the smallest numerical index containing
3574 the value `val` in the table `list`. Non-numerical indices are ignored.
3575 If `val` could not be found, `-1` is returned. `list` must not have
3577 * `table.insert_all(table, other_table)`:
3578 * Appends all values in `other_table` to `table` - uses `#table + 1` to
3580 * `table.key_value_swap(t)`: returns a table with keys and values swapped
3581 * If multiple keys in `t` map to the same value, it is unspecified which
3582 value maps to that key.
3583 * `table.shuffle(table, [from], [to], [random_func])`:
3584 * Shuffles elements `from` to `to` in `table` in place
3585 * `from` defaults to `1`
3586 * `to` defaults to `#table`
3587 * `random_func` defaults to `math.random`. This function receives two
3588 integers as arguments and should return a random integer inclusively
3590 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
3592 * returns the exact position on the surface of a pointed node
3593 * `minetest.get_tool_wear_after_use(uses [, initial_wear])`
3594 * Simulates a tool being used once and returns the added wear,
3595 such that, if only this function is used to calculate wear,
3596 the tool will break exactly after `uses` times of uses
3597 * `uses`: Number of times the tool can be used
3598 * `initial_wear`: The initial wear the tool starts with (default: 0)
3599 * `minetest.get_dig_params(groups, tool_capabilities [, wear])`:
3600 Simulates an item that digs a node.
3601 Returns a table with the following fields:
3602 * `diggable`: `true` if node can be dug, `false` otherwise.
3603 * `time`: Time it would take to dig the node.
3604 * `wear`: How much wear would be added to the tool (ignored for non-tools).
3605 `time` and `wear` are meaningless if node's not diggable
3607 * `groups`: Table of the node groups of the node that would be dug
3608 * `tool_capabilities`: Tool capabilities table of the item
3609 * `wear`: Amount of wear the tool starts with (default: 0)
3610 * `minetest.get_hit_params(groups, tool_capabilities [, time_from_last_punch [, wear]])`:
3611 Simulates an item that punches an object.
3612 Returns a table with the following fields:
3613 * `hp`: How much damage the punch would cause (between -65535 and 65535).
3614 * `wear`: How much wear would be added to the tool (ignored for non-tools).
3616 * `groups`: Damage groups of the object
3617 * `tool_capabilities`: Tool capabilities table of the item
3618 * `time_from_last_punch`: time in seconds since last punch action
3619 * `wear`: Amount of wear the item starts with (default: 0)
3627 Texts can be translated client-side with the help of `minetest.translate` and
3630 Translating a string
3631 --------------------
3633 Two functions are provided to translate strings: `minetest.translate` and
3634 `minetest.get_translator`.
3636 * `minetest.get_translator(textdomain)` is a simple wrapper around
3637 `minetest.translate`, and `minetest.get_translator(textdomain)(str, ...)` is
3638 equivalent to `minetest.translate(textdomain, str, ...)`.
3639 It is intended to be used in the following way, so that it avoids verbose
3640 repetitions of `minetest.translate`:
3642 local S = minetest.get_translator(textdomain)
3645 As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
3647 * `minetest.translate(textdomain, str, ...)` translates the string `str` with
3648 the given `textdomain` for disambiguation. The textdomain must match the
3649 textdomain specified in the translation file in order to get the string
3650 translated. This can be used so that a string is translated differently in
3652 It is advised to use the name of the mod as textdomain whenever possible, to
3653 avoid clashes with other mods.
3654 This function must be given a number of arguments equal to the number of
3655 arguments the translated string expects.
3656 Arguments are literal strings -- they will not be translated, so if you want
3657 them to be, they need to come as outputs of `minetest.translate` as well.
3659 For instance, suppose we want to translate "@1 Wool" with "@1" being replaced
3660 by the translation of "Red". We can do the following:
3662 local S = minetest.get_translator()
3663 S("@1 Wool", S("Red"))
3665 This will be displayed as "Red Wool" on old clients and on clients that do
3666 not have localization enabled. However, if we have for instance a translation
3667 file named `wool.fr.tr` containing the following:
3672 this will be displayed as "Laine Rouge" on clients with a French locale.
3674 Operations on translated strings
3675 --------------------------------
3677 The output of `minetest.translate` is a string, with escape sequences adding
3678 additional information to that string so that it can be translated on the
3679 different clients. In particular, you can't expect operations like string.length
3680 to work on them like you would expect them to, or string.gsub to work in the
3681 expected manner. However, string concatenation will still work as expected
3682 (note that you should only use this for things like formspecs; do not translate
3683 sentences by breaking them into parts; arguments should be used instead), and
3684 operations such as `minetest.colorize` which are also concatenation.
3686 Translation file format
3687 -----------------------
3689 A translation file has the suffix `.[lang].tr`, where `[lang]` is the language
3690 it corresponds to. It must be put into the `locale` subdirectory of the mod.
3691 The file should be a text file, with the following format:
3693 * Lines beginning with `# textdomain:` (the space is significant) can be used
3694 to specify the text domain of all following translations in the file.
3695 * All other empty lines or lines beginning with `#` are ignored.
3696 * Other lines should be in the format `original=translated`. Both `original`
3697 and `translated` can contain escape sequences beginning with `@` to insert
3698 arguments, literal `@`, `=` or newline (See [Escapes] below).
3699 There must be no extraneous whitespace around the `=` or at the beginning or
3700 the end of the line.
3705 Strings that need to be translated can contain several escapes, preceded by `@`.
3707 * `@@` acts as a literal `@`.
3708 * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated
3709 string that will be inlined when translated. Due to how translations are
3710 implemented, the original translation string **must** have its arguments in
3711 increasing order, without gaps or repetitions, starting from 1.
3712 * `@=` acts as a literal `=`. It is not required in strings given to
3713 `minetest.translate`, but is in translation files to avoid being confused
3714 with the `=` separating the original from the translation.
3715 * `@\n` (where the `\n` is a literal newline) acts as a literal newline.
3716 As with `@=`, this escape is not required in strings given to
3717 `minetest.translate`, but is in translation files.
3718 * `@n` acts as a literal newline as well.
3720 Server side translations
3721 ------------------------
3723 On some specific cases, server translation could be useful. For example, filter
3724 a list on labels and send results to client. A method is supplied to achieve
3727 `minetest.get_translated_string(lang_code, string)`: Translates `string` using
3728 translations for `lang_code` language. It gives the same result as if the string
3729 was translated by the client.
3731 The `lang_code` to use for a given player can be retrieved from
3732 the table returned by `minetest.get_player_information(name)`.
3734 IMPORTANT: This functionality should only be used for sorting, filtering or similar purposes.
3735 You do not need to use this to get translated strings to show up on the client.
3740 Perlin noise creates a continuously-varying value depending on the input values.
3741 Usually in Minetest the input values are either 2D or 3D co-ordinates in nodes.
3742 The result is used during map generation to create the terrain shape, vary heat
3743 and humidity to distribute biomes, vary the density of decorations or vary the
3746 Structure of perlin noise
3747 -------------------------
3749 An 'octave' is a simple noise generator that outputs a value between -1 and 1.
3750 The smooth wavy noise it generates has a single characteristic scale, almost
3751 like a 'wavelength', so on its own does not create fine detail.
3752 Due to this perlin noise combines several octaves to create variation on
3753 multiple scales. Each additional octave has a smaller 'wavelength' than the
3756 This combination results in noise varying very roughly between -2.0 and 2.0 and
3757 with an average value of 0.0, so `scale` and `offset` are then used to multiply
3758 and offset the noise variation.
3760 The final perlin noise variation is created as follows:
3762 noise = offset + scale * (octave1 +
3763 octave2 * persistence +
3764 octave3 * persistence ^ 2 +
3765 octave4 * persistence ^ 3 +
3771 Noise Parameters are commonly called `NoiseParams`.
3775 After the multiplication by `scale` this is added to the result and is the final
3776 step in creating the noise value.
3777 Can be positive or negative.
3781 Once all octaves have been combined, the result is multiplied by this.
3782 Can be positive or negative.
3786 For octave1, this is roughly the change of input value needed for a very large
3787 variation in the noise value generated by octave1. It is almost like a
3788 'wavelength' for the wavy noise variation.
3789 Each additional octave has a 'wavelength' that is smaller than the previous
3790 octave, to create finer detail. `spread` will therefore roughly be the typical
3791 size of the largest structures in the final noise variation.
3793 `spread` is a vector with values for x, y, z to allow the noise variation to be
3794 stretched or compressed in the desired axes.
3795 Values are positive numbers.
3799 This is a whole number that determines the entire pattern of the noise
3800 variation. Altering it enables different noise patterns to be created.
3801 With other parameters equal, different seeds produce different noise patterns
3802 and identical seeds produce identical noise patterns.
3804 For this parameter you can randomly choose any whole number. Usually it is
3805 preferable for this to be different from other seeds, but sometimes it is useful
3806 to be able to create identical noise patterns.
3808 In some noise APIs the world seed is added to the seed specified in noise
3809 parameters. This is done to make the resulting noise pattern vary in different
3810 worlds, and be 'world-specific'.
3814 The number of simple noise generators that are combined.
3815 A whole number, 1 or more.
3816 Each additional octave adds finer detail to the noise but also increases the
3817 noise calculation load.
3818 3 is a typical minimum for a high quality, complex and natural-looking noise
3819 variation. 1 octave has a slight 'gridlike' appearance.
3821 Choose the number of octaves according to the `spread` and `lacunarity`, and the
3822 size of the finest detail you require. For example:
3823 if `spread` is 512 nodes, `lacunarity` is 2.0 and finest detail required is 16
3824 nodes, octaves will be 6 because the 'wavelengths' of the octaves will be
3825 512, 256, 128, 64, 32, 16 nodes.
3826 Warning: If the 'wavelength' of any octave falls below 1 an error will occur.
3830 Each additional octave has an amplitude that is the amplitude of the previous
3831 octave multiplied by `persistence`, to reduce the amplitude of finer details,
3832 as is often helpful and natural to do so.
3833 Since this controls the balance of fine detail to large-scale detail
3834 `persistence` can be thought of as the 'roughness' of the noise.
3836 A positive or negative non-zero number, often between 0.3 and 1.0.
3837 A common medium value is 0.5, such that each octave has half the amplitude of
3838 the previous octave.
3839 This may need to be tuned when altering `lacunarity`; when doing so consider
3840 that a common medium value is 1 / lacunarity.
3844 Each additional octave has a 'wavelength' that is the 'wavelength' of the
3845 previous octave multiplied by 1 / lacunarity, to create finer detail.
3846 'lacunarity' is often 2.0 so 'wavelength' often halves per octave.
3848 A positive number no smaller than 1.0.
3849 Values below 2.0 create higher quality noise at the expense of requiring more
3850 octaves to cover a paticular range of 'wavelengths'.
3854 Leave this field unset for no special handling.
3855 Currently supported are `defaults`, `eased` and `absvalue`:
3859 Specify this if you would like to keep auto-selection of eased/not-eased while
3860 specifying some other flags.
3864 Maps noise gradient values onto a quintic S-curve before performing
3865 interpolation. This results in smooth, rolling noise.
3866 Disable this (`noeased`) for sharp-looking noise with a slightly gridded
3868 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is
3870 Easing a 3D noise significantly increases the noise calculation load, so use
3875 The absolute value of each octave's noise variation is used when combining the
3876 octaves. The final perlin noise variation is created as follows:
3878 noise = offset + scale * (abs(octave1) +
3879 abs(octave2) * persistence +
3880 abs(octave3) * persistence ^ 2 +
3881 abs(octave4) * persistence ^ 3 +
3886 For 2D or 3D perlin noise or perlin noise maps:
3891 spread = {x = 500, y = 500, z = 500},
3896 flags = "defaults, absvalue",
3899 For 2D noise the Z component of `spread` is still defined but is ignored.
3900 A single noise parameter table can be used for 2D or 3D noise.
3911 These tell in what manner the ore is generated.
3913 All default ores are of the uniformly-distributed scatter type.
3917 Randomly chooses a location and generates a cluster of ore.
3919 If `noise_params` is specified, the ore will be placed if the 3D perlin noise
3920 at that point is greater than the `noise_threshold`, giving the ability to
3921 create a non-equal distribution of ore.
3925 Creates a sheet of ore in a blob shape according to the 2D perlin noise
3926 described by `noise_params` and `noise_threshold`. This is essentially an
3927 improved version of the so-called "stratus" ore seen in some unofficial mods.
3929 This sheet consists of vertical columns of uniform randomly distributed height,
3930 varying between the inclusive range `column_height_min` and `column_height_max`.
3931 If `column_height_min` is not specified, this parameter defaults to 1.
3932 If `column_height_max` is not specified, this parameter defaults to `clust_size`
3933 for reverse compatibility. New code should prefer `column_height_max`.
3935 The `column_midpoint_factor` parameter controls the position of the column at
3936 which ore emanates from.
3937 If 1, columns grow upward. If 0, columns grow downward. If 0.5, columns grow
3938 equally starting from each direction.
3939 `column_midpoint_factor` is a decimal number ranging in value from 0 to 1. If
3940 this parameter is not specified, the default is 0.5.
3942 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this
3947 Creates a sheet of ore in a cloud-like puff shape.
3949 As with the `sheet` ore type, the size and shape of puffs are described by
3950 `noise_params` and `noise_threshold` and are placed at random vertical
3951 positions within the currently generated chunk.
3953 The vertical top and bottom displacement of each puff are determined by the
3954 noise parameters `np_puff_top` and `np_puff_bottom`, respectively.
3958 Creates a deformed sphere of ore according to 3d perlin noise described by
3959 `noise_params`. The maximum size of the blob is `clust_size`, and
3960 `clust_scarcity` has the same meaning as with the `scatter` type.
3964 Creates veins of ore varying in density by according to the intersection of two
3965 instances of 3d perlin noise with different seeds, both described by
3968 `random_factor` varies the influence random chance has on placement of an ore
3969 inside the vein, which is `1` by default. Note that modifying this parameter
3970 may require adjusting `noise_threshold`.
3972 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
3975 This ore type is difficult to control since it is sensitive to small changes.
3976 The following is a decent set of parameters to work from:
3981 spread = {x=200, y=200, z=200},
3988 noise_threshold = 1.6
3990 **WARNING**: Use this ore type *very* sparingly since it is ~200x more
3991 computationally expensive than any other ore.
3995 Creates a single undulating ore stratum that is continuous across mapchunk
3996 borders and horizontally spans the world.
3998 The 2D perlin noise described by `noise_params` defines the Y co-ordinate of
3999 the stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
4000 defines the stratum's vertical thickness (in units of nodes). Due to being
4001 continuous across mapchunk borders the stratum's vertical thickness is
4004 If the noise parameter `noise_params` is omitted the ore will occur from y_min
4005 to y_max in a simple horizontal stratum.
4007 A parameter `stratum_thickness` can be provided instead of the noise parameter
4008 `np_stratum_thickness`, to create a constant thickness.
4010 Leaving out one or both noise parameters makes the ore generation less
4011 intensive, useful when adding multiple strata.
4013 `y_min` and `y_max` define the limits of the ore generation and for performance
4014 reasons should be set as close together as possible but without clipping the
4015 stratum's Y variation.
4017 Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
4018 solid-ore stratum would require a `clust_scarcity` of 1.
4020 The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
4021 `random_factor` are ignored by this ore type.
4026 See section [Flag Specifier Format].
4028 Currently supported flags:
4029 `puff_cliffs`, `puff_additive_composition`.
4033 If set, puff ore generation will not taper down large differences in
4034 displacement when approaching the edge of a puff. This flag has no effect for
4035 ore types other than `puff`.
4037 ### `puff_additive_composition`
4039 By default, when noise described by `np_puff_top` or `np_puff_bottom` results
4040 in a negative displacement, the sub-column at that point is not generated. With
4041 this attribute set, puff ore generation will instead generate the absolute
4042 difference in noise displacement values. This flag has no effect for ore types
4051 The varying types of decorations that can be placed.
4056 Creates a 1 times `H` times 1 column of a specified node (or a random node from
4057 a list, if a decoration list is specified). Can specify a certain node it must
4058 spawn next to, such as water or lava, for example. Can also generate a
4059 decoration of random height between a specified lower and upper bound.
4060 This type of decoration is intended for placement of grass, flowers, cacti,
4061 papyri, waterlilies and so on.
4066 Copies a box of `MapNodes` from a specified schematic file (or raw description).
4067 Can specify a probability of a node randomly appearing when placed.
4068 This decoration type is intended to be used for multi-node sized discrete
4069 structures, such as trees, cave spikes, rocks, and so on.
4078 --------------------
4080 A schematic specifier identifies a schematic by either a filename to a
4081 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
4082 in the form of a table. This table specifies the following fields:
4084 * The `size` field is a 3D vector containing the dimensions of the provided
4085 schematic. (required field)
4086 * The `yslice_prob` field is a table of {ypos, prob} slice tables. A slice table
4087 sets the probability of a particular horizontal slice of the schematic being
4088 placed. (optional field)
4089 `ypos` = 0 for the lowest horizontal slice of a schematic.
4090 The default of `prob` is 255.
4091 * The `data` field is a flat table of MapNode tables making up the schematic,
4092 in the order of `[z [y [x]]]`. (required field)
4093 Each MapNode table contains:
4094 * `name`: the name of the map node to place (required)
4095 * `prob` (alias `param1`): the probability of this node being placed
4097 * `param2`: the raw param2 value of the node being placed onto the map
4099 * `force_place`: boolean representing if the node should forcibly overwrite
4100 any previous contents (default: false)
4102 About probability values:
4104 * A probability value of `0` or `1` means that node will never appear
4106 * A probability value of `254` or `255` means the node will always appear
4108 * If the probability value `p` is greater than `1`, then there is a
4109 `(p / 256 * 100)` percent chance that node will appear when the schematic is
4112 Schematic attributes
4113 --------------------
4115 See section [Flag Specifier Format].
4117 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
4120 * `place_center_x`: Placement of this decoration is centered along the X axis.
4121 * `place_center_y`: Placement of this decoration is centered along the Y axis.
4122 * `place_center_z`: Placement of this decoration is centered along the Z axis.
4123 * `force_placement`: Schematic nodes other than "ignore" will replace existing
4129 Lua Voxel Manipulator
4130 =====================
4135 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator'
4136 facility. The purpose of this object is for fast, low-level, bulk access to
4137 reading and writing Map content. As such, setting map nodes through VoxelManip
4138 will lack many of the higher level features and concepts you may be used to
4139 with other methods of setting nodes. For example, nodes will not have their
4140 construction and destruction callbacks run, and no rollback information is
4143 It is important to note that VoxelManip is designed for speed, and *not* ease
4144 of use or flexibility. If your mod requires a map manipulation facility that
4145 will handle 100% of all edge cases, or the use of high level node placement
4146 features, perhaps `minetest.set_node()` is better suited for the job.
4148 In addition, VoxelManip might not be faster, or could even be slower, for your
4149 specific use case. VoxelManip is most effective when setting large areas of map
4150 at once - for example, if only setting a 3x3x3 node area, a
4151 `minetest.set_node()` loop may be more optimal. Always profile code using both
4152 methods of map manipulation to determine which is most appropriate for your
4155 A recent simple test of setting cubic areas showed that `minetest.set_node()`
4156 is faster than a VoxelManip for a 3x3x3 node cube or smaller.
4161 A VoxelManip object can be created any time using either:
4162 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
4164 If the optional position parameters are present for either of these routines,
4165 the specified region will be pre-loaded into the VoxelManip object on creation.
4166 Otherwise, the area of map you wish to manipulate must first be loaded into the
4167 VoxelManip object using `VoxelManip:read_from_map()`.
4169 Note that `VoxelManip:read_from_map()` returns two position vectors. The region
4170 formed by these positions indicate the minimum and maximum (respectively)
4171 positions of the area actually loaded in the VoxelManip, which may be larger
4172 than the area requested. For convenience, the loaded area coordinates can also
4173 be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
4175 Now that the VoxelManip object is populated with map data, your mod can fetch a
4176 copy of this data using either of two methods. `VoxelManip:get_node_at()`,
4177 which retrieves an individual node in a MapNode formatted table at the position
4178 requested is the simplest method to use, but also the slowest.
4180 Nodes in a VoxelManip object may also be read in bulk to a flat array table
4183 * `VoxelManip:get_data()` for node content (in Content ID form, see section
4185 * `VoxelManip:get_light_data()` for node light levels, and
4186 * `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
4188 See section [Flat array format] for more details.
4190 It is very important to understand that the tables returned by any of the above
4191 three functions represent a snapshot of the VoxelManip's internal state at the
4192 time of the call. This copy of the data will not magically update itself if
4193 another function modifies the internal VoxelManip state.
4194 Any functions that modify a VoxelManip's contents work on the VoxelManip's
4195 internal state unless otherwise explicitly stated.
4197 Once the bulk data has been edited to your liking, the internal VoxelManip
4198 state can be set using:
4200 * `VoxelManip:set_data()` for node content (in Content ID form, see section
4202 * `VoxelManip:set_light_data()` for node light levels, and
4203 * `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
4205 The parameter to each of the above three functions can use any table at all in
4206 the same flat array format as produced by `get_data()` etc. and is not required
4207 to be a table retrieved from `get_data()`.
4209 Once the internal VoxelManip state has been modified to your liking, the
4210 changes can be committed back to the map by calling `VoxelManip:write_to_map()`
4212 ### Flat array format
4215 `Nx = p2.X - p1.X + 1`,
4216 `Ny = p2.Y - p1.Y + 1`, and
4217 `Nz = p2.Z - p1.Z + 1`.
4219 Then, for a loaded region of p1..p2, this array ranges from `1` up to and
4220 including the value of the expression `Nx * Ny * Nz`.
4222 Positions offset from p1 are present in the array with the format of:
4225 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
4226 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
4228 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
4229 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
4231 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
4233 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
4236 and the array index for a position p contained completely in p1..p2 is:
4238 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
4240 Note that this is the same "flat 3D array" format as
4241 `PerlinNoiseMap:get3dMap_flat()`.
4242 VoxelArea objects (see section [`VoxelArea`]) can be used to simplify calculation
4243 of the index for a single point in a flat VoxelManip array.
4247 A Content ID is a unique integer identifier for a specific node type.
4248 These IDs are used by VoxelManip in place of the node name string for
4249 `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
4250 `minetest.get_content_id()` to look up the Content ID for the specified node
4251 name, and `minetest.get_name_from_content_id()` to look up the node name string
4252 for a given Content ID.
4253 After registration of a node, its Content ID will remain the same throughout
4254 execution of the mod.
4255 Note that the node being queried needs to have already been been registered.
4257 The following builtin node types have their Content IDs defined as constants:
4259 * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
4260 * `minetest.CONTENT_AIR`: ID for "air" nodes
4261 * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
4263 ### Mapgen VoxelManip objects
4265 Inside of `on_generated()` callbacks, it is possible to retrieve the same
4266 VoxelManip object used by the core's Map Generator (commonly abbreviated
4267 Mapgen). Most of the rules previously described still apply but with a few
4270 * The Mapgen VoxelManip object is retrieved using:
4271 `minetest.get_mapgen_object("voxelmanip")`
4272 * This VoxelManip object already has the region of map just generated loaded
4273 into it; it's not necessary to call `VoxelManip:read_from_map()` before using
4274 a Mapgen VoxelManip.
4275 * The `on_generated()` callbacks of some mods may place individual nodes in the
4276 generated area using non-VoxelManip map modification methods. Because the
4277 same Mapgen VoxelManip object is passed through each `on_generated()`
4278 callback, it becomes necessary for the Mapgen VoxelManip object to maintain
4279 consistency with the current map state. For this reason, calling any of the
4280 following functions:
4281 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
4282 will also update the Mapgen VoxelManip object's internal state active on the
4284 * After modifying the Mapgen VoxelManip object's internal buffer, it may be
4285 necessary to update lighting information using either:
4286 `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
4288 ### Other API functions operating on a VoxelManip
4290 If any VoxelManip contents were set to a liquid node (`liquidtype ~= "none"`),
4291 `VoxelManip:update_liquids()` must be called for these liquid nodes to begin
4292 flowing. It is recommended to call this function only after having written all
4293 buffered data back to the VoxelManip object, save for special situations where
4294 the modder desires to only have certain liquid nodes begin flowing.
4296 The functions `minetest.generate_ores()` and `minetest.generate_decorations()`
4297 will generate all registered decorations and ores throughout the full area
4298 inside of the specified VoxelManip object.
4300 `minetest.place_schematic_on_vmanip()` is otherwise identical to
4301 `minetest.place_schematic()`, except instead of placing the specified schematic
4302 directly on the map at the specified position, it will place the schematic
4303 inside the VoxelManip.
4307 * Attempting to read data from a VoxelManip object before map is read will
4308 result in a zero-length array table for `VoxelManip:get_data()`, and an
4309 "ignore" node at any position for `VoxelManip:get_node_at()`.
4310 * If either a region of map has not yet been generated or is out-of-bounds of
4311 the map, that region is filled with "ignore" nodes.
4312 * Other mods, or the core itself, could possibly modify the area of map
4313 currently loaded into a VoxelManip object. With the exception of Mapgen
4314 VoxelManips (see above section), the internal buffers are not updated. For
4315 this reason, it is strongly encouraged to complete the usage of a particular
4316 VoxelManip object in the same callback it had been created.
4317 * If a VoxelManip object will be used often, such as in an `on_generated()`
4318 callback, consider passing a file-scoped table as the optional parameter to
4319 `VoxelManip:get_data()`, which serves as a static buffer the function can use
4320 to write map data to instead of returning a new table each call. This greatly
4321 enhances performance by avoiding unnecessary memory allocations.
4326 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object
4327 containing the region formed by `p1` and `p2`.
4328 * returns actual emerged `pmin`, actual emerged `pmax`
4329 * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to
4331 * **important**: data must be set using `VoxelManip:set_data()` before
4333 * if `light` is true, then lighting is automatically recalculated.
4334 The default value is true.
4335 If `light` is false, no light calculations happen, and you should correct
4336 all modified blocks with `minetest.fix_light()` as soon as possible.
4337 Keep in mind that modifying the map where light is incorrect can cause
4339 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
4340 the `VoxelManip` at that position
4341 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
4343 * `get_data([buffer])`: Retrieves the node content data loaded into the
4344 `VoxelManip` object.
4345 * returns raw node data in the form of an array of node content IDs
4346 * if the param `buffer` is present, this table will be used to store the
4348 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
4349 * `update_map()`: Does nothing, kept for compatibility.
4350 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to
4352 * `light` is a table, `{day=<0...15>, night=<0...15>}`
4353 * To be used only by a `VoxelManip` object from
4354 `minetest.get_mapgen_object`.
4355 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4357 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
4358 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4360 * Each value is the bitwise combination of day and night light values
4362 * `light = day + (night * 16)`
4363 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
4364 in the `VoxelManip`.
4365 * expects lighting data in the same format that `get_light_data()` returns
4366 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the
4367 `VoxelManip` object.
4368 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4370 * If the param `buffer` is present, this table will be used to store the
4372 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in
4374 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the
4376 * To be used only by a `VoxelManip` object from
4377 `minetest.get_mapgen_object`.
4378 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4379 area if left out or nil. For almost all uses these should be left out
4380 or nil to use the default.
4381 * `propagate_shadow` is an optional boolean deciding whether shadows in a
4382 generated mapchunk above are propagated down into the mapchunk, defaults
4383 to `true` if left out.
4384 * `update_liquids()`: Update liquid flow
4385 * `was_modified()`: Returns `true` or `false` if the data in the voxel
4386 manipulator had been modified since the last read from map, due to a call to
4387 `minetest.set_data()` on the loaded area elsewhere.
4388 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
4393 A helper class for voxel areas.
4394 It can be created via `VoxelArea:new{MinEdge = pmin, MaxEdge = pmax}`.
4395 The coordinates are *inclusive*, like most other things in Minetest.
4399 * `getExtent()`: returns a 3D vector containing the size of the area formed by
4400 `MinEdge` and `MaxEdge`.
4401 * `getVolume()`: returns the volume of the area formed by `MinEdge` and
4403 * `index(x, y, z)`: returns the index of an absolute position in a flat array
4405 * `x`, `y` and `z` must be integers to avoid an incorrect index result.
4406 * The position (x, y, z) is not checked for being inside the area volume,
4407 being outside can cause an incorrect index result.
4408 * Useful for things like `VoxelManip`, raw Schematic specifiers,
4409 `PerlinNoiseMap:get2d`/`3dMap`, and so on.
4410 * `indexp(p)`: same functionality as `index(x, y, z)` but takes a vector.
4411 * As with `index(x, y, z)`, the components of `p` must be integers, and `p`
4412 is not checked for being inside the area volume.
4413 * `position(i)`: returns the absolute position vector corresponding to index
4415 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by
4416 `MinEdge` and `MaxEdge`.
4417 * `containsp(p)`: same as above, except takes a vector
4418 * `containsi(i)`: same as above, except takes an index `i`
4419 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns
4421 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of
4423 * `iterp(minp, maxp)`: same as above, except takes a vector
4425 ### Y stride and z stride of a flat array
4427 For a particular position in a voxel area, whose flat array index is known,
4428 it is often useful to know the index of a neighboring or nearby position.
4429 The table below shows the changes of index required for 1 node movements along
4430 the axes in a voxel area:
4432 Movement Change of index
4442 local area = VoxelArea:new{MinEdge = emin, MaxEdge = emax}
4444 The values of `ystride` and `zstride` can be obtained using `area.ystride` and
4453 A mapgen object is a construct used in map generation. Mapgen objects can be
4454 used by an `on_generate` callback to speed up operations by avoiding
4455 unnecessary recalculations, these can be retrieved using the
4456 `minetest.get_mapgen_object()` function. If the requested Mapgen object is
4457 unavailable, or `get_mapgen_object()` was called outside of an `on_generate()`
4458 callback, `nil` is returned.
4460 The following Mapgen objects are currently available:
4464 This returns three values; the `VoxelManip` object to be used, minimum and
4465 maximum emerged position, in that order. All mapgens support this object.
4469 Returns an array containing the y coordinates of the ground levels of nodes in
4470 the most recently generated chunk by the current mapgen.
4474 Returns an array containing the biome IDs of nodes in the most recently
4475 generated chunk by the current mapgen.
4479 Returns an array containing the temperature values of nodes in the most
4480 recently generated chunk by the current mapgen.
4484 Returns an array containing the humidity values of nodes in the most recently
4485 generated chunk by the current mapgen.
4489 Returns a table mapping requested generation notification types to arrays of
4490 positions at which the corresponding generated structures are located within
4491 the current chunk. To set the capture of positions of interest to be recorded
4492 on generate, use `minetest.set_gen_notify()`.
4493 For decorations, the returned positions are the ground surface 'place_on'
4494 nodes, not the decorations themselves. A 'simple' type decoration is often 1
4495 node above the returned position and possibly displaced by 'place_offset_y'.
4497 Possible fields of the table returned are:
4503 * `large_cave_begin`
4507 Decorations have a key in the format of `"decoration#id"`, where `id` is the
4508 numeric unique decoration ID as returned by `minetest.get_decoration_id`.
4516 Functions receive a "luaentity" as `self`:
4518 * It has the member `.name`, which is the registered name `("mod:thing")`
4519 * It has the member `.object`, which is an `ObjectRef` pointing to the object
4520 * The original prototype stuff is visible directly via a metatable
4524 * `on_activate(self, staticdata, dtime_s)`
4525 * Called when the object is instantiated.
4526 * `dtime_s` is the time passed since the object was unloaded, which can be
4527 used for updating the entity state.
4528 * `on_deactivate(self)
4529 * Called when the object is about to get removed or unloaded.
4530 * `on_step(self, dtime)`
4531 * Called on every server tick, after movement and collision processing.
4532 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
4534 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)`
4535 * Called when somebody punches the object.
4536 * Note that you probably want to handle most punches using the automatic
4538 * `puncher`: an `ObjectRef` (can be `nil`)
4539 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4541 * `tool_capabilities`: capability table of used item (can be `nil`)
4542 * `dir`: unit vector of direction of punch. Always defined. Points from the
4543 puncher to the punched.
4544 * `damage`: damage that will be done to entity.
4545 * Can return `true` to prevent the default damage mechanism.
4546 * `on_death(self, killer)`
4547 * Called when the object dies.
4548 * `killer`: an `ObjectRef` (can be `nil`)
4549 * `on_rightclick(self, clicker)`
4550 * Called when `clicker` pressed the 'place/use' key while pointing
4551 to the object (not neccessarily an actual rightclick)
4552 * `clicker`: an `ObjectRef` (may or may not be a player)
4553 * `on_attach_child(self, child)`
4554 * `child`: an `ObjectRef` of the child that attaches
4555 * `on_detach_child(self, child)`
4556 * `child`: an `ObjectRef` of the child that detaches
4557 * `on_detach(self, parent)`
4558 * `parent`: an `ObjectRef` (can be `nil`) from where it got detached
4559 * This happens before the parent object is removed from the world
4560 * `get_staticdata(self)`
4561 * Should return a string that will be passed to `on_activate` when the
4562 object is instantiated the next time.
4574 axiom, --string initial tree axiom
4575 rules_a, --string rules set A
4576 rules_b, --string rules set B
4577 rules_c, --string rules set C
4578 rules_d, --string rules set D
4579 trunk, --string trunk node name
4580 leaves, --string leaves node name
4581 leaves2, --string secondary leaves node name
4582 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
4583 angle, --num angle in deg
4584 iterations, --num max # of iterations, usually 2 -5
4585 random_level, --num factor to lower nr of iterations, usually 0 - 3
4586 trunk_type, --string single/double/crossed) type of trunk: 1 node,
4587 -- 2x2 nodes or 3x3 in cross shape
4588 thin_branches, --boolean true -> use thin (1 node) branches
4589 fruit, --string fruit node name
4590 fruit_chance, --num chance (0-100) to replace leaves with fruit node
4591 seed, --num random seed, if no seed is provided, the engine
4595 Key for special L-System symbols used in axioms
4596 -----------------------------------------------
4598 * `G`: move forward one unit with the pen up
4599 * `F`: move forward one unit with the pen down drawing trunks and branches
4600 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
4601 * `T`: move forward one unit with the pen down drawing trunks only
4602 * `R`: move forward one unit with the pen down placing fruit
4603 * `A`: replace with rules set A
4604 * `B`: replace with rules set B
4605 * `C`: replace with rules set C
4606 * `D`: replace with rules set D
4607 * `a`: replace with rules set A, chance 90%
4608 * `b`: replace with rules set B, chance 80%
4609 * `c`: replace with rules set C, chance 70%
4610 * `d`: replace with rules set D, chance 60%
4611 * `+`: yaw the turtle right by `angle` parameter
4612 * `-`: yaw the turtle left by `angle` parameter
4613 * `&`: pitch the turtle down by `angle` parameter
4614 * `^`: pitch the turtle up by `angle` parameter
4615 * `/`: roll the turtle to the right by `angle` parameter
4616 * `*`: roll the turtle to the left by `angle` parameter
4617 * `[`: save in stack current state info
4618 * `]`: recover from stack state info
4623 Spawn a small apple tree:
4625 pos = {x=230,y=20,z=4}
4628 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
4629 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
4630 trunk="default:tree",
4631 leaves="default:leaves",
4635 trunk_type="single",
4638 fruit="default:apple"
4640 minetest.spawn_tree(pos,apple_tree)
4645 'minetest' namespace reference
4646 ==============================
4651 * `minetest.get_current_modname()`: returns the currently loading mod's name,
4653 * `minetest.get_modpath(modname)`: returns the directory path for a mod,
4654 e.g. `"/home/user/.minetest/usermods/modname"`.
4655 * Returns nil if the mod is not enabled or does not exist (not installed).
4656 * Works regardless of whether the mod has been loaded yet.
4657 * Useful for loading additional `.lua` modules or static data from a mod,
4658 or checking if a mod is enabled.
4659 * `minetest.get_modnames()`: returns a list of enabled mods, sorted alphabetically.
4660 * Does not include disabled mods, even if they are installed.
4661 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
4662 * Useful for storing custom data
4663 * `minetest.is_singleplayer()`
4664 * `minetest.features`: Table containing API feature flags
4667 glasslike_framed = true, -- 0.4.7
4668 nodebox_as_selectionbox = true, -- 0.4.7
4669 get_all_craft_recipes_works = true, -- 0.4.7
4670 -- The transparency channel of textures can optionally be used on
4672 use_texture_alpha = true,
4673 -- Tree and grass ABMs are no longer done from C++ (0.4.8)
4674 no_legacy_abms = true,
4675 -- Texture grouping is possible using parentheses (0.4.11)
4676 texture_names_parens = true,
4677 -- Unique Area ID for AreaStore:insert_area (0.4.14)
4678 area_store_custom_ids = true,
4679 -- add_entity supports passing initial staticdata to on_activate
4681 add_entity_with_staticdata = true,
4682 -- Chat messages are no longer predicted (0.4.16)
4683 no_chat_message_prediction = true,
4684 -- The transparency channel of textures can optionally be used on
4685 -- objects (ie: players and lua entities) (5.0.0)
4686 object_use_texture_alpha = true,
4687 -- Object selectionbox is settable independently from collisionbox
4689 object_independent_selectionbox = true,
4690 -- Specifies whether binary data can be uploaded or downloaded using
4691 -- the HTTP API (5.1.0)
4692 httpfetch_binary_data = true,
4693 -- Whether formspec_version[<version>] may be used (5.1.0)
4694 formspec_version_element = true,
4695 -- Whether AreaStore's IDs are kept on save/load (5.1.0)
4696 area_store_persistent_ids = true,
4697 -- Whether minetest.find_path is functional (5.2.0)
4698 pathfinder_works = true,
4699 -- Whether Collision info is available to an objects' on_step (5.3.0)
4700 object_step_has_moveresult = true,
4701 -- Whether get_velocity() and add_velocity() can be used on players (5.4.0)
4702 direct_velocity_on_players = true,
4703 -- nodedef's use_texture_alpha accepts new string modes (5.4.0)
4704 use_texture_alpha_string_modes = true,
4705 -- degrotate param2 rotates in units of 1.5° instead of 2°
4706 -- thus changing the range of values from 0-179 to 0-240 (5.5.0)
4707 degrotate_240_steps = true,
4708 -- ABM supports min_y and max_y fields in definition (5.5.0)
4709 abm_min_max_y = true,
4710 -- dynamic_add_media supports passing a table with options (5.5.0)
4711 dynamic_add_media_table = true,
4712 -- allows get_sky to return a table instead of separate values (5.6.0)
4713 get_sky_as_table = true,
4716 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
4717 * `arg`: string or table in format `{foo=true, bar=true}`
4718 * `missing_features`: `{foo=true, bar=true}`
4719 * `minetest.get_player_information(player_name)`: Table containing information
4720 about a player. Example return value:
4723 address = "127.0.0.1", -- IP address of client
4724 ip_version = 4, -- IPv4 / IPv6
4725 connection_uptime = 200, -- seconds since client connected
4726 protocol_version = 32, -- protocol version used by client
4727 formspec_version = 2, -- supported formspec version
4728 lang_code = "fr" -- Language code used for translation
4729 -- the following keys can be missing if no stats have been collected yet
4730 min_rtt = 0.01, -- minimum round trip time
4731 max_rtt = 0.2, -- maximum round trip time
4732 avg_rtt = 0.02, -- average round trip time
4733 min_jitter = 0.01, -- minimum packet time jitter
4734 max_jitter = 0.5, -- maximum packet time jitter
4735 avg_jitter = 0.03, -- average packet time jitter
4736 -- the following information is available in a debug build only!!!
4737 -- DO NOT USE IN MODS
4738 --ser_vers = 26, -- serialization version used by client
4739 --major = 0, -- major version number
4740 --minor = 4, -- minor version number
4741 --patch = 10, -- patch version number
4742 --vers_string = "0.4.9-git", -- full version string
4743 --state = "Active" -- current client state
4746 * `minetest.mkdir(path)`: returns success.
4747 * Creates a directory specified by `path`, creating parent directories
4748 if they don't exist.
4749 * `minetest.rmdir(path, recursive)`: returns success.
4750 * Removes a directory specified by `path`.
4751 * If `recursive` is set to `true`, the directory is recursively removed.
4752 Otherwise, the directory will only be removed if it is empty.
4753 * Returns true on success, false on failure.
4754 * `minetest.cpdir(source, destination)`: returns success.
4755 * Copies a directory specified by `path` to `destination`
4756 * Any files in `destination` will be overwritten if they already exist.
4757 * Returns true on success, false on failure.
4758 * `minetest.mvdir(source, destination)`: returns success.
4759 * Moves a directory specified by `path` to `destination`.
4760 * If the `destination` is a non-empty directory, then the move will fail.
4761 * Returns true on success, false on failure.
4762 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
4764 * nil: return all entries,
4765 * true: return only subdirectory names, or
4766 * false: return only file names.
4767 * `minetest.safe_file_write(path, content)`: returns boolean indicating success
4768 * Replaces contents of file at path with new contents in a safe (atomic)
4769 way. Use this instead of below code when writing e.g. database files:
4770 `local f = io.open(path, "wb"); f:write(content); f:close()`
4771 * `minetest.get_version()`: returns a table containing components of the
4772 engine version. Components:
4773 * `project`: Name of the project, eg, "Minetest"
4774 * `string`: Simple version, eg, "1.2.3-dev"
4775 * `hash`: Full git version (only set if available),
4776 eg, "1.2.3-dev-01234567-dirty".
4777 Use this for informational purposes only. The information in the returned
4778 table does not represent the capabilities of the engine, nor is it
4779 reliable or verifiable. Compatible forks will have a different name and
4780 version entirely. To check for the presence of engine features, test
4781 whether the functions exported by the wanted features exist. For example:
4782 `if minetest.check_for_falling then ... end`.
4783 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
4784 * `data`: string of data to hash
4785 * `raw`: return raw bytes instead of hex digits, default: false
4786 * `minetest.colorspec_to_colorstring(colorspec)`: Converts a ColorSpec to a
4787 ColorString. If the ColorSpec is invalid, returns `nil`.
4788 * `colorspec`: The ColorSpec to convert
4789 * `minetest.colorspec_to_bytes(colorspec)`: Converts a ColorSpec to a raw
4790 string of four bytes in an RGBA layout, returned as a string.
4791 * `colorspec`: The ColorSpec to convert
4792 * `minetest.encode_png(width, height, data, [compression])`: Encode a PNG
4793 image and return it in string form.
4794 * `width`: Width of the image
4795 * `height`: Height of the image
4796 * `data`: Image data, one of:
4797 * array table of ColorSpec, length must be width*height
4798 * string with raw RGBA pixels, length must be width*height*4
4799 * `compression`: Optional zlib compression level, number in range 0 to 9.
4800 The data is one-dimensional, starting in the upper left corner of the image
4801 and laid out in scanlines going from left to right, then top to bottom.
4802 Please note that it's not safe to use string.char to generate raw data,
4803 use `colorspec_to_bytes` to generate raw RGBA values in a predictable way.
4804 The resulting PNG image is always 32-bit. Palettes are not supported at the moment.
4805 You may use this to procedurally generate textures during server init.
4810 * `minetest.debug(...)`
4811 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
4812 * `minetest.log([level,] text)`
4813 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
4814 `"info"`, or `"verbose"`. Default is `"none"`.
4816 Registration functions
4817 ----------------------
4819 Call these functions only at load time!
4823 * `minetest.register_node(name, node definition)`
4824 * `minetest.register_craftitem(name, item definition)`
4825 * `minetest.register_tool(name, item definition)`
4826 * `minetest.override_item(name, redefinition)`
4827 * Overrides fields of an item registered with register_node/tool/craftitem.
4828 * Note: Item must already be defined, (opt)depend on the mod defining it.
4829 * Example: `minetest.override_item("default:mese",
4830 {light_source=minetest.LIGHT_MAX})`
4831 * `minetest.unregister_item(name)`
4832 * Unregisters the item from the engine, and deletes the entry with key
4833 `name` from `minetest.registered_items` and from the associated item table
4834 according to its nature: `minetest.registered_nodes`, etc.
4835 * `minetest.register_entity(name, entity definition)`
4836 * `minetest.register_abm(abm definition)`
4837 * `minetest.register_lbm(lbm definition)`
4838 * `minetest.register_alias(alias, original_name)`
4839 * Also use this to set the 'mapgen aliases' needed in a game for the core
4840 mapgens. See [Mapgen aliases] section above.
4841 * `minetest.register_alias_force(alias, original_name)`
4842 * `minetest.register_ore(ore definition)`
4843 * Returns an integer object handle uniquely identifying the registered
4845 * The order of ore registrations determines the order of ore generation.
4846 * `minetest.register_biome(biome definition)`
4847 * Returns an integer object handle uniquely identifying the registered
4848 biome on success. To get the biome ID, use `minetest.get_biome_id`.
4849 * `minetest.unregister_biome(name)`
4850 * Unregisters the biome from the engine, and deletes the entry with key
4851 `name` from `minetest.registered_biomes`.
4852 * Warning: This alters the biome to biome ID correspondences, so any
4853 decorations or ores using the 'biomes' field must afterwards be cleared
4855 * `minetest.register_decoration(decoration definition)`
4856 * Returns an integer object handle uniquely identifying the registered
4857 decoration on success. To get the decoration ID, use
4858 `minetest.get_decoration_id`.
4859 * The order of decoration registrations determines the order of decoration
4861 * `minetest.register_schematic(schematic definition)`
4862 * Returns an integer object handle uniquely identifying the registered
4863 schematic on success.
4864 * If the schematic is loaded from a file, the `name` field is set to the
4866 * If the function is called when loading the mod, and `name` is a relative
4867 path, then the current mod path will be prepended to the schematic
4869 * `minetest.clear_registered_biomes()`
4870 * Clears all biomes currently registered.
4871 * Warning: Clearing and re-registering biomes alters the biome to biome ID
4872 correspondences, so any decorations or ores using the 'biomes' field must
4873 afterwards be cleared and re-registered.
4874 * `minetest.clear_registered_decorations()`
4875 * Clears all decorations currently registered.
4876 * `minetest.clear_registered_ores()`
4877 * Clears all ores currently registered.
4878 * `minetest.clear_registered_schematics()`
4879 * Clears all schematics currently registered.
4883 * `minetest.register_craft(recipe)`
4884 * Check recipe table syntax for different types below.
4885 * `minetest.clear_craft(recipe)`
4886 * Will erase existing craft based either on output item or on input recipe.
4887 * Specify either output or input only. If you specify both, input will be
4888 ignored. For input use the same recipe table syntax as for
4889 `minetest.register_craft(recipe)`. For output specify only the item,
4891 * Returns false if no erase candidate could be found, otherwise returns true.
4892 * **Warning**! The type field ("shaped", "cooking" or any other) will be
4893 ignored if the recipe contains output. Erasing is then done independently
4894 from the crafting method.
4895 * `minetest.register_chatcommand(cmd, chatcommand definition)`
4896 * `minetest.override_chatcommand(name, redefinition)`
4897 * Overrides fields of a chatcommand registered with `register_chatcommand`.
4898 * `minetest.unregister_chatcommand(name)`
4899 * Unregisters a chatcommands registered with `register_chatcommand`.
4900 * `minetest.register_privilege(name, definition)`
4901 * `definition` can be a description or a definition table (see [Privilege
4903 * If it is a description, the priv will be granted to singleplayer and admin
4905 * To allow players with `basic_privs` to grant, see the `basic_privs`
4906 minetest.conf setting.
4907 * `minetest.register_authentication_handler(authentication handler definition)`
4908 * Registers an auth handler that overrides the builtin one.
4909 * This function can be called by a single mod once only.
4911 Global callback registration functions
4912 --------------------------------------
4914 Call these functions only at load time!
4916 * `minetest.register_globalstep(function(dtime))`
4917 * Called every server step, usually interval of 0.1s
4918 * `minetest.register_on_mods_loaded(function())`
4919 * Called after mods have finished loading and before the media is cached or the
4921 * `minetest.register_on_shutdown(function())`
4922 * Called before server shutdown
4923 * **Warning**: If the server terminates abnormally (i.e. crashes), the
4924 registered callbacks **will likely not be run**. Data should be saved at
4925 semi-frequent intervals as well as on server shutdown.
4926 * `minetest.register_on_placenode(function(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
4927 * Called when a node has been placed
4928 * If return `true` no item is taken from `itemstack`
4929 * `placer` may be any valid ObjectRef or nil.
4930 * **Not recommended**; use `on_construct` or `after_place_node` in node
4931 definition whenever possible.
4932 * `minetest.register_on_dignode(function(pos, oldnode, digger))`
4933 * Called when a node has been dug.
4934 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node
4935 definition whenever possible.
4936 * `minetest.register_on_punchnode(function(pos, node, puncher, pointed_thing))`
4937 * Called when a node is punched
4938 * `minetest.register_on_generated(function(minp, maxp, blockseed))`
4939 * Called after generating a piece of world. Modifying nodes inside the area
4940 is a bit faster than usually.
4941 * `minetest.register_on_newplayer(function(ObjectRef))`
4942 * Called when a new player enters the world for the first time
4943 * `minetest.register_on_punchplayer(function(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
4944 * Called when a player is punched
4945 * Note: This callback is invoked even if the punched player is dead.
4946 * `player`: ObjectRef - Player that was punched
4947 * `hitter`: ObjectRef - Player that hit
4948 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4950 * `tool_capabilities`: Capability table of used item (can be nil)
4951 * `dir`: Unit vector of direction of punch. Always defined. Points from
4952 the puncher to the punched.
4953 * `damage`: Number that represents the damage calculated by the engine
4954 * should return `true` to prevent the default damage mechanism
4955 * `minetest.register_on_rightclickplayer(function(player, clicker))`
4956 * Called when the 'place/use' key was used while pointing a player
4957 (not neccessarily an actual rightclick)
4958 * `player`: ObjectRef - Player that is acted upon
4959 * `clicker`: ObjectRef - Object that acted upon `player`, may or may not be a player
4960 * `minetest.register_on_player_hpchange(function(player, hp_change, reason), modifier)`
4961 * Called when the player gets damaged or healed
4962 * `player`: ObjectRef of the player
4963 * `hp_change`: the amount of change. Negative when it is damage.
4964 * `reason`: a PlayerHPChangeReason table.
4965 * The `type` field will have one of the following values:
4966 * `set_hp`: A mod or the engine called `set_hp` without
4967 giving a type - use this for custom damage types.
4968 * `punch`: Was punched. `reason.object` will hold the puncher, or nil if none.
4970 * `node_damage`: `damage_per_second` from a neighbouring node.
4971 `reason.node` will hold the node name or nil.
4974 * Any of the above types may have additional fields from mods.
4975 * `reason.from` will be `mod` or `engine`.
4976 * `modifier`: when true, the function should return the actual `hp_change`.
4977 Note: modifiers only get a temporary `hp_change` that can be modified by later modifiers.
4978 Modifiers can return true as a second argument to stop the execution of further functions.
4979 Non-modifiers receive the final HP change calculated by the modifiers.
4980 * `minetest.register_on_dieplayer(function(ObjectRef, reason))`
4981 * Called when a player dies
4982 * `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
4983 * `minetest.register_on_respawnplayer(function(ObjectRef))`
4984 * Called when player is to be respawned
4985 * Called _before_ repositioning of player occurs
4986 * return true in func to disable regular player placement
4987 * `minetest.register_on_prejoinplayer(function(name, ip))`
4988 * Called when a client connects to the server, prior to authentication
4989 * If it returns a string, the client is disconnected with that string as
4991 * `minetest.register_on_joinplayer(function(ObjectRef, last_login))`
4992 * Called when a player joins the game
4993 * `last_login`: The timestamp of the previous login, or nil if player is new
4994 * `minetest.register_on_leaveplayer(function(ObjectRef, timed_out))`
4995 * Called when a player leaves the game
4996 * `timed_out`: True for timeout, false for other reasons.
4997 * `minetest.register_on_authplayer(function(name, ip, is_success))`
4998 * Called when a client attempts to log into an account.
4999 * `name`: The name of the account being authenticated.
5000 * `ip`: The IP address of the client
5001 * `is_success`: Whether the client was successfully authenticated
5002 * For newly registered accounts, `is_success` will always be true
5003 * `minetest.register_on_auth_fail(function(name, ip))`
5004 * Deprecated: use `minetest.register_on_authplayer(name, ip, is_success)` instead.
5005 * `minetest.register_on_cheat(function(ObjectRef, cheat))`
5006 * Called when a player cheats
5007 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
5009 * `interacted_too_far`
5010 * `interacted_with_self`
5011 * `interacted_while_dead`
5012 * `finished_unknown_dig`
5015 * `minetest.register_on_chat_message(function(name, message))`
5016 * Called always when a player says something
5017 * Return `true` to mark the message as handled, which means that it will
5018 not be sent to other players.
5019 * `minetest.register_on_chatcommand(function(name, command, params))`
5020 * Called always when a chatcommand is triggered, before `minetest.registered_chatcommands`
5021 is checked to see if the command exists, but after the input is parsed.
5022 * Return `true` to mark the command as handled, which means that the default
5023 handlers will be prevented.
5024 * `minetest.register_on_player_receive_fields(function(player, formname, fields))`
5025 * Called when the server received input from `player` in a formspec with
5026 the given `formname`. Specifically, this is called on any of the
5028 * a button was pressed,
5029 * Enter was pressed while the focus was on a text field
5030 * a checkbox was toggled,
5031 * something was selected in a dropdown list,
5032 * a different tab was selected,
5033 * selection was changed in a textlist or table,
5034 * an entry was double-clicked in a textlist or table,
5035 * a scrollbar was moved, or
5036 * the form was actively closed by the player.
5037 * Fields are sent for formspec elements which define a field. `fields`
5038 is a table containing each formspecs element value (as string), with
5039 the `name` parameter as index for each. The value depends on the
5040 formspec element type:
5041 * `animated_image`: Returns the index of the current frame.
5042 * `button` and variants: If pressed, contains the user-facing button
5043 text as value. If not pressed, is `nil`
5044 * `field`, `textarea` and variants: Text in the field
5045 * `dropdown`: Either the index or value, depending on the `index event`
5047 * `tabheader`: Tab index, starting with `"1"` (only if tab changed)
5048 * `checkbox`: `"true"` if checked, `"false"` if unchecked
5049 * `textlist`: See `minetest.explode_textlist_event`
5050 * `table`: See `minetest.explode_table_event`
5051 * `scrollbar`: See `minetest.explode_scrollbar_event`
5052 * Special case: `["quit"]="true"` is sent when the user actively
5053 closed the form by mouse click, keypress or through a button_exit[]
5055 * Special case: `["key_enter"]="true"` is sent when the user pressed
5056 the Enter key and the focus was either nowhere (causing the formspec
5057 to be closed) or on a button. If the focus was on a text field,
5058 additionally, the index `key_enter_field` contains the name of the
5059 text field. See also: `field_close_on_enter`.
5060 * Newest functions are called first
5061 * If function returns `true`, remaining functions are not called
5062 * `minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv))`
5063 * Called when `player` crafts something
5064 * `itemstack` is the output
5065 * `old_craft_grid` contains the recipe (Note: the one in the inventory is
5067 * `craft_inv` is the inventory with the crafting grid
5068 * Return either an `ItemStack`, to replace the output, or `nil`, to not
5070 * `minetest.register_craft_predict(function(itemstack, player, old_craft_grid, craft_inv))`
5071 * The same as before, except that it is called before the player crafts, to
5072 make craft prediction, and it should not change anything.
5073 * `minetest.register_allow_player_inventory_action(function(player, action, inventory, inventory_info))`
5074 * Determines how much of a stack may be taken, put or moved to a
5076 * `player` (type `ObjectRef`) is the player who modified the inventory
5077 `inventory` (type `InvRef`).
5078 * List of possible `action` (string) values and their
5079 `inventory_info` (table) contents:
5080 * `move`: `{from_list=string, to_list=string, from_index=number, to_index=number, count=number}`
5081 * `put`: `{listname=string, index=number, stack=ItemStack}`
5082 * `take`: Same as `put`
5083 * Return a numeric value to limit the amount of items to be taken, put or
5084 moved. A value of `-1` for `take` will make the source stack infinite.
5085 * `minetest.register_on_player_inventory_action(function(player, action, inventory, inventory_info))`
5086 * Called after a take, put or move event from/to/in a player inventory
5087 * Function arguments: see `minetest.register_allow_player_inventory_action`
5088 * Does not accept or handle any return value.
5089 * `minetest.register_on_protection_violation(function(pos, name))`
5090 * Called by `builtin` and mods when a player violates protection at a
5091 position (eg, digs a node or punches a protected entity).
5092 * The registered functions can be called using
5093 `minetest.record_protection_violation`.
5094 * The provided function should check that the position is protected by the
5095 mod calling this function before it prints a message, if it does, to
5096 allow for multiple protection mods.
5097 * `minetest.register_on_item_eat(function(hp_change, replace_with_item, itemstack, user, pointed_thing))`
5098 * Called when an item is eaten, by `minetest.item_eat`
5099 * Return `itemstack` to cancel the default item eat response (i.e.: hp increase).
5100 * `minetest.register_on_priv_grant(function(name, granter, priv))`
5101 * Called when `granter` grants the priv `priv` to `name`.
5102 * Note that the callback will be called twice if it's done by a player,
5103 once with granter being the player name, and again with granter being nil.
5104 * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
5105 * Called when `revoker` revokes the priv `priv` from `name`.
5106 * Note that the callback will be called twice if it's done by a player,
5107 once with revoker being the player name, and again with revoker being nil.
5108 * `minetest.register_can_bypass_userlimit(function(name, ip))`
5109 * Called when `name` user connects with `ip`.
5110 * Return `true` to by pass the player limit
5111 * `minetest.register_on_modchannel_message(function(channel_name, sender, message))`
5112 * Called when an incoming mod channel message is received
5113 * You should have joined some channels to receive events.
5114 * If message comes from a server mod, `sender` field is an empty string.
5115 * `minetest.register_on_liquid_transformed(function(pos_list, node_list))`
5116 * Called after liquid nodes (`liquidtype ~= "none"`) are modified by the
5117 engine's liquid transformation process.
5118 * `pos_list` is an array of all modified positions.
5119 * `node_list` is an array of the old node that was previously at the position
5120 with the corresponding index in pos_list.
5125 * `minetest.settings`: Settings object containing all of the settings from the
5126 main config file (`minetest.conf`).
5127 * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
5128 parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
5133 * `minetest.string_to_privs(str[, delim])`:
5134 * Converts string representation of privs into table form
5135 * `delim`: String separating the privs. Defaults to `","`.
5136 * Returns `{ priv1 = true, ... }`
5137 * `minetest.privs_to_string(privs[, delim])`:
5138 * Returns the string representation of `privs`
5139 * `delim`: String to delimit privs. Defaults to `","`.
5140 * `minetest.get_player_privs(name) -> {priv1=true,...}`
5141 * `minetest.check_player_privs(player_or_name, ...)`:
5142 returns `bool, missing_privs`
5143 * A quickhand for checking privileges.
5144 * `player_or_name`: Either a Player object or the name of a player.
5145 * `...` is either a list of strings, e.g. `"priva", "privb"` or
5146 a table, e.g. `{ priva = true, privb = true }`.
5148 * `minetest.check_password_entry(name, entry, password)`
5149 * Returns true if the "password entry" for a player with name matches given
5150 password, false otherwise.
5151 * The "password entry" is the password representation generated by the
5152 engine as returned as part of a `get_auth()` call on the auth handler.
5153 * Only use this function for making it possible to log in via password from
5154 external protocols such as IRC, other uses are frowned upon.
5155 * `minetest.get_password_hash(name, raw_password)`
5156 * Convert a name-password pair to a password hash that Minetest can use.
5157 * The returned value alone is not a good basis for password checks based
5158 on comparing the password hash in the database with the password hash
5159 from the function, with an externally provided password, as the hash
5160 in the db might use the new SRP verifier format.
5161 * For this purpose, use `minetest.check_password_entry` instead.
5162 * `minetest.get_player_ip(name)`: returns an IP address string for the player
5164 * The player needs to be online for this to be successful.
5166 * `minetest.get_auth_handler()`: Return the currently active auth handler
5167 * See the [Authentication handler definition]
5168 * Use this to e.g. get the authentication data for a player:
5169 `local auth_data = minetest.get_auth_handler().get_auth(playername)`
5170 * `minetest.notify_authentication_modified(name)`
5171 * Must be called by the authentication handler for privilege changes.
5172 * `name`: string; if omitted, all auth data should be considered modified
5173 * `minetest.set_player_password(name, password_hash)`: Set password hash of
5175 * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player
5177 * `minetest.auth_reload()`
5178 * See `reload()` in authentication handler definition
5180 `minetest.set_player_password`, `minetest.set_player_privs`,
5181 `minetest.get_player_privs` and `minetest.auth_reload` call the authentication
5187 * `minetest.chat_send_all(text)`
5188 * `minetest.chat_send_player(name, text)`
5189 * `minetest.format_chat_message(name, message)`
5190 * Used by the server to format a chat message, based on the setting `chat_message_format`.
5191 Refer to the documentation of the setting for a list of valid placeholders.
5192 * Takes player name and message, and returns the formatted string to be sent to players.
5193 * Can be redefined by mods if required, for things like colored names or messages.
5194 * **Only** the first occurrence of each placeholder will be replaced.
5199 * `minetest.set_node(pos, node)`
5200 * `minetest.add_node(pos, node)`: alias to `minetest.set_node`
5201 * Set node at position `pos`
5202 * `node`: table `{name=string, param1=number, param2=number}`
5203 * If param1 or param2 is omitted, it's set to `0`.
5204 * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
5205 * `minetest.bulk_set_node({pos1, pos2, pos3, ...}, node)`
5206 * Set node on all positions set in the first argument.
5207 * e.g. `minetest.bulk_set_node({{x=0, y=1, z=1}, {x=1, y=2, z=2}}, {name="default:stone"})`
5208 * For node specification or position syntax see `minetest.set_node` call
5209 * Faster than set_node due to single call, but still considerably slower
5210 than Lua Voxel Manipulators (LVM) for large numbers of nodes.
5211 Unlike LVMs, this will call node callbacks. It also allows setting nodes
5212 in spread out positions which would cause LVMs to waste memory.
5213 For setting a cube, this is 1.3x faster than set_node whereas LVM is 20
5215 * `minetest.swap_node(pos, node)`
5216 * Set node at position, but don't remove metadata
5217 * `minetest.remove_node(pos)`
5218 * By default it does the same as `minetest.set_node(pos, {name="air"})`
5219 * `minetest.get_node(pos)`
5220 * Returns the node at the given position as table in the format
5221 `{name="node_name", param1=0, param2=0}`,
5222 returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
5223 * `minetest.get_node_or_nil(pos)`
5224 * Same as `get_node` but returns `nil` for unloaded areas.
5225 * `minetest.get_node_light(pos, timeofday)`
5226 * Gets the light value at the given position. Note that the light value
5227 "inside" the node at the given position is returned, so you usually want
5228 to get the light value of a neighbor.
5229 * `pos`: The position where to measure the light.
5230 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
5231 * Returns a number between `0` and `15` or `nil`
5232 * `nil` is returned e.g. when the map isn't loaded at `pos`
5233 * `minetest.get_natural_light(pos[, timeofday])`
5234 * Figures out the sunlight (or moonlight) value at pos at the given time of
5236 * `pos`: The position of the node
5237 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
5238 * Returns a number between `0` and `15` or `nil`
5239 * This function tests 203 nodes in the worst case, which happens very
5241 * `minetest.get_artificial_light(param1)`
5242 * Calculates the artificial light (light from e.g. torches) value from the
5244 * `param1`: The param1 value of a `paramtype = "light"` node.
5245 * Returns a number between `0` and `15`
5246 * Currently it's the same as `math.floor(param1 / 16)`, except that it
5247 ensures compatibility.
5248 * `minetest.place_node(pos, node)`
5249 * Place node with the same effects that a player would cause
5250 * `minetest.dig_node(pos)`
5251 * Dig node with the same effects that a player would cause
5252 * Returns `true` if successful, `false` on failure (e.g. protected location)
5253 * `minetest.punch_node(pos)`
5254 * Punch node with the same effects that a player would cause
5255 * `minetest.spawn_falling_node(pos)`
5256 * Change node into falling node
5257 * Returns `true` and the ObjectRef of the spawned entity if successful, `false` on failure
5259 * `minetest.find_nodes_with_meta(pos1, pos2)`
5260 * Get a table of positions of nodes that have metadata within a region
5262 * `minetest.get_meta(pos)`
5263 * Get a `NodeMetaRef` at that position
5264 * `minetest.get_node_timer(pos)`
5265 * Get `NodeTimerRef`
5267 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at
5269 * Returns `ObjectRef`, or `nil` if failed
5270 * `minetest.add_item(pos, item)`: Spawn item
5271 * Returns `ObjectRef`, or `nil` if failed
5272 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
5273 * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of
5275 * `radius`: using an euclidean metric
5276 * `minetest.get_objects_in_area(pos1, pos2)`: returns a list of
5278 * `pos1` and `pos2` are the min and max positions of the area to search.
5279 * `minetest.set_timeofday(val)`
5280 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
5281 * `minetest.get_timeofday()`
5282 * `minetest.get_gametime()`: returns the time, in seconds, since the world was
5284 * `minetest.get_day_count()`: returns number days elapsed since world was
5286 * accounts for time changes.
5287 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns
5289 * `radius`: using a maximum metric
5290 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
5291 * `search_center` is an optional boolean (default: `false`)
5292 If true `pos` is also checked for the nodes
5293 * `minetest.find_nodes_in_area(pos1, pos2, nodenames, [grouped])`
5294 * `pos1` and `pos2` are the min and max positions of the area to search.
5295 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
5296 * If `grouped` is true the return value is a table indexed by node name
5297 which contains lists of positions.
5298 * If `grouped` is false or absent the return values are as follows:
5299 first value: Table with all node positions
5300 second value: Table with the count of each node with the node name
5302 * Area volume is limited to 4,096,000 nodes
5303 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
5305 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
5306 * Return value: Table with all node positions with a node air above
5307 * Area volume is limited to 4,096,000 nodes
5308 * `minetest.get_perlin(noiseparams)`
5309 * Return world-specific perlin noise.
5310 * The actual seed used is the noiseparams seed plus the world seed.
5311 * `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
5312 * Deprecated: use `minetest.get_perlin(noiseparams)` instead.
5313 * Return world-specific perlin noise.
5314 * `minetest.get_voxel_manip([pos1, pos2])`
5315 * Return voxel manipulator object.
5316 * Loads the manipulator from the map if positions are passed.
5317 * `minetest.set_gen_notify(flags, {deco_ids})`
5318 * Set the types of on-generate notifications that should be collected.
5319 * `flags` is a flag field with the available flags:
5327 * The second parameter is a list of IDs of decorations which notification
5329 * `minetest.get_gen_notify()`
5330 * Returns a flagstring and a table with the `deco_id`s.
5331 * `minetest.get_decoration_id(decoration_name)`
5332 * Returns the decoration ID number for the provided decoration name string,
5333 or `nil` on failure.
5334 * `minetest.get_mapgen_object(objectname)`
5335 * Return requested mapgen object if available (see [Mapgen objects])
5336 * `minetest.get_heat(pos)`
5337 * Returns the heat at the position, or `nil` on failure.
5338 * `minetest.get_humidity(pos)`
5339 * Returns the humidity at the position, or `nil` on failure.
5340 * `minetest.get_biome_data(pos)`
5341 * Returns a table containing:
5342 * `biome` the biome id of the biome at that position
5343 * `heat` the heat at the position
5344 * `humidity` the humidity at the position
5345 * Or returns `nil` on failure.
5346 * `minetest.get_biome_id(biome_name)`
5347 * Returns the biome id, as used in the biomemap Mapgen object and returned
5348 by `minetest.get_biome_data(pos)`, for a given biome_name string.
5349 * `minetest.get_biome_name(biome_id)`
5350 * Returns the biome name string for the provided biome id, or `nil` on
5352 * If no biomes have been registered, such as in mgv6, returns `default`.
5353 * `minetest.get_mapgen_params()`
5354 * Deprecated: use `minetest.get_mapgen_setting(name)` instead.
5355 * Returns a table containing:
5361 * `minetest.set_mapgen_params(MapgenParams)`
5362 * Deprecated: use `minetest.set_mapgen_setting(name, value, override)`
5364 * Set map generation parameters.
5365 * Function cannot be called after the registration period; only
5366 initialization and `on_mapgen_init`.
5367 * Takes a table as an argument with the fields:
5373 * Leave field unset to leave that parameter unchanged.
5374 * `flags` contains a comma-delimited string of flags to set, or if the
5375 prefix `"no"` is attached, clears instead.
5376 * `flags` is in the same format and has the same options as `mg_flags` in
5378 * `minetest.get_mapgen_setting(name)`
5379 * Gets the *active* mapgen setting (or nil if none exists) in string
5380 format with the following order of precedence:
5381 1) Settings loaded from map_meta.txt or overrides set during mod
5383 2) Settings set by mods without a metafile override
5384 3) Settings explicitly set in the user config file, minetest.conf
5385 4) Settings set as the user config default
5386 * `minetest.get_mapgen_setting_noiseparams(name)`
5387 * Same as above, but returns the value as a NoiseParams table if the
5388 setting `name` exists and is a valid NoiseParams.
5389 * `minetest.set_mapgen_setting(name, value, [override_meta])`
5390 * Sets a mapgen param to `value`, and will take effect if the corresponding
5391 mapgen setting is not already present in map_meta.txt.
5392 * `override_meta` is an optional boolean (default: `false`). If this is set
5393 to true, the setting will become the active setting regardless of the map
5395 * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`.
5396 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
5397 * Same as above, except value is a NoiseParams table.
5398 * `minetest.set_noiseparams(name, noiseparams, set_default)`
5399 * Sets the noiseparams setting of `name` to the noiseparams table specified
5401 * `set_default` is an optional boolean (default: `true`) that specifies
5402 whether the setting should be applied to the default config or current
5404 * `minetest.get_noiseparams(name)`
5405 * Returns a table of the noiseparams for name.
5406 * `minetest.generate_ores(vm, pos1, pos2)`
5407 * Generate all registered ores within the VoxelManip `vm` and in the area
5408 from `pos1` to `pos2`.
5409 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
5410 * `minetest.generate_decorations(vm, pos1, pos2)`
5411 * Generate all registered decorations within the VoxelManip `vm` and in the
5412 area from `pos1` to `pos2`.
5413 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
5414 * `minetest.clear_objects([options])`
5415 * Clear all objects in the environment
5416 * Takes an optional table as an argument with the field `mode`.
5417 * mode = `"full"` : Load and go through every mapblock, clearing
5419 * mode = `"quick"`: Clear objects immediately in loaded mapblocks,
5420 clear objects in unloaded mapblocks only when the
5421 mapblocks are next activated.
5422 * `minetest.load_area(pos1[, pos2])`
5423 * Load the mapblocks containing the area from `pos1` to `pos2`.
5424 `pos2` defaults to `pos1` if not specified.
5425 * This function does not trigger map generation.
5426 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
5427 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be
5428 asynchronously fetched from memory, loaded from disk, or if inexistent,
5430 * If `callback` is a valid Lua function, this will be called for each block
5432 * The function signature of callback is:
5433 `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
5434 * `blockpos` is the *block* coordinates of the block that had been
5436 * `action` could be one of the following constant values:
5437 * `minetest.EMERGE_CANCELLED`
5438 * `minetest.EMERGE_ERRORED`
5439 * `minetest.EMERGE_FROM_MEMORY`
5440 * `minetest.EMERGE_FROM_DISK`
5441 * `minetest.EMERGE_GENERATED`
5442 * `calls_remaining` is the number of callbacks to be expected after
5444 * `param` is the user-defined parameter passed to emerge_area (or
5445 nil if the parameter was absent).
5446 * `minetest.delete_area(pos1, pos2)`
5447 * delete all mapblocks in the area from pos1 to pos2, inclusive
5448 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
5449 * Checks if there is anything other than air between pos1 and pos2.
5450 * Returns false if something is blocking the sight.
5451 * Returns the position of the blocking node when `false`
5452 * `pos1`: First position
5453 * `pos2`: Second position
5454 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
5455 * Creates a `Raycast` object.
5456 * `pos1`: start of the ray
5457 * `pos2`: end of the ray
5458 * `objects`: if false, only nodes will be returned. Default is `true`.
5459 * `liquids`: if false, liquid nodes (`liquidtype ~= "none"`) won't be
5460 returned. Default is `false`.
5461 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
5462 * returns table containing path that can be walked on
5463 * returns a table of 3D points representing a path from `pos1` to `pos2` or
5465 * Reasons for failure:
5466 * No path exists at all
5467 * No path exists within `searchdistance` (see below)
5468 * Start or end pos is buried in land
5469 * `pos1`: start position
5470 * `pos2`: end position
5471 * `searchdistance`: maximum distance from the search positions to search in.
5472 In detail: Path must be completely inside a cuboid. The minimum
5473 `searchdistance` of 1 will confine search between `pos1` and `pos2`.
5474 Larger values will increase the size of this cuboid in all directions
5475 * `max_jump`: maximum height difference to consider walkable
5476 * `max_drop`: maximum height difference to consider droppable
5477 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`.
5478 Difference between `"A*"` and `"A*_noprefetch"` is that
5479 `"A*"` will pre-calculate the cost-data, the other will calculate it
5481 * `minetest.spawn_tree (pos, {treedef})`
5482 * spawns L-system tree at given `pos` with definition in `treedef` table
5483 * `minetest.transforming_liquid_add(pos)`
5484 * add node to liquid flow update queue
5485 * `minetest.get_node_max_level(pos)`
5486 * get max available level for leveled node
5487 * `minetest.get_node_level(pos)`
5488 * get level of leveled node (water, snow)
5489 * `minetest.set_node_level(pos, level)`
5490 * set level of leveled node, default `level` equals `1`
5491 * if `totallevel > maxlevel`, returns rest (`total-max`).
5492 * `minetest.add_node_level(pos, level)`
5493 * increase level of leveled node by level, default `level` equals `1`
5494 * if `totallevel > maxlevel`, returns rest (`total-max`)
5495 * `level` must be between -127 and 127
5496 * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
5497 * resets the light in a cuboid-shaped part of
5498 the map and removes lighting bugs.
5499 * Loads the area if it is not loaded.
5500 * `pos1` is the corner of the cuboid with the least coordinates
5501 (in node coordinates), inclusive.
5502 * `pos2` is the opposite corner of the cuboid, inclusive.
5503 * The actual updated cuboid might be larger than the specified one,
5504 because only whole map blocks can be updated.
5505 The actual updated area consists of those map blocks that intersect
5506 with the given cuboid.
5507 * However, the neighborhood of the updated area might change
5508 as well, as light can spread out of the cuboid, also light
5510 * returns `false` if the area is not fully generated,
5512 * `minetest.check_single_for_falling(pos)`
5513 * causes an unsupported `group:falling_node` node to fall and causes an
5514 unattached `group:attached_node` node to fall.
5515 * does not spread these updates to neighbours.
5516 * `minetest.check_for_falling(pos)`
5517 * causes an unsupported `group:falling_node` node to fall and causes an
5518 unattached `group:attached_node` node to fall.
5519 * spread these updates to neighbours and can cause a cascade
5521 * `minetest.get_spawn_level(x, z)`
5522 * Returns a player spawn y co-ordinate for the provided (x, z)
5523 co-ordinates, or `nil` for an unsuitable spawn point.
5524 * For most mapgens a 'suitable spawn point' is one with y between
5525 `water_level` and `water_level + 16`, and in mgv7 well away from rivers,
5526 so `nil` will be returned for many (x, z) co-ordinates.
5527 * The spawn level returned is for a player spawn in unmodified terrain.
5528 * The spawn level is intentionally above terrain level to cope with
5529 full-node biome 'dust' nodes.
5534 You can find mod channels communication scheme in `doc/mod_channels.png`.
5536 * `minetest.mod_channel_join(channel_name)`
5537 * Server joins channel `channel_name`, and creates it if necessary. You
5538 should listen for incoming messages with
5539 `minetest.register_on_modchannel_message`
5544 `minetest.get_inventory(location)`: returns an `InvRef`
5547 * `{type="player", name="celeron55"}`
5548 * `{type="node", pos={x=, y=, z=}}`
5549 * `{type="detached", name="creative"}`
5550 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns
5552 * `callbacks`: See [Detached inventory callbacks]
5553 * `player_name`: Make detached inventory available to one player
5554 exclusively, by default they will be sent to every player (even if not
5556 Note that this parameter is mostly just a workaround and will be removed
5558 * Creates a detached inventory. If it already exists, it is cleared.
5559 * `minetest.remove_detached_inventory(name)`
5560 * Returns a `boolean` indicating whether the removal succeeded.
5561 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
5562 returns leftover ItemStack or nil to indicate no inventory change
5563 * See `minetest.item_eat` and `minetest.register_on_item_eat`
5568 * `minetest.show_formspec(playername, formname, formspec)`
5569 * `playername`: name of player to show formspec
5570 * `formname`: name passed to `on_player_receive_fields` callbacks.
5571 It should follow the `"modname:<whatever>"` naming convention
5572 * `formspec`: formspec to display
5573 * `minetest.close_formspec(playername, formname)`
5574 * `playername`: name of player to close formspec
5575 * `formname`: has to exactly match the one given in `show_formspec`, or the
5576 formspec will not close.
5577 * calling `show_formspec(playername, formname, "")` is equal to this
5579 * to close a formspec regardless of the formname, call
5580 `minetest.close_formspec(playername, "")`.
5581 **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
5582 * `minetest.formspec_escape(string)`: returns a string
5583 * escapes the characters "[", "]", "\", "," and ";", which can not be used
5585 * `minetest.explode_table_event(string)`: returns a table
5586 * returns e.g. `{type="CHG", row=1, column=2}`
5588 * `"INV"`: no row selected
5590 * `"DCL"`: double-click
5591 * `minetest.explode_textlist_event(string)`: returns a table
5592 * returns e.g. `{type="CHG", index=1}`
5594 * `"INV"`: no row selected
5596 * `"DCL"`: double-click
5597 * `minetest.explode_scrollbar_event(string)`: returns a table
5598 * returns e.g. `{type="CHG", value=500}`
5600 * `"INV"`: something failed
5601 * `"CHG"`: has been changed
5602 * `"VAL"`: not changed
5607 * `minetest.inventorycube(img1, img2, img3)`
5608 * Returns a string for making an image of a cube (useful as an item image)
5609 * `minetest.get_pointed_thing_position(pointed_thing, above)`
5610 * Returns the position of a `pointed_thing` or `nil` if the `pointed_thing`
5611 does not refer to a node or entity.
5612 * If the optional `above` parameter is true and the `pointed_thing` refers
5613 to a node, then it will return the `above` position of the `pointed_thing`.
5614 * `minetest.dir_to_facedir(dir, is6d)`
5615 * Convert a vector to a facedir value, used in `param2` for
5616 `paramtype2="facedir"`.
5617 * passing something non-`nil`/`false` for the optional second parameter
5618 causes it to take the y component into account.
5619 * `minetest.facedir_to_dir(facedir)`
5620 * Convert a facedir back into a vector aimed directly out the "back" of a
5622 * `minetest.dir_to_wallmounted(dir)`
5623 * Convert a vector to a wallmounted value, used for
5624 `paramtype2="wallmounted"`.
5625 * `minetest.wallmounted_to_dir(wallmounted)`
5626 * Convert a wallmounted value back into a vector aimed directly out the
5628 * `minetest.dir_to_yaw(dir)`
5629 * Convert a vector into a yaw (angle)
5630 * `minetest.yaw_to_dir(yaw)`
5631 * Convert yaw (angle) to a vector
5632 * `minetest.is_colored_paramtype(ptype)`
5633 * Returns a boolean. Returns `true` if the given `paramtype2` contains
5634 color information (`color`, `colorwallmounted` or `colorfacedir`).
5635 * `minetest.strip_param2_color(param2, paramtype2)`
5636 * Removes everything but the color information from the
5637 given `param2` value.
5638 * Returns `nil` if the given `paramtype2` does not contain color
5640 * `minetest.get_node_drops(node, toolname)`
5641 * Returns list of itemstrings that are dropped by `node` when dug
5642 with the item `toolname` (not limited to tools).
5643 * `node`: node as table or node name
5644 * `toolname`: name of the item used to dig (can be `nil`)
5645 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
5646 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
5647 * `input.width` = for example `3`
5648 * `input.items` = for example
5649 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
5650 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
5651 * `output.time` = a number, if unsuccessful: `0`
5652 * `output.replacements` = List of replacement `ItemStack`s that couldn't be
5653 placed in `decremented_input.items`. Replacements can be placed in
5654 `decremented_input` if the stack of the replaced item has a count of 1.
5655 * `decremented_input` = like `input`
5656 * `minetest.get_craft_recipe(output)`: returns input
5657 * returns last registered recipe for output item (node)
5658 * `output` is a node or item type such as `"default:torch"`
5659 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
5660 * `input.width` = for example `3`
5661 * `input.items` = for example
5662 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
5663 * `input.items` = `nil` if no recipe found
5664 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
5665 * returns indexed table with all registered recipes for query item (node)
5666 or `nil` if no recipe was found.
5667 * recipe entry table:
5668 * `method`: 'normal' or 'cooking' or 'fuel'
5669 * `width`: 0-3, 0 means shapeless recipe
5670 * `items`: indexed [1-9] table with recipe items
5671 * `output`: string with item name and quantity
5672 * Example query for `"default:gold_ingot"` will return table:
5675 [1]={method = "cooking", width = 3, output = "default:gold_ingot",
5676 items = {1 = "default:gold_lump"}},
5677 [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
5678 items = {1 = "default:goldblock"}}
5680 * `minetest.handle_node_drops(pos, drops, digger)`
5681 * `drops`: list of itemstrings
5682 * Handles drops from nodes after digging: Default action is to put them
5683 into digger's inventory.
5684 * Can be overridden to get different functionality (e.g. dropping items on
5686 * `minetest.itemstring_with_palette(item, palette_index)`: returns an item
5688 * Creates an item string which contains palette index information
5689 for hardware colorization. You can use the returned string
5690 as an output in a craft recipe.
5691 * `item`: the item stack which becomes colored. Can be in string,
5692 table and native form.
5693 * `palette_index`: this index is added to the item stack
5694 * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
5695 * Creates an item string which contains static color information
5696 for hardware colorization. Use this method if you wish to colorize
5697 an item that does not own a palette. You can use the returned string
5698 as an output in a craft recipe.
5699 * `item`: the item stack which becomes colored. Can be in string,
5700 table and native form.
5701 * `colorstring`: the new color of the item stack
5706 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
5707 returns `{{actor, pos, time, oldnode, newnode}, ...}`
5708 * Find who has done something to a node, or near a node
5709 * `actor`: `"player:<name>"`, also `"liquid"`.
5710 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns
5711 `boolean, log_messages`.
5712 * Revert latest actions of someone
5713 * `actor`: `"player:<name>"`, also `"liquid"`.
5715 Defaults for the `on_place` and `on_drop` item definition functions
5716 -------------------------------------------------------------------
5718 * `minetest.item_place_node(itemstack, placer, pointed_thing[, param2, prevent_after_place])`
5719 * Place item as a node
5720 * `param2` overrides `facedir` and wallmounted `param2`
5721 * `prevent_after_place`: if set to `true`, `after_place_node` is not called
5722 for the newly placed node to prevent a callback and placement loop
5723 * returns `itemstack, position`
5724 * `position`: the location the node was placed to. `nil` if nothing was placed.
5725 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
5727 * returns the leftover itemstack
5728 * **Note**: This function is deprecated and will never be called.
5729 * `minetest.item_place(itemstack, placer, pointed_thing[, param2])`
5730 * Wrapper that calls `minetest.item_place_node` if appropriate
5731 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
5732 * **Note**: is not called when wielded item overrides `on_place`
5733 * `param2` overrides facedir and wallmounted `param2`
5734 * returns `itemstack, position`
5735 * `position`: the location the node was placed to. `nil` if nothing was placed.
5736 * `minetest.item_drop(itemstack, dropper, pos)`
5738 * returns the leftover itemstack
5739 * `minetest.item_eat(hp_change[, replace_with_item])`
5740 * Returns `function(itemstack, user, pointed_thing)` as a
5741 function wrapper for `minetest.do_item_eat`.
5742 * `replace_with_item` is the itemstring which is added to the inventory.
5743 If the player is eating a stack, then replace_with_item goes to a
5746 Defaults for the `on_punch` and `on_dig` node definition callbacks
5747 ------------------------------------------------------------------
5749 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
5750 * Calls functions registered by `minetest.register_on_punchnode()`
5751 * `minetest.node_dig(pos, node, digger)`
5752 * Checks if node can be dug, puts item into inventory, removes node
5753 * Calls functions registered by `minetest.registered_on_dignodes()`
5758 * `minetest.sound_play(spec, parameters, [ephemeral])`: returns a handle
5759 * `spec` is a `SimpleSoundSpec`
5760 * `parameters` is a sound parameter table
5761 * `ephemeral` is a boolean (default: false)
5762 Ephemeral sounds will not return a handle and can't be stopped or faded.
5763 It is recommend to use this for short sounds that happen in response to
5764 player actions (e.g. door closing).
5765 * `minetest.sound_stop(handle)`
5766 * `handle` is a handle returned by `minetest.sound_play`
5767 * `minetest.sound_fade(handle, step, gain)`
5768 * `handle` is a handle returned by `minetest.sound_play`
5769 * `step` determines how fast a sound will fade.
5770 The gain will change by this much per second,
5771 until it reaches the target gain.
5772 Note: Older versions used a signed step. This is deprecated, but old
5773 code will still work. (the client uses abs(step) to correct it)
5774 * `gain` the target gain for the fade.
5775 Fading to zero will delete the sound.
5780 * `minetest.after(time, func, ...)` : returns job table to use as below.
5781 * Call the function `func` after `time` seconds, may be fractional
5782 * Optional: Variable number of arguments that are passed to `func`
5785 * Cancels the job function from being called
5790 The engine allows you to submit jobs to be ran in an isolated environment
5791 concurrently with normal server operation.
5792 A job consists of a function to be ran in the async environment, any amount of
5793 arguments (will be serialized) and a callback that will be called with the return
5794 value of the job function once it is finished.
5796 The async environment does *not* have access to the map, entities, players or any
5797 globals defined in the 'usual' environment. Consequently, functions like
5798 `minetest.get_node()` or `minetest.get_player_by_name()` simply do not exist in it.
5800 Arguments and return values passed through this can contain certain userdata
5801 objects that will be seamlessly copied (not shared) to the async environment.
5802 This allows you easy interoperability for delegating work to jobs.
5804 * `minetest.handle_async(func, callback, ...)`:
5805 * Queue the function `func` to be ran in an async environment.
5806 Note that there are multiple persistent workers and any of them may
5807 end up running a given job. The engine will scale the amount of
5808 worker threads automatically.
5809 * When `func` returns the callback is called (in the normal environment)
5810 with all of the return values as arguments.
5811 * Optional: Variable number of arguments that are passed to `func`
5812 * `minetest.register_async_dofile(path)`:
5813 * Register a path to a Lua file to be imported when an async environment
5814 is initialized. You can use this to preload code which you can then call
5815 later using `minetest.handle_async()`.
5817 ### List of APIs available in an async environment
5828 * only if transferred into environment; can't read/write to map
5831 Class instances that can be transferred between environments:
5838 * Standalone helpers such as logging, filesystem, encoding,
5839 hashing or compression APIs
5840 * `minetest.request_insecure_environment` (same restrictions apply)
5843 * `minetest.settings`
5844 * `minetest.registered_items`, `registered_nodes`, `registered_tools`,
5845 `registered_craftitems` and `registered_aliases`
5846 * with all functions and userdata values replaced by `true`, calling any
5847 callbacks here is obviously not possible
5852 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for
5853 server shutdown. Will display `message` to clients.
5854 * `reconnect` == true displays a reconnect button
5855 * `delay` adds an optional delay (in seconds) before shutdown.
5856 Negative delay cancels the current active shutdown.
5857 Zero delay triggers an immediate shutdown.
5858 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
5859 * `minetest.get_server_status(name, joined)`
5860 * Returns the server status string when a player joins or when the command
5861 `/status` is called. Returns `nil` or an empty string when the message is
5863 * `joined`: Boolean value, indicates whether the function was called when
5865 * This function may be overwritten by mods to customize the status message.
5866 * `minetest.get_server_uptime()`: returns the server uptime in seconds
5867 * `minetest.get_server_max_lag()`: returns the current maximum lag
5868 of the server in seconds or nil if server is not fully loaded yet
5869 * `minetest.remove_player(name)`: remove player from database (if they are not
5871 * As auth data is not removed, minetest.player_exists will continue to
5872 return true. Call the below method as well if you want to remove auth
5874 * Returns a code (0: successful, 1: no such player, 2: player is connected)
5875 * `minetest.remove_player_auth(name)`: remove player authentication data
5876 * Returns boolean indicating success (false if player nonexistant)
5877 * `minetest.dynamic_add_media(options, callback)`
5878 * `options`: table containing the following parameters
5879 * `filepath`: path to a media file on the filesystem
5880 * `to_player`: name of the player the media should be sent to instead of
5881 all players (optional)
5882 * `ephemeral`: boolean that marks the media as ephemeral,
5883 it will not be cached on the client (optional, default false)
5884 * `callback`: function with arguments `name`, which is a player name
5885 * Pushes the specified media file to client(s). (details below)
5886 The file must be a supported image, sound or model format.
5887 Dynamically added media is not persisted between server restarts.
5888 * Returns false on error, true if the request was accepted
5889 * The given callback will be called for every player as soon as the
5890 media is available on the client.
5892 * If `ephemeral`=false and `to_player` is unset the file is added to the media
5893 sent to clients on startup, this means the media will appear even on
5894 old clients if they rejoin the server.
5895 * If `ephemeral`=false the file must not be modified, deleted, moved or
5896 renamed after calling this function.
5897 * Regardless of any use of `ephemeral`, adding media files with the same
5898 name twice is not possible/guaranteed to work. An exception to this is the
5899 use of `to_player` to send the same, already existent file to multiple
5901 * Clients will attempt to fetch files added this way via remote media,
5902 this can make transfer of bigger files painless (if set up). Nevertheless
5903 it is advised not to use dynamic media for big media files.
5908 * `minetest.get_ban_list()`: returns a list of all bans formatted as string
5909 * `minetest.get_ban_description(ip_or_name)`: returns list of bans matching
5910 IP address or name formatted as string
5911 * `minetest.ban_player(name)`: ban the IP of a currently connected player
5912 * Returns boolean indicating success
5913 * `minetest.unban_player_or_ip(ip_or_name)`: remove ban record matching
5915 * `minetest.kick_player(name, [reason])`: disconnect a player with an optional
5917 * Returns boolean indicating success (false if player nonexistant)
5918 * `minetest.disconnect_player(name, [reason])`: disconnect a player with an
5919 optional reason, this will not prefix with 'Kicked: ' like kick_player.
5920 If no reason is given, it will default to 'Disconnected.'
5921 * Returns boolean indicating success (false if player nonexistant)
5926 * `minetest.add_particle(particle definition)`
5927 * Deprecated: `minetest.add_particle(pos, velocity, acceleration,
5928 expirationtime, size, collisiondetection, texture, playername)`
5930 * `minetest.add_particlespawner(particlespawner definition)`
5931 * Add a `ParticleSpawner`, an object that spawns an amount of particles
5932 over `time` seconds.
5933 * Returns an `id`, and -1 if adding didn't succeed
5934 * Deprecated: `minetest.add_particlespawner(amount, time,
5938 minexptime, maxexptime,
5940 collisiondetection, texture, playername)`
5942 * `minetest.delete_particlespawner(id, player)`
5943 * Delete `ParticleSpawner` with `id` (return value from
5944 `minetest.add_particlespawner`).
5945 * If playername is specified, only deletes on the player's client,
5946 otherwise on all clients.
5951 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
5952 * Create a schematic from the volume of map specified by the box formed by
5954 * Apply the specified probability and per-node force-place to the specified
5955 nodes according to the `probability_list`.
5956 * `probability_list` is an array of tables containing two fields, `pos`
5958 * `pos` is the 3D vector specifying the absolute coordinates of the
5959 node being modified,
5960 * `prob` is an integer value from `0` to `255` that encodes
5961 probability and per-node force-place. Probability has levels
5962 0-127, then 128 may be added to encode per-node force-place.
5963 For probability stated as 0-255, divide by 2 and round down to
5964 get values 0-127, then add 128 to apply per-node force-place.
5965 * If there are two or more entries with the same pos value, the
5967 * If `pos` is not inside the box formed by `p1` and `p2`, it is
5969 * If `probability_list` equals `nil`, no probabilities are applied.
5970 * Apply the specified probability to the specified horizontal slices
5971 according to the `slice_prob_list`.
5972 * `slice_prob_list` is an array of tables containing two fields, `ypos`
5974 * `ypos` indicates the y position of the slice with a probability
5975 applied, the lowest slice being `ypos = 0`.
5976 * If slice probability list equals `nil`, no slice probabilities
5978 * Saves schematic in the Minetest Schematic format to filename.
5980 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement, flags)`
5981 * Place the schematic specified by schematic (see [Schematic specifier]) at
5983 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
5984 * If the `rotation` parameter is omitted, the schematic is not rotated.
5985 * `replacements` = `{["old_name"] = "convert_to", ...}`
5986 * `force_placement` is a boolean indicating whether nodes other than `air`
5987 and `ignore` are replaced by the schematic.
5988 * Returns nil if the schematic could not be loaded.
5989 * **Warning**: Once you have loaded a schematic from a file, it will be
5990 cached. Future calls will always use the cached version and the
5991 replacement list defined for it, regardless of whether the file or the
5992 replacement list parameter have changed. The only way to load the file
5993 anew is to restart the server.
5994 * `flags` is a flag field with the available flags:
5999 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement, flags)`:
6000 * This function is analogous to minetest.place_schematic, but places a
6001 schematic onto the specified VoxelManip object `vmanip` instead of the
6003 * Returns false if any part of the schematic was cut-off due to the
6004 VoxelManip not containing the full area required, and true if the whole
6005 schematic was able to fit.
6006 * Returns nil if the schematic could not be loaded.
6007 * After execution, any external copies of the VoxelManip contents are
6009 * `flags` is a flag field with the available flags:
6014 * `minetest.serialize_schematic(schematic, format, options)`
6015 * Return the serialized schematic specified by schematic
6016 (see [Schematic specifier])
6017 * in the `format` of either "mts" or "lua".
6018 * "mts" - a string containing the binary MTS data used in the MTS file
6020 * "lua" - a string containing Lua code representing the schematic in table
6022 * `options` is a table containing the following optional parameters:
6023 * If `lua_use_comments` is true and `format` is "lua", the Lua code
6024 generated will have (X, Z) position comments for every X row
6025 generated in the schematic data for easier reading.
6026 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua",
6027 the Lua code generated will use that number of spaces as indentation
6028 instead of a tab character.
6030 * `minetest.read_schematic(schematic, options)`
6031 * Returns a Lua table representing the schematic (see: [Schematic specifier])
6032 * `schematic` is the schematic to read (see: [Schematic specifier])
6033 * `options` is a table containing the following optional parameters:
6034 * `write_yslice_prob`: string value:
6035 * `none`: no `write_yslice_prob` table is inserted,
6036 * `low`: only probabilities that are not 254 or 255 are written in
6037 the `write_ylisce_prob` table,
6038 * `all`: write all probabilities to the `write_yslice_prob` table.
6039 * The default for this option is `all`.
6040 * Any invalid value will be interpreted as `all`.
6045 * `minetest.request_http_api()`:
6046 * returns `HTTPApiTable` containing http functions if the calling mod has
6047 been granted access by being listed in the `secure.http_mods` or
6048 `secure.trusted_mods` setting, otherwise returns `nil`.
6049 * The returned table contains the functions `fetch`, `fetch_async` and
6050 `fetch_async_get` described below.
6051 * Only works at init time and must be called from the mod's main scope
6052 (not from a function).
6053 * Function only exists if minetest server was built with cURL support.
6054 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
6056 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
6057 * Performs given request asynchronously and calls callback upon completion
6058 * callback: `function(HTTPRequestResult res)`
6059 * Use this HTTP function if you are unsure, the others are for advanced use
6060 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
6061 * Performs given request asynchronously and returns handle for
6062 `HTTPApiTable.fetch_async_get`
6063 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
6064 * Return response data for given asynchronous HTTP request
6069 * `minetest.get_mod_storage()`:
6070 * returns reference to mod private `StorageRef`
6071 * must be called during mod load time
6076 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
6077 * `minetest.is_player(obj)`: boolean, whether `obj` is a player
6078 * `minetest.player_exists(name)`: boolean, whether player exists
6079 (regardless of online status)
6080 * `minetest.hud_replace_builtin(name, hud_definition)`
6081 * Replaces definition of a builtin hud element
6082 * `name`: `"breath"` or `"health"`
6083 * `hud_definition`: definition to replace builtin definition
6084 * `minetest.send_join_message(player_name)`
6085 * This function can be overridden by mods to change the join message.
6086 * `minetest.send_leave_message(player_name, timed_out)`
6087 * This function can be overridden by mods to change the leave message.
6088 * `minetest.hash_node_position(pos)`: returns an 48-bit integer
6089 * `pos`: table {x=number, y=number, z=number},
6090 * Gives a unique hash number for a node position (16+16+16=48bit)
6091 * `minetest.get_position_from_hash(hash)`: returns a position
6092 * Inverse transform of `minetest.hash_node_position`
6093 * `minetest.get_item_group(name, group)`: returns a rating
6094 * Get rating of a group of an item. (`0` means: not in group)
6095 * `minetest.get_node_group(name, group)`: returns a rating
6096 * Deprecated: An alias for the former.
6097 * `minetest.raillike_group(name)`: returns a rating
6098 * Returns rating of the connect_to_raillike group corresponding to name
6099 * If name is not yet the name of a connect_to_raillike group, a new group
6100 id is created, with that name.
6101 * `minetest.get_content_id(name)`: returns an integer
6102 * Gets the internal content ID of `name`
6103 * `minetest.get_name_from_content_id(content_id)`: returns a string
6104 * Gets the name of the content with that content ID
6105 * `minetest.parse_json(string[, nullvalue])`: returns something
6106 * Convert a string containing JSON data into the Lua equivalent
6107 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
6108 * On success returns a table, a string, a number, a boolean or `nullvalue`
6109 * On failure outputs an error message and returns `nil`
6110 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
6111 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error
6113 * Convert a Lua table into a JSON string
6114 * styled: Outputs in a human-readable format if this is set, defaults to
6116 * Unserializable things like functions and userdata will cause an error.
6117 * **Warning**: JSON is more strict than the Lua table format.
6118 1. You can only use strings and positive integers of at least one as
6120 2. You can not mix string and integer keys.
6121 This is due to the fact that JSON has two distinct array and object
6123 * Example: `write_json({10, {a = false}})`,
6124 returns `'[10, {"a": false}]'`
6125 * `minetest.serialize(table)`: returns a string
6126 * Convert a table containing tables, strings, numbers, booleans and `nil`s
6127 into string form readable by `minetest.deserialize`
6128 * Example: `serialize({foo="bar"})`, returns `'return { ["foo"] = "bar" }'`
6129 * `minetest.deserialize(string[, safe])`: returns a table
6130 * Convert a string returned by `minetest.serialize` into a table
6131 * `string` is loaded in an empty sandbox environment.
6132 * Will load functions if safe is false or omitted. Although these functions
6133 cannot directly access the global environment, they could bypass this
6134 restriction with maliciously crafted Lua bytecode if mod security is
6136 * This function should not be used on untrusted data, regardless of the
6137 value of `safe`. It is fine to serialize then deserialize user-provided
6138 data, but directly providing user input to deserialize is always unsafe.
6139 * Example: `deserialize('return { ["foo"] = "bar" }')`,
6140 returns `{foo="bar"}`
6141 * Example: `deserialize('print("foo")')`, returns `nil`
6142 (function call fails), returns
6143 `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
6144 * `minetest.compress(data, method, ...)`: returns `compressed_data`
6145 * Compress a string of data.
6146 * `method` is a string identifying the compression method to be used.
6147 * Supported compression methods:
6148 * Deflate (zlib): `"deflate"`
6149 * `...` indicates method-specific arguments. Currently defined arguments
6151 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
6152 * `minetest.decompress(compressed_data, method, ...)`: returns data
6153 * Decompress a string of data (using ZLib).
6154 * See documentation on `minetest.compress()` for supported compression
6156 * `...` indicates method-specific arguments. Currently, no methods use this
6157 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
6158 * Each argument is a 8 Bit unsigned integer
6159 * Returns the ColorString from rgb or rgba values
6160 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
6161 * `minetest.encode_base64(string)`: returns string encoded in base64
6162 * Encodes a string in base64.
6163 * `minetest.decode_base64(string)`: returns string or nil on failure
6164 * Padding characters are only supported starting at version 5.4.0, where
6165 5.5.0 and newer perform proper checks.
6166 * Decodes a string encoded in base64.
6167 * `minetest.is_protected(pos, name)`: returns boolean
6168 * Returning `true` restricts the player `name` from modifying (i.e. digging,
6169 placing) the node at position `pos`.
6170 * `name` will be `""` for non-players or unknown players.
6171 * This function should be overridden by protection mods. It is highly
6172 recommended to grant access to players with the `protection_bypass` privilege.
6173 * Cache and call the old version of this function if the position is
6174 not protected by the mod. This will allow using multiple protection mods.
6177 local old_is_protected = minetest.is_protected
6178 function minetest.is_protected(pos, name)
6179 if mymod:position_protected_from(pos, name) then
6182 return old_is_protected(pos, name)
6184 * `minetest.record_protection_violation(pos, name)`
6185 * This function calls functions registered with
6186 `minetest.register_on_protection_violation`.
6187 * `minetest.is_creative_enabled(name)`: returns boolean
6188 * Returning `true` means that Creative Mode is enabled for player `name`.
6189 * `name` will be `""` for non-players or if the player is unknown.
6190 * This function should be overridden by Creative Mode-related mods to
6191 implement a per-player Creative Mode.
6192 * By default, this function returns `true` if the setting
6193 `creative_mode` is `true` and `false` otherwise.
6194 * `minetest.is_area_protected(pos1, pos2, player_name, interval)`
6195 * Returns the position of the first node that `player_name` may not modify
6196 in the specified cuboid between `pos1` and `pos2`.
6197 * Returns `false` if no protections were found.
6198 * Applies `is_protected()` to a 3D lattice of points in the defined volume.
6199 The points are spaced evenly throughout the volume and have a spacing
6200 similar to, but no larger than, `interval`.
6201 * All corners and edges of the defined volume are checked.
6202 * `interval` defaults to 4.
6203 * `interval` should be carefully chosen and maximised to avoid an excessive
6204 number of points being checked.
6205 * Like `minetest.is_protected`, this function may be extended or
6206 overwritten by mods to provide a faster implementation to check the
6207 cuboid for intersections.
6208 * `minetest.rotate_and_place(itemstack, placer, pointed_thing[, infinitestacks,
6209 orient_flags, prevent_after_place])`
6210 * Attempt to predict the desired orientation of the facedir-capable node
6211 defined by `itemstack`, and place it accordingly (on-wall, on the floor,
6212 or hanging from the ceiling).
6213 * `infinitestacks`: if `true`, the itemstack is not changed. Otherwise the
6214 stacks are handled normally.
6215 * `orient_flags`: Optional table containing extra tweaks to the placement code:
6216 * `invert_wall`: if `true`, place wall-orientation on the ground and
6217 ground-orientation on the wall.
6218 * `force_wall` : if `true`, always place the node in wall orientation.
6219 * `force_ceiling`: if `true`, always place on the ceiling.
6220 * `force_floor`: if `true`, always place the node on the floor.
6221 * `force_facedir`: if `true`, forcefully reset the facedir to north
6222 when placing on the floor or ceiling.
6223 * The first four options are mutually-exclusive; the last in the list
6224 takes precedence over the first.
6225 * `prevent_after_place` is directly passed to `minetest.item_place_node`
6226 * Returns the new itemstack after placement
6227 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
6228 * calls `rotate_and_place()` with `infinitestacks` set according to the state
6229 of the creative mode setting, checks for "sneak" to set the `invert_wall`
6230 parameter and `prevent_after_place` set to `true`.
6232 * `minetest.calculate_knockback(player, hitter, time_from_last_punch,
6233 tool_capabilities, dir, distance, damage)`
6234 * Returns the amount of knockback applied on the punched player.
6235 * Arguments are equivalent to `register_on_punchplayer`, except the following:
6236 * `distance`: distance between puncher and punched player
6237 * This function can be overriden by mods that wish to modify this behaviour.
6238 * You may want to cache and call the old function to allow multiple mods to
6239 change knockback behaviour.
6241 * `minetest.forceload_block(pos[, transient])`
6242 * forceloads the position `pos`.
6243 * returns `true` if area could be forceloaded
6244 * If `transient` is `false` or absent, the forceload will be persistent
6245 (saved between server runs). If `true`, the forceload will be transient
6246 (not saved between server runs).
6248 * `minetest.forceload_free_block(pos[, transient])`
6249 * stops forceloading the position `pos`
6250 * If `transient` is `false` or absent, frees a persistent forceload.
6251 If `true`, frees a transient forceload.
6253 * `minetest.compare_block_status(pos, condition)`
6254 * Checks whether the mapblock at positition `pos` is in the wanted condition.
6255 * `condition` may be one of the following values:
6256 * `"unknown"`: not in memory
6257 * `"emerging"`: in the queue for loading from disk or generating
6258 * `"loaded"`: in memory but inactive (no ABMs are executed)
6259 * `"active"`: in memory and active
6260 * Other values are reserved for future functionality extensions
6261 * Return value, the comparison status:
6262 * `false`: Mapblock does not fulfil the wanted condition
6263 * `true`: Mapblock meets the requirement
6264 * `nil`: Unsupported `condition` value
6266 * `minetest.request_insecure_environment()`: returns an environment containing
6267 insecure functions if the calling mod has been listed as trusted in the
6268 `secure.trusted_mods` setting or security is disabled, otherwise returns
6270 * Only works at init time and must be called from the mod's main scope
6271 (ie: the init.lua of the mod, not from another Lua file or within a function).
6272 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE
6273 IT IN A LOCAL VARIABLE!**
6275 * `minetest.global_exists(name)`
6276 * Checks if a global variable has been set, without triggering a warning.
6281 * `minetest.env`: `EnvRef` of the server environment and world.
6282 * Any function in the minetest namespace can be called using the syntax
6283 `minetest.env:somefunction(somearguments)`
6284 instead of `minetest.somefunction(somearguments)`
6285 * Deprecated, but support is not to be dropped soon
6290 ### Registered definition tables
6292 * `minetest.registered_items`
6293 * Map of registered items, indexed by name
6294 * `minetest.registered_nodes`
6295 * Map of registered node definitions, indexed by name
6296 * `minetest.registered_craftitems`
6297 * Map of registered craft item definitions, indexed by name
6298 * `minetest.registered_tools`
6299 * Map of registered tool definitions, indexed by name
6300 * `minetest.registered_entities`
6301 * Map of registered entity prototypes, indexed by name
6302 * Values in this table may be modified directly.
6303 Note: changes to initial properties will only affect entities spawned afterwards,
6304 as they are only read when spawning.
6305 * `minetest.object_refs`
6306 * Map of object references, indexed by active object id
6307 * `minetest.luaentities`
6308 * Map of Lua entities, indexed by active object id
6309 * `minetest.registered_abms`
6310 * List of ABM definitions
6311 * `minetest.registered_lbms`
6312 * List of LBM definitions
6313 * `minetest.registered_aliases`
6314 * Map of registered aliases, indexed by name
6315 * `minetest.registered_ores`
6316 * Map of registered ore definitions, indexed by the `name` field.
6317 * If `name` is nil, the key is the object handle returned by
6318 `minetest.register_ore`.
6319 * `minetest.registered_biomes`
6320 * Map of registered biome definitions, indexed by the `name` field.
6321 * If `name` is nil, the key is the object handle returned by
6322 `minetest.register_biome`.
6323 * `minetest.registered_decorations`
6324 * Map of registered decoration definitions, indexed by the `name` field.
6325 * If `name` is nil, the key is the object handle returned by
6326 `minetest.register_decoration`.
6327 * `minetest.registered_schematics`
6328 * Map of registered schematic definitions, indexed by the `name` field.
6329 * If `name` is nil, the key is the object handle returned by
6330 `minetest.register_schematic`.
6331 * `minetest.registered_chatcommands`
6332 * Map of registered chat command definitions, indexed by name
6333 * `minetest.registered_privileges`
6334 * Map of registered privilege definitions, indexed by name
6335 * Registered privileges can be modified directly in this table.
6337 ### Registered callback tables
6339 All callbacks registered with [Global callback registration functions] are added
6340 to corresponding `minetest.registered_*` tables.
6348 Sorted alphabetically.
6353 AreaStore is a data structure to calculate intersections of 3D cuboid volumes
6354 and points. The `data` field (string) may be used to store and retrieve any
6355 mod-relevant information to the specified area.
6357 Despite its name, mods must take care of persisting AreaStore data. They may
6358 use the provided load and write functions for this.
6363 * `AreaStore(type_name)`
6364 * Returns a new AreaStore instance
6365 * `type_name`: optional, forces the internally used API.
6366 * Possible values: `"LibSpatial"` (default).
6367 * When other values are specified, or SpatialIndex is not available,
6368 the custom Minetest functions are used.
6369 * `get_area(id, include_corners, include_data)`
6370 * Returns the area information about the specified ID.
6371 * Returned values are either of these:
6373 nil -- Area not found
6374 true -- Without `include_corners` and `include_data`
6376 min = pos, max = pos -- `include_corners == true`
6377 data = string -- `include_data == true`
6380 * `get_areas_for_pos(pos, include_corners, include_data)`
6381 * Returns all areas as table, indexed by the area ID.
6382 * Table values: see `get_area`.
6383 * `get_areas_in_area(corner1, corner2, accept_overlap, include_corners, include_data)`
6384 * Returns all areas that contain all nodes inside the area specified by`
6385 `corner1 and `corner2` (inclusive).
6386 * `accept_overlap`: if `true`, areas are returned that have nodes in
6387 common (intersect) with the specified area.
6388 * Returns the same values as `get_areas_for_pos`.
6389 * `insert_area(corner1, corner2, data, [id])`: inserts an area into the store.
6390 * Returns the new area's ID, or nil if the insertion failed.
6391 * The (inclusive) positions `corner1` and `corner2` describe the area.
6392 * `data` is a string stored with the area.
6393 * `id` (optional): will be used as the internal area ID if it is an unique
6394 number between 0 and 2^32-2.
6396 * Requires SpatialIndex, no-op function otherwise.
6397 * Reserves resources for `count` many contained areas to improve
6398 efficiency when working with many area entries. Additional areas can still
6399 be inserted afterwards at the usual complexity.
6400 * `remove_area(id)`: removes the area with the given id from the store, returns
6402 * `set_cache_params(params)`: sets params for the included prefiltering cache.
6403 Calling invalidates the cache, so that its elements have to be newly
6405 * `params` is a table with the following fields:
6407 enabled = boolean, -- Whether to enable, default true
6408 block_radius = int, -- The radius (in nodes) of the areas the cache
6409 -- generates prefiltered lists for, minimum 16,
6411 limit = int, -- The cache size, minimum 20, default 1000
6412 * `to_string()`: Experimental. Returns area store serialized as a (binary)
6414 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to
6416 * `from_string(str)`: Experimental. Deserializes string and loads it into the
6418 Returns success and, optionally, an error message.
6419 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data
6425 An `InvRef` is a reference to an inventory.
6429 * `is_empty(listname)`: return `true` if list is empty
6430 * `get_size(listname)`: get size of a list
6431 * `set_size(listname, size)`: set size of a list
6432 * returns `false` on error (e.g. invalid `listname` or `size`)
6433 * `get_width(listname)`: get width of a list
6434 * `set_width(listname, width)`: set width of list; currently used for crafting
6435 * `get_stack(listname, i)`: get a copy of stack index `i` in list
6436 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
6437 * `get_list(listname)`: return full list (list of `ItemStack`s)
6438 * `set_list(listname, list)`: set full list (size will not change)
6439 * `get_lists()`: returns table that maps listnames to inventory lists
6440 * `set_lists(lists)`: sets inventory lists (size will not change)
6441 * `add_item(listname, stack)`: add item somewhere in list, returns leftover
6443 * `room_for_item(listname, stack):` returns `true` if the stack of items
6444 can be fully added to the list
6445 * `contains_item(listname, stack, [match_meta])`: returns `true` if
6446 the stack of items can be fully taken from the list.
6447 If `match_meta` is false, only the items' names are compared
6449 * `remove_item(listname, stack)`: take as many items as specified from the
6450 list, returns the items that were actually removed (as an `ItemStack`)
6451 -- note that any item metadata is ignored, so attempting to remove a specific
6452 unique item this way will likely remove the wrong one -- to do that use
6453 `set_stack` with an empty `ItemStack`.
6454 * `get_location()`: returns a location compatible to
6455 `minetest.get_inventory(location)`.
6456 * returns `{type="undefined"}` in case location is not known
6460 Detached & nodemeta inventories provide the following callbacks for move actions:
6464 The `allow_*` callbacks return how many items can be moved.
6466 * `allow_move`/`allow_metadata_inventory_move`: Moving items in the inventory
6467 * `allow_take`/`allow_metadata_inventory_take`: Taking items from the inventory
6468 * `allow_put`/`allow_metadata_inventory_put`: Putting items to the inventory
6472 The `on_*` callbacks are called after the items have been placed in the inventories.
6474 * `on_move`/`on_metadata_inventory_move`: Moving items in the inventory
6475 * `on_take`/`on_metadata_inventory_take`: Taking items from the inventory
6476 * `on_put`/`on_metadata_inventory_put`: Putting items to the inventory
6480 When a player tries to put an item to a place where another item is, the items are *swapped*.
6481 This means that all callbacks will be called twice (once for each action).
6486 An `ItemStack` is a stack of items.
6488 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
6489 an itemstring, a table or `nil`.
6493 * `is_empty()`: returns `true` if stack is empty.
6494 * `get_name()`: returns item name (e.g. `"default:stone"`).
6495 * `set_name(item_name)`: returns a boolean indicating whether the item was
6497 * `get_count()`: Returns number of items on the stack.
6498 * `set_count(count)`: returns a boolean indicating whether the item was cleared
6499 * `count`: number, unsigned 16 bit integer
6500 * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
6501 * `set_wear(wear)`: returns boolean indicating whether item was cleared
6502 * `wear`: number, unsigned 16 bit integer
6503 * `get_meta()`: returns ItemStackMetaRef. See section for more details
6504 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
6506 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
6507 * `get_description()`: returns the description shown in inventory list tooltips.
6508 * The engine uses this when showing item descriptions in tooltips.
6509 * Fields for finding the description, in order:
6510 * `description` in item metadata (See [Item Metadata].)
6511 * `description` in item definition
6513 * `get_short_description()`: returns the short description or nil.
6514 * Unlike the description, this does not include new lines.
6515 * Fields for finding the short description, in order:
6516 * `short_description` in item metadata (See [Item Metadata].)
6517 * `short_description` in item definition
6518 * first line of the description (From item meta or def, see `get_description()`.)
6519 * Returns nil if none of the above are set
6520 * `clear()`: removes all items from the stack, making it empty.
6521 * `replace(item)`: replace the contents of this stack.
6522 * `item` can also be an itemstring or table.
6523 * `to_string()`: returns the stack in itemstring form.
6524 * `to_table()`: returns the stack in Lua table form.
6525 * `get_stack_max()`: returns the maximum size of the stack (depends on the
6527 * `get_free_space()`: returns `get_stack_max() - get_count()`.
6528 * `is_known()`: returns `true` if the item name refers to a defined item type.
6529 * `get_definition()`: returns the item definition table.
6530 * `get_tool_capabilities()`: returns the digging properties of the item,
6531 or those of the hand if none are defined for this item type
6532 * `add_wear(amount)`
6533 * Increases wear by `amount` if the item is a tool, otherwise does nothing
6534 * Valid `amount` range is [0,65536]
6535 * `amount`: number, integer
6536 * `add_wear_by_uses(max_uses)`
6537 * Increases wear in such a way that, if only this function is called,
6538 the item breaks after `max_uses` times
6539 * Valid `max_uses` range is [0,65536]
6540 * Does nothing if item is not a tool or if `max_uses` is 0
6541 * `add_item(item)`: returns leftover `ItemStack`
6542 * Put some item or stack onto this stack
6543 * `item_fits(item)`: returns `true` if item or stack can be fully added to
6545 * `take_item(n)`: returns taken `ItemStack`
6546 * Take (and remove) up to `n` items from this stack
6547 * `n`: number, default: `1`
6548 * `peek_item(n)`: returns taken `ItemStack`
6549 * Copy (don't remove) up to `n` items from this stack
6550 * `n`: number, default: `1`
6555 ItemStack metadata: reference extra data and functionality stored in a stack.
6556 Can be obtained via `item:get_meta()`.
6560 * All methods in MetaDataRef
6561 * `set_tool_capabilities([tool_capabilities])`
6562 * Overrides the item's tool capabilities
6563 * A nil value will clear the override data and restore the original
6569 Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],
6570 and [`PlayerMetaRef`].
6574 * `contains(key)`: Returns true if key present, otherwise false.
6575 * Returns `nil` when the MetaData is inexistent.
6576 * `get(key)`: Returns `nil` if key not present, else the stored string.
6577 * `set_string(key, value)`: Value of `""` will delete the key.
6578 * `get_string(key)`: Returns `""` if key not present.
6579 * `set_int(key, value)`
6580 * `get_int(key)`: Returns `0` if key not present.
6581 * `set_float(key, value)`
6582 * `get_float(key)`: Returns `0` if key not present.
6583 * `to_table()`: returns `nil` or a table with keys:
6584 * `fields`: key-value storage
6585 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
6586 * `from_table(nil or {})`
6587 * Any non-table value will clear the metadata
6588 * See [Node Metadata] for an example
6589 * returns `true` on success
6591 * returns `true` if this metadata has the same key-value pairs as `other`
6596 An interface to use mod channels on client and server
6600 * `leave()`: leave the mod channel.
6601 * Server leaves channel `channel_name`.
6602 * No more incoming or outgoing messages can be sent to this channel from
6604 * This invalidate all future object usage.
6605 * Ensure you set mod_channel to nil after that to free Lua resources.
6606 * `is_writeable()`: returns true if channel is writeable and mod can send over
6608 * `send_all(message)`: Send `message` though the mod channel.
6609 * If mod channel is not writeable or invalid, message will be dropped.
6610 * Message size is limited to 65535 characters by protocol.
6615 Node metadata: reference extra data and functionality stored in a node.
6616 Can be obtained via `minetest.get_meta(pos)`.
6620 * All methods in MetaDataRef
6621 * `get_inventory()`: returns `InvRef`
6622 * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
6623 This will prevent them from being sent to the client. Note that the "private"
6624 status will only be remembered if an associated key-value pair exists,
6625 meaning it's best to call this when initializing all other meta (e.g.
6631 Node Timers: a high resolution persistent per-node timer.
6632 Can be gotten via `minetest.get_node_timer(pos)`.
6636 * `set(timeout,elapsed)`
6637 * set a timer's state
6638 * `timeout` is in seconds, and supports fractional values (0.1 etc)
6639 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
6640 * will trigger the node's `on_timer` function after `(timeout - elapsed)`
6644 * equivalent to `set(timeout,0)`
6647 * `get_timeout()`: returns current timeout in seconds
6648 * if `timeout` equals `0`, timer is inactive
6649 * `get_elapsed()`: returns current elapsed time in seconds
6650 * the node's `on_timer` function will be called after `(timeout - elapsed)`
6652 * `is_started()`: returns boolean state of timer
6653 * returns `true` if timer is started, otherwise `false`
6658 Moving things in the game are generally these.
6659 This is basically a reference to a C++ `ServerActiveObject`.
6661 ### Advice on handling `ObjectRefs`
6663 When you receive an `ObjectRef` as a callback argument or from another API
6664 function, it is possible to store the reference somewhere and keep it around.
6665 It will keep functioning until the object is unloaded or removed.
6667 However, doing this is **NOT** recommended as there is (intentionally) no method
6668 to test if a previously acquired `ObjectRef` is still valid.
6669 Instead, `ObjectRefs` should be "let go" of as soon as control is returned from
6670 Lua back to the engine.
6671 Doing so is much less error-prone and you will never need to wonder if the
6672 object you are working with still exists.
6677 * `get_pos()`: returns `{x=num, y=num, z=num}`
6678 * `set_pos(pos)`: `pos`=`{x=num, y=num, z=num}`
6679 * `get_velocity()`: returns the velocity, a vector.
6680 * `add_velocity(vel)`
6681 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
6682 * In comparison to using get_velocity, adding the velocity and then using
6683 set_velocity, add_velocity is supposed to avoid synchronization problems.
6684 Additionally, players also do not support set_velocity.
6686 * Does not apply during free_move.
6687 * Note that since the player speed is normalized at each move step,
6688 increasing e.g. Y velocity beyond what would usually be achieved
6689 (see: physics overrides) will cause existing X/Z velocity to be reduced.
6690 * Example: `add_velocity({x=0, y=6.5, z=0})` is equivalent to
6691 pressing the jump key (assuming default settings)
6692 * `move_to(pos, continuous=false)`
6693 * Does an interpolated move for Lua entities for visually smooth transitions.
6694 * If `continuous` is true, the Lua entity will not be moved to the current
6695 position before starting the interpolated move.
6696 * For players this does the same as `set_pos`,`continuous` is ignored.
6697 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
6698 * `puncher` = another `ObjectRef`,
6699 * `time_from_last_punch` = time since last punch action of the puncher
6700 * `direction`: can be `nil`
6701 * `right_click(clicker)`; `clicker` is another `ObjectRef`
6702 * `get_hp()`: returns number of health points
6703 * `set_hp(hp, reason)`: set number of health points
6704 * See reason in register_on_player_hpchange
6705 * Is limited to the range of 0 ... 65535 (2^16 - 1)
6706 * For players: HP are also limited by `hp_max` specified in the player's
6708 * `get_inventory()`: returns an `InvRef` for players, otherwise returns `nil`
6709 * `get_wield_list()`: returns the name of the inventory list the wielded item
6711 * `get_wield_index()`: returns the index of the wielded item
6712 * `get_wielded_item()`: returns an `ItemStack`
6713 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if
6715 * `set_armor_groups({group1=rating, group2=rating, ...})`
6716 * `get_armor_groups()`: returns a table with the armor group ratings
6717 * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
6718 * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
6719 * `frame_speed`: number, default: `15.0`
6720 * `frame_blend`: number, default: `0.0`
6721 * `frame_loop`: boolean, default: `true`
6722 * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and
6724 * `set_animation_frame_speed(frame_speed)`
6725 * `frame_speed`: number, default: `15.0`
6726 * `set_attach(parent[, bone, position, rotation, forced_visible])`
6727 * `bone`: string. Default is `""`, the root bone
6728 * `position`: `{x=num, y=num, z=num}`, relative, default `{x=0, y=0, z=0}`
6729 * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees.
6730 Default `{x=0, y=0, z=0}`
6731 * `forced_visible`: Boolean to control whether the attached entity
6732 should appear in first person. Default `false`.
6733 * This command may fail silently (do nothing) when it would result
6734 in circular attachments.
6735 * `get_attach()`: returns parent, bone, position, rotation, forced_visible,
6736 or nil if it isn't attached.
6737 * `get_children()`: returns a list of ObjectRefs that are attached to the
6740 * `set_bone_position([bone, position, rotation])`
6741 * `bone`: string. Default is `""`, the root bone
6742 * `position`: `{x=num, y=num, z=num}`, relative, `default {x=0, y=0, z=0}`
6743 * `rotation`: `{x=num, y=num, z=num}`, default `{x=0, y=0, z=0}`
6744 * `get_bone_position(bone)`: returns position and rotation of the bone
6745 * `set_properties(object property table)`
6746 * `get_properties()`: returns object property table
6747 * `is_player()`: returns true for players, false otherwise
6748 * `get_nametag_attributes()`
6749 * returns a table with the attributes of the nametag of an object
6752 color = {a=0..255, r=0..255, g=0..255, b=0..255},
6753 bgcolor = {a=0..255, r=0..255, g=0..255, b=0..255},
6755 * `set_nametag_attributes(attributes)`
6756 * sets the attributes of the nametag of an object
6759 text = "My Nametag",
6762 bgcolor = ColorSpec or false,
6763 -- ^ Sets background color of nametag
6764 -- `false` will cause the background to be set automatically based on user settings
6768 #### Lua entity only (no-op for other objects)
6770 * `remove()`: remove object
6771 * The object is removed after returning from Lua. However the `ObjectRef`
6772 itself instantly becomes unusable with all further method calls having
6773 no effect and returning `nil`.
6774 * `set_velocity(vel)`
6775 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
6776 * `set_acceleration(acc)`
6778 * `get_acceleration()`: returns the acceleration, a vector
6779 * `set_rotation(rot)`
6780 * `rot` is a vector (radians). X is pitch (elevation), Y is yaw (heading)
6781 and Z is roll (bank).
6782 * `get_rotation()`: returns the rotation, a vector (radians)
6783 * `set_yaw(yaw)`: sets the yaw in radians (heading).
6784 * `get_yaw()`: returns number in radians
6785 * `set_texture_mod(mod)`
6786 * Set a texture modifier to the base texture, for sprites and meshes.
6787 * When calling `set_texture_mod` again, the previous one is discarded.
6788 * `mod` the texture modifier. See [Texture modifiers].
6789 * `get_texture_mod()` returns current texture modifier
6790 * `set_sprite(start_frame, num_frames, framelength, select_x_by_camera)`
6791 * Specifies and starts a sprite animation
6792 * Animations iterate along the frame `y` position.
6793 * `start_frame`: {x=column number, y=row number}, the coordinate of the
6794 first frame, default: `{x=0, y=0}`
6795 * `num_frames`: Total frames in the texture, default: `1`
6796 * `framelength`: Time per animated frame in seconds, default: `0.2`
6797 * `select_x_by_camera`: Only for visual = `sprite`. Changes the frame `x`
6798 position according to the view direction. default: `false`.
6799 * First column: subject facing the camera
6800 * Second column: subject looking to the left
6801 * Third column: subject backing the camera
6802 * Fourth column: subject looking to the right
6803 * Fifth column: subject viewed from above
6804 * Sixth column: subject viewed from below
6805 * `get_entity_name()` (**Deprecated**: Will be removed in a future version, use the field `self.name` instead)
6808 #### Player only (no-op for other objects)
6810 * `get_player_name()`: returns `""` if is not a player
6811 * `get_player_velocity()`: **DEPRECATED**, use get_velocity() instead.
6812 table {x, y, z} representing the player's instantaneous velocity in nodes/s
6813 * `add_player_velocity(vel)`: **DEPRECATED**, use add_velocity(vel) instead.
6814 * `get_look_dir()`: get camera direction as a unit vector
6815 * `get_look_vertical()`: pitch in radians
6816 * Angle ranges between -pi/2 and pi/2, which are straight up and down
6818 * `get_look_horizontal()`: yaw in radians
6819 * Angle is counter-clockwise from the +z direction.
6820 * `set_look_vertical(radians)`: sets look pitch
6821 * radians: Angle from looking forward, where positive is downwards.
6822 * `set_look_horizontal(radians)`: sets look yaw
6823 * radians: Angle from the +z direction, where positive is counter-clockwise.
6824 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use
6825 `get_look_vertical`.
6826 * Angle ranges between -pi/2 and pi/2, which are straight down and up
6828 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use
6829 `get_look_horizontal`.
6830 * Angle is counter-clockwise from the +x direction.
6831 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use
6832 `set_look_vertical`.
6833 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use
6834 `set_look_horizontal`.
6835 * `get_breath()`: returns player's breath
6836 * `set_breath(value)`: sets player's breath
6838 * `0`: player is drowning
6839 * max: bubbles bar is not shown
6840 * See [Object properties] for more information
6841 * Is limited to range 0 ... 65535 (2^16 - 1)
6842 * `set_fov(fov, is_multiplier, transition_time)`: Sets player's FOV
6844 * `is_multiplier`: Set to `true` if the FOV value is a multiplier.
6845 Defaults to `false`.
6846 * `transition_time`: If defined, enables smooth FOV transition.
6847 Interpreted as the time (in seconds) to reach target FOV.
6848 If set to 0, FOV change is instantaneous. Defaults to 0.
6849 * Set `fov` to 0 to clear FOV override.
6850 * `get_fov()`: Returns the following:
6851 * Server-sent FOV value. Returns 0 if an FOV override doesn't exist.
6852 * Boolean indicating whether the FOV value is a multiplier.
6853 * Time (in seconds) taken for the FOV transition. Set by `set_fov`.
6854 * `set_attribute(attribute, value)`: DEPRECATED, use get_meta() instead
6855 * Sets an extra attribute with value on player.
6856 * `value` must be a string, or a number which will be converted to a
6858 * If `value` is `nil`, remove attribute from player.
6859 * `get_attribute(attribute)`: DEPRECATED, use get_meta() instead
6860 * Returns value (a string) for extra attribute.
6861 * Returns `nil` if no attribute found.
6862 * `get_meta()`: Returns a PlayerMetaRef.
6863 * `set_inventory_formspec(formspec)`
6864 * Redefine player's inventory form
6865 * Should usually be called in `on_joinplayer`
6866 * If `formspec` is `""`, the player's inventory is disabled.
6867 * `get_inventory_formspec()`: returns a formspec string
6868 * `set_formspec_prepend(formspec)`:
6869 * the formspec string will be added to every formspec shown to the user,
6870 except for those with a no_prepend[] tag.
6871 * This should be used to set style elements such as background[] and
6872 bgcolor[], any non-style elements (eg: label) may result in weird behaviour.
6873 * Only affects formspecs shown after this is called.
6874 * `get_formspec_prepend(formspec)`: returns a formspec string.
6875 * `get_player_control()`: returns table with player pressed keys
6876 * The table consists of fields with the following boolean values
6877 representing the pressed keys: `up`, `down`, `left`, `right`, `jump`,
6878 `aux1`, `sneak`, `dig`, `place`, `LMB`, `RMB`, and `zoom`.
6879 * The fields `LMB` and `RMB` are equal to `dig` and `place` respectively,
6880 and exist only to preserve backwards compatibility.
6881 * Returns an empty table `{}` if the object is not a player.
6882 * `get_player_control_bits()`: returns integer with bit packed player pressed
6895 * Returns `0` (no bits set) if the object is not a player.
6896 * `set_physics_override(override_table)`
6897 * `override_table` is a table with the following fields:
6898 * `speed`: multiplier to default walking speed value (default: `1`)
6899 * `jump`: multiplier to default jump value (default: `1`)
6900 * `gravity`: multiplier to default gravity value (default: `1`)
6901 * `sneak`: whether player can sneak (default: `true`)
6902 * `sneak_glitch`: whether player can use the new move code replications
6903 of the old sneak side-effects: sneak ladders and 2 node sneak jump
6905 * `new_move`: use new move/sneak code. When `false` the exact old code
6906 is used for the specific old sneak behaviour (default: `true`)
6907 * `get_physics_override()`: returns the table given to `set_physics_override`
6908 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
6910 * `hud_remove(id)`: remove the HUD element of the specified id
6911 * `hud_change(id, stat, value)`: change a value of a previously added HUD
6913 * element `stat` values:
6914 `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
6915 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
6916 * `hud_set_flags(flags)`: sets specified HUD flags of player.
6917 * `flags`: A table with the following fields set to boolean values
6923 * `minimap`: Modifies the client's permission to view the minimap.
6924 The client may locally elect to not view the minimap.
6925 * `minimap_radar`: is only usable when `minimap` is true
6926 * `basic_debug`: Allow showing basic debug info that might give a gameplay advantage.
6927 This includes map seed, player position, look direction, the pointed node and block bounds.
6928 Does not affect players with the `debug` privilege.
6929 * If a flag equals `nil`, the flag is not modified
6930 * `hud_get_flags()`: returns a table of player HUD flags with boolean values.
6931 * See `hud_set_flags` for a list of flags that can be toggled.
6932 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
6933 * `count`: number of items, must be between `1` and `32`
6934 * `hud_get_hotbar_itemcount`: returns number of visible items
6935 * `hud_set_hotbar_image(texturename)`
6936 * sets background image for hotbar
6937 * `hud_get_hotbar_image`: returns texturename
6938 * `hud_set_hotbar_selected_image(texturename)`
6939 * sets image for selected item of hotbar
6940 * `hud_get_hotbar_selected_image`: returns texturename
6941 * `set_minimap_modes({mode, mode, ...}, selected_mode)`
6942 * Overrides the available minimap modes (and toggle order), and changes the
6944 * `mode` is a table consisting of up to four fields:
6945 * `type`: Available type:
6946 * `off`: Minimap off
6947 * `surface`: Minimap in surface mode
6948 * `radar`: Minimap in radar mode
6949 * `texture`: Texture to be displayed instead of terrain map
6950 (texture is centered around 0,0 and can be scaled).
6951 Texture size is limited to 512 x 512 pixel.
6952 * `label`: Optional label to display on minimap mode toggle
6953 The translation must be handled within the mod.
6954 * `size`: Sidelength or diameter, in number of nodes, of the terrain
6955 displayed in minimap
6956 * `texture`: Only for texture type, name of the texture to display
6957 * `scale`: Only for texture type, scale of the texture map in nodes per
6958 pixel (for example a `scale` of 2 means each pixel represents a 2x2
6960 * `selected_mode` is the mode index to be selected after modes have been changed
6961 (0 is the first mode).
6962 * `set_sky(sky_parameters)`
6963 * The presence of the function `set_sun`, `set_moon` or `set_stars` indicates
6964 whether `set_sky` accepts this format. Check the legacy format otherwise.
6965 * Passing no arguments resets the sky to its default values.
6966 * `sky_parameters` is a table with the following optional fields:
6967 * `base_color`: ColorSpec, changes fog in "skybox" and "plain".
6968 (default: `#ffffff`)
6969 * `type`: Available types:
6970 * `"regular"`: Uses 0 textures, `base_color` ignored
6971 * `"skybox"`: Uses 6 textures, `base_color` used as fog.
6972 * `"plain"`: Uses 0 textures, `base_color` used as both fog and sky.
6973 (default: `"regular"`)
6974 * `textures`: A table containing up to six textures in the following
6975 order: Y+ (top), Y- (bottom), X- (west), X+ (east), Z+ (north), Z- (south).
6976 * `clouds`: Boolean for whether clouds appear. (default: `true`)
6977 * `sky_color`: A table used in `"regular"` type only, containing the
6978 following values (alpha is ignored):
6979 * `day_sky`: ColorSpec, for the top half of the sky during the day.
6980 (default: `#61b5f5`)
6981 * `day_horizon`: ColorSpec, for the bottom half of the sky during the day.
6982 (default: `#90d3f6`)
6983 * `dawn_sky`: ColorSpec, for the top half of the sky during dawn/sunset.
6984 (default: `#b4bafa`)
6985 The resulting sky color will be a darkened version of the ColorSpec.
6986 Warning: The darkening of the ColorSpec is subject to change.
6987 * `dawn_horizon`: ColorSpec, for the bottom half of the sky during dawn/sunset.
6988 (default: `#bac1f0`)
6989 The resulting sky color will be a darkened version of the ColorSpec.
6990 Warning: The darkening of the ColorSpec is subject to change.
6991 * `night_sky`: ColorSpec, for the top half of the sky during the night.
6992 (default: `#006bff`)
6993 The resulting sky color will be a dark version of the ColorSpec.
6994 Warning: The darkening of the ColorSpec is subject to change.
6995 * `night_horizon`: ColorSpec, for the bottom half of the sky during the night.
6996 (default: `#4090ff`)
6997 The resulting sky color will be a dark version of the ColorSpec.
6998 Warning: The darkening of the ColorSpec is subject to change.
6999 * `indoors`: ColorSpec, for when you're either indoors or underground.
7000 (default: `#646464`)
7001 * `fog_sun_tint`: ColorSpec, changes the fog tinting for the sun
7002 at sunrise and sunset. (default: `#f47d1d`)
7003 * `fog_moon_tint`: ColorSpec, changes the fog tinting for the moon
7004 at sunrise and sunset. (default: `#7f99cc`)
7005 * `fog_tint_type`: string, changes which mode the directional fog
7006 abides by, `"custom"` uses `sun_tint` and `moon_tint`, while
7007 `"default"` uses the classic Minetest sun and moon tinting.
7008 Will use tonemaps, if set to `"default"`. (default: `"default"`)
7009 * `set_sky(base_color, type, {texture names}, clouds)`
7010 * Deprecated. Use `set_sky(sky_parameters)`
7011 * `base_color`: ColorSpec, defaults to white
7012 * `type`: Available types:
7013 * `"regular"`: Uses 0 textures, `bgcolor` ignored
7014 * `"skybox"`: Uses 6 textures, `bgcolor` used
7015 * `"plain"`: Uses 0 textures, `bgcolor` used
7016 * `clouds`: Boolean for whether clouds appear in front of `"skybox"` or
7017 `"plain"` custom skyboxes (default: `true`)
7018 * `get_sky(as_table)`:
7019 * `as_table`: boolean that determines whether the deprecated version of this
7020 function is being used.
7021 * `true` returns a table containing sky parameters as defined in `set_sky(sky_parameters)`.
7022 * Deprecated: `false` or `nil` returns base_color, type, table of textures,
7024 * `get_sky_color()`:
7025 * Deprecated: Use `get_sky(as_table)` instead.
7026 * returns a table with the `sky_color` parameters as in `set_sky`.
7027 * `set_sun(sun_parameters)`:
7028 * Passing no arguments resets the sun to its default values.
7029 * `sun_parameters` is a table with the following optional fields:
7030 * `visible`: Boolean for whether the sun is visible.
7032 * `texture`: A regular texture for the sun. Setting to `""`
7033 will re-enable the mesh sun. (default: "sun.png", if it exists)
7034 * `tonemap`: A 512x1 texture containing the tonemap for the sun
7035 (default: `"sun_tonemap.png"`)
7036 * `sunrise`: A regular texture for the sunrise texture.
7037 (default: `"sunrisebg.png"`)
7038 * `sunrise_visible`: Boolean for whether the sunrise texture is visible.
7040 * `scale`: Float controlling the overall size of the sun. (default: `1`)
7041 * `get_sun()`: returns a table with the current sun parameters as in
7043 * `set_moon(moon_parameters)`:
7044 * Passing no arguments resets the moon to its default values.
7045 * `moon_parameters` is a table with the following optional fields:
7046 * `visible`: Boolean for whether the moon is visible.
7048 * `texture`: A regular texture for the moon. Setting to `""`
7049 will re-enable the mesh moon. (default: `"moon.png"`, if it exists)
7050 Note: Relative to the sun, the moon texture is rotated by 180°.
7051 You can use the `^[transformR180` texture modifier to achieve the same orientation.
7052 * `tonemap`: A 512x1 texture containing the tonemap for the moon
7053 (default: `"moon_tonemap.png"`)
7054 * `scale`: Float controlling the overall size of the moon (default: `1`)
7055 * `get_moon()`: returns a table with the current moon parameters as in
7057 * `set_stars(star_parameters)`:
7058 * Passing no arguments resets stars to their default values.
7059 * `star_parameters` is a table with the following optional fields:
7060 * `visible`: Boolean for whether the stars are visible.
7062 * `count`: Integer number to set the number of stars in
7063 the skybox. Only applies to `"skybox"` and `"regular"` sky types.
7065 * `star_color`: ColorSpec, sets the colors of the stars,
7066 alpha channel is used to set overall star brightness.
7067 (default: `#ebebff69`)
7068 * `scale`: Float controlling the overall size of the stars (default: `1`)
7069 * `get_stars()`: returns a table with the current stars parameters as in
7071 * `set_clouds(cloud_parameters)`: set cloud parameters
7072 * Passing no arguments resets clouds to their default values.
7073 * `cloud_parameters` is a table with the following optional fields:
7074 * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
7075 * `color`: basic cloud color with alpha channel, ColorSpec
7076 (default `#fff0f0e5`).
7077 * `ambient`: cloud color lower bound, use for a "glow at night" effect.
7078 ColorSpec (alpha ignored, default `#000000`)
7079 * `height`: cloud height, i.e. y of cloud base (default per conf,
7081 * `thickness`: cloud thickness in nodes (default `16`)
7082 * `speed`: 2D cloud speed + direction in nodes per second
7083 (default `{x=0, z=-2}`).
7084 * `get_clouds()`: returns a table with the current cloud parameters as in
7086 * `override_day_night_ratio(ratio or nil)`
7087 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific
7089 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
7090 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
7091 * `set_local_animation(idle, walk, dig, walk_while_dig, frame_speed)`:
7092 set animation for player model in third person view.
7093 * Every animation equals to a `{x=starting frame, y=ending frame}` table.
7094 * `frame_speed` sets the animations frame speed. Default is 30.
7095 * `get_local_animation()`: returns idle, walk, dig, walk_while_dig tables and
7097 * `set_eye_offset([firstperson, thirdperson])`: defines offset vectors for
7098 camera per player. An argument defaults to `{x=0, y=0, z=0}` if unspecified.
7099 * in first person view
7100 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
7101 * `get_eye_offset()`: returns first and third person offsets.
7102 * `send_mapblock(blockpos)`:
7103 * Sends a server-side loaded mapblock to the player.
7104 * Returns `false` if failed.
7105 * Resource intensive - use sparsely
7106 * To get blockpos, integer divide pos by 16
7107 * `set_lighting(light_definition)`: sets lighting for the player
7108 * `light_definition` is a table with the following optional fields:
7109 * `shadows` is a table that controls ambient shadows
7110 * `intensity` sets the intensity of the shadows from 0 (no shadows, default) to 1 (blackness)
7111 * `get_lighting()`: returns the current state of lighting for the player.
7112 * Result is a table with the same fields as `light_definition` in `set_lighting`.
7113 * `respawn()`: Respawns the player using the same mechanism as the death screen,
7114 including calling on_respawnplayer callbacks.
7119 A 32-bit pseudorandom number generator.
7120 Uses PCG32, an algorithm of the permuted congruential generator family,
7121 offering very strong randomness.
7123 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
7127 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
7128 * `next(min, max)`: return next integer random number [`min`...`max`]
7129 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed
7130 random number [`min`...`max`].
7131 * This is only a rough approximation of a normal distribution with:
7132 * `mean = (max - min) / 2`, and
7133 * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
7134 * Increasing `num_trials` improves accuracy of the approximation
7139 A perlin noise generator.
7140 It can be created via `PerlinNoise()` or `minetest.get_perlin()`.
7141 For `minetest.get_perlin()`, the actual seed used is the noiseparams seed
7142 plus the world seed, to create world-specific noise.
7144 `PerlinNoise(noiseparams)`
7145 `PerlinNoise(seed, octaves, persistence, spread)` (Deprecated).
7147 `minetest.get_perlin(noiseparams)`
7148 `minetest.get_perlin(seeddiff, octaves, persistence, spread)` (Deprecated).
7152 * `get_2d(pos)`: returns 2D noise value at `pos={x=,y=}`
7153 * `get_3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
7158 A fast, bulk perlin noise generator.
7160 It can be created via `PerlinNoiseMap(noiseparams, size)` or
7161 `minetest.get_perlin_map(noiseparams, size)`.
7162 For `minetest.get_perlin_map()`, the actual seed used is the noiseparams seed
7163 plus the world seed, to create world-specific noise.
7165 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
7166 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
7169 For each of the functions with an optional `buffer` parameter: If `buffer` is
7170 not nil, this table will be used to store the result instead of creating a new
7175 * `get_2d_map(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
7176 with values starting at `pos={x=,y=}`
7177 * `get_3d_map(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>`
7178 3D array of 3D noise with values starting at `pos={x=,y=,z=}`.
7179 * `get_2d_map_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element
7180 array of 2D noise with values starting at `pos={x=,y=}`
7181 * `get_3d_map_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
7182 * `calc_2d_map(pos)`: Calculates the 2d noise map starting at `pos`. The result
7183 is stored internally.
7184 * `calc_3d_map(pos)`: Calculates the 3d noise map starting at `pos`. The result
7185 is stored internally.
7186 * `get_map_slice(slice_offset, slice_size, buffer)`: In the form of an array,
7187 returns a slice of the most recently computed noise results. The result slice
7188 begins at coordinates `slice_offset` and takes a chunk of `slice_size`.
7189 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer
7191 `noisevals = noise:get_map_slice({y=20}, {y=2})`
7192 It is important to note that `slice_offset` offset coordinates begin at 1,
7193 and are relative to the starting position of the most recently calculated
7195 To grab a single vertical column of noise starting at map coordinates
7196 x = 1023, y=1000, z = 1000:
7197 `noise:calc_3d_map({x=1000, y=1000, z=1000})`
7198 `noisevals = noise:get_map_slice({x=24, z=1}, {x=1, z=1})`
7204 Uses the same method of storage as the deprecated player attribute API, so
7205 data there will also be in player meta.
7206 Can be obtained using `player:get_meta()`.
7210 * All methods in MetaDataRef
7215 A 16-bit pseudorandom number generator.
7216 Uses a well-known LCG algorithm introduced by K&R.
7218 It can be created via `PseudoRandom(seed)`.
7222 * `next()`: return next integer random number [`0`...`32767`]
7223 * `next(min, max)`: return next integer random number [`min`...`max`]
7224 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
7225 due to the simple implementation making bad distribution otherwise.
7230 A raycast on the map. It works with selection boxes.
7231 Can be used as an iterator in a for loop as:
7233 local ray = Raycast(...)
7234 for pointed_thing in ray do
7238 The map is loaded as the ray advances. If the map is modified after the
7239 `Raycast` is created, the changes may or may not have an effect on the object.
7241 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
7242 `minetest.raycast(pos1, pos2, objects, liquids)` where:
7244 * `pos1`: start of the ray
7245 * `pos2`: end of the ray
7246 * `objects`: if false, only nodes will be returned. Default is true.
7247 * `liquids`: if false, liquid nodes (`liquidtype ~= "none"`) won't be
7248 returned. Default is false.
7252 * `next()`: returns a `pointed_thing` with exact pointing location
7253 * Returns the next thing pointed by the ray or nil.
7258 Interface for the operating system's crypto-secure PRNG.
7260 It can be created via `SecureRandom()`. The constructor returns nil if a
7261 secure random device cannot be found on the system.
7265 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many
7266 random bytes, as a string.
7271 An interface to read config files in the format of `minetest.conf`.
7273 It can be created via `Settings(filename)`.
7277 * `get(key)`: returns a value
7278 * `get_bool(key, [default])`: returns a boolean
7279 * `default` is the value returned if `key` is not found.
7280 * Returns `nil` if `key` is not found and `default` not specified.
7281 * `get_np_group(key)`: returns a NoiseParams table
7283 * Returns `{flag = true/false, ...}` according to the set flags.
7284 * Is currently limited to mapgen flags `mg_flags` and mapgen-specific
7285 flags like `mgv5_spflags`.
7287 * Setting names can't contain whitespace or any of `="{}#`.
7288 * Setting values can't contain the sequence `\n"""`.
7289 * Setting names starting with "secure." can't be set on the main settings
7290 object (`minetest.settings`).
7291 * `set_bool(key, value)`
7292 * See documentation for set() above.
7293 * `set_np_group(key, value)`
7294 * `value` is a NoiseParams table.
7295 * Also, see documentation for set() above.
7296 * `remove(key)`: returns a boolean (`true` for success)
7297 * `get_names()`: returns `{key1,...}`
7298 * `write()`: returns a boolean (`true` for success)
7299 * Writes changes to file.
7300 * `to_table()`: returns `{[key1]=value1,...}`
7304 The settings have the format `key = value`. Example:
7316 Mod metadata: per mod metadata, saved automatically.
7317 Can be obtained via `minetest.get_mod_storage()` during load time.
7319 WARNING: This storage backend is incaptable to save raw binary data due
7320 to restrictions of JSON.
7324 * All methods in MetaDataRef
7335 Used by `ObjectRef` methods. Part of an Entity definition.
7336 These properties are not persistent, but are applied automatically to the
7337 corresponding Lua entity using the given registration fields.
7338 Player properties need to be saved manually.
7342 -- For players only. Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`.
7345 -- For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`.
7348 -- For players only. Zoom FOV in degrees.
7349 -- Note that zoom loads and/or generates world beyond the server's
7350 -- maximum send and generate distances, so acts like a telescope.
7351 -- Smaller zoom_fov values increase the distance loaded/generated.
7352 -- Defaults to 15 in creative mode, 0 in survival mode.
7353 -- zoom_fov = 0 disables zooming for the player.
7356 -- For players only. Camera height above feet position in nodes.
7357 -- Defaults to 1.625.
7360 -- Collide with `walkable` nodes.
7362 collide_with_objects = true,
7363 -- Collide with other objects if physical = true
7365 collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5}, -- Default
7366 selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
7367 -- Selection box uses collision box dimensions when not set.
7368 -- For both boxes: {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from
7372 -- Overrides selection box when false
7374 visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem" / "item",
7375 -- "cube" is a node-sized cube.
7376 -- "sprite" is a flat texture always facing the player.
7377 -- "upright_sprite" is a vertical flat texture.
7378 -- "mesh" uses the defined mesh model.
7379 -- "wielditem" is used for dropped items.
7380 -- (see builtin/game/item_entity.lua).
7381 -- For this use 'wield_item = itemname' (Deprecated: 'textures = {itemname}').
7382 -- If the item has a 'wield_image' the object will be an extrusion of
7384 -- If 'itemname' is a cubic node or nodebox the object will appear
7385 -- identical to 'itemname'.
7386 -- If 'itemname' is a plantlike node the object will be an extrusion
7388 -- Otherwise for non-node items, the object will be an extrusion of
7389 -- 'inventory_image'.
7390 -- If 'itemname' contains a ColorString or palette index (e.g. from
7391 -- `minetest.itemstring_with_palette()`), the entity will inherit the color.
7392 -- "item" is similar to "wielditem" but ignores the 'wield_image' parameter.
7394 visual_size = {x = 1, y = 1, z = 1},
7395 -- Multipliers for the visual size. If `z` is not specified, `x` will be used
7396 -- to scale the entity along both horizontal axes.
7399 -- File name of mesh when using "mesh" visual
7402 -- Number of required textures depends on visual.
7403 -- "cube" uses 6 textures just like a node, but all 6 must be defined.
7404 -- "sprite" uses 1 texture.
7405 -- "upright_sprite" uses 2 textures: {front, back}.
7406 -- "wielditem" expects 'textures = {itemname}' (see 'visual' above).
7407 -- "mesh" requires one texture for each mesh buffer/material (in order)
7410 -- Number of required colors depends on visual
7412 use_texture_alpha = false,
7413 -- Use texture's alpha channel.
7414 -- Excludes "upright_sprite" and "wielditem".
7415 -- Note: currently causes visual issues when viewed through other
7416 -- semi-transparent materials such as water.
7418 spritediv = {x = 1, y = 1},
7419 -- Used with spritesheet textures for animation and/or frame selection
7420 -- according to position relative to player.
7421 -- Defines the number of columns and rows in the spritesheet:
7424 initial_sprite_basepos = {x = 0, y = 0},
7425 -- Used with spritesheet textures.
7426 -- Defines the {column, row} position of the initially used frame in the
7430 -- If false, object is invisible and can't be pointed.
7432 makes_footstep_sound = false,
7433 -- If true, is able to make footstep sounds of nodes
7434 -- (see node sound definition for details).
7436 automatic_rotate = 0,
7437 -- Set constant rotation in radians per second, positive or negative.
7438 -- Object rotates along the local Y-axis, and works with set_rotation.
7439 -- Set to 0 to disable constant rotation.
7442 -- If positive number, object will climb upwards when it moves
7443 -- horizontally against a `walkable` node, if the height difference
7444 -- is within `stepheight`.
7446 automatic_face_movement_dir = 0.0,
7447 -- Automatically set yaw to movement direction, offset in degrees.
7448 -- 'false' to disable.
7450 automatic_face_movement_max_rotation_per_sec = -1,
7451 -- Limit automatic rotation to this value in degrees per second.
7452 -- No limit if value <= 0.
7454 backface_culling = true,
7455 -- Set to false to disable backface_culling for model
7458 -- Add this much extra lighting when calculating texture color.
7459 -- Value < 0 disables light's effect on texture color.
7460 -- For faking self-lighting, UI style entities, or programmatic coloring
7464 -- The name to display on the head of the object. By default empty.
7465 -- If the object is a player, a nil or empty nametag is replaced by the player's name.
7466 -- For all other objects, a nil or empty string removes the nametag.
7467 -- To hide a nametag, set its color alpha to zero. That will disable it entirely.
7469 nametag_color = <ColorSpec>,
7470 -- Sets text color of nametag
7472 nametag_bgcolor = <ColorSpec>,
7473 -- Sets background color of nametag
7474 -- `false` will cause the background to be set automatically based on user settings.
7478 -- Same as infotext for nodes. Empty by default
7481 -- If false, never save this object statically. It will simply be
7482 -- deleted when the block gets unloaded.
7483 -- The get_staticdata() callback is never called then.
7484 -- Defaults to 'true'.
7486 damage_texture_modifier = "^[brighten",
7487 -- Texture modifier to be applied for a short duration when object is hit
7490 -- Setting this to 'false' disables diffuse lighting of entity
7492 show_on_minimap = false,
7493 -- Defaults to true for players, false for other entities.
7494 -- If set to true the entity will show as a marker on the minimap.
7500 Used by `minetest.register_entity`.
7503 initial_properties = {
7505 mesh = "boats_boat.obj",
7508 -- A table of object properties, see the `Object properties` section.
7509 -- Object properties being read directly from the entity definition
7510 -- table is deprecated. Define object properties in this
7511 -- `initial_properties` table instead.
7513 on_activate = function(self, staticdata, dtime_s),
7515 on_step = function(self, dtime, moveresult),
7516 -- Called every server step
7517 -- dtime: Elapsed time
7518 -- moveresult: Table with collision info (only available if physical=true)
7520 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
7522 on_rightclick = function(self, clicker),
7524 get_staticdata = function(self),
7525 -- Called sometimes; the string returned is passed to on_activate when
7526 -- the entity is re-activated from static state
7528 _custom_field = whatever,
7529 -- You can define arbitrary member variables here (see Item definition
7530 -- for more info) by using a '_' prefix
7533 Collision info passed to `on_step` (`moveresult` argument):
7536 touching_ground = boolean,
7538 standing_on_object = boolean,
7541 type = string, -- "node" or "object",
7542 axis = string, -- "x", "y" or "z"
7543 node_pos = vector, -- if type is "node"
7544 object = ObjectRef, -- if type is "object"
7545 old_velocity = vector,
7546 new_velocity = vector,
7550 -- `collisions` does not contain data of unloaded mapblock collisions
7551 -- or when the velocity changes are negligibly small
7554 ABM (ActiveBlockModifier) definition
7555 ------------------------------------
7557 Used by `minetest.register_abm`.
7560 label = "Lava cooling",
7561 -- Descriptive label for profiling purposes (optional).
7562 -- Definitions with identical labels will be listed as one.
7564 nodenames = {"default:lava_source"},
7565 -- Apply `action` function to these nodes.
7566 -- `group:groupname` can also be used here.
7568 neighbors = {"default:water_source", "default:water_flowing"},
7569 -- Only apply `action` to nodes that have one of, or any
7570 -- combination of, these neighbors.
7571 -- If left out or empty, any neighbor will do.
7572 -- `group:groupname` can also be used here.
7575 -- Operation interval in seconds
7578 -- Chance of triggering `action` per-node per-interval is 1.0 / this
7583 -- min and max height levels where ABM will be processed
7584 -- can be used to reduce CPU usage
7587 -- If true, catch-up behaviour is enabled: The `chance` value is
7588 -- temporarily reduced when returning to an area to simulate time lost
7589 -- by the area being unattended. Note that the `chance` value can often
7592 action = function(pos, node, active_object_count, active_object_count_wider),
7593 -- Function triggered for each qualifying node.
7594 -- `active_object_count` is number of active objects in the node's
7596 -- `active_object_count_wider` is number of active objects in the node's
7597 -- mapblock plus all 26 neighboring mapblocks. If any neighboring
7598 -- mapblocks are unloaded an estmate is calculated for them based on
7599 -- loaded mapblocks.
7602 LBM (LoadingBlockModifier) definition
7603 -------------------------------------
7605 Used by `minetest.register_lbm`.
7607 A loading block modifier (LBM) is used to define a function that is called for
7608 specific nodes (defined by `nodenames`) when a mapblock which contains such nodes
7612 label = "Upgrade legacy doors",
7613 -- Descriptive label for profiling purposes (optional).
7614 -- Definitions with identical labels will be listed as one.
7616 name = "modname:replace_legacy_door",
7618 nodenames = {"default:lava_source"},
7619 -- List of node names to trigger the LBM on.
7620 -- Also non-registered nodes will work.
7621 -- Groups (as of group:groupname) will work as well.
7623 run_at_every_load = false,
7624 -- Whether to run the LBM's action every time a block gets loaded,
7625 -- and not only the first time the block gets loaded after the LBM
7628 action = function(pos, node),
7635 * `{name="image.png", animation={Tile Animation definition}}`
7636 * `{name="image.png", backface_culling=bool, align_style="node"/"world"/"user", scale=int}`
7637 * backface culling enabled by default for most nodes
7638 * align style determines whether the texture will be rotated with the node
7639 or kept aligned with its surroundings. "user" means that client
7640 setting will be used, similar to `glasslike_framed_optional`.
7641 Note: supported by solid nodes and nodeboxes only.
7642 * scale is used to make texture span several (exactly `scale`) nodes,
7643 instead of just one, in each direction. Works for world-aligned
7645 Note that as the effect is applied on per-mapblock basis, `16` should
7646 be equally divisible by `scale` or you may get wrong results.
7647 * `{name="image.png", color=ColorSpec}`
7648 * the texture's color will be multiplied with this color.
7649 * the tile's color overrides the owning node's color in all cases.
7650 * deprecated, yet still supported field names:
7653 Tile animation definition
7654 -------------------------
7657 type = "vertical_frames",
7660 -- Width of a frame in pixels
7663 -- Height of a frame in pixels
7673 -- Width in number of frames
7676 -- Height in number of frames
7679 -- Length of a single frame
7685 Used by `minetest.register_node`, `minetest.register_craftitem`, and
7686 `minetest.register_tool`.
7689 description = "Steel Axe",
7690 -- Can contain new lines. "\n" has to be used as new line character.
7691 -- See also: `get_description` in [`ItemStack`]
7693 short_description = "Steel Axe",
7694 -- Must not contain new lines.
7696 -- Use an [`ItemStack`] to get the short description, eg:
7697 -- ItemStack(itemname):get_short_description()
7700 -- key = name, value = rating; rating = 1..3.
7701 -- If rating not applicable, use 1.
7702 -- e.g. {wool = 1, fluffy = 3}
7703 -- {soil = 2, outerspace = 1, crumbly = 1}
7704 -- {bendy = 2, snappy = 1},
7705 -- {hard = 1, metal = 1, spikes = 1}
7707 inventory_image = "default_tool_steelaxe.png",
7709 inventory_overlay = "overlay.png",
7710 -- An overlay which does not get colorized
7717 -- An image file containing the palette of a node.
7718 -- You can set the currently used color as the "palette_index" field of
7719 -- the item stack metadata.
7720 -- The palette is always stretched to fit indices between 0 and 255, to
7721 -- ensure compatibility with "colorfacedir" and "colorwallmounted" nodes.
7723 color = "0xFFFFFFFF",
7724 -- The color of the item. The palette overrides this.
7726 wield_scale = {x = 1, y = 1, z = 1},
7728 -- The default value of 99 may be configured by
7729 -- users using the setting "default_stack_max"
7734 liquids_pointable = false,
7735 -- If true, item points to all liquid nodes (`liquidtype ~= "none"`),
7736 -- even those for which `pointable = false`
7739 -- When used for nodes: Defines amount of light emitted by node.
7740 -- Otherwise: Defines texture glow when viewed as a dropped item
7741 -- To set the maximum (14), use the value 'minetest.LIGHT_MAX'.
7742 -- A value outside the range 0 to minetest.LIGHT_MAX causes undefined
7745 -- See "Tool Capabilities" section for an example including explanation
7746 tool_capabilities = {
7747 full_punch_interval = 1.0,
7751 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00},
7752 uses = 20, maxlevel = 2},
7754 damage_groups = {groupname = damage},
7755 -- Damage values must be between -32768 and 32767 (2^15)
7757 punch_attack_uses = nil,
7758 -- Amount of uses this tool has for attacking players and entities
7759 -- by punching them (0 = infinite uses).
7760 -- For compatibility, this is automatically set from the first
7761 -- suitable groupcap using the forumla "uses * 3^(maxlevel - 1)".
7762 -- It is recommend to set this explicitly instead of relying on the
7763 -- fallback behavior.
7766 node_placement_prediction = nil,
7767 -- If nil and item is node, prediction is made automatically.
7768 -- If nil and item is not a node, no prediction is made.
7769 -- If "" and item is anything, no prediction is made.
7770 -- Otherwise should be name of node which the client immediately places
7771 -- on ground when the player places the item. Server will always update
7772 -- actual result to client in a short moment.
7774 node_dig_prediction = "air",
7775 -- if "", no prediction is made.
7776 -- if "air", node is removed.
7777 -- Otherwise should be name of node which the client immediately places
7778 -- upon digging. Server will always update actual result shortly.
7781 -- Definition of items sounds to be played at various events.
7782 -- All fields in this table are optional.
7784 breaks = <SimpleSoundSpec>,
7785 -- When tool breaks due to wear. Ignored for non-tools
7787 eat = <SimpleSoundSpec>,
7788 -- When item is eaten with `minetest.do_item_eat`
7791 on_place = function(itemstack, placer, pointed_thing),
7792 -- When the 'place' key was pressed with the item in hand
7793 -- and a node was pointed at.
7794 -- Shall place item and return the leftover itemstack
7795 -- or nil to not modify the inventory.
7796 -- The placer may be any ObjectRef or nil.
7797 -- default: minetest.item_place
7799 on_secondary_use = function(itemstack, user, pointed_thing),
7800 -- Same as on_place but called when not pointing at a node.
7801 -- Function must return either nil if inventory shall not be modified,
7802 -- or an itemstack to replace the original itemstack.
7803 -- The user may be any ObjectRef or nil.
7806 on_drop = function(itemstack, dropper, pos),
7807 -- Shall drop item and return the leftover itemstack.
7808 -- The dropper may be any ObjectRef or nil.
7809 -- default: minetest.item_drop
7811 on_use = function(itemstack, user, pointed_thing),
7813 -- When user pressed the 'punch/mine' key with the item in hand.
7814 -- Function must return either nil if inventory shall not be modified,
7815 -- or an itemstack to replace the original itemstack.
7816 -- e.g. itemstack:take_item(); return itemstack
7817 -- Otherwise, the function is free to do what it wants.
7818 -- The user may be any ObjectRef or nil.
7819 -- The default functions handle regular use cases.
7821 after_use = function(itemstack, user, node, digparams),
7823 -- If defined, should return an itemstack and will be called instead of
7824 -- wearing out the item (if tool). If returns nil, does nothing.
7825 -- If after_use doesn't exist, it is the same as:
7826 -- function(itemstack, user, node, digparams)
7827 -- itemstack:add_wear(digparams.wear)
7830 -- The user may be any ObjectRef or nil.
7832 _custom_field = whatever,
7833 -- Add your own custom fields. By convention, all custom field names
7834 -- should start with `_` to avoid naming collisions with future engine
7841 Used by `minetest.register_node`.
7844 -- <all fields allowed in item definitions>,
7846 drawtype = "normal", -- See "Node drawtypes"
7849 -- Supported for drawtypes "plantlike", "signlike", "torchlike",
7850 -- "firelike", "mesh", "nodebox", "allfaces".
7851 -- For plantlike and firelike, the image will start at the bottom of the
7852 -- node. For torchlike, the image will start at the surface to which the
7853 -- node "attaches". For the other drawtypes the image will be centered
7856 tiles = {tile definition 1, def2, def3, def4, def5, def6},
7857 -- Textures of node; +Y, -Y, +X, -X, +Z, -Z
7858 -- Old field name was 'tile_images'.
7859 -- List can be shortened to needed length.
7861 overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6},
7862 -- Same as `tiles`, but these textures are drawn on top of the base
7863 -- tiles. You can use this to colorize only specific parts of your
7864 -- texture. If the texture name is an empty string, that overlay is not
7865 -- drawn. Since such tiles are drawn twice, it is not recommended to use
7866 -- overlays on very common nodes.
7868 special_tiles = {tile definition 1, Tile definition 2},
7869 -- Special textures of node; used rarely.
7870 -- Old field name was 'special_materials'.
7871 -- List can be shortened to needed length.
7874 -- The node's original color will be multiplied with this color.
7875 -- If the node has a palette, then this setting only has an effect in
7876 -- the inventory and on the wield item.
7878 use_texture_alpha = ...,
7879 -- Specifies how the texture's alpha channel will be used for rendering.
7881 -- * "opaque": Node is rendered opaque regardless of alpha channel
7882 -- * "clip": A given pixel is either fully see-through or opaque
7883 -- depending on the alpha channel being below/above 50% in value
7884 -- * "blend": The alpha channel specifies how transparent a given pixel
7885 -- of the rendered node is
7886 -- The default is "opaque" for drawtypes normal, liquid and flowingliquid;
7887 -- "clip" otherwise.
7888 -- If set to a boolean value (deprecated): true either sets it to blend
7889 -- or clip, false sets it to clip or opaque mode depending on the drawtype.
7891 palette = "palette.png",
7892 -- The node's `param2` is used to select a pixel from the image.
7893 -- Pixels are arranged from left to right and from top to bottom.
7894 -- The node's color will be multiplied with the selected pixel's color.
7895 -- Tiles can override this behavior.
7896 -- Only when `paramtype2` supports palettes.
7898 post_effect_color = "green#0F",
7899 -- Screen tint if player is inside node, see "ColorSpec"
7901 paramtype = "none", -- See "Nodes"
7903 paramtype2 = "none", -- See "Nodes"
7905 place_param2 = nil, -- Force value for param2 when player places node
7907 is_ground_content = true,
7908 -- If false, the cave generator and dungeon generator will not carve
7909 -- through this node.
7910 -- Specifically, this stops mod-added nodes being removed by caves and
7911 -- dungeons when those generate in a neighbor mapchunk and extend out
7912 -- beyond the edge of that mapchunk.
7914 sunlight_propagates = false,
7915 -- If true, sunlight will go infinitely through this node
7917 walkable = true, -- If true, objects collide with node
7919 pointable = true, -- If true, can be pointed at
7921 diggable = true, -- If false, can never be dug
7923 climbable = false, -- If true, can be climbed on (ladder)
7925 move_resistance = 0,
7926 -- Slows down movement of players through this node (max. 7).
7927 -- If this is nil, it will be equal to liquid_viscosity.
7928 -- Note: If liquid movement physics apply to the node
7929 -- (see `liquid_move_physics`), the movement speed will also be
7930 -- affected by the `movement_liquid_*` settings.
7932 buildable_to = false, -- If true, placed nodes can replace this node
7935 -- If true, liquids flow into and replace this node.
7936 -- Warning: making a liquid node 'floodable' will cause problems.
7938 liquidtype = "none", -- specifies liquid flowing physics
7939 -- * "none": no liquid flowing physics
7940 -- * "source": spawns flowing liquid nodes at all 4 sides and below;
7941 -- recommended drawtype: "liquid".
7942 -- * "flowing": spawned from source, spawns more flowing liquid nodes
7943 -- around it until `liquid_range` is reached;
7944 -- will drain out without a source;
7945 -- recommended drawtype: "flowingliquid".
7946 -- If it's "source" or "flowing" and `liquid_range > 0`, then
7947 -- both `liquid_alternative_*` fields must be specified
7949 liquid_alternative_flowing = "", -- Flowing version of source liquid
7951 liquid_alternative_source = "", -- Source version of flowing liquid
7953 liquid_viscosity = 0,
7954 -- Controls speed at which the liquid spreads/flows (max. 7).
7955 -- 0 is fastest, 7 is slowest.
7956 -- By default, this also slows down movement of players inside the node
7957 -- (can be overridden using `move_resistance`)
7959 liquid_renewable = true,
7960 -- If true, a new liquid source can be created by placing two or more
7963 liquid_move_physics = nil, -- specifies movement physics if inside node
7964 -- * false: No liquid movement physics apply.
7965 -- * true: Enables liquid movement physics. Enables things like
7966 -- ability to "swim" up/down, sinking slowly if not moving,
7967 -- smoother speed change when falling into, etc. The `movement_liquid_*`
7969 -- * nil: Will be treated as true if `liquidype ~= "none"`
7970 -- and as false otherwise.
7974 -- Only valid for "nodebox" drawtype with 'type = "leveled"'.
7975 -- Allows defining the nodebox height without using param2.
7976 -- The nodebox height is 'leveled' / 64 nodes.
7977 -- The maximum value of 'leveled' is `leveled_max`.
7980 -- Maximum value for `leveled` (0-127), enforced in
7981 -- `minetest.set_node_level` and `minetest.add_node_level`.
7982 -- Values above 124 might causes collision detection issues.
7985 -- Maximum distance that flowing liquid nodes can spread around
7986 -- source on flat land;
7987 -- maximum = 8; set to 0 to disable liquid flow
7990 -- Player will take this amount of damage if no bubbles are left
7992 damage_per_second = 0,
7993 -- If player is inside node, this damage is caused
7995 node_box = {type="regular"}, -- See "Node boxes"
7997 connects_to = nodenames,
7998 -- Used for nodebox nodes with the type == "connected".
7999 -- Specifies to what neighboring nodes connections will be drawn.
8000 -- e.g. `{"group:fence", "default:wood"}` or `"default:stone"`
8002 connect_sides = { "top", "bottom", "front", "left", "back", "right" },
8003 -- Tells connected nodebox nodes to connect only to these sides of this
8007 -- File name of mesh when using "mesh" drawtype
8012 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
8013 -- Node box format: see [Node boxes]
8016 -- Custom selection box definition. Multiple boxes can be defined.
8017 -- If "nodebox" drawtype is used and selection_box is nil, then node_box
8018 -- definition is used for the selection box.
8023 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
8024 -- Node box format: see [Node boxes]
8027 -- Custom collision box definition. Multiple boxes can be defined.
8028 -- If "nodebox" drawtype is used and collision_box is nil, then node_box
8029 -- definition is used for the collision box.
8031 -- Support maps made in and before January 2012
8032 legacy_facedir_simple = false,
8033 legacy_wallmounted = false,
8036 -- Valid for drawtypes:
8037 -- mesh, nodebox, plantlike, allfaces_optional, liquid, flowingliquid.
8038 -- 1 - wave node like plants (node top moves side-to-side, bottom is fixed)
8039 -- 2 - wave node like leaves (whole node moves side-to-side)
8040 -- 3 - wave node like liquids (whole node moves up and down)
8041 -- Not all models will properly wave.
8042 -- plantlike drawtype can only wave like plants.
8043 -- allfaces_optional drawtype can only wave like leaves.
8044 -- liquid, flowingliquid drawtypes can only wave like liquids.
8047 -- Definition of node sounds to be played at various events.
8048 -- All fields in this table are optional.
8050 footstep = <SimpleSoundSpec>,
8051 -- If walkable, played when object walks on it. If node is
8052 -- climbable or a liquid, played when object moves through it
8054 dig = <SimpleSoundSpec> or "__group",
8055 -- While digging node.
8056 -- If `"__group"`, then the sound will be
8057 -- `default_dig_<groupname>`, where `<groupname>` is the
8058 -- name of the item's digging group with the fastest digging time.
8059 -- In case of a tie, one of the sounds will be played (but we
8060 -- cannot predict which one)
8061 -- Default value: `"__group"`
8063 dug = <SimpleSoundSpec>,
8066 place = <SimpleSoundSpec>,
8067 -- Node was placed. Also played after falling
8069 place_failed = <SimpleSoundSpec>,
8070 -- When node placement failed.
8071 -- Note: This happens if the _built-in_ node placement failed.
8072 -- This sound will still be played if the node is placed in the
8073 -- `on_place` callback manually.
8075 fall = <SimpleSoundSpec>,
8076 -- When node starts to fall or is detached
8080 -- Name of dropped item when dug.
8081 -- Default dropped item is the node itself.
8082 -- Using a table allows multiple items, drop chances and item filtering.
8083 -- Item filtering by string matching is deprecated.
8086 -- Maximum number of item lists to drop.
8087 -- The entries in 'items' are processed in order. For each:
8088 -- Item filtering is applied, chance of drop is applied, if both are
8089 -- successful the entire item list is dropped.
8090 -- Entry processing continues until the number of dropped item lists
8091 -- equals 'max_items'.
8092 -- Therefore, entries should progress from low to high drop chance.
8096 -- 1 in 1000 chance of dropping a diamond.
8097 -- Default rarity is '1'.
8099 items = {"default:diamond"},
8102 -- Only drop if using an item whose name is identical to one
8104 tools = {"default:shovel_mese", "default:shovel_diamond"},
8106 items = {"default:dirt"},
8107 -- Whether all items in the dropped item list inherit the
8108 -- hardware coloring palette color from the dug node.
8109 -- Default is 'false'.
8110 inherit_color = true,
8113 -- Only drop if using an item whose name contains
8114 -- "default:shovel_" (this item filtering by string matching
8115 -- is deprecated, use tool_groups instead).
8116 tools = {"~default:shovel_"},
8118 -- The item list dropped.
8119 items = {"default:sand", "default:desert_sand"},
8122 -- Only drop if using an item in the "magicwand" group, or
8123 -- an item that is in both the "pickaxe" and the "lucky"
8127 {"pickaxe", "lucky"}
8129 items = {"default:coal_lump"},
8134 on_construct = function(pos),
8135 -- Node constructor; called after adding node.
8136 -- Can set up metadata and stuff like that.
8137 -- Not called for bulk node placement (i.e. schematics and VoxelManip).
8140 on_destruct = function(pos),
8141 -- Node destructor; called before removing node.
8142 -- Not called for bulk node placement.
8145 after_destruct = function(pos, oldnode),
8146 -- Node destructor; called after removing node.
8147 -- Not called for bulk node placement.
8150 on_flood = function(pos, oldnode, newnode),
8151 -- Called when a liquid (newnode) is about to flood oldnode, if it has
8152 -- `floodable = true` in the nodedef. Not called for bulk node placement
8153 -- (i.e. schematics and VoxelManip) or air nodes. If return true the
8154 -- node is not flooded, but on_flood callback will most likely be called
8155 -- over and over again every liquid update interval.
8157 -- Warning: making a liquid node 'floodable' will cause problems.
8159 preserve_metadata = function(pos, oldnode, oldmeta, drops),
8160 -- Called when oldnode is about be converted to an item, but before the
8161 -- node is deleted from the world or the drops are added. This is
8162 -- generally the result of either the node being dug or an attached node
8163 -- becoming detached.
8164 -- oldmeta is the NodeMetaRef of the oldnode before deletion.
8165 -- drops is a table of ItemStacks, so any metadata to be preserved can
8166 -- be added directly to one or more of the dropped items. See
8167 -- "ItemStackMetaRef".
8170 after_place_node = function(pos, placer, itemstack, pointed_thing),
8171 -- Called after constructing node when node was placed using
8172 -- minetest.item_place_node / minetest.place_node.
8173 -- If return true no item is taken from itemstack.
8174 -- `placer` may be any valid ObjectRef or nil.
8177 after_dig_node = function(pos, oldnode, oldmetadata, digger),
8178 -- oldmetadata is in table format.
8179 -- Called after destructing node when node was dug using
8180 -- minetest.node_dig / minetest.dig_node.
8183 can_dig = function(pos, [player]),
8184 -- Returns true if node can be dug, or false if not.
8187 on_punch = function(pos, node, puncher, pointed_thing),
8188 -- default: minetest.node_punch
8189 -- Called when puncher (an ObjectRef) punches the node at pos.
8190 -- By default calls minetest.register_on_punchnode callbacks.
8192 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing),
8194 -- Called when clicker (an ObjectRef) used the 'place/build' key
8195 -- (not neccessarily an actual rightclick)
8196 -- while pointing at the node at pos with 'node' being the node table.
8197 -- itemstack will hold clicker's wielded item.
8198 -- Shall return the leftover itemstack.
8199 -- Note: pointed_thing can be nil, if a mod calls this function.
8200 -- This function does not get triggered by clients <=0.4.16 if the
8201 -- "formspec" node metadata field is set.
8203 on_dig = function(pos, node, digger),
8204 -- default: minetest.node_dig
8205 -- By default checks privileges, wears out item (if tool) and removes node.
8206 -- return true if the node was dug successfully, false otherwise.
8207 -- Deprecated: returning nil is the same as returning true.
8209 on_timer = function(pos, elapsed),
8211 -- called by NodeTimers, see minetest.get_node_timer and NodeTimerRef.
8212 -- elapsed is the total time passed since the timer was started.
8213 -- return true to run the timer for another cycle with the same timeout
8216 on_receive_fields = function(pos, formname, fields, sender),
8217 -- fields = {name1 = value1, name2 = value2, ...}
8218 -- Called when an UI form (e.g. sign text input) returns data.
8219 -- See minetest.register_on_player_receive_fields for more info.
8222 allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
8223 -- Called when a player wants to move items inside the inventory.
8224 -- Return value: number of items allowed to move.
8226 allow_metadata_inventory_put = function(pos, listname, index, stack, player),
8227 -- Called when a player wants to put something into the inventory.
8228 -- Return value: number of items allowed to put.
8229 -- Return value -1: Allow and don't modify item count in inventory.
8231 allow_metadata_inventory_take = function(pos, listname, index, stack, player),
8232 -- Called when a player wants to take something out of the inventory.
8233 -- Return value: number of items allowed to take.
8234 -- Return value -1: Allow and don't modify item count in inventory.
8236 on_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
8237 on_metadata_inventory_put = function(pos, listname, index, stack, player),
8238 on_metadata_inventory_take = function(pos, listname, index, stack, player),
8239 -- Called after the actual action has happened, according to what was
8243 on_blast = function(pos, intensity),
8244 -- intensity: 1.0 = mid range of regular TNT.
8245 -- If defined, called when an explosion touches the node, instead of
8246 -- removing the node.
8248 mod_origin = "modname",
8249 -- stores which mod actually registered a node
8250 -- if it can not find a source, returns "??"
8251 -- useful for getting what mod truly registered something
8252 -- example: if a node is registered as ":othermodname:nodename",
8253 -- nodename will show "othermodname", but mod_orgin will say "modname"
8259 Used by `minetest.register_craft`.
8264 output = "default:pick_stone",
8266 {"default:cobble", "default:cobble", "default:cobble"},
8267 {"", "default:stick", ""},
8268 {"", "default:stick", ""}, -- Also groups; e.g. "group:crumbly"
8270 replacements = <list of item pairs>,
8271 -- replacements: replace one input item with another item on crafting
8279 output = "mushrooms:mushroom_stew",
8282 "mushrooms:mushroom_brown",
8283 "mushrooms:mushroom_red",
8285 replacements = <list of item pairs>,
8291 type = "toolrepair",
8292 additional_wear = -0.02, -- multiplier of 65536
8295 Adds a shapeless recipe for *every* tool that doesn't have the `disable_repair=1`
8296 group. Player can put 2 equal tools in the craft grid to get one "repaired" tool
8298 The wear of the output is determined by the wear of both tools, plus a
8299 'repair bonus' given by `additional_wear`. To reduce the wear (i.e. 'repair'),
8300 you want `additional_wear` to be negative.
8302 The formula used to calculate the resulting wear is:
8304 65536 - ( (65536 - tool_1_wear) + (65536 - tool_2_wear) + 65536 * additional_wear )
8306 The result is rounded and can't be lower than 0. If the result is 65536 or higher,
8307 no crafting is possible.
8313 output = "default:glass",
8314 recipe = "default:sand",
8322 recipe = "bucket:bucket_lava",
8324 replacements = {{"bucket:bucket_lava", "bucket:bucket_empty"}},
8330 Used by `minetest.register_ore`.
8332 See [Ores] section above for essential information.
8335 ore_type = "scatter",
8337 ore = "default:stone_with_coal",
8340 -- Facedir rotation. Default is 0 (unchanged rotation)
8342 wherein = "default:stone",
8343 -- A list of nodenames is supported too
8345 clust_scarcity = 8 * 8 * 8,
8346 -- Ore has a 1 out of clust_scarcity chance of spawning in a node.
8347 -- If the desired average distance between ores is 'd', set this to
8351 -- Number of ores in a cluster
8354 -- Size of the bounding box of the cluster.
8355 -- In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27
8356 -- nodes are coal ore.
8360 -- Lower and upper limits for ore
8363 -- Attributes for the ore generation, see 'Ore attributes' section above
8365 noise_threshold = 0.5,
8366 -- If noise is above this threshold, ore is placed. Not needed for a
8367 -- uniform distribution.
8372 spread = {x = 100, y = 100, z = 100},
8377 -- NoiseParams structure describing one of the perlin noises used for
8378 -- ore distribution.
8379 -- Needed by "sheet", "puff", "blob" and "vein" ores.
8380 -- Omit from "scatter" ore for a uniform ore distribution.
8381 -- Omit from "stratum" ore for a simple horizontal strata from y_min to
8384 biomes = {"desert", "rainforest"},
8385 -- List of biomes in which this ore occurs.
8386 -- Occurs in all biomes if this is omitted, and ignored if the Mapgen
8387 -- being used does not support biomes.
8388 -- Can be a list of (or a single) biome names, IDs, or definitions.
8390 -- Type-specific parameters
8393 column_height_min = 1,
8394 column_height_max = 16,
8395 column_midpoint_factor = 0.5,
8401 spread = {x = 100, y = 100, z = 100},
8409 spread = {x = 100, y = 100, z = 100},
8416 random_factor = 1.0,
8419 np_stratum_thickness = {
8422 spread = {x = 100, y = 100, z = 100},
8427 stratum_thickness = 8,
8433 Used by `minetest.register_biome`.
8435 The maximum number of biomes that can be used is 65535. However, using an
8436 excessive number of biomes will slow down map generation. Depending on desired
8437 performance and computing power the practical limit is much lower.
8442 node_dust = "default:snow",
8443 -- Node dropped onto upper surface after all else is generated
8445 node_top = "default:dirt_with_snow",
8447 -- Node forming surface layer of biome and thickness of this layer
8449 node_filler = "default:permafrost",
8451 -- Node forming lower layer of biome and thickness of this layer
8453 node_stone = "default:bluestone",
8454 -- Node that replaces all stone nodes between roughly y_min and y_max.
8456 node_water_top = "default:ice",
8457 depth_water_top = 10,
8458 -- Node forming a surface layer in seawater with the defined thickness
8461 -- Node that replaces all seawater nodes not in the surface layer
8463 node_river_water = "default:ice",
8464 -- Node that replaces river water in mapgens that use
8465 -- default:river_water
8467 node_riverbed = "default:gravel",
8469 -- Node placed under river water and thickness of this layer
8471 node_cave_liquid = "default:lava_source",
8472 node_cave_liquid = {"default:water_source", "default:lava_source"},
8473 -- Nodes placed inside 50% of the medium size caves.
8474 -- Multiple nodes can be specified, each cave will use a randomly
8475 -- chosen node from the list.
8476 -- If this field is left out or 'nil', cave liquids fall back to
8477 -- classic behaviour of lava and water distributed using 3D noise.
8478 -- For no cave liquid, specify "air".
8480 node_dungeon = "default:cobble",
8481 -- Node used for primary dungeon structure.
8482 -- If absent, dungeon nodes fall back to the 'mapgen_cobble' mapgen
8483 -- alias, if that is also absent, dungeon nodes fall back to the biome
8485 -- If present, the following two nodes are also used.
8487 node_dungeon_alt = "default:mossycobble",
8488 -- Node used for randomly-distributed alternative structure nodes.
8489 -- If alternative structure nodes are not wanted leave this absent for
8490 -- performance reasons.
8492 node_dungeon_stair = "stairs:stair_cobble",
8493 -- Node used for dungeon stairs.
8494 -- If absent, stairs fall back to 'node_dungeon'.
8498 -- Upper and lower limits for biome.
8499 -- Alternatively you can use xyz limits as shown below.
8501 max_pos = {x = 31000, y = 128, z = 31000},
8502 min_pos = {x = -31000, y = 9, z = -31000},
8503 -- xyz limits for biome, an alternative to using 'y_min' and 'y_max'.
8504 -- Biome is limited to a cuboid defined by these positions.
8505 -- Any x, y or z field left undefined defaults to -31000 in 'min_pos' or
8506 -- 31000 in 'max_pos'.
8509 -- Vertical distance in nodes above 'y_max' over which the biome will
8510 -- blend with the biome above.
8511 -- Set to 0 for no vertical blend. Defaults to 0.
8514 humidity_point = 50,
8515 -- Characteristic temperature and humidity for the biome.
8516 -- These values create 'biome points' on a voronoi diagram with heat and
8517 -- humidity as axes. The resulting voronoi cells determine the
8518 -- distribution of the biomes.
8519 -- Heat and humidity have average values of 50, vary mostly between
8520 -- 0 and 100 but can exceed these values.
8523 Decoration definition
8524 ---------------------
8526 See [Decoration types]. Used by `minetest.register_decoration`.
8529 deco_type = "simple",
8531 place_on = "default:dirt_with_grass",
8532 -- Node (or list of nodes) that the decoration can be placed on
8535 -- Size of the square divisions of the mapchunk being generated.
8536 -- Determines the resolution of noise variation if used.
8537 -- If the chunk size is not evenly divisible by sidelen, sidelen is made
8538 -- equal to the chunk size.
8541 -- The value determines 'decorations per surface node'.
8542 -- Used only if noise_params is not specified.
8543 -- If >= 10.0 complete coverage is enabled and decoration placement uses
8544 -- a different and much faster method.
8549 spread = {x = 100, y = 100, z = 100},
8556 -- NoiseParams structure describing the perlin noise used for decoration
8558 -- A noise value is calculated for each square division and determines
8559 -- 'decorations per surface node' within each division.
8560 -- If the noise value >= 10.0 complete coverage is enabled and
8561 -- decoration placement uses a different and much faster method.
8563 biomes = {"Oceanside", "Hills", "Plains"},
8564 -- List of biomes in which this decoration occurs. Occurs in all biomes
8565 -- if this is omitted, and ignored if the Mapgen being used does not
8567 -- Can be a list of (or a single) biome names, IDs, or definitions.
8571 -- Lower and upper limits for decoration.
8572 -- These parameters refer to the Y co-ordinate of the 'place_on' node.
8574 spawn_by = "default:water",
8575 -- Node (or list of nodes) that the decoration only spawns next to.
8576 -- Checks the 8 neighbouring nodes on the same Y, and also the ones
8577 -- at Y+1, excluding both center nodes.
8580 -- Number of spawn_by nodes that must be surrounding the decoration
8581 -- position to occur.
8582 -- If absent or -1, decorations occur next to any nodes.
8584 flags = "liquid_surface, force_placement, all_floors, all_ceilings",
8585 -- Flags for all decoration types.
8586 -- "liquid_surface": Instead of placement on the highest solid surface
8587 -- in a mapchunk column, placement is on the highest liquid surface.
8588 -- Placement is disabled if solid nodes are found above the liquid
8590 -- "force_placement": Nodes other than "air" and "ignore" are replaced
8591 -- by the decoration.
8592 -- "all_floors", "all_ceilings": Instead of placement on the highest
8593 -- surface in a mapchunk the decoration is placed on all floor and/or
8594 -- ceiling surfaces, for example in caves and dungeons.
8595 -- Ceiling decorations act as an inversion of floor decorations so the
8596 -- effect of 'place_offset_y' is inverted.
8597 -- Y-slice probabilities do not function correctly for ceiling
8598 -- schematic decorations as the behaviour is unchanged.
8599 -- If a single decoration registration has both flags the floor and
8600 -- ceiling decorations will be aligned vertically.
8602 ----- Simple-type parameters
8604 decoration = "default:grass",
8605 -- The node name used as the decoration.
8606 -- If instead a list of strings, a randomly selected node from the list
8607 -- is placed as the decoration.
8610 -- Decoration height in nodes.
8611 -- If height_max is not 0, this is the lower limit of a randomly
8615 -- Upper limit of the randomly selected height.
8616 -- If absent, the parameter 'height' is used as a constant.
8619 -- Param2 value of decoration nodes.
8620 -- If param2_max is not 0, this is the lower limit of a randomly
8624 -- Upper limit of the randomly selected param2.
8625 -- If absent, the parameter 'param2' is used as a constant.
8628 -- Y offset of the decoration base node relative to the standard base
8630 -- Can be positive or negative. Default is 0.
8631 -- Effect is inverted for "all_ceilings" decorations.
8632 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
8633 -- to the 'place_on' node.
8635 ----- Schematic-type parameters
8637 schematic = "foobar.mts",
8638 -- If schematic is a string, it is the filepath relative to the current
8639 -- working directory of the specified Minetest schematic file.
8640 -- Could also be the ID of a previously registered schematic.
8643 size = {x = 4, y = 6, z = 4},
8645 {name = "default:cobble", param1 = 255, param2 = 0},
8646 {name = "default:dirt_with_grass", param1 = 255, param2 = 0},
8647 {name = "air", param1 = 255, param2 = 0},
8651 {ypos = 2, prob = 128},
8652 {ypos = 5, prob = 64},
8656 -- Alternative schematic specification by supplying a table. The fields
8657 -- size and data are mandatory whereas yslice_prob is optional.
8658 -- See 'Schematic specifier' for details.
8660 replacements = {["oldname"] = "convert_to", ...},
8662 flags = "place_center_x, place_center_y, place_center_z",
8663 -- Flags for schematic decorations. See 'Schematic attributes'.
8666 -- Rotation can be "0", "90", "180", "270", or "random"
8669 -- If the flag 'place_center_y' is set this parameter is ignored.
8670 -- Y offset of the schematic base node layer relative to the 'place_on'
8672 -- Can be positive or negative. Default is 0.
8673 -- Effect is inverted for "all_ceilings" decorations.
8674 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
8675 -- to the 'place_on' node.
8678 Chat command definition
8679 -----------------------
8681 Used by `minetest.register_chatcommand`.
8684 params = "<name> <privilege>", -- Short parameter description
8686 description = "Remove privilege from player", -- Full description
8688 privs = {privs=true}, -- Require the "privs" privilege to run
8690 func = function(name, param),
8691 -- Called when command is run. Returns boolean success and text output.
8692 -- Special case: The help message is shown to the player if `func`
8693 -- returns false without a text output.
8696 Note that in params, use of symbols is as follows:
8698 * `<>` signifies a placeholder to be replaced when the command is used. For
8699 example, when a player name is needed: `<name>`
8700 * `[]` signifies param is optional and not required when the command is used.
8701 For example, if you require param1 but param2 is optional:
8702 `<param1> [<param2>]`
8703 * `|` signifies exclusive or. The command requires one param from the options
8704 provided. For example: `<param1> | <param2>`
8705 * `()` signifies grouping. For example, when param1 and param2 are both
8706 required, or only param3 is required: `(<param1> <param2>) | <param3>`
8708 Privilege definition
8709 --------------------
8711 Used by `minetest.register_privilege`.
8715 -- Privilege description
8717 give_to_singleplayer = true,
8718 -- Whether to grant the privilege to singleplayer.
8720 give_to_admin = true,
8721 -- Whether to grant the privilege to the server admin.
8722 -- Uses value of 'give_to_singleplayer' by default.
8724 on_grant = function(name, granter_name),
8725 -- Called when given to player 'name' by 'granter_name'.
8726 -- 'granter_name' will be nil if the priv was granted by a mod.
8728 on_revoke = function(name, revoker_name),
8729 -- Called when taken from player 'name' by 'revoker_name'.
8730 -- 'revoker_name' will be nil if the priv was revoked by a mod.
8732 -- Note that the above two callbacks will be called twice if a player is
8733 -- responsible, once with the player name, and then with a nil player
8735 -- Return true in the above callbacks to stop register_on_priv_grant or
8736 -- revoke being called.
8739 Detached inventory callbacks
8740 ----------------------------
8742 Used by `minetest.create_detached_inventory`.
8745 allow_move = function(inv, from_list, from_index, to_list, to_index, count, player),
8746 -- Called when a player wants to move items inside the inventory.
8747 -- Return value: number of items allowed to move.
8749 allow_put = function(inv, listname, index, stack, player),
8750 -- Called when a player wants to put something into the inventory.
8751 -- Return value: number of items allowed to put.
8752 -- Return value -1: Allow and don't modify item count in inventory.
8754 allow_take = function(inv, listname, index, stack, player),
8755 -- Called when a player wants to take something out of the inventory.
8756 -- Return value: number of items allowed to take.
8757 -- Return value -1: Allow and don't modify item count in inventory.
8759 on_move = function(inv, from_list, from_index, to_list, to_index, count, player),
8760 on_put = function(inv, listname, index, stack, player),
8761 on_take = function(inv, listname, index, stack, player),
8762 -- Called after the actual action has happened, according to what was
8772 Used by `Player:hud_add`. Returned by `Player:hud_get`.
8775 hud_elem_type = "image", -- See HUD element types
8776 -- Type of element, can be "image", "text", "statbar", "inventory",
8777 -- "compass" or "minimap"
8779 position = {x=0.5, y=0.5},
8780 -- Left corner position of element
8784 scale = {x = 2, y = 2},
8793 -- Selected item in inventory. 0 for no item selected.
8796 -- Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
8798 alignment = {x=0, y=0},
8800 offset = {x=0, y=0},
8802 size = { x=100, y=100 },
8803 -- Size of element in pixels
8806 -- Z index : lower z-index HUDs are displayed behind higher z-index HUDs
8809 -- For "text" elements sets font style: bitfield with 1 = bold, 2 = italic, 4 = monospace
8815 Used by `minetest.add_particle`.
8818 pos = {x=0, y=0, z=0},
8819 velocity = {x=0, y=0, z=0},
8820 acceleration = {x=0, y=0, z=0},
8821 -- Spawn particle at pos with velocity and acceleration
8824 -- Disappears after expirationtime seconds
8827 -- Scales the visual size of the particle texture.
8828 -- If `node` is set, size can be set to 0 to spawn a randomly-sized
8829 -- particle (just like actual node dig particles).
8831 collisiondetection = false,
8832 -- If true collides with `walkable` nodes and, depending on the
8833 -- `object_collision` field, objects too.
8835 collision_removal = false,
8836 -- If true particle is removed when it collides.
8837 -- Requires collisiondetection = true to have any effect.
8839 object_collision = false,
8840 -- If true particle collides with objects that are defined as
8841 -- `physical = true,` and `collide_with_objects = true,`.
8842 -- Requires collisiondetection = true to have any effect.
8845 -- If true faces player using y axis only
8847 texture = "image.png",
8848 -- The texture of the particle
8850 playername = "singleplayer",
8851 -- Optional, if specified spawns particle only on the player's client
8853 animation = {Tile Animation definition},
8854 -- Optional, specifies how to animate the particle texture
8857 -- Optional, specify particle self-luminescence in darkness.
8860 node = {name = "ignore", param2 = 0},
8861 -- Optional, if specified the particle will have the same appearance as
8862 -- node dig particles for the given node.
8863 -- `texture` and `animation` will be ignored if this is set.
8866 -- Optional, only valid in combination with `node`
8867 -- If set to a valid number 1-6, specifies the tile from which the
8868 -- particle texture is picked.
8869 -- Otherwise, the default behavior is used. (currently: any random tile)
8873 `ParticleSpawner` definition
8874 ----------------------------
8876 Used by `minetest.add_particlespawner`.
8880 -- Number of particles spawned over the time period `time`.
8883 -- Lifespan of spawner in seconds.
8884 -- If time is 0 spawner has infinite lifespan and spawns the `amount` on
8885 -- a per-second basis.
8887 minpos = {x=0, y=0, z=0},
8888 maxpos = {x=0, y=0, z=0},
8889 minvel = {x=0, y=0, z=0},
8890 maxvel = {x=0, y=0, z=0},
8891 minacc = {x=0, y=0, z=0},
8892 maxacc = {x=0, y=0, z=0},
8897 -- The particles' properties are random values between the min and max
8899 -- applies to: pos, velocity, acceleration, expirationtime, size
8900 -- If `node` is set, min and maxsize can be set to 0 to spawn
8901 -- randomly-sized particles (just like actual node dig particles).
8903 collisiondetection = false,
8904 -- If true collide with `walkable` nodes and, depending on the
8905 -- `object_collision` field, objects too.
8907 collision_removal = false,
8908 -- If true particles are removed when they collide.
8909 -- Requires collisiondetection = true to have any effect.
8911 object_collision = false,
8912 -- If true particles collide with objects that are defined as
8913 -- `physical = true,` and `collide_with_objects = true,`.
8914 -- Requires collisiondetection = true to have any effect.
8916 attached = ObjectRef,
8917 -- If defined, particle positions, velocities and accelerations are
8918 -- relative to this object's position and yaw
8921 -- If true face player using y axis only
8923 texture = "image.png",
8924 -- The texture of the particle
8926 playername = "singleplayer",
8927 -- Optional, if specified spawns particles only on the player's client
8929 animation = {Tile Animation definition},
8930 -- Optional, specifies how to animate the particles' texture
8933 -- Optional, specify particle self-luminescence in darkness.
8936 node = {name = "ignore", param2 = 0},
8937 -- Optional, if specified the particles will have the same appearance as
8938 -- node dig particles for the given node.
8939 -- `texture` and `animation` will be ignored if this is set.
8942 -- Optional, only valid in combination with `node`
8943 -- If set to a valid number 1-6, specifies the tile from which the
8944 -- particle texture is picked.
8945 -- Otherwise, the default behavior is used. (currently: any random tile)
8948 `HTTPRequest` definition
8949 ------------------------
8951 Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
8954 url = "http://example.org",
8957 -- Timeout for request to be completed in seconds. Default depends on engine settings.
8959 method = "GET", "POST", "PUT" or "DELETE"
8960 -- The http method to use. Defaults to "GET".
8962 data = "Raw request data string" OR {field1 = "data1", field2 = "data2"},
8963 -- Data for the POST, PUT or DELETE request.
8964 -- Accepts both a string and a table. If a table is specified, encodes
8965 -- table as x-www-form-urlencoded key-value pairs.
8967 user_agent = "ExampleUserAgent",
8968 -- Optional, if specified replaces the default minetest user agent with
8971 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
8972 -- Optional, if specified adds additional headers to the HTTP request.
8973 -- You must make sure that the header strings follow HTTP specification
8977 -- Optional, if true performs a multipart HTTP request.
8978 -- Default is false.
8979 -- Post only, data must be array
8981 post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
8982 -- Deprecated, use `data` instead. Forces `method = "POST"`.
8985 `HTTPRequestResult` definition
8986 ------------------------------
8988 Passed to `HTTPApiTable.fetch` callback. Returned by
8989 `HTTPApiTable.fetch_async_get`.
8993 -- If true, the request has finished (either succeeded, failed or timed
8997 -- If true, the request was successful
9000 -- If true, the request timed out
9008 Authentication handler definition
9009 ---------------------------------
9011 Used by `minetest.register_authentication_handler`.
9014 get_auth = function(name),
9015 -- Get authentication data for existing player `name` (`nil` if player
9017 -- Returns following structure:
9018 -- `{password=<string>, privileges=<table>, last_login=<number or nil>}`
9020 create_auth = function(name, password),
9021 -- Create new auth data for player `name`.
9022 -- Note that `password` is not plain-text but an arbitrary
9023 -- representation decided by the engine.
9025 delete_auth = function(name),
9026 -- Delete auth data of player `name`.
9027 -- Returns boolean indicating success (false if player is nonexistent).
9029 set_password = function(name, password),
9030 -- Set password of player `name` to `password`.
9031 -- Auth data should be created if not present.
9033 set_privileges = function(name, privileges),
9034 -- Set privileges of player `name`.
9035 -- `privileges` is in table form, auth data should be created if not
9038 reload = function(),
9039 -- Reload authentication data from the storage location.
9040 -- Returns boolean indicating success.
9042 record_login = function(name),
9043 -- Called when player joins, used for keeping track of last_login
9045 iterate = function(),
9046 -- Returns an iterator (use with `for` loops) for all player names
9047 -- currently in the auth database
9053 Functions: bit.tobit, bit.tohex, bit.bnot, bit.band, bit.bor, bit.bxor, bit.lshift, bit.rshift, bit.arshift, bit.rol, bit.ror, bit.bswap
9055 See http://bitop.luajit.org/ for advanced information.