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 * `name`: Required, a human readable title to address the game, e.g. `name = Minetest`.
66 * `description`: Short description to be shown in the content tab
67 * `allowed_mapgens = <comma-separated mapgens>`
68 e.g. `allowed_mapgens = v5,v6,flat`
69 Mapgens not in this list are removed from the list of mapgens for the
71 If not specified, all mapgens are allowed.
72 * `disallowed_mapgens = <comma-separated mapgens>`
73 e.g. `disallowed_mapgens = v5,v6,flat`
74 These mapgens are removed from the list of mapgens for the game.
75 When both `allowed_mapgens` and `disallowed_mapgens` are
76 specified, `allowed_mapgens` is applied before
78 * `disallowed_mapgen_settings= <comma-separated mapgen settings>`
79 e.g. `disallowed_mapgen_settings = mgv5_spflags`
80 These settings are hidden for this game in the world creation
81 dialog and game start menu.
82 * `author`: The author of the game. It only appears when downloaded from
84 * `release`: Ignore this: Should only ever be set by ContentDB, as it is
85 an internal ID used to track versions.
87 Used to set default settings when running this game.
89 In the same format as the one in builtin.
90 This settingtypes.txt will be parsed by the menu and the settings will be
91 displayed in the "Games" category in the advanced settings tab.
92 * If the game contains a folder called `textures` the server will load it as a
93 texturepack, overriding mod textures.
94 Any server texturepack will override mod textures and the game texturepack.
99 Games can provide custom main menu images. They are put inside a `menu`
100 directory inside the game directory.
102 The images are named `$identifier.png`, where `$identifier` is one of
103 `overlay`, `background`, `footer`, `header`.
104 If you want to specify multiple images for one identifier, add additional
105 images named like `$identifier.$n.png`, with an ascending number $n starting
106 with 1, and a random image will be chosen from the provided ones.
117 Paths are relative to the directories listed in the [Paths] section above.
119 * `games/<gameid>/mods/`
121 * `worlds/<worldname>/worldmods/`
126 It is possible to include a game in a world; in this case, no mods or
127 games are loaded or checked from anywhere else.
129 This is useful for e.g. adventure worlds and happens if the `<worldname>/game/`
132 Mods should then be placed in `<worldname>/game/mods/`.
137 Mods can be put in a subdirectory, if the parent directory, which otherwise
138 should be a mod, contains a file named `modpack.conf`.
139 The file is a key-value store of modpack details.
141 * `name`: The modpack name. Allows Minetest to determine the modpack name even
142 if the folder is wrongly named.
143 * `description`: Description of mod to be shown in the Mods tab of the main
145 * `author`: The author of the modpack. It only appears when downloaded from
147 * `release`: Ignore this: Should only ever be set by ContentDB, as it is an
148 internal ID used to track versions.
149 * `title`: A human-readable title to address the modpack.
151 Note: to support 0.4.x, please also create an empty modpack.txt file.
153 Mod directory structure
154 -----------------------
160 │ ├── settingtypes.txt
164 │ │ ├── modname_stuff.png
165 │ │ ├── modname_stuff_normal.png
166 │ │ ├── modname_something_else.png
167 │ │ ├── subfolder_foo
168 │ │ │ ├── modname_more_stuff.png
169 │ │ │ └── another_subfolder
170 │ │ └── bar_subfolder
179 The location of this directory can be fetched by using
180 `minetest.get_modpath(modname)`.
184 A `Settings` file that provides meta information about the mod.
186 * `name`: The mod name. Allows Minetest to determine the mod name even if the
187 folder is wrongly named.
188 * `description`: Description of mod to be shown in the Mods tab of the main
190 * `depends`: A comma separated list of dependencies. These are mods that must be
191 loaded before this mod.
192 * `optional_depends`: A comma separated list of optional dependencies.
193 Like a dependency, but no error if the mod doesn't exist.
194 * `author`: The author of the mod. It only appears when downloaded from
196 * `release`: Ignore this: Should only ever be set by ContentDB, as it is an
197 internal ID used to track versions.
198 * `title`: A human-readable title to address the mod.
200 Note: to support 0.4.x, please also provide depends.txt.
204 A screenshot shown in the mod manager within the main menu. It should
205 have an aspect ratio of 3:2 and a minimum size of 300×200 pixels.
209 **Deprecated:** you should use mod.conf instead.
211 This file is used if there are no dependencies in mod.conf.
213 List of mods that have to be loaded before loading this mod.
215 A single line contains a single modname.
217 Optional dependencies can be defined by appending a question mark
218 to a single modname. This means that if the specified mod
219 is missing, it does not prevent this mod from being loaded.
221 ### `description.txt`
223 **Deprecated:** you should use mod.conf instead.
225 This file is used if there is no description in mod.conf.
227 A file containing a description to be shown in the Mods tab of the main menu.
229 ### `settingtypes.txt`
231 The format is documented in `builtin/settingtypes.txt`.
232 It is parsed by the main menu settings dialogue to list mod-specific
233 settings in the "Mods" category.
237 The main Lua script. Running this script should register everything it
238 wants to register. Subsequent execution depends on minetest calling the
239 registered callbacks.
241 `minetest.settings` can be used to read custom or existing settings at load
242 time, if necessary. (See [`Settings`])
244 ### `textures`, `sounds`, `media`, `models`, `locale`
246 Media files (textures, sounds, whatever) that will be transferred to the
247 client and will be available for use by the mod and translation files for
248 the clients (see [Translations]).
250 It is suggested to use the folders for the purpous they are thought for,
251 eg. put textures into `textures`, translation files into `locale`,
252 models for entities or meshnodes into `models` et cetera.
254 These folders and subfolders can contain subfolders.
255 Subfolders with names starting with `_` or `.` are ignored.
256 If a subfolder contains a media file with the same name as a media file
257 in one of its parents, the parent's file is used.
262 Registered names should generally be in this format:
266 `<whatever>` can have these characters:
270 This is to prevent conflicting names from corrupting maps and is
271 enforced by the mod loader.
273 Registered names can be overridden by prefixing the name with `:`. This can
274 be used for overriding the registrations of some other mod.
276 The `:` prefix can also be used for maintaining backwards compatibility.
280 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
281 So the name should be `experimental:tnt`.
283 Any mod can redefine `experimental:tnt` by using the name
287 when registering it. That mod is required to have `experimental` as a
296 Aliases of itemnames can be added by using
297 `minetest.register_alias(alias, original_name)` or
298 `minetest.register_alias_force(alias, original_name)`.
300 This adds an alias `alias` for the item called `original_name`.
301 From now on, you can use `alias` to refer to the item `original_name`.
303 The only difference between `minetest.register_alias` and
304 `minetest.register_alias_force` is that if an item named `alias` already exists,
305 `minetest.register_alias` will do nothing while
306 `minetest.register_alias_force` will unregister it.
308 This can be used for maintaining backwards compatibility.
310 This can also set quick access names for things, e.g. if
311 you have an item called `epiclylongmodname:stuff`, you could do
313 minetest.register_alias("stuff", "epiclylongmodname:stuff")
315 and be able to use `/giveme stuff`.
320 In a game, a certain number of these must be set to tell core mapgens which
321 of the game's nodes are to be used for core mapgen generation. For example:
323 minetest.register_alias("mapgen_stone", "default:stone")
325 ### Aliases for non-V6 mapgens
327 #### Essential aliases
330 * mapgen_water_source
331 * mapgen_river_water_source
333 `mapgen_river_water_source` is required for mapgens with sloping rivers where
334 it is necessary to have a river liquid node with a short `liquid_range` and
335 `liquid_renewable = false` to avoid flooding.
337 #### Optional aliases
341 Fallback lava node used if cave liquids are not defined in biome definitions.
342 Deprecated for non-V6 mapgens, define cave liquids in biome definitions instead.
346 Fallback node used if dungeon nodes are not defined in biome definitions.
347 Deprecated for non-V6 mapgens, define dungeon nodes in biome definitions instead.
349 ### Aliases needed for Mapgen V6
352 * mapgen_water_source
355 * mapgen_dirt_with_grass
358 * mapgen_desert_stone
360 * mapgen_dirt_with_snow
369 * mapgen_jungleleaves
372 * mapgen_pine_needles
375 * mapgen_stair_cobble
377 * mapgen_stair_desert_stone
379 ### Setting the node used in Mapgen Singlenode
381 By default the world is filled with air nodes. To set a different node use, for
384 minetest.register_alias("mapgen_singlenode", "default:stone")
392 Mods should generally prefix their textures with `modname_`, e.g. given
393 the mod name `foomod`, a texture could be called:
397 Textures are referred to by their complete name, or alternatively by
398 stripping out the file extension:
400 * e.g. `foomod_foothing.png`
401 * e.g. `foomod_foothing`
407 There are various texture modifiers that can be used
408 to let the client generate textures on-the-fly.
409 The modifiers are applied directly in sRGB colorspace,
410 i.e. without gamma-correction.
412 ### Texture overlaying
414 Textures can be overlaid by putting a `^` between them.
418 default_dirt.png^default_grass_side.png
420 `default_grass_side.png` is overlaid over `default_dirt.png`.
421 The texture with the lower resolution will be automatically upscaled to
422 the higher resolution texture.
426 Textures can be grouped together by enclosing them in `(` and `)`.
428 Example: `cobble.png^(thing1.png^thing2.png)`
430 A texture for `thing1.png^thing2.png` is created and the resulting
431 texture is overlaid on top of `cobble.png`.
435 Modifiers that accept texture names (e.g. `[combine`) accept escaping to allow
436 passing complex texture names as arguments. Escaping is done with backslash and
437 is required for `^` and `:`.
439 Example: `cobble.png^[lowpart:50:color.png\^[mask\:trans.png`
441 The lower 50 percent of `color.png^[mask:trans.png` are overlaid
442 on top of `cobble.png`.
444 ### Advanced texture modifiers
450 * `[crack:<t>:<n>:<p>`
451 * `[cracko:<t>:<n>:<p>`
455 * `<t>`: tile count (in each direction)
456 * `<n>`: animation frame count
457 * `<p>`: current animation frame
459 Draw a step of the crack animation on the texture.
460 `crack` draws it normally, while `cracko` lays it over, keeping transparent
465 default_cobble.png^[crack:10:1
467 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
473 * `<file>`: texture to combine
475 Creates a texture of size `<w>` times `<h>` and blits the listed files to their
476 specified coordinates.
480 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
482 #### `[resize:<w>x<h>`
484 Resizes the texture to the given dimensions.
488 default_sandstone.png^[resize:16x16
492 Makes the base image transparent according to the given ratio.
494 `r` must be between 0 (transparent) and 255 (opaque).
498 default_sandstone.png^[opacity:127
500 #### `[invert:<mode>`
502 Inverts the given channels of the base image.
503 Mode may contain the characters "r", "g", "b", "a".
504 Only the channels that are mentioned in the mode string will be inverted.
508 default_apple.png^[invert:rgb
512 Brightens the texture.
516 tnt_tnt_side.png^[brighten
520 Makes the texture completely opaque.
524 default_leaves.png^[noalpha
526 #### `[makealpha:<r>,<g>,<b>`
528 Convert one color to transparency.
532 default_cobble.png^[makealpha:128,128,128
536 * `<t>`: transformation(s) to apply
538 Rotates and/or flips the image.
540 `<t>` can be a number (between 0 and 7) or a transform name.
541 Rotations are counter-clockwise.
544 1 R90 rotate by 90 degrees
545 2 R180 rotate by 180 degrees
546 3 R270 rotate by 270 degrees
548 5 FXR90 flip X then rotate by 90 degrees
550 7 FYR90 flip Y then rotate by 90 degrees
554 default_stone.png^[transformFXR90
556 #### `[inventorycube{<top>{<left>{<right>`
558 Escaping does not apply here and `^` is replaced by `&` in texture names
561 Create an inventory cube texture using the side textures.
565 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
567 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
568 `dirt.png^grass_side.png` textures
570 #### `[lowpart:<percent>:<file>`
572 Blit the lower `<percent>`% part of `<file>` on the texture.
576 base.png^[lowpart:25:overlay.png
578 #### `[verticalframe:<t>:<n>`
580 * `<t>`: animation frame count
581 * `<n>`: current animation frame
583 Crops the texture to a frame of a vertical animation.
587 default_torch_animated.png^[verticalframe:16:8
591 Apply a mask to the base image.
593 The mask is applied using binary AND.
595 #### `[sheet:<w>x<h>:<x>,<y>`
597 Retrieves a tile at position x,y from the base image
598 which it assumes to be a tilesheet with dimensions w,h.
600 #### `[colorize:<color>:<ratio>`
602 Colorize the textures with the given color.
603 `<color>` is specified as a `ColorString`.
604 `<ratio>` is an int ranging from 0 to 255 or the word "`alpha`". If
605 it is an int, then it specifies how far to interpolate between the
606 colors where 0 is only the texture color and 255 is only `<color>`. If
607 omitted, the alpha of `<color>` will be used as the ratio. If it is
608 the word "`alpha`", then each texture pixel will contain the RGB of
609 `<color>` and the alpha of `<color>` multiplied by the alpha of the
612 #### `[multiply:<color>`
614 Multiplies texture colors with the given color.
615 `<color>` is specified as a `ColorString`.
616 Result is more like what you'd expect if you put a color on top of another
617 color, meaning white surfaces get a lot of your new color while black parts
618 don't change very much.
623 The goal of hardware coloring is to simplify the creation of
624 colorful nodes. If your textures use the same pattern, and they only
625 differ in their color (like colored wool blocks), you can use hardware
626 coloring instead of creating and managing many texture files.
627 All of these methods use color multiplication (so a white-black texture
628 with red coloring will result in red-black color).
632 This method is useful if you wish to create nodes/items with
633 the same texture, in different colors, each in a new node/item definition.
637 When you register an item or node, set its `color` field (which accepts a
638 `ColorSpec`) to the desired color.
640 An `ItemStack`'s static color can be overwritten by the `color` metadata
641 field. If you set that field to a `ColorString`, that color will be used.
645 Each tile may have an individual static color, which overwrites every
646 other coloring method. To disable the coloring of a face,
647 set its color to white (because multiplying with white does nothing).
648 You can set the `color` property of the tiles in the node's definition
649 if the tile is in table format.
653 For nodes and items which can have many colors, a palette is more
654 suitable. A palette is a texture, which can contain up to 256 pixels.
655 Each pixel is one possible color for the node/item.
656 You can register one node/item, which can have up to 256 colors.
658 #### Palette indexing
660 When using palettes, you always provide a pixel index for the given
661 node or `ItemStack`. The palette is read from left to right and from
662 top to bottom. If the palette has less than 256 pixels, then it is
663 stretched to contain exactly 256 pixels (after arranging the pixels
664 to one line). The indexing starts from 0.
668 * 16x16 palette, index = 0: the top left corner
669 * 16x16 palette, index = 4: the fifth pixel in the first row
670 * 16x16 palette, index = 16: the pixel below the top left corner
671 * 16x16 palette, index = 255: the bottom right corner
672 * 2 (width) x 4 (height) palette, index = 31: the top left corner.
673 The palette has 8 pixels, so each pixel is stretched to 32 pixels,
674 to ensure the total 256 pixels.
675 * 2x4 palette, index = 32: the top right corner
676 * 2x4 palette, index = 63: the top right corner
677 * 2x4 palette, index = 64: the pixel below the top left corner
679 #### Using palettes with items
681 When registering an item, set the item definition's `palette` field to
682 a texture. You can also use texture modifiers.
684 The `ItemStack`'s color depends on the `palette_index` field of the
685 stack's metadata. `palette_index` is an integer, which specifies the
686 index of the pixel to use.
688 #### Linking palettes with nodes
690 When registering a node, set the item definition's `palette` field to
691 a texture. You can also use texture modifiers.
692 The node's color depends on its `param2`, so you also must set an
693 appropriate `paramtype2`:
695 * `paramtype2 = "color"` for nodes which use their full `param2` for
696 palette indexing. These nodes can have 256 different colors.
697 The palette should contain 256 pixels.
698 * `paramtype2 = "colorwallmounted"` for nodes which use the first
699 five bits (most significant) of `param2` for palette indexing.
700 The remaining three bits are describing rotation, as in `wallmounted`
701 paramtype2. Division by 8 yields the palette index (without stretching the
702 palette). These nodes can have 32 different colors, and the palette
703 should contain 32 pixels.
705 * `param2 = 17` is 2 * 8 + 1, so the rotation is 1 and the third (= 2 + 1)
706 pixel will be picked from the palette.
707 * `param2 = 35` is 4 * 8 + 3, so the rotation is 3 and the fifth (= 4 + 1)
708 pixel will be picked from the palette.
709 * `paramtype2 = "colorfacedir"` for nodes which use the first
710 three bits of `param2` for palette indexing. The remaining
711 five bits are describing rotation, as in `facedir` paramtype2.
712 Division by 32 yields the palette index (without stretching the
713 palette). These nodes can have 8 different colors, and the
714 palette should contain 8 pixels.
716 * `param2 = 17` is 0 * 32 + 17, so the rotation is 17 and the
717 first (= 0 + 1) pixel will be picked from the palette.
718 * `param2 = 35` is 1 * 32 + 3, so the rotation is 3 and the
719 second (= 1 + 1) pixel will be picked from the palette.
721 To colorize a node on the map, set its `param2` value (according
722 to the node's paramtype2).
724 ### Conversion between nodes in the inventory and on the map
726 Static coloring is the same for both cases, there is no need
729 If the `ItemStack`'s metadata contains the `color` field, it will be
730 lost on placement, because nodes on the map can only use palettes.
732 If the `ItemStack`'s metadata contains the `palette_index` field, it is
733 automatically transferred between node and item forms by the engine,
734 when a player digs or places a colored node.
735 You can disable this feature by setting the `drop` field of the node
736 to itself (without metadata).
737 To transfer the color to a special drop, you need a drop table.
741 minetest.register_node("mod:stone", {
742 description = "Stone",
743 tiles = {"default_stone.png"},
744 paramtype2 = "color",
745 palette = "palette.png",
748 -- assume that mod:cobblestone also has the same palette
749 {items = {"mod:cobblestone"}, inherit_color = true },
754 ### Colored items in craft recipes
756 Craft recipes only support item strings, but fortunately item strings
757 can also contain metadata. Example craft recipe registration:
759 minetest.register_craft({
760 output = minetest.itemstring_with_palette("wool:block", 3),
768 To set the `color` field, you can use `minetest.itemstring_with_color`.
770 Metadata field filtering in the `recipe` field are not supported yet,
771 so the craft output is independent of the color of the ingredients.
776 Sometimes hardware coloring is not enough, because it affects the
777 whole tile. Soft texture overlays were added to Minetest to allow
778 the dynamic coloring of only specific parts of the node's texture.
779 For example a grass block may have colored grass, while keeping the
782 These overlays are 'soft', because unlike texture modifiers, the layers
783 are not merged in the memory, but they are simply drawn on top of each
784 other. This allows different hardware coloring, but also means that
785 tiles with overlays are drawn slower. Using too much overlays might
788 For inventory and wield images you can specify overlays which
789 hardware coloring does not modify. You have to set `inventory_overlay`
790 and `wield_overlay` fields to an image name.
792 To define a node overlay, simply set the `overlay_tiles` field of the node
793 definition. These tiles are defined in the same way as plain tiles:
794 they can have a texture name, color etc.
795 To skip one face, set that overlay tile to an empty string.
797 Example (colored grass block):
799 minetest.register_node("default:dirt_with_grass", {
800 description = "Dirt with Grass",
801 -- Regular tiles, as usual
802 -- The dirt tile disables palette coloring
803 tiles = {{name = "default_grass.png"},
804 {name = "default_dirt.png", color = "white"}},
805 -- Overlay tiles: define them in the same style
806 -- The top and bottom tile does not have overlay
807 overlay_tiles = {"", "",
808 {name = "default_grass_side.png"}},
809 -- Global color, used in inventory
811 -- Palette in the world
812 paramtype2 = "color",
813 palette = "default_foilage.png",
822 Only Ogg Vorbis files are supported.
824 For positional playing of sounds, only single-channel (mono) files are
825 supported. Otherwise OpenAL will play them non-positionally.
827 Mods should generally prefix their sounds with `modname_`, e.g. given
828 the mod name "`foomod`", a sound could be called:
832 Sounds are referred to by their name with a dot, a single digit and the
833 file extension stripped out. When a sound is played, the actual sound file
834 is chosen randomly from the matching sounds.
836 When playing the sound `foomod_foosound`, the sound is chosen randomly
837 from the available ones of the following files:
839 * `foomod_foosound.ogg`
840 * `foomod_foosound.0.ogg`
841 * `foomod_foosound.1.ogg`
843 * `foomod_foosound.9.ogg`
845 Examples of sound parameter tables:
847 -- Play locationless on all clients
849 gain = 1.0, -- default
850 fade = 0.0, -- default, change to a value > 0 to fade the sound in
851 pitch = 1.0, -- default
853 -- Play locationless to one player
856 gain = 1.0, -- default
857 fade = 0.0, -- default, change to a value > 0 to fade the sound in
858 pitch = 1.0, -- default
860 -- Play locationless to one player, looped
863 gain = 1.0, -- default
866 -- Play at a location
868 pos = {x = 1, y = 2, z = 3},
869 gain = 1.0, -- default
870 max_hear_distance = 32, -- default, uses an euclidean metric
872 -- Play connected to an object, looped
874 object = <an ObjectRef>,
875 gain = 1.0, -- default
876 max_hear_distance = 32, -- default, uses an euclidean metric
879 -- Play at a location, heard by anyone *but* the given player
881 pos = {x = 32, y = 0, z = 100},
882 max_hear_distance = 40,
883 exclude_player = name,
886 Looped sounds must either be connected to an object or played locationless to
887 one player using `to_player = name`.
889 A positional sound will only be heard by players that are within
890 `max_hear_distance` of the sound position, at the start of the sound.
892 `exclude_player = name` can be applied to locationless, positional and object-
893 bound sounds to exclude a single player from hearing them.
898 Specifies a sound name, gain (=volume) and pitch.
899 This is either a string or a table.
901 In string form, you just specify the sound name or
902 the empty string for no sound.
904 Table form has the following fields:
907 * `gain`: Volume (`1.0` = 100%)
908 * `pitch`: Pitch (`1.0` = 100%)
910 `gain` and `pitch` are optional and default to `1.0`.
916 * `"default_place_node"`: Play e.g. `default_place_node.ogg`
917 * `{name = "default_place_node"}`: Same as above
918 * `{name = "default_place_node", gain = 0.5}`: 50% volume
919 * `{name = "default_place_node", gain = 0.9, pitch = 1.1}`: 90% volume, 110% pitch
924 These sound files are played back by the engine if provided.
926 * `player_damage`: Played when the local player takes damage (gain = 0.5)
927 * `player_falling_damage`: Played when the local player takes
928 damage by falling (gain = 0.5)
929 * `player_jump`: Played when the local player jumps
930 * `default_dig_<groupname>`: Default node digging sound
931 (see node sound definition for details)
933 Registered definitions
934 ======================
936 Anything added using certain [Registration functions] gets added to one or more
937 of the global [Registered definition tables].
939 Note that in some cases you will stumble upon things that are not contained
940 in these tables (e.g. when a mod has been removed). Always check for
941 existence before trying to access the fields.
945 All nodes register with `minetest.register_node` get added to the table
946 `minetest.registered_nodes`.
948 If you want to check the drawtype of a node, you could do:
950 local function get_nodedef_field(nodename, fieldname)
951 if not minetest.registered_nodes[nodename] then
954 return minetest.registered_nodes[nodename][fieldname]
956 local drawtype = get_nodedef_field(nodename, "drawtype")
964 Nodes are the bulk data of the world: cubes and other things that take the
965 space of a cube. Huge amounts of them are handled efficiently, but they
968 The definition of a node is stored and can be accessed by using
970 minetest.registered_nodes[node.name]
972 See [Registered definitions].
974 Nodes are passed by value between Lua and the engine.
975 They are represented by a table:
977 {name="name", param1=num, param2=num}
979 `param1` and `param2` are 8-bit integers ranging from 0 to 255. The engine uses
980 them for certain automated functions. If you don't use these functions, you can
981 use them to store arbitrary values.
986 The functions of `param1` and `param2` are determined by certain fields in the
989 The function of `param1` is determined by `paramtype` in node definition.
990 `param1` is reserved for the engine when `paramtype != "none"`.
992 * `paramtype = "light"`
993 * The value stores light with and without sun in its upper and lower 4 bits
995 * Required by a light source node to enable spreading its light.
996 * Required by the following drawtypes as they determine their visual
997 brightness from their internal light value:
1007 * `paramtype = "none"`
1008 * `param1` will not be used by the engine and can be used to store
1011 The function of `param2` is determined by `paramtype2` in node definition.
1012 `param2` is reserved for the engine when `paramtype2 != "none"`.
1014 * `paramtype2 = "flowingliquid"`
1015 * Used by `drawtype = "flowingliquid"` and `liquidtype = "flowing"`
1016 * The liquid level and a flag of the liquid are stored in `param2`
1017 * Bits 0-2: Liquid level (0-7). The higher, the more liquid is in this node;
1018 see `minetest.get_node_level`, `minetest.set_node_level` and `minetest.add_node_level`
1019 to access/manipulate the content of this field
1020 * Bit 3: If set, liquid is flowing downwards (no graphical effect)
1021 * `paramtype2 = "wallmounted"`
1022 * Supported drawtypes: "torchlike", "signlike", "normal", "nodebox", "mesh"
1023 * The rotation of the node is stored in `param2`
1024 * You can make this value by using `minetest.dir_to_wallmounted()`
1025 * Values range 0 - 5
1026 * The value denotes at which direction the node is "mounted":
1027 0 = y+, 1 = y-, 2 = x+, 3 = x-, 4 = z+, 5 = z-
1028 * `paramtype2 = "facedir"`
1029 * Supported drawtypes: "normal", "nodebox", "mesh"
1030 * The rotation of the node is stored in `param2`. Furnaces and chests are
1031 rotated this way. Can be made by using `minetest.dir_to_facedir()`.
1032 * Values range 0 - 23
1033 * facedir / 4 = axis direction:
1034 0 = y+, 1 = z+, 2 = z-, 3 = x+, 4 = x-, 5 = y-
1035 * facedir modulo 4 = rotation around that axis
1036 * `paramtype2 = "leveled"`
1037 * Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
1039 * The level of the top face of the nodebox is stored in `param2`.
1040 * The other faces are defined by 'fixed = {}' like 'type = "fixed"'
1042 * The nodebox height is (`param2` / 64) nodes.
1043 * The maximum accepted value of `param2` is 127.
1045 * The height of the 'plantlike' section is stored in `param2`.
1046 * The height is (`param2` / 16) nodes.
1047 * `paramtype2 = "degrotate"`
1048 * Only valid for "plantlike" drawtype. The rotation of the node is stored in
1050 * Values range 0 - 179. The value stored in `param2` is multiplied by two to
1051 get the actual rotation in degrees of the node.
1052 * `paramtype2 = "meshoptions"`
1053 * Only valid for "plantlike" drawtype. `param2` encodes the shape and
1054 optional modifiers of the "plant". `param2` is a bitfield.
1055 * Bits 0 to 2 select the shape.
1056 Use only one of the values below:
1057 * 0 = a "x" shaped plant (ordinary plant)
1058 * 1 = a "+" shaped plant (just rotated 45 degrees)
1059 * 2 = a "*" shaped plant with 3 faces instead of 2
1060 * 3 = a "#" shaped plant with 4 faces instead of 2
1061 * 4 = a "#" shaped plant with 4 faces that lean outwards
1062 * 5-7 are unused and reserved for future meshes.
1063 * Bits 3 to 7 are used to enable any number of optional modifiers.
1064 Just add the corresponding value(s) below to `param2`:
1065 * 8 - Makes the plant slightly vary placement horizontally
1066 * 16 - Makes the plant mesh 1.4x larger
1067 * 32 - Moves each face randomly a small bit down (1/8 max)
1068 * values 64 and 128 (bits 6-7) are reserved for future use.
1069 * Example: `param2 = 0` selects a normal "x" shaped plant
1070 * Example: `param2 = 17` selects a "+" shaped plant, 1.4x larger (1+16)
1071 * `paramtype2 = "color"`
1072 * `param2` tells which color is picked from the palette.
1073 The palette should have 256 pixels.
1074 * `paramtype2 = "colorfacedir"`
1075 * Same as `facedir`, but with colors.
1076 * The first three bits of `param2` tells which color is picked from the
1077 palette. The palette should have 8 pixels.
1078 * `paramtype2 = "colorwallmounted"`
1079 * Same as `wallmounted`, but with colors.
1080 * The first five bits of `param2` tells which color is picked from the
1081 palette. The palette should have 32 pixels.
1082 * `paramtype2 = "glasslikeliquidlevel"`
1083 * Only valid for "glasslike_framed" or "glasslike_framed_optional"
1085 * `param2` values 0-63 define 64 levels of internal liquid, 0 being empty
1087 * Liquid texture is defined using `special_tiles = {"modname_tilename.png"}`
1088 * `paramtype2 = "none"`
1089 * `param2` will not be used by the engine and can be used to store
1092 Nodes can also contain extra data. See [Node Metadata].
1097 There are a bunch of different looking node types.
1099 Look for examples in `games/devtest` or `games/minetest_game`.
1102 * A node-sized cube.
1104 * Invisible, uses no texture.
1106 * The cubic source node for a liquid.
1108 * The flowing version of a liquid, appears with various heights and slopes.
1110 * Often used for partially-transparent nodes.
1111 * Only external sides of textures are visible.
1112 * `glasslike_framed`
1113 * All face-connected nodes are drawn as one volume within a surrounding
1115 * The frame appearance is generated from the edges of the first texture
1116 specified in `tiles`. The width of the edges used are 1/16th of texture
1117 size: 1 pixel for 16x16, 2 pixels for 32x32 etc.
1118 * The glass 'shine' (or other desired detail) on each node face is supplied
1119 by the second texture specified in `tiles`.
1120 * `glasslike_framed_optional`
1121 * This switches between the above 2 drawtypes according to the menu setting
1124 * Often used for partially-transparent nodes.
1125 * External and internal sides of textures are visible.
1126 * `allfaces_optional`
1127 * Often used for leaves nodes.
1128 * This switches between `normal`, `glasslike` and `allfaces` according to
1129 the menu setting: Opaque Leaves / Simple Leaves / Fancy Leaves.
1130 * With 'Simple Leaves' selected, the texture specified in `special_tiles`
1131 is used instead, if present. This allows a visually thicker texture to be
1132 used to compensate for how `glasslike` reduces visual thickness.
1134 * A single vertical texture.
1135 * If placed on top of a node, uses the first texture specified in `tiles`.
1136 * If placed against the underside of a node, uses the second texture
1137 specified in `tiles`.
1138 * If placed on the side of a node, uses the third texture specified in
1139 `tiles` and is perpendicular to that node.
1141 * A single texture parallel to, and mounted against, the top, underside or
1144 * Two vertical and diagonal textures at right-angles to each other.
1145 * See `paramtype2 = "meshoptions"` above for other options.
1147 * When above a flat surface, appears as 6 textures, the central 2 as
1148 `plantlike` plus 4 more surrounding those.
1149 * If not above a surface the central 2 do not appear, but the texture
1150 appears against the faces of surrounding nodes if they are present.
1152 * A 3D model suitable for a wooden fence.
1153 * One placed node appears as a single vertical post.
1154 * Adjacently-placed nodes cause horizontal bars to appear between them.
1156 * Often used for tracks for mining carts.
1157 * Requires 4 textures to be specified in `tiles`, in order: Straight,
1158 curved, t-junction, crossing.
1159 * Each placed node automatically switches to a suitable rotated texture
1160 determined by the adjacent `raillike` nodes, in order to create a
1161 continuous track network.
1162 * Becomes a sloping node if placed against stepped nodes.
1164 * Often used for stairs and slabs.
1165 * Allows defining nodes consisting of an arbitrary number of boxes.
1166 * See [Node boxes] below for more information.
1168 * Uses models for nodes.
1169 * Tiles should hold model materials textures.
1170 * Only static meshes are implemented.
1171 * For supported model formats see Irrlicht engine documentation.
1172 * `plantlike_rooted`
1173 * Enables underwater `plantlike` without air bubbles around the nodes.
1174 * Consists of a base cube at the co-ordinates of the node plus a
1175 `plantlike` extension above with a height of `param2 / 16` nodes.
1176 * The `plantlike` extension visually passes through any nodes above the
1177 base cube without affecting them.
1178 * The base cube texture tiles are defined as normal, the `plantlike`
1179 extension uses the defined special tile, for example:
1180 `special_tiles = {{name = "default_papyrus.png"}},`
1182 `*_optional` drawtypes need less rendering time if deactivated
1183 (always client-side).
1188 Node selection boxes are defined using "node boxes".
1190 A nodebox is defined as any of:
1193 -- A normal cube; the default in most things
1197 -- A fixed box (or boxes) (facedir param2 is used, if applicable)
1199 fixed = box OR {box1, box2, ...}
1202 -- A variable height box (or boxes) with the top face position defined
1203 -- by the node parameter 'leveled = ', or if 'paramtype2 == "leveled"'
1205 -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
1207 fixed = box OR {box1, box2, ...}
1210 -- A box like the selection box for torches
1211 -- (wallmounted param2 is used, if applicable)
1212 type = "wallmounted",
1218 -- A node that has optional boxes depending on neighbouring nodes'
1219 -- presence and type. See also `connects_to`.
1221 fixed = box OR {box1, box2, ...}
1222 connect_top = box OR {box1, box2, ...}
1223 connect_bottom = box OR {box1, box2, ...}
1224 connect_front = box OR {box1, box2, ...}
1225 connect_left = box OR {box1, box2, ...}
1226 connect_back = box OR {box1, box2, ...}
1227 connect_right = box OR {box1, box2, ...}
1228 -- The following `disconnected_*` boxes are the opposites of the
1229 -- `connect_*` ones above, i.e. when a node has no suitable neighbour
1230 -- on the respective side, the corresponding disconnected box is drawn.
1231 disconnected_top = box OR {box1, box2, ...}
1232 disconnected_bottom = box OR {box1, box2, ...}
1233 disconnected_front = box OR {box1, box2, ...}
1234 disconnected_left = box OR {box1, box2, ...}
1235 disconnected_back = box OR {box1, box2, ...}
1236 disconnected_right = box OR {box1, box2, ...}
1237 disconnected = box OR {box1, box2, ...} -- when there is *no* neighbour
1238 disconnected_sides = box OR {box1, box2, ...} -- when there are *no*
1239 -- neighbours to the sides
1242 A `box` is defined as:
1244 {x1, y1, z1, x2, y2, z2}
1246 A box of a regular node would look like:
1248 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
1250 To avoid collision issues, keep each value within the range of +/- 1.45.
1251 This also applies to leveled nodeboxes, where the final height shall not
1252 exceed this soft limit.
1256 Map terminology and coordinates
1257 ===============================
1259 Nodes, mapblocks, mapchunks
1260 ---------------------------
1262 A 'node' is the fundamental cubic unit of a world and appears to a player as
1263 roughly 1x1x1 meters in size.
1265 A 'mapblock' (often abbreviated to 'block') is 16x16x16 nodes and is the
1266 fundamental region of a world that is stored in the world database, sent to
1267 clients and handled by many parts of the engine.
1268 'mapblock' is preferred terminology to 'block' to help avoid confusion with
1269 'node', however 'block' often appears in the API.
1271 A 'mapchunk' (sometimes abbreviated to 'chunk') is usually 5x5x5 mapblocks
1272 (80x80x80 nodes) and is the volume of world generated in one operation by
1274 The size in mapblocks has been chosen to optimise map generation.
1279 ### Orientation of axes
1281 For node and mapblock coordinates, +X is East, +Y is up, +Z is North.
1283 ### Node coordinates
1285 Almost all positions used in the API use node coordinates.
1287 ### Mapblock coordinates
1289 Occasionally the API uses 'blockpos' which refers to mapblock coordinates that
1290 specify a particular mapblock.
1291 For example blockpos (0,0,0) specifies the mapblock that extends from
1292 node position (0,0,0) to node position (15,15,15).
1294 #### Converting node position to the containing blockpos
1296 To calculate the blockpos of the mapblock that contains the node at 'nodepos',
1299 * blockpos = math.floor(nodepos / 16)
1301 #### Converting blockpos to min/max node positions
1303 To calculate the min/max node positions contained in the mapblock at 'blockpos',
1307 nodepos = blockpos * 16
1309 nodepos = blockpos * 16 + 15
1320 The position field is used for all element types.
1322 To account for differing resolutions, the position coordinates are the
1323 percentage of the screen, ranging in value from `0` to `1`.
1325 The name field is not yet used, but should contain a description of what the
1326 HUD element represents.
1328 The `direction` field is the direction in which something is drawn.
1329 `0` draws from left to right, `1` draws from right to left, `2` draws from
1330 top to bottom, and `3` draws from bottom to top.
1332 The `alignment` field specifies how the item will be aligned. It is a table
1333 where `x` and `y` range from `-1` to `1`, with `0` being central. `-1` is
1334 moved to the left/up, and `1` is to the right/down. Fractional values can be
1337 The `offset` field specifies a pixel offset from the position. Contrary to
1338 position, the offset is not scaled to screen size. This allows for some
1339 precisely positioned items in the HUD.
1341 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
1344 The `z_index` field specifies the order of HUD elements from back to front.
1345 Lower z-index elements are displayed behind higher z-index elements. Elements
1346 with same z-index are displayed in an arbitrary order. Default 0.
1347 Supports negative values. By convention, the following values are recommended:
1349 * -400: Graphical effects, such as vignette
1350 * -300: Name tags, waypoints
1352 * -100: Things that block the player's view, e.g. masks
1353 * 0: Default. For standard in-game HUD elements like crosshair, hotbar,
1354 minimap, builtin statbars, etc.
1355 * 100: Temporary text messages or notification icons
1356 * 1000: Full-screen effects such as full-black screen or credits.
1357 This includes effects that cover the entire screen
1358 * Other: If your HUD element doesn't fit into any category, pick a number
1359 between the suggested values
1363 Below are the specific uses for fields in each type; fields not listed for that
1368 Displays an image on the HUD.
1370 * `scale`: The scale of the image, with 1 being the original texture size.
1371 Only the X coordinate scale is used (positive values).
1372 Negative values represent that percentage of the screen it
1373 should take; e.g. `x=-100` means 100% (width).
1374 * `text`: The name of the texture that is displayed.
1375 * `alignment`: The alignment of the image.
1376 * `offset`: offset in pixels from position.
1380 Displays text on the HUD.
1382 * `scale`: Defines the bounding rectangle of the text.
1383 A value such as `{x=100, y=100}` should work.
1384 * `text`: The text to be displayed in the HUD element.
1385 * `number`: An integer containing the RGB value of the color used to draw the
1386 text. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1387 * `alignment`: The alignment of the text.
1388 * `offset`: offset in pixels from position.
1389 * `size`: size of the text.
1390 The player-set font size is multiplied by size.x (y value isn't used).
1394 Displays a horizontal bar made up of half-images with an optional background.
1396 * `text`: The name of the texture to use.
1397 * `text2`: Optional texture name to enable a background / "off state"
1398 texture (useful to visualize the maximal value). Both textures
1399 must have the same size.
1400 * `number`: The number of half-textures that are displayed.
1401 If odd, will end with a vertically center-split texture.
1402 * `item`: Same as `number` but for the "off state" texture
1403 * `direction`: To which direction the images will extend to
1404 * `offset`: offset in pixels from position.
1405 * `size`: If used, will force full-image size to this value (override texture
1410 * `text`: The name of the inventory list to be displayed.
1411 * `number`: Number of items in the inventory to be displayed.
1412 * `item`: Position of item that is selected.
1414 * `offset`: offset in pixels from position.
1418 Displays distance to selected world position.
1420 * `name`: The name of the waypoint.
1421 * `text`: Distance suffix. Can be blank.
1422 * `precision`: Waypoint precision, integer >= 0. Defaults to 10.
1423 If set to 0, distance is not shown. Shown value is `floor(distance*precision)/precision`.
1424 When the precision is an integer multiple of 10, there will be `log_10(precision)` digits after the decimal point.
1425 `precision = 1000`, for example, will show 3 decimal places (eg: `0.999`).
1426 `precision = 2` will show multiples of `0.5`; precision = 5 will show multiples of `0.2` and so on:
1427 `precision = n` will show multiples of `1/n`
1428 * `number:` An integer containing the RGB value of the color used to draw the
1430 * `world_pos`: World position of the waypoint.
1431 * `offset`: offset in pixels from position.
1432 * `alignment`: The alignment of the waypoint.
1434 ### `image_waypoint`
1436 Same as `image`, but does not accept a `position`; the position is instead determined by `world_pos`, the world position of the waypoint.
1438 * `scale`: The scale of the image, with 1 being the original texture size.
1439 Only the X coordinate scale is used (positive values).
1440 Negative values represent that percentage of the screen it
1441 should take; e.g. `x=-100` means 100% (width).
1442 * `text`: The name of the texture that is displayed.
1443 * `alignment`: The alignment of the image.
1444 * `world_pos`: World position of the waypoint.
1445 * `offset`: offset in pixels from position.
1449 Displays an image oriented or translated according to current heading direction.
1451 * `size`: The size of this element. Negative values represent percentage
1452 of the screen; e.g. `x=-100` means 100% (width).
1453 * `scale`: Scale of the translated image (used only for dir = 2 or dir = 3).
1454 * `text`: The name of the texture to use.
1455 * `alignment`: The alignment of the image.
1456 * `offset`: Offset in pixels from position.
1457 * `dir`: How the image is rotated/translated:
1458 * 0 - Rotate as heading direction
1459 * 1 - Rotate in reverse direction
1460 * 2 - Translate as landscape direction
1461 * 3 - Translate in reverse direction
1463 If translation is chosen, texture is repeated horizontally to fill the whole element.
1467 Displays a minimap on the HUD.
1469 * `size`: Size of the minimap to display. Minimap should be a square to avoid
1471 * `alignment`: The alignment of the minimap.
1472 * `offset`: offset in pixels from position.
1474 Representations of simple things
1475 ================================
1480 {x=num, y=num, z=num}
1482 For helper functions see [Spatial Vectors].
1487 * `{type="nothing"}`
1488 * `{type="node", under=pos, above=pos}`
1489 * Indicates a pointed node selection box.
1490 * `under` refers to the node position behind the pointed face.
1491 * `above` refers to the node position in front of the pointed face.
1492 * `{type="object", ref=ObjectRef}`
1494 Exact pointing location (currently only `Raycast` supports these fields):
1496 * `pointed_thing.intersection_point`: The absolute world coordinates of the
1497 point on the selection box which is pointed at. May be in the selection box
1498 if the pointer is in the box too.
1499 * `pointed_thing.box_id`: The ID of the pointed selection box (counting starts
1501 * `pointed_thing.intersection_normal`: Unit vector, points outwards of the
1502 selected selection box. This specifies which face is pointed at.
1503 Is a null vector `{x = 0, y = 0, z = 0}` when the pointer is inside the
1509 Flag Specifier Format
1510 =====================
1512 Flags using the standardized flag specifier format can be specified in either
1513 of two ways, by string or table.
1515 The string format is a comma-delimited set of flag names; whitespace and
1516 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1517 flag, and specifying a flag prefixed by the string `"no"` explicitly
1518 clears the flag from whatever the default may be.
1520 In addition to the standard string flag format, the schematic flags field can
1521 also be a table of flag names to boolean values representing whether or not the
1522 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1523 is present, mapped to a boolean of any value, the specified flag is unset.
1525 E.g. A flag field of value
1527 {place_center_x = true, place_center_y=false, place_center_z=true}
1531 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1533 which is equivalent to
1535 "place_center_x, noplace_center_y, place_center_z"
1539 "place_center_x, place_center_z"
1541 since, by default, no schematic attributes are set.
1552 There are three kinds of items: nodes, tools and craftitems.
1554 * Node: Can be placed in the world's voxel grid
1555 * Tool: Has a wear property but cannot be stacked. The default use action is to
1556 dig nodes or hit objects according to its tool capabilities.
1557 * Craftitem: Cannot dig nodes or be placed
1562 All item stacks have an amount between 0 and 65535. It is 1 by
1563 default. Tool item stacks can not have an amount greater than 1.
1565 Tools use a wear (damage) value ranging from 0 to 65535. The
1566 value 0 is the default and is used for unworn tools. The values
1567 1 to 65535 are used for worn tools, where a higher value stands for
1568 a higher wear. Non-tools always have a wear value of 0.
1573 Items and item stacks can exist in three formats: Serializes, table format
1576 When an item must be passed to a function, it can usually be in any of
1581 This is called "stackstring" or "itemstring". It is a simple string with
1582 1-3 components: the full item identifier, an optional amount and an optional
1585 <identifier> [<amount>[ <wear>]]
1589 * `'default:apple'`: 1 apple
1590 * `'default:dirt 5'`: 5 dirt
1591 * `'default:pick_stone'`: a new stone pickaxe
1592 * `'default:pick_wood 1 21323'`: a wooden pickaxe, ca. 1/3 worn out
1600 {name="default:dirt", count=5, wear=0, metadata=""}
1602 A wooden pick about 1/3 worn out:
1604 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1608 {name="default:apple", count=1, wear=0, metadata=""}
1612 A native C++ format with many helper methods. Useful for converting
1613 between formats. See the [Class reference] section for details.
1621 In a number of places, there is a group table. Groups define the
1622 properties of a thing (item, node, armor of entity, capabilities of
1623 tool) in such a way that the engine and other mods can can interact with
1624 the thing without actually knowing what the thing is.
1629 Groups are stored in a table, having the group names with keys and the
1630 group ratings as values. Group ratings are integer values within the
1631 range [-32767, 32767]. For example:
1634 groups = {crumbly=3, soil=1}
1636 -- A more special dirt-kind of thing
1637 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1639 Groups always have a rating associated with them. If there is no
1640 useful meaning for a rating for an enabled group, it shall be `1`.
1642 When not defined, the rating of a group defaults to `0`. Thus when you
1643 read groups, you must interpret `nil` and `0` as the same value, `0`.
1645 You can read the rating of a group for an item or a node by using
1647 minetest.get_item_group(itemname, groupname)
1652 Groups of items can define what kind of an item it is (e.g. wool).
1657 In addition to the general item things, groups are used to define whether
1658 a node is destroyable and how long it takes to destroy by a tool.
1663 For entities, groups are, as of now, used only for calculating damage.
1664 The rating is the percentage of damage caused by tools with this damage group.
1665 See [Entity damage mechanism].
1667 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1668 object.set_armor_groups({fleshy=30, cracky=80})
1673 Groups in tools define which groups of nodes and entities they are
1676 Groups in crafting recipes
1677 --------------------------
1679 An example: Make meat soup from any meat, any water and any bowl:
1682 output = 'food:meat_soup_raw',
1688 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1691 Another example: Make red wool from white wool and red dye:
1695 output = 'wool:red',
1696 recipe = {'wool:white', 'group:dye,basecolor_red'},
1702 The asterisk `(*)` after a group name describes that there is no engine
1703 functionality bound to it, and implementation is left up as a suggestion
1706 ### Node, item and tool groups
1708 * `not_in_creative_inventory`: (*) Special group for inventory mods to indicate
1709 that the item should be hidden in item lists.
1712 ### Node-only groups
1714 * `attached_node`: if the node under it is not a walkable block the node will be
1715 dropped as an item. If the node is wallmounted the wallmounted direction is
1717 * `bouncy`: value is bounce speed in percent
1718 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1719 connect to each other
1720 * `dig_immediate`: Player can always pick up node without reducing tool wear
1721 * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
1722 * `3`: the node always gets the digging time 0 seconds (torch)
1723 * `disable_jump`: Player (and possibly other things) cannot jump from node
1724 or if their feet are in the node. Note: not supported for `new_move = false`
1725 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1726 * `falling_node`: if there is no walkable block under the node it will fall
1727 * `float`: the node will not fall through liquids
1728 * `level`: Can be used to give an additional sense of progression in the game.
1729 * A larger level will cause e.g. a weapon of a lower level make much less
1730 damage, and get worn out much faster, or not be able to get drops
1731 from destroyed nodes.
1732 * `0` is something that is directly accessible at the start of gameplay
1733 * There is no upper limit
1734 * See also: `leveldiff` in [Tools]
1735 * `slippery`: Players and items will slide on the node.
1736 Slipperiness rises steadily with `slippery` value, starting at 1.
1739 ### Tool-only groups
1741 * `disable_repair`: If set to 1 for a tool, it cannot be repaired using the
1742 `"toolrepair"` crafting recipe
1745 ### `ObjectRef` groups
1747 * `immortal`: Skips all damage and breath handling for an object. This group
1748 will also hide the integrated HUD status bars for players. It is
1749 automatically set to all players when damage is disabled on the server and
1750 cannot be reset (subject to change).
1751 * `punch_operable`: For entities; disables the regular damage mechanism for
1752 players punching it by hand or a non-tool item, so that it can do something
1753 else than take damage.
1757 Known damage and digging time defining groups
1758 ---------------------------------------------
1760 * `crumbly`: dirt, sand
1761 * `cracky`: tough but crackable stuff like stone.
1762 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1763 plants, wire, sheets of metal
1764 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1765 * `fleshy`: Living things like animals and the player. This could imply
1766 some blood effects when hitting.
1767 * `explody`: Especially prone to explosions
1768 * `oddly_breakable_by_hand`:
1769 Can be added to nodes that shouldn't logically be breakable by the
1770 hand but are. Somewhat similar to `dig_immediate`, but times are more
1771 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1772 speed of a tool if the tool can dig at a faster speed than this
1773 suggests for the hand.
1775 Examples of custom groups
1776 -------------------------
1778 Item groups are often used for defining, well, _groups of items_.
1780 * `meat`: any meat-kind of a thing (rating might define the size or healing
1781 ability or be irrelevant -- it is not defined as of yet)
1782 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1784 * `flammable`: can be set on fire. Rating might define the intensity of the
1785 fire, affecting e.g. the speed of the spreading of an open fire.
1786 * `wool`: any wool (any origin, any color)
1787 * `metal`: any metal
1788 * `weapon`: any weapon
1789 * `heavy`: anything considerably heavy
1791 Digging time calculation specifics
1792 ----------------------------------
1794 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1795 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1796 faster digging time.
1798 The `level` group is used to limit the toughness of nodes a tool can dig
1799 and to scale the digging times / damage to a greater extent.
1801 **Please do understand this**, otherwise you cannot use the system to it's
1804 Tools define their properties by a list of parameters for groups. They
1805 cannot dig other groups; thus it is important to use a standard bunch of
1806 groups to enable interaction with tools.
1819 * Full punch interval
1820 * Maximum drop level
1821 * For an arbitrary list of groups:
1822 * Uses (until the tool breaks)
1823 * Maximum level (usually `0`, `1`, `2` or `3`)
1827 ### Full punch interval
1829 When used as a weapon, the tool will do full damage if this time is spent
1830 between punches. If e.g. half the time is spent, the tool will do half
1833 ### Maximum drop level
1835 Suggests the maximum level of node, when dug with the tool, that will drop
1836 it's useful item. (e.g. iron ore to drop a lump of iron).
1838 This is not automated; it is the responsibility of the node definition
1843 Determines how many uses the tool has when it is used for digging a node,
1844 of this group, of the maximum level. For lower leveled nodes, the use count
1845 is multiplied by `3^leveldiff`.
1846 `leveldiff` is the difference of the tool's `maxlevel` `groupcaps` and the
1847 node's `level` group. The node cannot be dug if `leveldiff` is less than zero.
1849 * `uses=10, leveldiff=0`: actual uses: 10
1850 * `uses=10, leveldiff=1`: actual uses: 30
1851 * `uses=10, leveldiff=2`: actual uses: 90
1855 Tells what is the maximum level of a node of this group that the tool will
1860 List of digging times for different ratings of the group, for nodes of the
1863 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1864 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1865 for this group, and unable to dig the rating `1`, which is the toughest.
1866 Unless there is a matching group that enables digging otherwise.
1868 If the result digging time is 0, a delay of 0.15 seconds is added between
1869 digging nodes; If the player releases LMB after digging, this delay is set to 0,
1870 i.e. players can more quickly click the nodes away instead of holding LMB.
1874 List of damage for groups of entities. See [Entity damage mechanism].
1876 Example definition of the capabilities of a tool
1877 ------------------------------------------------
1879 tool_capabilities = {
1880 full_punch_interval=1.5,
1883 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1885 damage_groups = {fleshy=2},
1888 This makes the tool be able to dig nodes that fulfil both of these:
1890 * Have the `crumbly` group
1891 * Have a `level` group less or equal to `2`
1893 Table of resulting digging times:
1895 crumbly 0 1 2 3 4 <- level
1897 1 0.80 1.60 1.60 - -
1898 2 0.60 1.20 1.20 - -
1899 3 0.40 0.80 0.80 - -
1901 level diff: 2 1 0 -1 -2
1903 Table of resulting tool uses:
1912 * At `crumbly==0`, the node is not diggable.
1913 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1914 easy nodes to be quickly breakable.
1915 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1920 Entity damage mechanism
1921 =======================
1926 foreach group in cap.damage_groups:
1927 damage += cap.damage_groups[group]
1928 * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
1929 * (object.armor_groups[group] / 100.0)
1930 -- Where object.armor_groups[group] is 0 for inexistent values
1933 Client predicts damage based on damage groups. Because of this, it is able to
1934 give an immediate response when an entity is damaged or dies; the response is
1935 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1937 Currently a smoke puff will appear when an entity dies.
1939 The group `immortal` completely disables normal damage.
1941 Entities can define a special armor group, which is `punch_operable`. This
1942 group disables the regular damage mechanism for players punching it by hand or
1943 a non-tool item, so that it can do something else than take damage.
1945 On the Lua side, every punch calls:
1947 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction,
1950 This should never be called directly, because damage is usually not handled by
1953 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1954 accessed unless absolutely required, to encourage interoperability.
1955 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1956 * `tool_capabilities` can be `nil`.
1957 * `direction` is a unit vector, pointing from the source of the punch to
1959 * `damage` damage that will be done to entity
1960 Return value of this function will determine if damage is done by this function
1961 (retval true) or shall be done by engine (retval false)
1963 To punch an entity/object in Lua, call:
1965 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1967 * Return value is tool wear.
1968 * Parameters are equal to the above callback.
1969 * If `direction` equals `nil` and `puncher` does not equal `nil`, `direction`
1970 will be automatically filled in based on the location of `puncher`.
1981 The instance of a node in the world normally only contains the three values
1982 mentioned in [Nodes]. However, it is possible to insert extra data into a node.
1983 It is called "node metadata"; See `NodeMetaRef`.
1985 Node metadata contains two things:
1990 Some of the values in the key-value store are handled specially:
1992 * `formspec`: Defines a right-click inventory menu. See [Formspec].
1993 * `infotext`: Text shown on the screen when the node is pointed at
1997 local meta = minetest.get_meta(pos)
1998 meta:set_string("formspec",
2000 "list[context;main;0,0;8,4;]"..
2001 "list[current_player;main;0,5;8,4;]")
2002 meta:set_string("infotext", "Chest");
2003 local inv = meta:get_inventory()
2004 inv:set_size("main", 8*4)
2005 print(dump(meta:to_table()))
2008 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
2009 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
2010 [10] = "", [11] = "", [12] = "", [13] = "",
2011 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
2012 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
2013 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
2014 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
2018 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
2026 Item stacks can store metadata too. See [`ItemStackMetaRef`].
2028 Item metadata only contains a key-value store.
2030 Some of the values in the key-value store are handled specially:
2032 * `description`: Set the item stack's description.
2033 See also: `get_description` in [`ItemStack`]
2034 * `short_description`: Set the item stack's short description.
2035 See also: `get_short_description` in [`ItemStack`]
2036 * `color`: A `ColorString`, which sets the stack's color.
2037 * `palette_index`: If the item has a palette, this is used to get the
2038 current color from the palette.
2042 local meta = stack:get_meta()
2043 meta:set_string("key", "value")
2044 print(dump(meta:to_table()))
2052 Formspec defines a menu. This supports inventories and some of the
2053 typical widgets like buttons, checkboxes, text input fields, etc.
2054 It is a string, with a somewhat strange format.
2056 A formspec is made out of formspec elements, which includes widgets
2057 like buttons but also can be used to set stuff like background color.
2059 Many formspec elements have a `name`, which is a unique identifier which
2060 is used when the server receives user input. You must not use the name
2061 "quit" for formspec elements.
2063 Spaces and newlines can be inserted between the blocks, as is used in the
2066 Position and size units are inventory slots unless the new coordinate system
2067 is enabled. `X` and `Y` position the formspec element relative to the top left
2068 of the menu or container. `W` and `H` are its width and height values.
2070 If the new system is enabled, all elements have unified coordinates for all
2071 elements with no padding or spacing in between. This is highly recommended
2072 for new forms. See `real_coordinates[<bool>]` and `Migrating to Real
2075 Inventories with a `player:<name>` inventory location are only sent to the
2076 player named `<name>`.
2078 When displaying text which can contain formspec code, e.g. text set by a player,
2079 use `minetest.formspec_escape`.
2080 For coloured text you can use `minetest.colorize`.
2082 Since formspec version 3, elements drawn in the order they are defined. All
2083 background elements are drawn before all other elements.
2085 **WARNING**: do _not_ use a element name starting with `key_`; those names are
2086 reserved to pass key press events to formspec!
2088 **WARNING**: Minetest allows you to add elements to every single formspec instance
2089 using `player:set_formspec_prepend()`, which may be the reason backgrounds are
2090 appearing when you don't expect them to, or why things are styled differently
2091 to normal. See [`no_prepend[]`] and [Styling Formspecs].
2099 list[context;main;0,0;8,4;]
2100 list[current_player;main;0,5;8,4;]
2105 list[context;fuel;2,3;1,1;]
2106 list[context;src;2,1;1,1;]
2107 list[context;dst;5,1;2,2;]
2108 list[current_player;main;0,5;8,4;]
2110 ### Minecraft-like player inventory
2113 image[1,0.6;1,2;player.png]
2114 list[current_player;main;0,3.5;8,4;]
2115 list[current_player;craft;3,0;3,3;]
2116 list[current_player;craftpreview;7,1;1,1;]
2121 * FORMSPEC VERSION 1:
2123 * FORMSPEC VERSION 2:
2124 * Forced real coordinates
2125 * background9[]: 9-slice scaling parameters
2126 * FORMSPEC VERSION 3:
2127 * Formspec elements are drawn in the order of definition
2128 * bgcolor[]: use 3 parameters (bgcolor, formspec (now an enum), fbgcolor)
2129 * box[] and image[] elements enable clipping by default
2130 * new element: scroll_container[]
2131 * FORMSPEC VERSION 4:
2132 * Allow dropdown indexing events
2137 ### `formspec_version[<version>]`
2139 * Set the formspec version to a certain number. If not specified,
2140 version 1 is assumed.
2141 * Must be specified before `size` element.
2142 * Clients older than this version can neither show newer elements nor display
2143 elements with new arguments correctly.
2144 * Available since feature `formspec_version_element`.
2145 * See also: [Version History]
2147 ### `size[<W>,<H>,<fixed_size>]`
2149 * Define the size of the menu in inventory slots
2150 * `fixed_size`: `true`/`false` (optional)
2151 * deprecated: `invsize[<W>,<H>;]`
2153 ### `position[<X>,<Y>]`
2155 * Must be used after `size` element.
2156 * Defines the position on the game window of the formspec's `anchor` point.
2157 * For X and Y, 0.0 and 1.0 represent opposite edges of the game window,
2159 * [0.0, 0.0] sets the position to the top left corner of the game window.
2160 * [1.0, 1.0] sets the position to the bottom right of the game window.
2161 * Defaults to the center of the game window [0.5, 0.5].
2163 ### `anchor[<X>,<Y>]`
2165 * Must be used after both `size` and `position` (if present) elements.
2166 * Defines the location of the anchor point within the formspec.
2167 * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec,
2169 * [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
2170 * [1.0, 0.0] sets the anchor to the top right of the formspec.
2171 * Defaults to the center of the formspec [0.5, 0.5].
2173 * `position` and `anchor` elements need suitable values to avoid a formspec
2174 extending off the game window due to particular game window sizes.
2178 * Must be used after the `size`, `position`, and `anchor` elements (if present).
2179 * Disables player:set_formspec_prepend() from applying to this formspec.
2181 ### `real_coordinates[<bool>]`
2183 * INFORMATION: Enable it automatically using `formspec_version` version 2 or newer.
2184 * When set to true, all following formspec elements will use the new coordinate system.
2185 * If used immediately after `size`, `position`, `anchor`, and `no_prepend` elements
2186 (if present), the form size will use the new coordinate system.
2187 * **Note**: Formspec prepends are not affected by the coordinates in the main form.
2188 They must enable it explicitly.
2189 * For information on converting forms to the new coordinate system, see `Migrating
2190 to Real Coordinates`.
2192 ### `container[<X>,<Y>]`
2194 * Start of a container block, moves all physical elements in the container by
2196 * Must have matching `container_end`
2197 * Containers can be nested, in which case the offsets are added
2198 (child containers are relative to parent containers)
2200 ### `container_end[]`
2202 * End of a container, following elements are no longer relative to this
2205 ### `scroll_container[<X>,<Y>;<W>,<H>;<scrollbar name>;<orientation>;<scroll factor>]`
2207 * Start of a scroll_container block. All contained elements will ...
2208 * take the scroll_container coordinate as position origin,
2209 * be additionally moved by the current value of the scrollbar with the name
2210 `scrollbar name` times `scroll factor` along the orientation `orientation` and
2211 * be clipped to the rectangle defined by `X`, `Y`, `W` and `H`.
2212 * `orientation`: possible values are `vertical` and `horizontal`.
2213 * `scroll factor`: optional, defaults to `0.1`.
2214 * Nesting is possible.
2215 * Some elements might work a little different if they are in a scroll_container.
2216 * Note: If you want the scroll_container to actually work, you also need to add a
2217 scrollbar element with the specified name. Furthermore, it is highly recommended
2218 to use a scrollbaroptions element on this scrollbar.
2220 ### `scroll_container_end[]`
2222 * End of a scroll_container, following elements are no longer bound to this
2225 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
2227 * Show an inventory list if it has been sent to the client. Nothing will
2228 be shown if the inventory list is of size 0.
2229 * **Note**: With the new coordinate system, the spacing between inventory
2230 slots is one-fourth the size of an inventory slot by default. Also see
2231 [Styling Formspecs] for changing the size of slots and spacing.
2233 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
2235 * Show an inventory list if it has been sent to the client. Nothing will
2236 be shown if the inventory list is of size 0.
2237 * **Note**: With the new coordinate system, the spacing between inventory
2238 slots is one-fourth the size of an inventory slot.
2240 ### `listring[<inventory location>;<list name>]`
2242 * Allows to create a ring of inventory lists
2243 * Shift-clicking on items in one element of the ring
2244 will send them to the next inventory list inside the ring
2245 * The first occurrence of an element inside the ring will
2246 determine the inventory where items will be sent to
2250 * Shorthand for doing `listring[<inventory location>;<list name>]`
2251 for the last two inventory lists added by list[...]
2253 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
2255 * Sets background color of slots as `ColorString`
2256 * Sets background color of slots on mouse hovering
2258 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
2260 * Sets background color of slots as `ColorString`
2261 * Sets background color of slots on mouse hovering
2262 * Sets color of slots border
2264 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
2266 * Sets background color of slots as `ColorString`
2267 * Sets background color of slots on mouse hovering
2268 * Sets color of slots border
2269 * Sets default background color of tooltips
2270 * Sets default font color of tooltips
2272 ### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2274 * Adds tooltip for an element
2275 * `bgcolor` tooltip background color as `ColorString` (optional)
2276 * `fontcolor` tooltip font color as `ColorString` (optional)
2278 ### `tooltip[<X>,<Y>;<W>,<H>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2280 * Adds tooltip for an area. Other tooltips will take priority when present.
2281 * `bgcolor` tooltip background color as `ColorString` (optional)
2282 * `fontcolor` tooltip font color as `ColorString` (optional)
2284 ### `image[<X>,<Y>;<W>,<H>;<texture name>]`
2288 ### `animated_image[<X>,<Y>;<W>,<H>;<name>;<texture name>;<frame count>;<frame duration>;<frame start>]`
2290 * Show an animated image. The image is drawn like a "vertical_frames" tile
2291 animation (See [Tile animation definition]), but uses a frame count/duration
2293 * `name`: Element name to send when an event occurs. The event value is the index of the current frame.
2294 * `texture name`: The image to use.
2295 * `frame count`: The number of frames animating the image.
2296 * `frame duration`: Milliseconds between each frame. `0` means the frames don't advance.
2297 * `frame start` (Optional): The index of the frame to start on. Default `1`.
2299 ### `model[<X>,<Y>;<W>,<H>;<name>;<mesh>;<textures>;<rotation X,Y>;<continuous>;<mouse control>;<frame loop range>]`
2301 * Show a mesh model.
2302 * `name`: Element name that can be used for styling
2303 * `mesh`: The mesh model to use.
2304 * `textures`: The mesh textures to use according to the mesh materials.
2305 Texture names must be separated by commas.
2306 * `rotation {X,Y}` (Optional): Initial rotation of the camera.
2307 The axes are euler angles in degrees.
2308 * `continuous` (Optional): Whether the rotation is continuous. Default `false`.
2309 * `mouse control` (Optional): Whether the model can be controlled with the mouse. Default `true`.
2310 * `frame loop range` (Optional): Range of the animation frames.
2311 * Defaults to the full range of all available frames.
2312 * Syntax: `<begin>,<end>`
2314 ### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
2316 * Show an inventory image of registered item/node
2318 ### `bgcolor[<bgcolor>;<fullscreen>;<fbgcolor>]`
2320 * Sets background color of formspec.
2321 * `bgcolor` and `fbgcolor` (optional) are `ColorString`s, they define the color
2322 of the non-fullscreen and the fullscreen background.
2323 * `fullscreen` (optional) can be one of the following:
2324 * `false`: Only the non-fullscreen background color is drawn. (default)
2325 * `true`: Only the fullscreen background color is drawn.
2326 * `both`: The non-fullscreen and the fullscreen background color are drawn.
2327 * `neither`: No background color is drawn.
2328 * Note: Leave a parameter empty to not modify the value.
2329 * Note: `fbgcolor`, leaving parameters empty and values for `fullscreen` that
2330 are not bools are only available since formspec version 3.
2332 ### `background[<X>,<Y>;<W>,<H>;<texture name>]`
2334 * Example for formspec 8x4 in 16x resolution: image shall be sized
2335 8 times 16px times 4 times 16px.
2337 ### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
2339 * Example for formspec 8x4 in 16x resolution:
2340 image shall be sized 8 times 16px times 4 times 16px
2341 * If `auto_clip` is `true`, the background is clipped to the formspec size
2342 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2344 ### `background9[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>;<middle>]`
2346 * 9-sliced background. See https://en.wikipedia.org/wiki/9-slice_scaling
2347 * Middle is a rect which defines the middle of the 9-slice.
2348 * `x` - The middle will be x pixels from all sides.
2349 * `x,y` - The middle will be x pixels from the horizontal and y from the vertical.
2350 * `x,y,x2,y2` - The middle will start at x,y, and end at x2, y2. Negative x2 and y2 values
2351 will be added to the width and height of the texture, allowing it to be used as the
2352 distance from the far end.
2353 * All numbers in middle are integers.
2354 * Example for formspec 8x4 in 16x resolution:
2355 image shall be sized 8 times 16px times 4 times 16px
2356 * If `auto_clip` is `true`, the background is clipped to the formspec size
2357 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2358 * Available since formspec version 2
2360 ### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
2362 * Textual password style field; will be sent to server when a button is clicked
2363 * When enter is pressed in field, fields.key_enter_field will be sent with the
2365 * With the old coordinate system, fields are a set height, but will be vertically
2366 centred on `H`. With the new coordinate system, `H` will modify the height.
2367 * `name` is the name of the field as returned in fields to `on_receive_fields`
2368 * `label`, if not blank, will be text printed on the top left above the field
2369 * See `field_close_on_enter` to stop enter closing the formspec
2371 ### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2373 * Textual field; will be sent to server when a button is clicked
2374 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2375 the name of this field.
2376 * With the old coordinate system, fields are a set height, but will be vertically
2377 centred on `H`. With the new coordinate system, `H` will modify the height.
2378 * `name` is the name of the field as returned in fields to `on_receive_fields`
2379 * `label`, if not blank, will be text printed on the top left above the field
2380 * `default` is the default value of the field
2381 * `default` may contain variable references such as `${text}` which
2382 will fill the value from the metadata value `text`
2383 * **Note**: no extra text or more than a single variable is supported ATM.
2384 * See `field_close_on_enter` to stop enter closing the formspec
2386 ### `field[<name>;<label>;<default>]`
2388 * As above, but without position/size units
2389 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2390 the name of this field.
2391 * Special field for creating simple forms, such as sign text input
2392 * Must be used without a `size[]` element
2393 * A "Proceed" button will be added automatically
2394 * See `field_close_on_enter` to stop enter closing the formspec
2396 ### `field_close_on_enter[<name>;<close_on_enter>]`
2398 * <name> is the name of the field
2399 * if <close_on_enter> is false, pressing enter in the field will submit the
2400 form but not close it.
2401 * defaults to true when not specified (ie: no tag for a field)
2403 ### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2405 * Same as fields above, but with multi-line input
2406 * If the text overflows, a vertical scrollbar is added.
2407 * If the name is empty, the textarea is read-only and
2408 the background is not shown, which corresponds to a multi-line label.
2410 ### `label[<X>,<Y>;<label>]`
2412 * The label formspec element displays the text set in `label`
2413 at the specified position.
2414 * **Note**: If the new coordinate system is enabled, labels are
2415 positioned from the center of the text, not the top.
2416 * The text is displayed directly without automatic line breaking,
2417 so label should not be used for big text chunks. Newlines can be
2418 used to make labels multiline.
2419 * **Note**: With the new coordinate system, newlines are spaced with
2420 half a coordinate. With the old system, newlines are spaced 2/5 of
2423 ### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]`
2424 * Displays a static formatted text with hyperlinks.
2425 * **Note**: This element is currently unstable and subject to change.
2426 * `x`, `y`, `w` and `h` work as per field
2427 * `name` is the name of the field as returned in fields to `on_receive_fields` in case of action in text.
2428 * `text` is the formatted text using `Markup Language` described below.
2430 ### `vertlabel[<X>,<Y>;<label>]`
2431 * Textual label drawn vertically
2432 * `label` is the text on the label
2433 * **Note**: If the new coordinate system is enabled, vertlabels are
2434 positioned from the center of the text, not the left.
2436 ### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
2438 * Clickable button. When clicked, fields will be sent.
2439 * With the old coordinate system, buttons are a set height, but will be vertically
2440 centred on `H`. With the new coordinate system, `H` will modify the height.
2441 * `label` is the text on the button
2443 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2445 * `texture name` is the filename of an image
2446 * **Note**: Height is supported on both the old and new coordinate systems
2449 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
2451 * `texture name` is the filename of an image
2452 * `noclip=true` means the image button doesn't need to be within specified
2454 * `drawborder`: draw button border or not
2455 * `pressed texture name` is the filename of an image on pressed state
2457 ### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
2459 * `item name` is the registered name of an item/node
2460 * The item description will be used as the tooltip. This can be overridden with
2463 ### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
2465 * When clicked, fields will be sent and the form will quit.
2466 * Same as `button` in all other respects.
2468 ### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2470 * When clicked, fields will be sent and the form will quit.
2471 * Same as `image_button` in all other respects.
2473 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
2475 * Scrollable item list showing arbitrary text elements
2476 * `name` fieldname sent to server on doubleclick value is current selected
2478 * `listelements` can be prepended by #color in hexadecimal format RRGGBB
2480 * if you want a listelement to start with "#" write "##".
2482 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
2484 * Scrollable itemlist showing arbitrary text elements
2485 * `name` fieldname sent to server on doubleclick value is current selected
2487 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
2488 * if you want a listelement to start with "#" write "##"
2489 * Index to be selected within textlist
2490 * `true`/`false`: draw transparent background
2491 * See also `minetest.explode_textlist_event`
2492 (main menu: `core.explode_textlist_event`).
2494 ### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2496 * Show a tab**header** at specific position (ignores formsize)
2497 * `X` and `Y`: position of the tabheader
2498 * *Note*: Width and height are automatically chosen with this syntax
2499 * `name` fieldname data is transferred to Lua
2500 * `caption 1`...: name shown on top of tab
2501 * `current_tab`: index of selected tab 1...
2502 * `transparent` (optional): if true, tabs are semi-transparent
2503 * `draw_border` (optional): if true, draw a thin line at tab base
2505 ### `tabheader[<X>,<Y>;<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2507 * Show a tab**header** at specific position (ignores formsize)
2508 * **Important note**: This syntax for tabheaders can only be used with the
2509 new coordinate system.
2510 * `X` and `Y`: position of the tabheader
2511 * `H`: height of the tabheader. Width is automatically determined with this syntax.
2512 * `name` fieldname data is transferred to Lua
2513 * `caption 1`...: name shown on top of tab
2514 * `current_tab`: index of selected tab 1...
2515 * `transparent` (optional): show transparent
2516 * `draw_border` (optional): draw border
2518 ### `tabheader[<X>,<Y>;<W>,<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2520 * Show a tab**header** at specific position (ignores formsize)
2521 * **Important note**: This syntax for tabheaders can only be used with the
2522 new coordinate system.
2523 * `X` and `Y`: position of the tabheader
2524 * `W` and `H`: width and height of the tabheader
2525 * `name` fieldname data is transferred to Lua
2526 * `caption 1`...: name shown on top of tab
2527 * `current_tab`: index of selected tab 1...
2528 * `transparent` (optional): show transparent
2529 * `draw_border` (optional): draw border
2531 ### `box[<X>,<Y>;<W>,<H>;<color>]`
2533 * Simple colored box
2534 * `color` is color specified as a `ColorString`.
2535 If the alpha component is left blank, the box will be semitransparent.
2536 If the color is not specified, the box will use the options specified by
2537 its style. If the color is specified, all styling options will be ignored.
2539 ### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
2541 * Show a dropdown field
2542 * **Important note**: There are two different operation modes:
2543 1. handle directly on change (only changed dropdown is submitted)
2544 2. read the value on pressing a button (all dropdown values are available)
2545 * `X` and `Y`: position of the dropdown
2546 * `W`: width of the dropdown. Height is automatically chosen with this syntax.
2547 * Fieldname data is transferred to Lua
2548 * Items to be shown in dropdown
2549 * Index of currently selected dropdown item
2550 * `index event` (optional, allowed parameter since formspec version 4): Specifies the
2551 event field value for selected items.
2552 * `true`: Selected item index
2553 * `false` (default): Selected item value
2555 ### `dropdown[<X>,<Y>;<W>,<H>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
2557 * Show a dropdown field
2558 * **Important note**: This syntax for dropdowns can only be used with the
2559 new coordinate system.
2560 * **Important note**: There are two different operation modes:
2561 1. handle directly on change (only changed dropdown is submitted)
2562 2. read the value on pressing a button (all dropdown values are available)
2563 * `X` and `Y`: position of the dropdown
2564 * `W` and `H`: width and height of the dropdown
2565 * Fieldname data is transferred to Lua
2566 * Items to be shown in dropdown
2567 * Index of currently selected dropdown item
2568 * `index event` (optional, allowed parameter since formspec version 4): Specifies the
2569 event field value for selected items.
2570 * `true`: Selected item index
2571 * `false` (default): Selected item value
2573 ### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
2576 * `name` fieldname data is transferred to Lua
2577 * `label` to be shown left of checkbox
2578 * `selected` (optional): `true`/`false`
2579 * **Note**: If the new coordinate system is enabled, checkboxes are
2580 positioned from the center of the checkbox, not the top.
2582 ### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
2584 * Show a scrollbar using options defined by the previous `scrollbaroptions[]`
2585 * There are two ways to use it:
2586 1. handle the changed event (only changed scrollbar is available)
2587 2. read the value on pressing a button (all scrollbars are available)
2588 * `orientation`: `vertical`/`horizontal`. Default horizontal.
2589 * Fieldname data is transferred to Lua
2590 * Value of this trackbar is set to (`0`-`1000`) by default
2591 * See also `minetest.explode_scrollbar_event`
2592 (main menu: `core.explode_scrollbar_event`).
2594 ### `scrollbaroptions[opt1;opt2;...]`
2595 * Sets options for all following `scrollbar[]` elements
2597 * Sets scrollbar minimum value, defaults to `0`.
2599 * Sets scrollbar maximum value, defaults to `1000`.
2600 If the max is equal to the min, the scrollbar will be disabled.
2602 * Sets scrollbar step value when the arrows are clicked or the mouse wheel is
2604 * If this is set to a negative number, the value will be reset to `10`.
2606 * Sets scrollbar step value used by page up and page down.
2607 * If this is set to a negative number, the value will be reset to `100`.
2609 * Sets size of the thumb on the scrollbar. Size is calculated in the number of
2610 units the thumb spans out of the range of the scrollbar values.
2611 * Example: If a scrollbar has a `min` of 1 and a `max` of 100, a thumbsize of 10
2612 would span a tenth of the scrollbar space.
2613 * If this is set to zero or less, the value will be reset to `1`.
2614 * `arrows=<show/hide/default>`
2615 * Whether to show the arrow buttons on the scrollbar. `default` hides the arrows
2616 when the scrollbar gets too small, but shows them otherwise.
2618 ### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
2620 * Show scrollable table using options defined by the previous `tableoptions[]`
2621 * Displays cells as defined by the previous `tablecolumns[]`
2622 * `name`: fieldname sent to server on row select or doubleclick
2623 * `cell 1`...`cell n`: cell contents given in row-major order
2624 * `selected idx`: index of row to be selected within table (first row = `1`)
2625 * See also `minetest.explode_table_event`
2626 (main menu: `core.explode_table_event`).
2628 ### `tableoptions[<opt 1>;<opt 2>;...]`
2630 * Sets options for `table[]`
2632 * default text color (`ColorString`), defaults to `#FFFFFF`
2633 * `background=#RRGGBB`
2634 * table background color (`ColorString`), defaults to `#000000`
2635 * `border=<true/false>`
2636 * should the table be drawn with a border? (default: `true`)
2637 * `highlight=#RRGGBB`
2638 * highlight background color (`ColorString`), defaults to `#466432`
2639 * `highlight_text=#RRGGBB`
2640 * highlight text color (`ColorString`), defaults to `#FFFFFF`
2641 * `opendepth=<value>`
2642 * all subtrees up to `depth < value` are open (default value = `0`)
2643 * only useful when there is a column of type "tree"
2645 ### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
2647 * Sets columns for `table[]`
2648 * Types: `text`, `image`, `color`, `indent`, `tree`
2649 * `text`: show cell contents as text
2650 * `image`: cell contents are an image index, use column options to define
2652 * `color`: cell contents are a ColorString and define color of following
2654 * `indent`: cell contents are a number and define indentation of following
2656 * `tree`: same as indent, but user can open and close subtrees
2660 * for `text` and `image`: content alignment within cells.
2661 Available values: `left` (default), `center`, `right`, `inline`
2663 * for `text` and `image`: minimum width in em (default: `0`)
2664 * for `indent` and `tree`: indent width in em (default: `1.5`)
2665 * `padding=<value>`: padding left of the column, in em (default `0.5`).
2666 Exception: defaults to 0 for indent columns
2667 * `tooltip=<value>`: tooltip text (default: empty)
2668 * `image` column options:
2669 * `0=<value>` sets image for image index 0
2670 * `1=<value>` sets image for image index 1
2671 * `2=<value>` sets image for image index 2
2672 * and so on; defined indices need not be contiguous empty or
2673 non-numeric cells are treated as `0`.
2674 * `color` column options:
2675 * `span=<value>`: number of following columns to affect
2676 (default: infinite).
2678 ### `style[<selector 1>,<selector 2>;<prop1>;<prop2>;...]`
2680 * Set the style for the element(s) matching `selector` by name.
2681 * `selector` can be one of:
2682 * `<name>` - An element name. Includes `*`, which represents every element.
2683 * `<name>:<state>` - An element name, a colon, and one or more states.
2684 * `state` is a list of states separated by the `+` character.
2685 * If a state is provided, the style will only take effect when the element is in that state.
2686 * All provided states must be active for the style to apply.
2687 * Note: this **must** be before the element is defined.
2688 * See [Styling Formspecs].
2691 ### `style_type[<selector 1>,<selector 2>;<prop1>;<prop2>;...]`
2693 * Set the style for the element(s) matching `selector` by type.
2694 * `selector` can be one of:
2695 * `<type>` - An element type. Includes `*`, which represents every element.
2696 * `<type>:<state>` - An element type, a colon, and one or more states.
2697 * `state` is a list of states separated by the `+` character.
2698 * If a state is provided, the style will only take effect when the element is in that state.
2699 * All provided states must be active for the style to apply.
2700 * See [Styling Formspecs].
2702 ### `set_focus[<name>;<force>]`
2704 * Sets the focus to the element with the same `name` parameter.
2705 * **Note**: This element must be placed before the element it focuses.
2706 * `force` (optional, default `false`): By default, focus is not applied for
2707 re-sent formspecs with the same name so that player-set focus is kept.
2708 `true` sets the focus to the specified element for every sent formspec.
2709 * The following elements have the ability to be focused:
2724 Migrating to Real Coordinates
2725 -----------------------------
2727 In the old system, positions included padding and spacing. Padding is a gap between
2728 the formspec window edges and content, and spacing is the gaps between items. For
2729 example, two `1x1` elements at `0,0` and `1,1` would have a spacing of `5/4` between them,
2730 and a padding of `3/8` from the formspec edge. It may be easiest to recreate old layouts
2731 in the new coordinate system from scratch.
2733 To recreate an old layout with padding, you'll need to pass the positions and sizes
2734 through the following formula to re-introduce padding:
2737 pos = (oldpos + 1)*spacing + padding
2743 You'll need to change the `size[]` tag like this:
2746 size = (oldsize-1)*spacing + padding*2 + 1
2749 A few elements had random offsets in the old system. Here is a table which shows these
2750 offsets when migrating:
2752 | Element | Position | Size | Notes
2753 |---------|------------|---------|-------
2754 | box | +0.3, +0.1 | 0, -0.4 |
2755 | button | | | Buttons now support height, so set h = 2 * 15/13 * 0.35, and reposition if h ~= 15/13 * 0.35 before
2756 | list | | | Spacing is now 0.25 for both directions, meaning lists will be taller in height
2757 | label | 0, +0.3 | | The first line of text is now positioned centered exactly at the position specified
2762 Formspec elements can be themed using the style elements:
2764 style[<name 1>,<name 2>;<prop1>;<prop2>;...]
2765 style[<name 1>:<state>,<name 2>:<state>;<prop1>;<prop2>;...]
2766 style_type[<type 1>,<type 2>;<prop1>;<prop2>;...]
2767 style_type[<type 1>:<state>,<type 2>:<state>;<prop1>;<prop2>;...]
2771 property_name=property_value
2775 style_type[button;bgcolor=#006699]
2776 style[world_delete;bgcolor=red;textcolor=yellow]
2777 button[4,3.95;2.6,1;world_delete;Delete]
2779 A name/type can optionally be a comma separated list of names/types, like so:
2781 world_delete,world_create,world_configure
2784 A `*` type can be used to select every element in the formspec.
2786 Any name/type in the list can also be accompanied by a `+`-separated list of states, like so:
2788 world_delete:hovered+pressed
2791 States allow you to apply styles in response to changes in the element, instead of applying at all times.
2793 Setting a property to nothing will reset it to the default value. For example:
2795 style_type[button;bgimg=button.png;bgimg_pressed=button_pressed.png;border=false]
2796 style[btn_exit;bgimg=;bgimg_pressed=;border=;bgcolor=red]
2799 ### Supported Element Types
2801 Some types may inherit styles from parent types.
2803 * animated_image, inherits from image
2806 * button_exit, inherits from button
2816 * pwdfield, inherits from field
2822 * vertlabel, inherits from label
2825 ### Valid Properties
2828 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2830 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2831 * Defaults to false in formspec_version version 3 or higher
2832 * **Note**: `colors`, `bordercolors`, and `borderwidths` accept multiple input types:
2833 * Single value (e.g. `#FF0`): All corners/borders.
2834 * Two values (e.g. `red,#FFAAFF`): top-left and bottom-right,top-right and bottom-left/
2835 top and bottom,left and right.
2836 * Four values (e.g. `blue,#A0F,green,#FFFA`): top-left/top and rotates clockwise.
2837 * These work similarly to CSS borders.
2838 * colors - `ColorString`. Sets the color(s) of the box corners. Default `black`.
2839 * bordercolors - `ColorString`. Sets the color(s) of the borders. Default `black`.
2840 * borderwidths - Integer. Sets the width(s) of the borders in pixels. If the width is
2841 negative, the border will extend inside the box, whereas positive extends outside
2842 the box. A width of zero results in no border; this is default.
2843 * button, button_exit, image_button, item_image_button
2844 * alpha - boolean, whether to draw alpha in bgimg. Default true.
2845 * bgcolor - color, sets button tint.
2846 * bgcolor_hovered - color when hovered. Defaults to a lighter bgcolor when not provided.
2847 * This is deprecated, use states instead.
2848 * bgcolor_pressed - color when pressed. Defaults to a darker bgcolor when not provided.
2849 * This is deprecated, use states instead.
2850 * bgimg - standard background image. Defaults to none.
2851 * bgimg_hovered - background image when hovered. Defaults to bgimg when not provided.
2852 * This is deprecated, use states instead.
2853 * bgimg_middle - Makes the bgimg textures render in 9-sliced mode and defines the middle rect.
2854 See background9[] documentation for more details. This property also pads the
2855 button's content when set.
2856 * bgimg_pressed - background image when pressed. Defaults to bgimg when not provided.
2857 * This is deprecated, use states instead.
2858 * font - Sets font type. This is a comma separated list of options. Valid options:
2859 * Main font type options. These cannot be combined with each other:
2860 * `normal`: Default font
2861 * `mono`: Monospaced font
2862 * Font modification options. If used without a main font type, `normal` is used:
2863 * `bold`: Makes font bold.
2864 * `italic`: Makes font italic.
2866 * font_size - Sets font size. Default is user-set. Can have multiple values:
2867 * `<number>`: Sets absolute font size to `number`.
2868 * `+<number>`/`-<number>`: Offsets default font size by `number` points.
2869 * `*<number>`: Multiplies default font size by `number`, similar to CSS `em`.
2870 * border - boolean, draw border. Set to false to hide the bevelled button pane. Default true.
2871 * content_offset - 2d vector, shifts the position of the button's content without resizing it.
2872 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2873 * padding - rect, adds space between the edges of the button and the content. This value is
2874 relative to bgimg_middle.
2875 * sound - a sound to be played when triggered.
2876 * textcolor - color, default white.
2878 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2879 * sound - a sound to be played when triggered.
2881 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2882 * sound - a sound to be played when the entry is changed.
2883 * field, pwdfield, textarea
2884 * border - set to false to hide the textbox background and border. Default true.
2885 * font - Sets font type. See button `font` property for more information.
2886 * font_size - Sets font size. See button `font_size` property for more information.
2887 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2888 * textcolor - color. Default white.
2890 * bgcolor - color, sets background color.
2891 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2892 * Default to false in formspec_version version 3 or higher
2894 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2895 * Default to false in formspec_version version 3 or higher
2897 * noclip - boolean, set to true to allow the element to exceed formspec bounds. Default to false.
2899 * font - Sets font type. See button `font` property for more information.
2900 * font_size - Sets font size. See button `font_size` property for more information.
2901 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2903 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2904 * size - 2d vector, sets the size of inventory slots in coordinates.
2905 * spacing - 2d vector, sets the space between inventory slots in coordinates.
2906 * image_button (additional properties)
2907 * fgimg - standard image. Defaults to none.
2908 * fgimg_hovered - image when hovered. Defaults to fgimg when not provided.
2909 * This is deprecated, use states instead.
2910 * fgimg_pressed - image when pressed. Defaults to fgimg when not provided.
2911 * This is deprecated, use states instead.
2912 * NOTE: The parameters of any given image_button will take precedence over fgimg/fgimg_pressed
2913 * sound - a sound to be played when triggered.
2915 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2917 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2918 * sound - a sound to be played when a different tab is selected.
2919 * textcolor - color. Default white.
2921 * font - Sets font type. See button `font` property for more information.
2922 * font_size - Sets font size. See button `font_size` property for more information.
2923 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2928 * default - Equivalent to providing no states
2929 * button, button_exit, image_button, item_image_button
2930 * hovered - Active when the mouse is hovering over the element
2931 * pressed - Active when the button is pressed
2936 Markup language used in `hypertext[]` elements uses tags that look like HTML tags.
2937 The markup language is currently unstable and subject to change. Use with caution.
2938 Some tags can enclose text, they open with `<tagname>` and close with `</tagname>`.
2939 Tags can have attributes, in that case, attributes are in the opening tag in
2940 form of a key/value separated with equal signs. Attribute values should not be quoted.
2942 These are the technically basic tags but see below for usual tags. Base tags are:
2944 `<style color=... font=... size=...>...</style>`
2946 Changes the style of the text.
2948 * `color`: Text color. Given color is a `colorspec`.
2949 * `size`: Text size.
2950 * `font`: Text font (`mono` or `normal`).
2952 `<global background=... margin=... valign=... color=... hovercolor=... size=... font=... halign=... >`
2957 * `background`: Text background, a `colorspec` or `none`.
2958 * `margin`: Page margins in pixel.
2959 * `valign`: Text vertical alignment (`top`, `middle`, `bottom`).
2961 Inheriting styles (affects child elements):
2962 * `color`: Default text color. Given color is a `colorspec`.
2963 * `hovercolor`: Color of <action> tags when mouse is over.
2964 * `size`: Default text size.
2965 * `font`: Default text font (`mono` or `normal`).
2966 * `halign`: Default text horizontal alignment (`left`, `right`, `center`, `justify`).
2968 This tag needs to be placed only once as it changes the global settings of the
2969 text. Anyway, if several tags are placed, each changed will be made in the order
2972 `<tag name=... color=... hovercolor=... font=... size=...>`
2974 Defines or redefines tag style. This can be used to define new tags.
2975 * `name`: Name of the tag to define or change.
2976 * `color`: Text color. Given color is a `colorspec`.
2977 * `hovercolor`: Text color when element hovered (only for `action` tags). Given color is a `colorspec`.
2978 * `size`: Text size.
2979 * `font`: Text font (`mono` or `normal`).
2981 Following tags are the usual tags for text layout. They are defined by default.
2982 Other tags can be added using `<tag ...>` tag.
2984 `<normal>...</normal>`: Normal size text
2986 `<big>...</big>`: Big text
2988 `<bigger>...</bigger>`: Bigger text
2990 `<center>...</center>`: Centered text
2992 `<left>...</left>`: Left-aligned text
2994 `<right>...</right>`: Right-aligned text
2996 `<justify>...</justify>`: Justified text
2998 `<mono>...</mono>`: Monospaced font
3000 `<b>...</b>`, `<i>...</i>`, `<u>...</u>`: Bold, italic, underline styles.
3002 `<action name=...>...</action>`
3004 Make that text a clickable text triggering an action.
3006 * `name`: Name of the action (mandatory).
3008 When clicked, the formspec is send to the server. The value of the text field
3009 sent to `on_player_receive_fields` will be "action:" concatenated to the action
3012 `<img name=... float=... width=... height=...>`
3014 Draws an image which is present in the client media cache.
3016 * `name`: Name of the texture (mandatory).
3017 * `float`: If present, makes the image floating (`left` or `right`).
3018 * `width`: Force image width instead of taking texture width.
3019 * `height`: Force image height instead of taking texture height.
3021 If only width or height given, texture aspect is kept.
3023 `<item name=... float=... width=... height=... rotate=...>`
3025 Draws an item image.
3027 * `name`: Item string of the item to draw (mandatory).
3028 * `float`: If present, makes the image floating (`left` or `right`).
3029 * `width`: Item image width.
3030 * `height`: Item image height.
3031 * `rotate`: Rotate item image if set to `yes` or `X,Y,Z`. X, Y and Z being
3032 rotation speeds in percent of standard speed (-1000 to 1000). Works only if
3033 `inventory_items_animations` is set to true.
3034 * `angle`: Angle in which the item image is shown. Value has `X,Y,Z` form.
3035 X, Y and Z being angles around each three axes. Works only if
3036 `inventory_items_animations` is set to true.
3044 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
3045 * `"current_player"`: Player to whom the menu is shown
3046 * `"player:<name>"`: Any player
3047 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
3048 * `"detached:<name>"`: A detached inventory
3050 Player Inventory lists
3051 ----------------------
3053 * `main`: list containing the default inventory
3054 * `craft`: list containing the craft input
3055 * `craftpreview`: list containing the craft prediction
3056 * `craftresult`: list containing the crafted output
3057 * `hand`: list containing an override for the empty hand
3058 * Is not created automatically, use `InvRef:set_size`
3059 * Is only used to enhance the empty hand's tool capabilities
3067 `#RGB` defines a color in hexadecimal format.
3069 `#RGBA` defines a color in hexadecimal format and alpha channel.
3071 `#RRGGBB` defines a color in hexadecimal format.
3073 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
3075 Named colors are also supported and are equivalent to
3076 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
3077 To specify the value of the alpha channel, append `#AA` to the end of the color
3078 name (e.g. `colorname#08`). For named colors the hexadecimal string
3079 representing the alpha value must (always) be two hexadecimal digits.
3084 A ColorSpec specifies a 32-bit color. It can be written in any of the following
3087 * table form: Each element ranging from 0..255 (a, if absent, defaults to 255):
3088 * `colorspec = {a=255, r=0, g=255, b=0}`
3089 * numerical form: The raw integer value of an ARGB8 quad:
3090 * `colorspec = 0xFF00FF00`
3091 * string form: A ColorString (defined above):
3092 * `colorspec = "green"`
3100 Most text can contain escape sequences, that can for example color the text.
3101 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
3102 The following functions provide escape sequences:
3104 * `minetest.get_color_escape_sequence(color)`:
3105 * `color` is a ColorString
3106 * The escape sequence sets the text color to `color`
3107 * `minetest.colorize(color, message)`:
3109 `minetest.get_color_escape_sequence(color) ..
3111 minetest.get_color_escape_sequence("#ffffff")`
3112 * `minetest.rainbow(message)`:
3113 * Rainbow colorizes the message.
3114 * `minetest.get_background_escape_sequence(color)`
3115 * `color` is a ColorString
3116 * The escape sequence sets the background of the whole text element to
3117 `color`. Only defined for item descriptions and tooltips.
3118 * `minetest.strip_foreground_colors(str)`
3119 * Removes foreground colors added by `get_color_escape_sequence`.
3120 * `minetest.strip_background_colors(str)`
3121 * Removes background colors added by `get_background_escape_sequence`.
3122 * `minetest.strip_colors(str)`
3123 * Removes all color escape sequences.
3130 A spatial vector is similar to a position, but instead using
3131 absolute world coordinates, it uses *relative* coordinates, relative to
3132 no particular point.
3134 Internally, it is implemented as a table with the 3 fields
3135 `x`, `y` and `z`. Example: `{x = 0, y = 1, z = 0}`.
3137 For the following functions, `v`, `v1`, `v2` are vectors,
3138 `p1`, `p2` are positions,
3139 `s` is a scalar (a number):
3141 * `vector.new(a[, b, c])`:
3143 * A copy of `a` if `a` is a vector.
3144 * `{x = a, y = b, z = c}`, if all of `a`, `b`, `c` are defined numbers.
3145 * `vector.direction(p1, p2)`:
3146 * Returns a vector of length 1 with direction `p1` to `p2`.
3147 * If `p1` and `p2` are identical, returns `{x = 0, y = 0, z = 0}`.
3148 * `vector.distance(p1, p2)`:
3149 * Returns zero or a positive number, the distance between `p1` and `p2`.
3150 * `vector.length(v)`:
3151 * Returns zero or a positive number, the length of vector `v`.
3152 * `vector.normalize(v)`:
3153 * Returns a vector of length 1 with direction of vector `v`.
3154 * If `v` has zero length, returns `{x = 0, y = 0, z = 0}`.
3155 * `vector.floor(v)`:
3156 * Returns a vector, each dimension rounded down.
3157 * `vector.round(v)`:
3158 * Returns a vector, each dimension rounded to nearest integer.
3159 * `vector.apply(v, func)`:
3160 * Returns a vector where the function `func` has been applied to each
3162 * `vector.equals(v1, v2)`:
3163 * Returns a boolean, `true` if the vectors are identical.
3164 * `vector.sort(v1, v2)`:
3165 * Returns in order minp, maxp vectors of the cuboid defined by `v1`, `v2`.
3166 * `vector.angle(v1, v2)`:
3167 * Returns the angle between `v1` and `v2` in radians.
3168 * `vector.dot(v1, v2)`:
3169 * Returns the dot product of `v1` and `v2`.
3170 * `vector.cross(v1, v2)`:
3171 * Returns the cross product of `v1` and `v2`.
3172 * `vector.offset(v, x, y, z)`:
3173 * Returns the sum of the vectors `v` and `{x = x, y = y, z = z}`.
3175 For the following functions `x` can be either a vector or a number:
3177 * `vector.add(v, x)`:
3179 * If `x` is a vector: Returns the sum of `v` and `x`.
3180 * If `x` is a number: Adds `x` to each component of `v`.
3181 * `vector.subtract(v, x)`:
3183 * If `x` is a vector: Returns the difference of `v` subtracted by `x`.
3184 * If `x` is a number: Subtracts `x` from each component of `v`.
3185 * `vector.multiply(v, s)`:
3186 * Returns a scaled vector.
3187 * Deprecated: If `s` is a vector: Returns the Schur product.
3188 * `vector.divide(v, s)`:
3189 * Returns a scaled vector.
3190 * Deprecated: If `s` is a vector: Returns the Schur quotient.
3192 For the following functions `a` is an angle in radians and `r` is a rotation
3193 vector ({x = <pitch>, y = <yaw>, z = <roll>}) where pitch, yaw and roll are
3196 * `vector.rotate(v, r)`:
3197 * Applies the rotation `r` to `v` and returns the result.
3198 * `vector.rotate({x = 0, y = 0, z = 1}, r)` and
3199 `vector.rotate({x = 0, y = 1, z = 0}, r)` return vectors pointing
3200 forward and up relative to an entity's rotation `r`.
3201 * `vector.rotate_around_axis(v1, v2, a)`:
3202 * Returns `v1` rotated around axis `v2` by `a` radians according to
3203 the right hand rule.
3204 * `vector.dir_to_rotation(direction[, up])`:
3205 * Returns a rotation vector for `direction` pointing forward using `up`
3207 * If `up` is omitted, the roll of the returned vector defaults to zero.
3208 * Otherwise `direction` and `up` need to be vectors in a 90 degree angle to each other.
3216 * `dump2(obj, name, dumped)`: returns a string which makes `obj`
3217 human-readable, handles reference loops.
3218 * `obj`: arbitrary variable
3219 * `name`: string, default: `"_"`
3220 * `dumped`: table, default: `{}`
3221 * `dump(obj, dumped)`: returns a string which makes `obj` human-readable
3222 * `obj`: arbitrary variable
3223 * `dumped`: table, default: `{}`
3224 * `math.hypot(x, y)`
3225 * Get the hypotenuse of a triangle with legs x and y.
3226 Useful for distance calculation.
3227 * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
3228 * Get the sign of a number.
3229 * tolerance: number, default: `0.0`
3230 * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
3232 * `math.factorial(x)`: returns the factorial of `x`
3233 * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
3234 * `separator`: string, default: `","`
3235 * `include_empty`: boolean, default: `false`
3236 * `max_splits`: number, if it's negative, splits aren't limited,
3238 * `sep_is_pattern`: boolean, it specifies whether separator is a plain
3239 string or a pattern (regex), default: `false`
3240 * e.g. `"a,b":split","` returns `{"a","b"}`
3241 * `string:trim()`: returns the string without whitespace pre- and suffixes
3242 * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
3243 * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
3244 * Adds newlines to the string to keep it within the specified character
3246 * Note that the returned lines may be longer than the limit since it only
3247 splits at word borders.
3248 * `limit`: number, maximal amount of characters in one line
3249 * `as_table`: boolean, if set to true, a table of lines instead of a string
3250 is returned, default: `false`
3251 * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
3252 * `pos`: table {x=X, y=Y, z=Z}
3253 * Converts the position `pos` to a human-readable, printable string
3254 * `decimal_places`: number, if specified, the x, y and z values of
3255 the position are rounded to the given decimal place.
3256 * `minetest.string_to_pos(string)`: returns a position or `nil`
3257 * Same but in reverse.
3258 * If the string can't be parsed to a position, nothing is returned.
3259 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
3260 * Converts a string representing an area box into two positions
3261 * `minetest.formspec_escape(string)`: returns a string
3262 * escapes the characters "[", "]", "\", "," and ";", which can not be used
3264 * `minetest.is_yes(arg)`
3265 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
3266 * `minetest.is_nan(arg)`
3267 * returns true when the passed number represents NaN.
3268 * `minetest.get_us_time()`
3269 * returns time with microsecond precision. May not return wall time.
3270 * This value might overflow on certain 32-bit systems!
3271 * `table.copy(table)`: returns a table
3272 * returns a deep copy of `table`
3273 * `table.indexof(list, val)`: returns the smallest numerical index containing
3274 the value `val` in the table `list`. Non-numerical indices are ignored.
3275 If `val` could not be found, `-1` is returned. `list` must not have
3277 * `table.insert_all(table, other_table)`:
3278 * Appends all values in `other_table` to `table` - uses `#table + 1` to
3280 * `table.key_value_swap(t)`: returns a table with keys and values swapped
3281 * If multiple keys in `t` map to the same value, it is unspecified which
3282 value maps to that key.
3283 * `table.shuffle(table, [from], [to], [random_func])`:
3284 * Shuffles elements `from` to `to` in `table` in place
3285 * `from` defaults to `1`
3286 * `to` defaults to `#table`
3287 * `random_func` defaults to `math.random`. This function receives two
3288 integers as arguments and should return a random integer inclusively
3290 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
3292 * returns the exact position on the surface of a pointed node
3293 * `minetest.get_dig_params(groups, tool_capabilities)`: Simulates a tool
3295 Returns a table with the following fields:
3296 * `diggable`: `true` if node can be dug, `false` otherwise.
3297 * `time`: Time it would take to dig the node.
3298 * `wear`: How much wear would be added to the tool.
3299 `time` and `wear` are meaningless if node's not diggable
3301 * `groups`: Table of the node groups of the node that would be dug
3302 * `tool_capabilities`: Tool capabilities table of the tool
3303 * `minetest.get_hit_params(groups, tool_capabilities [, time_from_last_punch])`:
3304 Simulates an item that punches an object.
3305 Returns a table with the following fields:
3306 * `hp`: How much damage the punch would cause.
3307 * `wear`: How much wear would be added to the tool.
3309 * `groups`: Damage groups of the object
3310 * `tool_capabilities`: Tool capabilities table of the item
3311 * `time_from_last_punch`: time in seconds since last punch action
3319 Texts can be translated client-side with the help of `minetest.translate` and
3322 Translating a string
3323 --------------------
3325 Two functions are provided to translate strings: `minetest.translate` and
3326 `minetest.get_translator`.
3328 * `minetest.get_translator(textdomain)` is a simple wrapper around
3329 `minetest.translate`, and `minetest.get_translator(textdomain)(str, ...)` is
3330 equivalent to `minetest.translate(textdomain, str, ...)`.
3331 It is intended to be used in the following way, so that it avoids verbose
3332 repetitions of `minetest.translate`:
3334 local S = minetest.get_translator(textdomain)
3337 As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
3339 * `minetest.translate(textdomain, str, ...)` translates the string `str` with
3340 the given `textdomain` for disambiguation. The textdomain must match the
3341 textdomain specified in the translation file in order to get the string
3342 translated. This can be used so that a string is translated differently in
3344 It is advised to use the name of the mod as textdomain whenever possible, to
3345 avoid clashes with other mods.
3346 This function must be given a number of arguments equal to the number of
3347 arguments the translated string expects.
3348 Arguments are literal strings -- they will not be translated, so if you want
3349 them to be, they need to come as outputs of `minetest.translate` as well.
3351 For instance, suppose we want to translate "@1 Wool" with "@1" being replaced
3352 by the translation of "Red". We can do the following:
3354 local S = minetest.get_translator()
3355 S("@1 Wool", S("Red"))
3357 This will be displayed as "Red Wool" on old clients and on clients that do
3358 not have localization enabled. However, if we have for instance a translation
3359 file named `wool.fr.tr` containing the following:
3364 this will be displayed as "Laine Rouge" on clients with a French locale.
3366 Operations on translated strings
3367 --------------------------------
3369 The output of `minetest.translate` is a string, with escape sequences adding
3370 additional information to that string so that it can be translated on the
3371 different clients. In particular, you can't expect operations like string.length
3372 to work on them like you would expect them to, or string.gsub to work in the
3373 expected manner. However, string concatenation will still work as expected
3374 (note that you should only use this for things like formspecs; do not translate
3375 sentences by breaking them into parts; arguments should be used instead), and
3376 operations such as `minetest.colorize` which are also concatenation.
3378 Translation file format
3379 -----------------------
3381 A translation file has the suffix `.[lang].tr`, where `[lang]` is the language
3382 it corresponds to. It must be put into the `locale` subdirectory of the mod.
3383 The file should be a text file, with the following format:
3385 * Lines beginning with `# textdomain:` (the space is significant) can be used
3386 to specify the text domain of all following translations in the file.
3387 * All other empty lines or lines beginning with `#` are ignored.
3388 * Other lines should be in the format `original=translated`. Both `original`
3389 and `translated` can contain escape sequences beginning with `@` to insert
3390 arguments, literal `@`, `=` or newline (See [Escapes] below).
3391 There must be no extraneous whitespace around the `=` or at the beginning or
3392 the end of the line.
3397 Strings that need to be translated can contain several escapes, preceded by `@`.
3399 * `@@` acts as a literal `@`.
3400 * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated
3401 string that will be inlined when translated. Due to how translations are
3402 implemented, the original translation string **must** have its arguments in
3403 increasing order, without gaps or repetitions, starting from 1.
3404 * `@=` acts as a literal `=`. It is not required in strings given to
3405 `minetest.translate`, but is in translation files to avoid being confused
3406 with the `=` separating the original from the translation.
3407 * `@\n` (where the `\n` is a literal newline) acts as a literal newline.
3408 As with `@=`, this escape is not required in strings given to
3409 `minetest.translate`, but is in translation files.
3410 * `@n` acts as a literal newline as well.
3412 Server side translations
3413 ------------------------
3415 On some specific cases, server translation could be useful. For example, filter
3416 a list on labels and send results to client. A method is supplied to achieve
3419 `minetest.get_translated_string(lang_code, string)`: Translates `string` using
3420 translations for `lang_code` language. It gives the same result as if the string
3421 was translated by the client.
3423 The `lang_code` to use for a given player can be retrieved from
3424 the table returned by `minetest.get_player_information(name)`.
3426 IMPORTANT: This functionality should only be used for sorting, filtering or similar purposes.
3427 You do not need to use this to get translated strings to show up on the client.
3432 Perlin noise creates a continuously-varying value depending on the input values.
3433 Usually in Minetest the input values are either 2D or 3D co-ordinates in nodes.
3434 The result is used during map generation to create the terrain shape, vary heat
3435 and humidity to distribute biomes, vary the density of decorations or vary the
3438 Structure of perlin noise
3439 -------------------------
3441 An 'octave' is a simple noise generator that outputs a value between -1 and 1.
3442 The smooth wavy noise it generates has a single characteristic scale, almost
3443 like a 'wavelength', so on its own does not create fine detail.
3444 Due to this perlin noise combines several octaves to create variation on
3445 multiple scales. Each additional octave has a smaller 'wavelength' than the
3448 This combination results in noise varying very roughly between -2.0 and 2.0 and
3449 with an average value of 0.0, so `scale` and `offset` are then used to multiply
3450 and offset the noise variation.
3452 The final perlin noise variation is created as follows:
3454 noise = offset + scale * (octave1 +
3455 octave2 * persistence +
3456 octave3 * persistence ^ 2 +
3457 octave4 * persistence ^ 3 +
3463 Noise Parameters are commonly called `NoiseParams`.
3467 After the multiplication by `scale` this is added to the result and is the final
3468 step in creating the noise value.
3469 Can be positive or negative.
3473 Once all octaves have been combined, the result is multiplied by this.
3474 Can be positive or negative.
3478 For octave1, this is roughly the change of input value needed for a very large
3479 variation in the noise value generated by octave1. It is almost like a
3480 'wavelength' for the wavy noise variation.
3481 Each additional octave has a 'wavelength' that is smaller than the previous
3482 octave, to create finer detail. `spread` will therefore roughly be the typical
3483 size of the largest structures in the final noise variation.
3485 `spread` is a vector with values for x, y, z to allow the noise variation to be
3486 stretched or compressed in the desired axes.
3487 Values are positive numbers.
3491 This is a whole number that determines the entire pattern of the noise
3492 variation. Altering it enables different noise patterns to be created.
3493 With other parameters equal, different seeds produce different noise patterns
3494 and identical seeds produce identical noise patterns.
3496 For this parameter you can randomly choose any whole number. Usually it is
3497 preferable for this to be different from other seeds, but sometimes it is useful
3498 to be able to create identical noise patterns.
3500 In some noise APIs the world seed is added to the seed specified in noise
3501 parameters. This is done to make the resulting noise pattern vary in different
3502 worlds, and be 'world-specific'.
3506 The number of simple noise generators that are combined.
3507 A whole number, 1 or more.
3508 Each additional octave adds finer detail to the noise but also increases the
3509 noise calculation load.
3510 3 is a typical minimum for a high quality, complex and natural-looking noise
3511 variation. 1 octave has a slight 'gridlike' appearence.
3513 Choose the number of octaves according to the `spread` and `lacunarity`, and the
3514 size of the finest detail you require. For example:
3515 if `spread` is 512 nodes, `lacunarity` is 2.0 and finest detail required is 16
3516 nodes, octaves will be 6 because the 'wavelengths' of the octaves will be
3517 512, 256, 128, 64, 32, 16 nodes.
3518 Warning: If the 'wavelength' of any octave falls below 1 an error will occur.
3522 Each additional octave has an amplitude that is the amplitude of the previous
3523 octave multiplied by `persistence`, to reduce the amplitude of finer details,
3524 as is often helpful and natural to do so.
3525 Since this controls the balance of fine detail to large-scale detail
3526 `persistence` can be thought of as the 'roughness' of the noise.
3528 A positive or negative non-zero number, often between 0.3 and 1.0.
3529 A common medium value is 0.5, such that each octave has half the amplitude of
3530 the previous octave.
3531 This may need to be tuned when altering `lacunarity`; when doing so consider
3532 that a common medium value is 1 / lacunarity.
3536 Each additional octave has a 'wavelength' that is the 'wavelength' of the
3537 previous octave multiplied by 1 / lacunarity, to create finer detail.
3538 'lacunarity' is often 2.0 so 'wavelength' often halves per octave.
3540 A positive number no smaller than 1.0.
3541 Values below 2.0 create higher quality noise at the expense of requiring more
3542 octaves to cover a paticular range of 'wavelengths'.
3546 Leave this field unset for no special handling.
3547 Currently supported are `defaults`, `eased` and `absvalue`:
3551 Specify this if you would like to keep auto-selection of eased/not-eased while
3552 specifying some other flags.
3556 Maps noise gradient values onto a quintic S-curve before performing
3557 interpolation. This results in smooth, rolling noise.
3558 Disable this (`noeased`) for sharp-looking noise with a slightly gridded
3560 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is
3562 Easing a 3D noise significantly increases the noise calculation load, so use
3567 The absolute value of each octave's noise variation is used when combining the
3568 octaves. The final perlin noise variation is created as follows:
3570 noise = offset + scale * (abs(octave1) +
3571 abs(octave2) * persistence +
3572 abs(octave3) * persistence ^ 2 +
3573 abs(octave4) * persistence ^ 3 +
3578 For 2D or 3D perlin noise or perlin noise maps:
3583 spread = {x = 500, y = 500, z = 500},
3588 flags = "defaults, absvalue",
3591 For 2D noise the Z component of `spread` is still defined but is ignored.
3592 A single noise parameter table can be used for 2D or 3D noise.
3603 These tell in what manner the ore is generated.
3605 All default ores are of the uniformly-distributed scatter type.
3609 Randomly chooses a location and generates a cluster of ore.
3611 If `noise_params` is specified, the ore will be placed if the 3D perlin noise
3612 at that point is greater than the `noise_threshold`, giving the ability to
3613 create a non-equal distribution of ore.
3617 Creates a sheet of ore in a blob shape according to the 2D perlin noise
3618 described by `noise_params` and `noise_threshold`. This is essentially an
3619 improved version of the so-called "stratus" ore seen in some unofficial mods.
3621 This sheet consists of vertical columns of uniform randomly distributed height,
3622 varying between the inclusive range `column_height_min` and `column_height_max`.
3623 If `column_height_min` is not specified, this parameter defaults to 1.
3624 If `column_height_max` is not specified, this parameter defaults to `clust_size`
3625 for reverse compatibility. New code should prefer `column_height_max`.
3627 The `column_midpoint_factor` parameter controls the position of the column at
3628 which ore emanates from.
3629 If 1, columns grow upward. If 0, columns grow downward. If 0.5, columns grow
3630 equally starting from each direction.
3631 `column_midpoint_factor` is a decimal number ranging in value from 0 to 1. If
3632 this parameter is not specified, the default is 0.5.
3634 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this
3639 Creates a sheet of ore in a cloud-like puff shape.
3641 As with the `sheet` ore type, the size and shape of puffs are described by
3642 `noise_params` and `noise_threshold` and are placed at random vertical
3643 positions within the currently generated chunk.
3645 The vertical top and bottom displacement of each puff are determined by the
3646 noise parameters `np_puff_top` and `np_puff_bottom`, respectively.
3650 Creates a deformed sphere of ore according to 3d perlin noise described by
3651 `noise_params`. The maximum size of the blob is `clust_size`, and
3652 `clust_scarcity` has the same meaning as with the `scatter` type.
3656 Creates veins of ore varying in density by according to the intersection of two
3657 instances of 3d perlin noise with different seeds, both described by
3660 `random_factor` varies the influence random chance has on placement of an ore
3661 inside the vein, which is `1` by default. Note that modifying this parameter
3662 may require adjusting `noise_threshold`.
3664 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
3667 This ore type is difficult to control since it is sensitive to small changes.
3668 The following is a decent set of parameters to work from:
3673 spread = {x=200, y=200, z=200},
3680 noise_threshold = 1.6
3682 **WARNING**: Use this ore type *very* sparingly since it is ~200x more
3683 computationally expensive than any other ore.
3687 Creates a single undulating ore stratum that is continuous across mapchunk
3688 borders and horizontally spans the world.
3690 The 2D perlin noise described by `noise_params` defines the Y co-ordinate of
3691 the stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
3692 defines the stratum's vertical thickness (in units of nodes). Due to being
3693 continuous across mapchunk borders the stratum's vertical thickness is
3696 If the noise parameter `noise_params` is omitted the ore will occur from y_min
3697 to y_max in a simple horizontal stratum.
3699 A parameter `stratum_thickness` can be provided instead of the noise parameter
3700 `np_stratum_thickness`, to create a constant thickness.
3702 Leaving out one or both noise parameters makes the ore generation less
3703 intensive, useful when adding multiple strata.
3705 `y_min` and `y_max` define the limits of the ore generation and for performance
3706 reasons should be set as close together as possible but without clipping the
3707 stratum's Y variation.
3709 Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
3710 solid-ore stratum would require a `clust_scarcity` of 1.
3712 The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
3713 `random_factor` are ignored by this ore type.
3718 See section [Flag Specifier Format].
3720 Currently supported flags:
3721 `puff_cliffs`, `puff_additive_composition`.
3725 If set, puff ore generation will not taper down large differences in
3726 displacement when approaching the edge of a puff. This flag has no effect for
3727 ore types other than `puff`.
3729 ### `puff_additive_composition`
3731 By default, when noise described by `np_puff_top` or `np_puff_bottom` results
3732 in a negative displacement, the sub-column at that point is not generated. With
3733 this attribute set, puff ore generation will instead generate the absolute
3734 difference in noise displacement values. This flag has no effect for ore types
3743 The varying types of decorations that can be placed.
3748 Creates a 1 times `H` times 1 column of a specified node (or a random node from
3749 a list, if a decoration list is specified). Can specify a certain node it must
3750 spawn next to, such as water or lava, for example. Can also generate a
3751 decoration of random height between a specified lower and upper bound.
3752 This type of decoration is intended for placement of grass, flowers, cacti,
3753 papyri, waterlilies and so on.
3758 Copies a box of `MapNodes` from a specified schematic file (or raw description).
3759 Can specify a probability of a node randomly appearing when placed.
3760 This decoration type is intended to be used for multi-node sized discrete
3761 structures, such as trees, cave spikes, rocks, and so on.
3770 --------------------
3772 A schematic specifier identifies a schematic by either a filename to a
3773 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
3774 in the form of a table. This table specifies the following fields:
3776 * The `size` field is a 3D vector containing the dimensions of the provided
3777 schematic. (required field)
3778 * The `yslice_prob` field is a table of {ypos, prob} slice tables. A slice table
3779 sets the probability of a particular horizontal slice of the schematic being
3780 placed. (optional field)
3781 `ypos` = 0 for the lowest horizontal slice of a schematic.
3782 The default of `prob` is 255.
3783 * The `data` field is a flat table of MapNode tables making up the schematic,
3784 in the order of `[z [y [x]]]`. (required field)
3785 Each MapNode table contains:
3786 * `name`: the name of the map node to place (required)
3787 * `prob` (alias `param1`): the probability of this node being placed
3789 * `param2`: the raw param2 value of the node being placed onto the map
3791 * `force_place`: boolean representing if the node should forcibly overwrite
3792 any previous contents (default: false)
3794 About probability values:
3796 * A probability value of `0` or `1` means that node will never appear
3798 * A probability value of `254` or `255` means the node will always appear
3800 * If the probability value `p` is greater than `1`, then there is a
3801 `(p / 256 * 100)` percent chance that node will appear when the schematic is
3804 Schematic attributes
3805 --------------------
3807 See section [Flag Specifier Format].
3809 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
3812 * `place_center_x`: Placement of this decoration is centered along the X axis.
3813 * `place_center_y`: Placement of this decoration is centered along the Y axis.
3814 * `place_center_z`: Placement of this decoration is centered along the Z axis.
3815 * `force_placement`: Schematic nodes other than "ignore" will replace existing
3821 Lua Voxel Manipulator
3822 =====================
3827 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator'
3828 facility. The purpose of this object is for fast, low-level, bulk access to
3829 reading and writing Map content. As such, setting map nodes through VoxelManip
3830 will lack many of the higher level features and concepts you may be used to
3831 with other methods of setting nodes. For example, nodes will not have their
3832 construction and destruction callbacks run, and no rollback information is
3835 It is important to note that VoxelManip is designed for speed, and *not* ease
3836 of use or flexibility. If your mod requires a map manipulation facility that
3837 will handle 100% of all edge cases, or the use of high level node placement
3838 features, perhaps `minetest.set_node()` is better suited for the job.
3840 In addition, VoxelManip might not be faster, or could even be slower, for your
3841 specific use case. VoxelManip is most effective when setting large areas of map
3842 at once - for example, if only setting a 3x3x3 node area, a
3843 `minetest.set_node()` loop may be more optimal. Always profile code using both
3844 methods of map manipulation to determine which is most appropriate for your
3847 A recent simple test of setting cubic areas showed that `minetest.set_node()`
3848 is faster than a VoxelManip for a 3x3x3 node cube or smaller.
3853 A VoxelManip object can be created any time using either:
3854 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
3856 If the optional position parameters are present for either of these routines,
3857 the specified region will be pre-loaded into the VoxelManip object on creation.
3858 Otherwise, the area of map you wish to manipulate must first be loaded into the
3859 VoxelManip object using `VoxelManip:read_from_map()`.
3861 Note that `VoxelManip:read_from_map()` returns two position vectors. The region
3862 formed by these positions indicate the minimum and maximum (respectively)
3863 positions of the area actually loaded in the VoxelManip, which may be larger
3864 than the area requested. For convenience, the loaded area coordinates can also
3865 be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
3867 Now that the VoxelManip object is populated with map data, your mod can fetch a
3868 copy of this data using either of two methods. `VoxelManip:get_node_at()`,
3869 which retrieves an individual node in a MapNode formatted table at the position
3870 requested is the simplest method to use, but also the slowest.
3872 Nodes in a VoxelManip object may also be read in bulk to a flat array table
3875 * `VoxelManip:get_data()` for node content (in Content ID form, see section
3877 * `VoxelManip:get_light_data()` for node light levels, and
3878 * `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
3880 See section [Flat array format] for more details.
3882 It is very important to understand that the tables returned by any of the above
3883 three functions represent a snapshot of the VoxelManip's internal state at the
3884 time of the call. This copy of the data will not magically update itself if
3885 another function modifies the internal VoxelManip state.
3886 Any functions that modify a VoxelManip's contents work on the VoxelManip's
3887 internal state unless otherwise explicitly stated.
3889 Once the bulk data has been edited to your liking, the internal VoxelManip
3890 state can be set using:
3892 * `VoxelManip:set_data()` for node content (in Content ID form, see section
3894 * `VoxelManip:set_light_data()` for node light levels, and
3895 * `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
3897 The parameter to each of the above three functions can use any table at all in
3898 the same flat array format as produced by `get_data()` etc. and is not required
3899 to be a table retrieved from `get_data()`.
3901 Once the internal VoxelManip state has been modified to your liking, the
3902 changes can be committed back to the map by calling `VoxelManip:write_to_map()`
3904 ### Flat array format
3907 `Nx = p2.X - p1.X + 1`,
3908 `Ny = p2.Y - p1.Y + 1`, and
3909 `Nz = p2.Z - p1.Z + 1`.
3911 Then, for a loaded region of p1..p2, this array ranges from `1` up to and
3912 including the value of the expression `Nx * Ny * Nz`.
3914 Positions offset from p1 are present in the array with the format of:
3917 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
3918 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
3920 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
3921 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
3923 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
3925 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
3928 and the array index for a position p contained completely in p1..p2 is:
3930 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
3932 Note that this is the same "flat 3D array" format as
3933 `PerlinNoiseMap:get3dMap_flat()`.
3934 VoxelArea objects (see section [`VoxelArea`]) can be used to simplify calculation
3935 of the index for a single point in a flat VoxelManip array.
3939 A Content ID is a unique integer identifier for a specific node type.
3940 These IDs are used by VoxelManip in place of the node name string for
3941 `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
3942 `minetest.get_content_id()` to look up the Content ID for the specified node
3943 name, and `minetest.get_name_from_content_id()` to look up the node name string
3944 for a given Content ID.
3945 After registration of a node, its Content ID will remain the same throughout
3946 execution of the mod.
3947 Note that the node being queried needs to have already been been registered.
3949 The following builtin node types have their Content IDs defined as constants:
3951 * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
3952 * `minetest.CONTENT_AIR`: ID for "air" nodes
3953 * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
3955 ### Mapgen VoxelManip objects
3957 Inside of `on_generated()` callbacks, it is possible to retrieve the same
3958 VoxelManip object used by the core's Map Generator (commonly abbreviated
3959 Mapgen). Most of the rules previously described still apply but with a few
3962 * The Mapgen VoxelManip object is retrieved using:
3963 `minetest.get_mapgen_object("voxelmanip")`
3964 * This VoxelManip object already has the region of map just generated loaded
3965 into it; it's not necessary to call `VoxelManip:read_from_map()` before using
3966 a Mapgen VoxelManip.
3967 * The `on_generated()` callbacks of some mods may place individual nodes in the
3968 generated area using non-VoxelManip map modification methods. Because the
3969 same Mapgen VoxelManip object is passed through each `on_generated()`
3970 callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3971 consistency with the current map state. For this reason, calling any of the
3972 following functions:
3973 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3974 will also update the Mapgen VoxelManip object's internal state active on the
3976 * After modifying the Mapgen VoxelManip object's internal buffer, it may be
3977 necessary to update lighting information using either:
3978 `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3980 ### Other API functions operating on a VoxelManip
3982 If any VoxelManip contents were set to a liquid node,
3983 `VoxelManip:update_liquids()` must be called for these liquid nodes to begin
3984 flowing. It is recommended to call this function only after having written all
3985 buffered data back to the VoxelManip object, save for special situations where
3986 the modder desires to only have certain liquid nodes begin flowing.
3988 The functions `minetest.generate_ores()` and `minetest.generate_decorations()`
3989 will generate all registered decorations and ores throughout the full area
3990 inside of the specified VoxelManip object.
3992 `minetest.place_schematic_on_vmanip()` is otherwise identical to
3993 `minetest.place_schematic()`, except instead of placing the specified schematic
3994 directly on the map at the specified position, it will place the schematic
3995 inside the VoxelManip.
3999 * Attempting to read data from a VoxelManip object before map is read will
4000 result in a zero-length array table for `VoxelManip:get_data()`, and an
4001 "ignore" node at any position for `VoxelManip:get_node_at()`.
4002 * If either a region of map has not yet been generated or is out-of-bounds of
4003 the map, that region is filled with "ignore" nodes.
4004 * Other mods, or the core itself, could possibly modify the area of map
4005 currently loaded into a VoxelManip object. With the exception of Mapgen
4006 VoxelManips (see above section), the internal buffers are not updated. For
4007 this reason, it is strongly encouraged to complete the usage of a particular
4008 VoxelManip object in the same callback it had been created.
4009 * If a VoxelManip object will be used often, such as in an `on_generated()`
4010 callback, consider passing a file-scoped table as the optional parameter to
4011 `VoxelManip:get_data()`, which serves as a static buffer the function can use
4012 to write map data to instead of returning a new table each call. This greatly
4013 enhances performance by avoiding unnecessary memory allocations.
4018 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object
4019 containing the region formed by `p1` and `p2`.
4020 * returns actual emerged `pmin`, actual emerged `pmax`
4021 * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to
4023 * **important**: data must be set using `VoxelManip:set_data()` before
4025 * if `light` is true, then lighting is automatically recalculated.
4026 The default value is true.
4027 If `light` is false, no light calculations happen, and you should correct
4028 all modified blocks with `minetest.fix_light()` as soon as possible.
4029 Keep in mind that modifying the map where light is incorrect can cause
4031 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
4032 the `VoxelManip` at that position
4033 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
4035 * `get_data([buffer])`: Retrieves the node content data loaded into the
4036 `VoxelManip` object.
4037 * returns raw node data in the form of an array of node content IDs
4038 * if the param `buffer` is present, this table will be used to store the
4040 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
4041 * `update_map()`: Does nothing, kept for compatibility.
4042 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to
4044 * `light` is a table, `{day=<0...15>, night=<0...15>}`
4045 * To be used only by a `VoxelManip` object from
4046 `minetest.get_mapgen_object`.
4047 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4049 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
4050 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4052 * Each value is the bitwise combination of day and night light values
4054 * `light = day + (night * 16)`
4055 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
4056 in the `VoxelManip`.
4057 * expects lighting data in the same format that `get_light_data()` returns
4058 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the
4059 `VoxelManip` object.
4060 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4062 * If the param `buffer` is present, this table will be used to store the
4064 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in
4066 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the
4068 * To be used only by a `VoxelManip` object from
4069 `minetest.get_mapgen_object`.
4070 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4071 area if left out or nil. For almost all uses these should be left out
4072 or nil to use the default.
4073 * `propagate_shadow` is an optional boolean deciding whether shadows in a
4074 generated mapchunk above are propagated down into the mapchunk, defaults
4075 to `true` if left out.
4076 * `update_liquids()`: Update liquid flow
4077 * `was_modified()`: Returns `true` or `false` if the data in the voxel
4078 manipulator had been modified since the last read from map, due to a call to
4079 `minetest.set_data()` on the loaded area elsewhere.
4080 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
4085 A helper class for voxel areas.
4086 It can be created via `VoxelArea:new{MinEdge = pmin, MaxEdge = pmax}`.
4087 The coordinates are *inclusive*, like most other things in Minetest.
4091 * `getExtent()`: returns a 3D vector containing the size of the area formed by
4092 `MinEdge` and `MaxEdge`.
4093 * `getVolume()`: returns the volume of the area formed by `MinEdge` and
4095 * `index(x, y, z)`: returns the index of an absolute position in a flat array
4097 * `x`, `y` and `z` must be integers to avoid an incorrect index result.
4098 * The position (x, y, z) is not checked for being inside the area volume,
4099 being outside can cause an incorrect index result.
4100 * Useful for things like `VoxelManip`, raw Schematic specifiers,
4101 `PerlinNoiseMap:get2d`/`3dMap`, and so on.
4102 * `indexp(p)`: same functionality as `index(x, y, z)` but takes a vector.
4103 * As with `index(x, y, z)`, the components of `p` must be integers, and `p`
4104 is not checked for being inside the area volume.
4105 * `position(i)`: returns the absolute position vector corresponding to index
4107 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by
4108 `MinEdge` and `MaxEdge`.
4109 * `containsp(p)`: same as above, except takes a vector
4110 * `containsi(i)`: same as above, except takes an index `i`
4111 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns
4113 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of
4115 * `iterp(minp, maxp)`: same as above, except takes a vector
4117 ### Y stride and z stride of a flat array
4119 For a particular position in a voxel area, whose flat array index is known,
4120 it is often useful to know the index of a neighboring or nearby position.
4121 The table below shows the changes of index required for 1 node movements along
4122 the axes in a voxel area:
4124 Movement Change of index
4134 local area = VoxelArea:new{MinEdge = emin, MaxEdge = emax}
4136 The values of `ystride` and `zstride` can be obtained using `area.ystride` and
4145 A mapgen object is a construct used in map generation. Mapgen objects can be
4146 used by an `on_generate` callback to speed up operations by avoiding
4147 unnecessary recalculations, these can be retrieved using the
4148 `minetest.get_mapgen_object()` function. If the requested Mapgen object is
4149 unavailable, or `get_mapgen_object()` was called outside of an `on_generate()`
4150 callback, `nil` is returned.
4152 The following Mapgen objects are currently available:
4156 This returns three values; the `VoxelManip` object to be used, minimum and
4157 maximum emerged position, in that order. All mapgens support this object.
4161 Returns an array containing the y coordinates of the ground levels of nodes in
4162 the most recently generated chunk by the current mapgen.
4166 Returns an array containing the biome IDs of nodes in the most recently
4167 generated chunk by the current mapgen.
4171 Returns an array containing the temperature values of nodes in the most
4172 recently generated chunk by the current mapgen.
4176 Returns an array containing the humidity values of nodes in the most recently
4177 generated chunk by the current mapgen.
4181 Returns a table mapping requested generation notification types to arrays of
4182 positions at which the corresponding generated structures are located within
4183 the current chunk. To set the capture of positions of interest to be recorded
4184 on generate, use `minetest.set_gen_notify()`.
4185 For decorations, the returned positions are the ground surface 'place_on'
4186 nodes, not the decorations themselves. A 'simple' type decoration is often 1
4187 node above the returned position and possibly displaced by 'place_offset_y'.
4189 Possible fields of the table returned are:
4195 * `large_cave_begin`
4199 Decorations have a key in the format of `"decoration#id"`, where `id` is the
4200 numeric unique decoration ID as returned by `minetest.get_decoration_id`.
4208 Functions receive a "luaentity" as `self`:
4210 * It has the member `.name`, which is the registered name `("mod:thing")`
4211 * It has the member `.object`, which is an `ObjectRef` pointing to the object
4212 * The original prototype stuff is visible directly via a metatable
4216 * `on_activate(self, staticdata, dtime_s)`
4217 * Called when the object is instantiated.
4218 * `dtime_s` is the time passed since the object was unloaded, which can be
4219 used for updating the entity state.
4220 * `on_deactivate(self)
4221 * Called when the object is about to get removed or unloaded.
4222 * `on_step(self, dtime)`
4223 * Called on every server tick, after movement and collision processing.
4224 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
4226 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)`
4227 * Called when somebody punches the object.
4228 * Note that you probably want to handle most punches using the automatic
4230 * `puncher`: an `ObjectRef` (can be `nil`)
4231 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4233 * `tool_capabilities`: capability table of used tool (can be `nil`)
4234 * `dir`: unit vector of direction of punch. Always defined. Points from the
4235 puncher to the punched.
4236 * `damage`: damage that will be done to entity.
4237 * Can return `true` to prevent the default damage mechanism.
4238 * `on_death(self, killer)`
4239 * Called when the object dies.
4240 * `killer`: an `ObjectRef` (can be `nil`)
4241 * `on_rightclick(self, clicker)`
4242 * `on_attach_child(self, child)`
4243 * `child`: an `ObjectRef` of the child that attaches
4244 * `on_detach_child(self, child)`
4245 * `child`: an `ObjectRef` of the child that detaches
4246 * `on_detach(self, parent)`
4247 * `parent`: an `ObjectRef` (can be `nil`) from where it got detached
4248 * This happens before the parent object is removed from the world
4249 * `get_staticdata(self)`
4250 * Should return a string that will be passed to `on_activate` when the
4251 object is instantiated the next time.
4263 axiom, --string initial tree axiom
4264 rules_a, --string rules set A
4265 rules_b, --string rules set B
4266 rules_c, --string rules set C
4267 rules_d, --string rules set D
4268 trunk, --string trunk node name
4269 leaves, --string leaves node name
4270 leaves2, --string secondary leaves node name
4271 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
4272 angle, --num angle in deg
4273 iterations, --num max # of iterations, usually 2 -5
4274 random_level, --num factor to lower nr of iterations, usually 0 - 3
4275 trunk_type, --string single/double/crossed) type of trunk: 1 node,
4276 -- 2x2 nodes or 3x3 in cross shape
4277 thin_branches, --boolean true -> use thin (1 node) branches
4278 fruit, --string fruit node name
4279 fruit_chance, --num chance (0-100) to replace leaves with fruit node
4280 seed, --num random seed, if no seed is provided, the engine
4284 Key for special L-System symbols used in axioms
4285 -----------------------------------------------
4287 * `G`: move forward one unit with the pen up
4288 * `F`: move forward one unit with the pen down drawing trunks and branches
4289 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
4290 * `T`: move forward one unit with the pen down drawing trunks only
4291 * `R`: move forward one unit with the pen down placing fruit
4292 * `A`: replace with rules set A
4293 * `B`: replace with rules set B
4294 * `C`: replace with rules set C
4295 * `D`: replace with rules set D
4296 * `a`: replace with rules set A, chance 90%
4297 * `b`: replace with rules set B, chance 80%
4298 * `c`: replace with rules set C, chance 70%
4299 * `d`: replace with rules set D, chance 60%
4300 * `+`: yaw the turtle right by `angle` parameter
4301 * `-`: yaw the turtle left by `angle` parameter
4302 * `&`: pitch the turtle down by `angle` parameter
4303 * `^`: pitch the turtle up by `angle` parameter
4304 * `/`: roll the turtle to the right by `angle` parameter
4305 * `*`: roll the turtle to the left by `angle` parameter
4306 * `[`: save in stack current state info
4307 * `]`: recover from stack state info
4312 Spawn a small apple tree:
4314 pos = {x=230,y=20,z=4}
4317 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
4318 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
4319 trunk="default:tree",
4320 leaves="default:leaves",
4324 trunk_type="single",
4327 fruit="default:apple"
4329 minetest.spawn_tree(pos,apple_tree)
4334 'minetest' namespace reference
4335 ==============================
4340 * `minetest.get_current_modname()`: returns the currently loading mod's name,
4342 * `minetest.get_modpath(modname)`: returns the directory path for a mod,
4343 e.g. `"/home/user/.minetest/usermods/modname"`.
4344 * Returns nil if the mod is not enabled or does not exist (not installed).
4345 * Works regardless of whether the mod has been loaded yet.
4346 * Useful for loading additional `.lua` modules or static data from a mod,
4347 or checking if a mod is enabled.
4348 * `minetest.get_modnames()`: returns a list of enabled mods, sorted alphabetically.
4349 * Does not include disabled mods, even if they are installed.
4350 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
4351 * Useful for storing custom data
4352 * `minetest.is_singleplayer()`
4353 * `minetest.features`: Table containing API feature flags
4356 glasslike_framed = true, -- 0.4.7
4357 nodebox_as_selectionbox = true, -- 0.4.7
4358 get_all_craft_recipes_works = true, -- 0.4.7
4359 -- The transparency channel of textures can optionally be used on
4361 use_texture_alpha = true,
4362 -- Tree and grass ABMs are no longer done from C++ (0.4.8)
4363 no_legacy_abms = true,
4364 -- Texture grouping is possible using parentheses (0.4.11)
4365 texture_names_parens = true,
4366 -- Unique Area ID for AreaStore:insert_area (0.4.14)
4367 area_store_custom_ids = true,
4368 -- add_entity supports passing initial staticdata to on_activate
4370 add_entity_with_staticdata = true,
4371 -- Chat messages are no longer predicted (0.4.16)
4372 no_chat_message_prediction = true,
4373 -- The transparency channel of textures can optionally be used on
4374 -- objects (ie: players and lua entities) (5.0.0)
4375 object_use_texture_alpha = true,
4376 -- Object selectionbox is settable independently from collisionbox
4378 object_independent_selectionbox = true,
4379 -- Specifies whether binary data can be uploaded or downloaded using
4380 -- the HTTP API (5.1.0)
4381 httpfetch_binary_data = true,
4382 -- Whether formspec_version[<version>] may be used (5.1.0)
4383 formspec_version_element = true,
4384 -- Whether AreaStore's IDs are kept on save/load (5.1.0)
4385 area_store_persistent_ids = true,
4386 -- Whether minetest.find_path is functional (5.2.0)
4387 pathfinder_works = true,
4388 -- Whether Collision info is available to an objects' on_step (5.3.0)
4389 object_step_has_moveresult = true,
4390 -- Whether get_velocity() and add_velocity() can be used on players (5.4.0)
4391 direct_velocity_on_players = true,
4392 -- nodedef's use_texture_alpha accepts new string modes (5.4.0)
4393 use_texture_alpha_string_modes = true,
4396 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
4397 * `arg`: string or table in format `{foo=true, bar=true}`
4398 * `missing_features`: `{foo=true, bar=true}`
4399 * `minetest.get_player_information(player_name)`: Table containing information
4400 about a player. Example return value:
4403 address = "127.0.0.1", -- IP address of client
4404 ip_version = 4, -- IPv4 / IPv6
4405 connection_uptime = 200, -- seconds since client connected
4406 protocol_version = 32, -- protocol version used by client
4407 formspec_version = 2, -- supported formspec version
4408 lang_code = "fr" -- Language code used for translation
4409 -- the following keys can be missing if no stats have been collected yet
4410 min_rtt = 0.01, -- minimum round trip time
4411 max_rtt = 0.2, -- maximum round trip time
4412 avg_rtt = 0.02, -- average round trip time
4413 min_jitter = 0.01, -- minimum packet time jitter
4414 max_jitter = 0.5, -- maximum packet time jitter
4415 avg_jitter = 0.03, -- average packet time jitter
4416 -- the following information is available in a debug build only!!!
4417 -- DO NOT USE IN MODS
4418 --ser_vers = 26, -- serialization version used by client
4419 --major = 0, -- major version number
4420 --minor = 4, -- minor version number
4421 --patch = 10, -- patch version number
4422 --vers_string = "0.4.9-git", -- full version string
4423 --state = "Active" -- current client state
4426 * `minetest.mkdir(path)`: returns success.
4427 * Creates a directory specified by `path`, creating parent directories
4428 if they don't exist.
4429 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
4431 * nil: return all entries,
4432 * true: return only subdirectory names, or
4433 * false: return only file names.
4434 * `minetest.safe_file_write(path, content)`: returns boolean indicating success
4435 * Replaces contents of file at path with new contents in a safe (atomic)
4436 way. Use this instead of below code when writing e.g. database files:
4437 `local f = io.open(path, "wb"); f:write(content); f:close()`
4438 * `minetest.get_version()`: returns a table containing components of the
4439 engine version. Components:
4440 * `project`: Name of the project, eg, "Minetest"
4441 * `string`: Simple version, eg, "1.2.3-dev"
4442 * `hash`: Full git version (only set if available),
4443 eg, "1.2.3-dev-01234567-dirty".
4444 Use this for informational purposes only. The information in the returned
4445 table does not represent the capabilities of the engine, nor is it
4446 reliable or verifiable. Compatible forks will have a different name and
4447 version entirely. To check for the presence of engine features, test
4448 whether the functions exported by the wanted features exist. For example:
4449 `if minetest.check_for_falling then ... end`.
4450 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
4451 * `data`: string of data to hash
4452 * `raw`: return raw bytes instead of hex digits, default: false
4457 * `minetest.debug(...)`
4458 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
4459 * `minetest.log([level,] text)`
4460 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
4461 `"info"`, or `"verbose"`. Default is `"none"`.
4463 Registration functions
4464 ----------------------
4466 Call these functions only at load time!
4470 * `minetest.register_node(name, node definition)`
4471 * `minetest.register_craftitem(name, item definition)`
4472 * `minetest.register_tool(name, item definition)`
4473 * `minetest.override_item(name, redefinition)`
4474 * Overrides fields of an item registered with register_node/tool/craftitem.
4475 * Note: Item must already be defined, (opt)depend on the mod defining it.
4476 * Example: `minetest.override_item("default:mese",
4477 {light_source=minetest.LIGHT_MAX})`
4478 * `minetest.unregister_item(name)`
4479 * Unregisters the item from the engine, and deletes the entry with key
4480 `name` from `minetest.registered_items` and from the associated item table
4481 according to its nature: `minetest.registered_nodes`, etc.
4482 * `minetest.register_entity(name, entity definition)`
4483 * `minetest.register_abm(abm definition)`
4484 * `minetest.register_lbm(lbm definition)`
4485 * `minetest.register_alias(alias, original_name)`
4486 * Also use this to set the 'mapgen aliases' needed in a game for the core
4487 mapgens. See [Mapgen aliases] section above.
4488 * `minetest.register_alias_force(alias, original_name)`
4489 * `minetest.register_ore(ore definition)`
4490 * Returns an integer object handle uniquely identifying the registered
4492 * The order of ore registrations determines the order of ore generation.
4493 * `minetest.register_biome(biome definition)`
4494 * Returns an integer object handle uniquely identifying the registered
4495 biome on success. To get the biome ID, use `minetest.get_biome_id`.
4496 * `minetest.unregister_biome(name)`
4497 * Unregisters the biome from the engine, and deletes the entry with key
4498 `name` from `minetest.registered_biomes`.
4499 * Warning: This alters the biome to biome ID correspondences, so any
4500 decorations or ores using the 'biomes' field must afterwards be cleared
4502 * `minetest.register_decoration(decoration definition)`
4503 * Returns an integer object handle uniquely identifying the registered
4504 decoration on success. To get the decoration ID, use
4505 `minetest.get_decoration_id`.
4506 * The order of decoration registrations determines the order of decoration
4508 * `minetest.register_schematic(schematic definition)`
4509 * Returns an integer object handle uniquely identifying the registered
4510 schematic on success.
4511 * If the schematic is loaded from a file, the `name` field is set to the
4513 * If the function is called when loading the mod, and `name` is a relative
4514 path, then the current mod path will be prepended to the schematic
4516 * `minetest.clear_registered_biomes()`
4517 * Clears all biomes currently registered.
4518 * Warning: Clearing and re-registering biomes alters the biome to biome ID
4519 correspondences, so any decorations or ores using the 'biomes' field must
4520 afterwards be cleared and re-registered.
4521 * `minetest.clear_registered_decorations()`
4522 * Clears all decorations currently registered.
4523 * `minetest.clear_registered_ores()`
4524 * Clears all ores currently registered.
4525 * `minetest.clear_registered_schematics()`
4526 * Clears all schematics currently registered.
4530 * `minetest.register_craft(recipe)`
4531 * Check recipe table syntax for different types below.
4532 * `minetest.clear_craft(recipe)`
4533 * Will erase existing craft based either on output item or on input recipe.
4534 * Specify either output or input only. If you specify both, input will be
4535 ignored. For input use the same recipe table syntax as for
4536 `minetest.register_craft(recipe)`. For output specify only the item,
4538 * Returns false if no erase candidate could be found, otherwise returns true.
4539 * **Warning**! The type field ("shaped", "cooking" or any other) will be
4540 ignored if the recipe contains output. Erasing is then done independently
4541 from the crafting method.
4542 * `minetest.register_chatcommand(cmd, chatcommand definition)`
4543 * `minetest.override_chatcommand(name, redefinition)`
4544 * Overrides fields of a chatcommand registered with `register_chatcommand`.
4545 * `minetest.unregister_chatcommand(name)`
4546 * Unregisters a chatcommands registered with `register_chatcommand`.
4547 * `minetest.register_privilege(name, definition)`
4548 * `definition` can be a description or a definition table (see [Privilege
4550 * If it is a description, the priv will be granted to singleplayer and admin
4552 * To allow players with `basic_privs` to grant, see the `basic_privs`
4553 minetest.conf setting.
4554 * `minetest.register_authentication_handler(authentication handler definition)`
4555 * Registers an auth handler that overrides the builtin one.
4556 * This function can be called by a single mod once only.
4558 Global callback registration functions
4559 --------------------------------------
4561 Call these functions only at load time!
4563 * `minetest.register_globalstep(function(dtime))`
4564 * Called every server step, usually interval of 0.1s
4565 * `minetest.register_on_mods_loaded(function())`
4566 * Called after mods have finished loading and before the media is cached or the
4568 * `minetest.register_on_shutdown(function())`
4569 * Called before server shutdown
4570 * **Warning**: If the server terminates abnormally (i.e. crashes), the
4571 registered callbacks **will likely not be run**. Data should be saved at
4572 semi-frequent intervals as well as on server shutdown.
4573 * `minetest.register_on_placenode(function(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
4574 * Called when a node has been placed
4575 * If return `true` no item is taken from `itemstack`
4576 * `placer` may be any valid ObjectRef or nil.
4577 * **Not recommended**; use `on_construct` or `after_place_node` in node
4578 definition whenever possible.
4579 * `minetest.register_on_dignode(function(pos, oldnode, digger))`
4580 * Called when a node has been dug.
4581 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node
4582 definition whenever possible.
4583 * `minetest.register_on_punchnode(function(pos, node, puncher, pointed_thing))`
4584 * Called when a node is punched
4585 * `minetest.register_on_generated(function(minp, maxp, blockseed))`
4586 * Called after generating a piece of world. Modifying nodes inside the area
4587 is a bit faster than usually.
4588 * `minetest.register_on_newplayer(function(ObjectRef))`
4589 * Called when a new player enters the world for the first time
4590 * `minetest.register_on_punchplayer(function(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
4591 * Called when a player is punched
4592 * Note: This callback is invoked even if the punched player is dead.
4593 * `player`: ObjectRef - Player that was punched
4594 * `hitter`: ObjectRef - Player that hit
4595 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4597 * `tool_capabilities`: Capability table of used tool (can be nil)
4598 * `dir`: Unit vector of direction of punch. Always defined. Points from
4599 the puncher to the punched.
4600 * `damage`: Number that represents the damage calculated by the engine
4601 * should return `true` to prevent the default damage mechanism
4602 * `minetest.register_on_rightclickplayer(function(player, clicker))`
4603 * Called when a player is right-clicked
4604 * `player`: ObjectRef - Player that was right-clicked
4605 * `clicker`: ObjectRef - Object that right-clicked, may or may not be a player
4606 * `minetest.register_on_player_hpchange(function(player, hp_change, reason), modifier)`
4607 * Called when the player gets damaged or healed
4608 * `player`: ObjectRef of the player
4609 * `hp_change`: the amount of change. Negative when it is damage.
4610 * `reason`: a PlayerHPChangeReason table.
4611 * The `type` field will have one of the following values:
4612 * `set_hp`: A mod or the engine called `set_hp` without
4613 giving a type - use this for custom damage types.
4614 * `punch`: Was punched. `reason.object` will hold the puncher, or nil if none.
4616 * `node_damage`: `damage_per_second` from a neighbouring node.
4617 `reason.node` will hold the node name or nil.
4620 * Any of the above types may have additional fields from mods.
4621 * `reason.from` will be `mod` or `engine`.
4622 * `modifier`: when true, the function should return the actual `hp_change`.
4623 Note: modifiers only get a temporary `hp_change` that can be modified by later modifiers.
4624 Modifiers can return true as a second argument to stop the execution of further functions.
4625 Non-modifiers receive the final HP change calculated by the modifiers.
4626 * `minetest.register_on_dieplayer(function(ObjectRef, reason))`
4627 * Called when a player dies
4628 * `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
4629 * `minetest.register_on_respawnplayer(function(ObjectRef))`
4630 * Called when player is to be respawned
4631 * Called _before_ repositioning of player occurs
4632 * return true in func to disable regular player placement
4633 * `minetest.register_on_prejoinplayer(function(name, ip))`
4634 * Called when a client connects to the server, prior to authentication
4635 * If it returns a string, the client is disconnected with that string as
4637 * `minetest.register_on_joinplayer(function(ObjectRef, last_login))`
4638 * Called when a player joins the game
4639 * `last_login`: The timestamp of the previous login, or nil if player is new
4640 * `minetest.register_on_leaveplayer(function(ObjectRef, timed_out))`
4641 * Called when a player leaves the game
4642 * `timed_out`: True for timeout, false for other reasons.
4643 * `minetest.register_on_authplayer(function(name, ip, is_success))`
4644 * Called when a client attempts to log into an account.
4645 * `name`: The name of the account being authenticated.
4646 * `ip`: The IP address of the client
4647 * `is_success`: Whether the client was successfully authenticated
4648 * For newly registered accounts, `is_success` will always be true
4649 * `minetest.register_on_auth_fail(function(name, ip))`
4650 * Deprecated: use `minetest.register_on_authplayer(name, ip, is_success)` instead.
4651 * `minetest.register_on_cheat(function(ObjectRef, cheat))`
4652 * Called when a player cheats
4653 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
4655 * `interacted_too_far`
4656 * `interacted_while_dead`
4657 * `finished_unknown_dig`
4660 * `minetest.register_on_chat_message(function(name, message))`
4661 * Called always when a player says something
4662 * Return `true` to mark the message as handled, which means that it will
4663 not be sent to other players.
4664 * `minetest.register_on_chatcommand(function(name, command, params))`
4665 * Called always when a chatcommand is triggered, before `minetest.registered_chatcommands`
4666 is checked to see if the command exists, but after the input is parsed.
4667 * Return `true` to mark the command as handled, which means that the default
4668 handlers will be prevented.
4669 * `minetest.register_on_player_receive_fields(function(player, formname, fields))`
4670 * Called when the server received input from `player` in a formspec with
4671 the given `formname`. Specifically, this is called on any of the
4673 * a button was pressed,
4674 * Enter was pressed while the focus was on a text field
4675 * a checkbox was toggled,
4676 * something was selected in a dropdown list,
4677 * a different tab was selected,
4678 * selection was changed in a textlist or table,
4679 * an entry was double-clicked in a textlist or table,
4680 * a scrollbar was moved, or
4681 * the form was actively closed by the player.
4682 * Fields are sent for formspec elements which define a field. `fields`
4683 is a table containing each formspecs element value (as string), with
4684 the `name` parameter as index for each. The value depends on the
4685 formspec element type:
4686 * `animated_image`: Returns the index of the current frame.
4687 * `button` and variants: If pressed, contains the user-facing button
4688 text as value. If not pressed, is `nil`
4689 * `field`, `textarea` and variants: Text in the field
4690 * `dropdown`: Either the index or value, depending on the `index event`
4692 * `tabheader`: Tab index, starting with `"1"` (only if tab changed)
4693 * `checkbox`: `"true"` if checked, `"false"` if unchecked
4694 * `textlist`: See `minetest.explode_textlist_event`
4695 * `table`: See `minetest.explode_table_event`
4696 * `scrollbar`: See `minetest.explode_scrollbar_event`
4697 * Special case: `["quit"]="true"` is sent when the user actively
4698 closed the form by mouse click, keypress or through a button_exit[]
4700 * Special case: `["key_enter"]="true"` is sent when the user pressed
4701 the Enter key and the focus was either nowhere (causing the formspec
4702 to be closed) or on a button. If the focus was on a text field,
4703 additionally, the index `key_enter_field` contains the name of the
4704 text field. See also: `field_close_on_enter`.
4705 * Newest functions are called first
4706 * If function returns `true`, remaining functions are not called
4707 * `minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv))`
4708 * Called when `player` crafts something
4709 * `itemstack` is the output
4710 * `old_craft_grid` contains the recipe (Note: the one in the inventory is
4712 * `craft_inv` is the inventory with the crafting grid
4713 * Return either an `ItemStack`, to replace the output, or `nil`, to not
4715 * `minetest.register_craft_predict(function(itemstack, player, old_craft_grid, craft_inv))`
4716 * The same as before, except that it is called before the player crafts, to
4717 make craft prediction, and it should not change anything.
4718 * `minetest.register_allow_player_inventory_action(function(player, action, inventory, inventory_info))`
4719 * Determines how much of a stack may be taken, put or moved to a
4721 * `player` (type `ObjectRef`) is the player who modified the inventory
4722 `inventory` (type `InvRef`).
4723 * List of possible `action` (string) values and their
4724 `inventory_info` (table) contents:
4725 * `move`: `{from_list=string, to_list=string, from_index=number, to_index=number, count=number}`
4726 * `put`: `{listname=string, index=number, stack=ItemStack}`
4727 * `take`: Same as `put`
4728 * Return a numeric value to limit the amount of items to be taken, put or
4729 moved. A value of `-1` for `take` will make the source stack infinite.
4730 * `minetest.register_on_player_inventory_action(function(player, action, inventory, inventory_info))`
4731 * Called after a take, put or move event from/to/in a player inventory
4732 * Function arguments: see `minetest.register_allow_player_inventory_action`
4733 * Does not accept or handle any return value.
4734 * `minetest.register_on_protection_violation(function(pos, name))`
4735 * Called by `builtin` and mods when a player violates protection at a
4736 position (eg, digs a node or punches a protected entity).
4737 * The registered functions can be called using
4738 `minetest.record_protection_violation`.
4739 * The provided function should check that the position is protected by the
4740 mod calling this function before it prints a message, if it does, to
4741 allow for multiple protection mods.
4742 * `minetest.register_on_item_eat(function(hp_change, replace_with_item, itemstack, user, pointed_thing))`
4743 * Called when an item is eaten, by `minetest.item_eat`
4744 * Return `itemstack` to cancel the default item eat response (i.e.: hp increase).
4745 * `minetest.register_on_priv_grant(function(name, granter, priv))`
4746 * Called when `granter` grants the priv `priv` to `name`.
4747 * Note that the callback will be called twice if it's done by a player,
4748 once with granter being the player name, and again with granter being nil.
4749 * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
4750 * Called when `revoker` revokes the priv `priv` from `name`.
4751 * Note that the callback will be called twice if it's done by a player,
4752 once with revoker being the player name, and again with revoker being nil.
4753 * `minetest.register_can_bypass_userlimit(function(name, ip))`
4754 * Called when `name` user connects with `ip`.
4755 * Return `true` to by pass the player limit
4756 * `minetest.register_on_modchannel_message(function(channel_name, sender, message))`
4757 * Called when an incoming mod channel message is received
4758 * You should have joined some channels to receive events.
4759 * If message comes from a server mod, `sender` field is an empty string.
4764 * `minetest.settings`: Settings object containing all of the settings from the
4765 main config file (`minetest.conf`).
4766 * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
4767 parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
4772 * `minetest.string_to_privs(str[, delim])`:
4773 * Converts string representation of privs into table form
4774 * `delim`: String separating the privs. Defaults to `","`.
4775 * Returns `{ priv1 = true, ... }`
4776 * `minetest.privs_to_string(privs[, delim])`:
4777 * Returns the string representation of `privs`
4778 * `delim`: String to delimit privs. Defaults to `","`.
4779 * `minetest.get_player_privs(name) -> {priv1=true,...}`
4780 * `minetest.check_player_privs(player_or_name, ...)`:
4781 returns `bool, missing_privs`
4782 * A quickhand for checking privileges.
4783 * `player_or_name`: Either a Player object or the name of a player.
4784 * `...` is either a list of strings, e.g. `"priva", "privb"` or
4785 a table, e.g. `{ priva = true, privb = true }`.
4787 * `minetest.check_password_entry(name, entry, password)`
4788 * Returns true if the "password entry" for a player with name matches given
4789 password, false otherwise.
4790 * The "password entry" is the password representation generated by the
4791 engine as returned as part of a `get_auth()` call on the auth handler.
4792 * Only use this function for making it possible to log in via password from
4793 external protocols such as IRC, other uses are frowned upon.
4794 * `minetest.get_password_hash(name, raw_password)`
4795 * Convert a name-password pair to a password hash that Minetest can use.
4796 * The returned value alone is not a good basis for password checks based
4797 on comparing the password hash in the database with the password hash
4798 from the function, with an externally provided password, as the hash
4799 in the db might use the new SRP verifier format.
4800 * For this purpose, use `minetest.check_password_entry` instead.
4801 * `minetest.get_player_ip(name)`: returns an IP address string for the player
4803 * The player needs to be online for this to be successful.
4805 * `minetest.get_auth_handler()`: Return the currently active auth handler
4806 * See the [Authentication handler definition]
4807 * Use this to e.g. get the authentication data for a player:
4808 `local auth_data = minetest.get_auth_handler().get_auth(playername)`
4809 * `minetest.notify_authentication_modified(name)`
4810 * Must be called by the authentication handler for privilege changes.
4811 * `name`: string; if omitted, all auth data should be considered modified
4812 * `minetest.set_player_password(name, password_hash)`: Set password hash of
4814 * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player
4816 * `minetest.auth_reload()`
4817 * See `reload()` in authentication handler definition
4819 `minetest.set_player_password`, `minetest.set_player_privs`,
4820 `minetest.get_player_privs` and `minetest.auth_reload` call the authentication
4826 * `minetest.chat_send_all(text)`
4827 * `minetest.chat_send_player(name, text)`
4828 * `minetest.format_chat_message(name, message)`
4829 * Used by the server to format a chat message, based on the setting `chat_message_format`.
4830 Refer to the documentation of the setting for a list of valid placeholders.
4831 * Takes player name and message, and returns the formatted string to be sent to players.
4832 * Can be redefined by mods if required, for things like colored names or messages.
4833 * **Only** the first occurrence of each placeholder will be replaced.
4838 * `minetest.set_node(pos, node)`
4839 * `minetest.add_node(pos, node)`: alias to `minetest.set_node`
4840 * Set node at position `pos`
4841 * `node`: table `{name=string, param1=number, param2=number}`
4842 * If param1 or param2 is omitted, it's set to `0`.
4843 * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
4844 * `minetest.bulk_set_node({pos1, pos2, pos3, ...}, node)`
4845 * Set node on all positions set in the first argument.
4846 * e.g. `minetest.bulk_set_node({{x=0, y=1, z=1}, {x=1, y=2, z=2}}, {name="default:stone"})`
4847 * For node specification or position syntax see `minetest.set_node` call
4848 * Faster than set_node due to single call, but still considerably slower
4849 than Lua Voxel Manipulators (LVM) for large numbers of nodes.
4850 Unlike LVMs, this will call node callbacks. It also allows setting nodes
4851 in spread out positions which would cause LVMs to waste memory.
4852 For setting a cube, this is 1.3x faster than set_node whereas LVM is 20
4854 * `minetest.swap_node(pos, node)`
4855 * Set node at position, but don't remove metadata
4856 * `minetest.remove_node(pos)`
4857 * By default it does the same as `minetest.set_node(pos, {name="air"})`
4858 * `minetest.get_node(pos)`
4859 * Returns the node at the given position as table in the format
4860 `{name="node_name", param1=0, param2=0}`,
4861 returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
4862 * `minetest.get_node_or_nil(pos)`
4863 * Same as `get_node` but returns `nil` for unloaded areas.
4864 * `minetest.get_node_light(pos, timeofday)`
4865 * Gets the light value at the given position. Note that the light value
4866 "inside" the node at the given position is returned, so you usually want
4867 to get the light value of a neighbor.
4868 * `pos`: The position where to measure the light.
4869 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
4870 * Returns a number between `0` and `15` or `nil`
4871 * `nil` is returned e.g. when the map isn't loaded at `pos`
4872 * `minetest.get_natural_light(pos[, timeofday])`
4873 * Figures out the sunlight (or moonlight) value at pos at the given time of
4875 * `pos`: The position of the node
4876 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
4877 * Returns a number between `0` and `15` or `nil`
4878 * This function tests 203 nodes in the worst case, which happens very
4880 * `minetest.get_artificial_light(param1)`
4881 * Calculates the artificial light (light from e.g. torches) value from the
4883 * `param1`: The param1 value of a `paramtype = "light"` node.
4884 * Returns a number between `0` and `15`
4885 * Currently it's the same as `math.floor(param1 / 16)`, except that it
4886 ensures compatibility.
4887 * `minetest.place_node(pos, node)`
4888 * Place node with the same effects that a player would cause
4889 * `minetest.dig_node(pos)`
4890 * Dig node with the same effects that a player would cause
4891 * Returns `true` if successful, `false` on failure (e.g. protected location)
4892 * `minetest.punch_node(pos)`
4893 * Punch node with the same effects that a player would cause
4894 * `minetest.spawn_falling_node(pos)`
4895 * Change node into falling node
4896 * Returns `true` if successful, `false` on failure
4898 * `minetest.find_nodes_with_meta(pos1, pos2)`
4899 * Get a table of positions of nodes that have metadata within a region
4901 * `minetest.get_meta(pos)`
4902 * Get a `NodeMetaRef` at that position
4903 * `minetest.get_node_timer(pos)`
4904 * Get `NodeTimerRef`
4906 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at
4908 * Returns `ObjectRef`, or `nil` if failed
4909 * `minetest.add_item(pos, item)`: Spawn item
4910 * Returns `ObjectRef`, or `nil` if failed
4911 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
4912 * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of
4914 * `radius`: using an euclidean metric
4915 * `minetest.get_objects_in_area(pos1, pos2)`: returns a list of
4917 * `pos1` and `pos2` are the min and max positions of the area to search.
4918 * `minetest.set_timeofday(val)`
4919 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
4920 * `minetest.get_timeofday()`
4921 * `minetest.get_gametime()`: returns the time, in seconds, since the world was
4923 * `minetest.get_day_count()`: returns number days elapsed since world was
4925 * accounts for time changes.
4926 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns
4928 * `radius`: using a maximum metric
4929 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4930 * `search_center` is an optional boolean (default: `false`)
4931 If true `pos` is also checked for the nodes
4932 * `minetest.find_nodes_in_area(pos1, pos2, nodenames, [grouped])`
4933 * `pos1` and `pos2` are the min and max positions of the area to search.
4934 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4935 * If `grouped` is true the return value is a table indexed by node name
4936 which contains lists of positions.
4937 * If `grouped` is false or absent the return values are as follows:
4938 first value: Table with all node positions
4939 second value: Table with the count of each node with the node name
4941 * Area volume is limited to 4,096,000 nodes
4942 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
4944 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4945 * Return value: Table with all node positions with a node air above
4946 * Area volume is limited to 4,096,000 nodes
4947 * `minetest.get_perlin(noiseparams)`
4948 * Return world-specific perlin noise.
4949 * The actual seed used is the noiseparams seed plus the world seed.
4950 * `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
4951 * Deprecated: use `minetest.get_perlin(noiseparams)` instead.
4952 * Return world-specific perlin noise.
4953 * `minetest.get_voxel_manip([pos1, pos2])`
4954 * Return voxel manipulator object.
4955 * Loads the manipulator from the map if positions are passed.
4956 * `minetest.set_gen_notify(flags, {deco_ids})`
4957 * Set the types of on-generate notifications that should be collected.
4958 * `flags` is a flag field with the available flags:
4966 * The second parameter is a list of IDs of decorations which notification
4968 * `minetest.get_gen_notify()`
4969 * Returns a flagstring and a table with the `deco_id`s.
4970 * `minetest.get_decoration_id(decoration_name)`
4971 * Returns the decoration ID number for the provided decoration name string,
4972 or `nil` on failure.
4973 * `minetest.get_mapgen_object(objectname)`
4974 * Return requested mapgen object if available (see [Mapgen objects])
4975 * `minetest.get_heat(pos)`
4976 * Returns the heat at the position, or `nil` on failure.
4977 * `minetest.get_humidity(pos)`
4978 * Returns the humidity at the position, or `nil` on failure.
4979 * `minetest.get_biome_data(pos)`
4980 * Returns a table containing:
4981 * `biome` the biome id of the biome at that position
4982 * `heat` the heat at the position
4983 * `humidity` the humidity at the position
4984 * Or returns `nil` on failure.
4985 * `minetest.get_biome_id(biome_name)`
4986 * Returns the biome id, as used in the biomemap Mapgen object and returned
4987 by `minetest.get_biome_data(pos)`, for a given biome_name string.
4988 * `minetest.get_biome_name(biome_id)`
4989 * Returns the biome name string for the provided biome id, or `nil` on
4991 * If no biomes have been registered, such as in mgv6, returns `default`.
4992 * `minetest.get_mapgen_params()`
4993 * Deprecated: use `minetest.get_mapgen_setting(name)` instead.
4994 * Returns a table containing:
5000 * `minetest.set_mapgen_params(MapgenParams)`
5001 * Deprecated: use `minetest.set_mapgen_setting(name, value, override)`
5003 * Set map generation parameters.
5004 * Function cannot be called after the registration period; only
5005 initialization and `on_mapgen_init`.
5006 * Takes a table as an argument with the fields:
5012 * Leave field unset to leave that parameter unchanged.
5013 * `flags` contains a comma-delimited string of flags to set, or if the
5014 prefix `"no"` is attached, clears instead.
5015 * `flags` is in the same format and has the same options as `mg_flags` in
5017 * `minetest.get_mapgen_setting(name)`
5018 * Gets the *active* mapgen setting (or nil if none exists) in string
5019 format with the following order of precedence:
5020 1) Settings loaded from map_meta.txt or overrides set during mod
5022 2) Settings set by mods without a metafile override
5023 3) Settings explicitly set in the user config file, minetest.conf
5024 4) Settings set as the user config default
5025 * `minetest.get_mapgen_setting_noiseparams(name)`
5026 * Same as above, but returns the value as a NoiseParams table if the
5027 setting `name` exists and is a valid NoiseParams.
5028 * `minetest.set_mapgen_setting(name, value, [override_meta])`
5029 * Sets a mapgen param to `value`, and will take effect if the corresponding
5030 mapgen setting is not already present in map_meta.txt.
5031 * `override_meta` is an optional boolean (default: `false`). If this is set
5032 to true, the setting will become the active setting regardless of the map
5034 * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`.
5035 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
5036 * Same as above, except value is a NoiseParams table.
5037 * `minetest.set_noiseparams(name, noiseparams, set_default)`
5038 * Sets the noiseparams setting of `name` to the noiseparams table specified
5040 * `set_default` is an optional boolean (default: `true`) that specifies
5041 whether the setting should be applied to the default config or current
5043 * `minetest.get_noiseparams(name)`
5044 * Returns a table of the noiseparams for name.
5045 * `minetest.generate_ores(vm, pos1, pos2)`
5046 * Generate all registered ores within the VoxelManip `vm` and in the area
5047 from `pos1` to `pos2`.
5048 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
5049 * `minetest.generate_decorations(vm, pos1, pos2)`
5050 * Generate all registered decorations within the VoxelManip `vm` and in the
5051 area from `pos1` to `pos2`.
5052 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
5053 * `minetest.clear_objects([options])`
5054 * Clear all objects in the environment
5055 * Takes an optional table as an argument with the field `mode`.
5056 * mode = `"full"` : Load and go through every mapblock, clearing
5058 * mode = `"quick"`: Clear objects immediately in loaded mapblocks,
5059 clear objects in unloaded mapblocks only when the
5060 mapblocks are next activated.
5061 * `minetest.load_area(pos1[, pos2])`
5062 * Load the mapblocks containing the area from `pos1` to `pos2`.
5063 `pos2` defaults to `pos1` if not specified.
5064 * This function does not trigger map generation.
5065 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
5066 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be
5067 asynchronously fetched from memory, loaded from disk, or if inexistent,
5069 * If `callback` is a valid Lua function, this will be called for each block
5071 * The function signature of callback is:
5072 `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
5073 * `blockpos` is the *block* coordinates of the block that had been
5075 * `action` could be one of the following constant values:
5076 * `minetest.EMERGE_CANCELLED`
5077 * `minetest.EMERGE_ERRORED`
5078 * `minetest.EMERGE_FROM_MEMORY`
5079 * `minetest.EMERGE_FROM_DISK`
5080 * `minetest.EMERGE_GENERATED`
5081 * `calls_remaining` is the number of callbacks to be expected after
5083 * `param` is the user-defined parameter passed to emerge_area (or
5084 nil if the parameter was absent).
5085 * `minetest.delete_area(pos1, pos2)`
5086 * delete all mapblocks in the area from pos1 to pos2, inclusive
5087 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
5088 * Checks if there is anything other than air between pos1 and pos2.
5089 * Returns false if something is blocking the sight.
5090 * Returns the position of the blocking node when `false`
5091 * `pos1`: First position
5092 * `pos2`: Second position
5093 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
5094 * Creates a `Raycast` object.
5095 * `pos1`: start of the ray
5096 * `pos2`: end of the ray
5097 * `objects`: if false, only nodes will be returned. Default is `true`.
5098 * `liquids`: if false, liquid nodes won't be returned. Default is `false`.
5099 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
5100 * returns table containing path that can be walked on
5101 * returns a table of 3D points representing a path from `pos1` to `pos2` or
5103 * Reasons for failure:
5104 * No path exists at all
5105 * No path exists within `searchdistance` (see below)
5106 * Start or end pos is buried in land
5107 * `pos1`: start position
5108 * `pos2`: end position
5109 * `searchdistance`: maximum distance from the search positions to search in.
5110 In detail: Path must be completely inside a cuboid. The minimum
5111 `searchdistance` of 1 will confine search between `pos1` and `pos2`.
5112 Larger values will increase the size of this cuboid in all directions
5113 * `max_jump`: maximum height difference to consider walkable
5114 * `max_drop`: maximum height difference to consider droppable
5115 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`.
5116 Difference between `"A*"` and `"A*_noprefetch"` is that
5117 `"A*"` will pre-calculate the cost-data, the other will calculate it
5119 * `minetest.spawn_tree (pos, {treedef})`
5120 * spawns L-system tree at given `pos` with definition in `treedef` table
5121 * `minetest.transforming_liquid_add(pos)`
5122 * add node to liquid update queue
5123 * `minetest.get_node_max_level(pos)`
5124 * get max available level for leveled node
5125 * `minetest.get_node_level(pos)`
5126 * get level of leveled node (water, snow)
5127 * `minetest.set_node_level(pos, level)`
5128 * set level of leveled node, default `level` equals `1`
5129 * if `totallevel > maxlevel`, returns rest (`total-max`).
5130 * `minetest.add_node_level(pos, level)`
5131 * increase level of leveled node by level, default `level` equals `1`
5132 * if `totallevel > maxlevel`, returns rest (`total-max`)
5133 * `level` must be between -127 and 127
5134 * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
5135 * resets the light in a cuboid-shaped part of
5136 the map and removes lighting bugs.
5137 * Loads the area if it is not loaded.
5138 * `pos1` is the corner of the cuboid with the least coordinates
5139 (in node coordinates), inclusive.
5140 * `pos2` is the opposite corner of the cuboid, inclusive.
5141 * The actual updated cuboid might be larger than the specified one,
5142 because only whole map blocks can be updated.
5143 The actual updated area consists of those map blocks that intersect
5144 with the given cuboid.
5145 * However, the neighborhood of the updated area might change
5146 as well, as light can spread out of the cuboid, also light
5148 * returns `false` if the area is not fully generated,
5150 * `minetest.check_single_for_falling(pos)`
5151 * causes an unsupported `group:falling_node` node to fall and causes an
5152 unattached `group:attached_node` node to fall.
5153 * does not spread these updates to neighbours.
5154 * `minetest.check_for_falling(pos)`
5155 * causes an unsupported `group:falling_node` node to fall and causes an
5156 unattached `group:attached_node` node to fall.
5157 * spread these updates to neighbours and can cause a cascade
5159 * `minetest.get_spawn_level(x, z)`
5160 * Returns a player spawn y co-ordinate for the provided (x, z)
5161 co-ordinates, or `nil` for an unsuitable spawn point.
5162 * For most mapgens a 'suitable spawn point' is one with y between
5163 `water_level` and `water_level + 16`, and in mgv7 well away from rivers,
5164 so `nil` will be returned for many (x, z) co-ordinates.
5165 * The spawn level returned is for a player spawn in unmodified terrain.
5166 * The spawn level is intentionally above terrain level to cope with
5167 full-node biome 'dust' nodes.
5172 You can find mod channels communication scheme in `doc/mod_channels.png`.
5174 * `minetest.mod_channel_join(channel_name)`
5175 * Server joins channel `channel_name`, and creates it if necessary. You
5176 should listen for incoming messages with
5177 `minetest.register_on_modchannel_message`
5182 `minetest.get_inventory(location)`: returns an `InvRef`
5185 * `{type="player", name="celeron55"}`
5186 * `{type="node", pos={x=, y=, z=}}`
5187 * `{type="detached", name="creative"}`
5188 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns
5190 * `callbacks`: See [Detached inventory callbacks]
5191 * `player_name`: Make detached inventory available to one player
5192 exclusively, by default they will be sent to every player (even if not
5194 Note that this parameter is mostly just a workaround and will be removed
5196 * Creates a detached inventory. If it already exists, it is cleared.
5197 * `minetest.remove_detached_inventory(name)`
5198 * Returns a `boolean` indicating whether the removal succeeded.
5199 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
5200 returns left over ItemStack.
5201 * See `minetest.item_eat` and `minetest.register_on_item_eat`
5206 * `minetest.show_formspec(playername, formname, formspec)`
5207 * `playername`: name of player to show formspec
5208 * `formname`: name passed to `on_player_receive_fields` callbacks.
5209 It should follow the `"modname:<whatever>"` naming convention
5210 * `formspec`: formspec to display
5211 * `minetest.close_formspec(playername, formname)`
5212 * `playername`: name of player to close formspec
5213 * `formname`: has to exactly match the one given in `show_formspec`, or the
5214 formspec will not close.
5215 * calling `show_formspec(playername, formname, "")` is equal to this
5217 * to close a formspec regardless of the formname, call
5218 `minetest.close_formspec(playername, "")`.
5219 **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
5220 * `minetest.formspec_escape(string)`: returns a string
5221 * escapes the characters "[", "]", "\", "," and ";", which can not be used
5223 * `minetest.explode_table_event(string)`: returns a table
5224 * returns e.g. `{type="CHG", row=1, column=2}`
5226 * `"INV"`: no row selected
5228 * `"DCL"`: double-click
5229 * `minetest.explode_textlist_event(string)`: returns a table
5230 * returns e.g. `{type="CHG", index=1}`
5232 * `"INV"`: no row selected
5234 * `"DCL"`: double-click
5235 * `minetest.explode_scrollbar_event(string)`: returns a table
5236 * returns e.g. `{type="CHG", value=500}`
5238 * `"INV"`: something failed
5239 * `"CHG"`: has been changed
5240 * `"VAL"`: not changed
5245 * `minetest.inventorycube(img1, img2, img3)`
5246 * Returns a string for making an image of a cube (useful as an item image)
5247 * `minetest.get_pointed_thing_position(pointed_thing, above)`
5248 * Returns the position of a `pointed_thing` or `nil` if the `pointed_thing`
5249 does not refer to a node or entity.
5250 * If the optional `above` parameter is true and the `pointed_thing` refers
5251 to a node, then it will return the `above` position of the `pointed_thing`.
5252 * `minetest.dir_to_facedir(dir, is6d)`
5253 * Convert a vector to a facedir value, used in `param2` for
5254 `paramtype2="facedir"`.
5255 * passing something non-`nil`/`false` for the optional second parameter
5256 causes it to take the y component into account.
5257 * `minetest.facedir_to_dir(facedir)`
5258 * Convert a facedir back into a vector aimed directly out the "back" of a
5260 * `minetest.dir_to_wallmounted(dir)`
5261 * Convert a vector to a wallmounted value, used for
5262 `paramtype2="wallmounted"`.
5263 * `minetest.wallmounted_to_dir(wallmounted)`
5264 * Convert a wallmounted value back into a vector aimed directly out the
5266 * `minetest.dir_to_yaw(dir)`
5267 * Convert a vector into a yaw (angle)
5268 * `minetest.yaw_to_dir(yaw)`
5269 * Convert yaw (angle) to a vector
5270 * `minetest.is_colored_paramtype(ptype)`
5271 * Returns a boolean. Returns `true` if the given `paramtype2` contains
5272 color information (`color`, `colorwallmounted` or `colorfacedir`).
5273 * `minetest.strip_param2_color(param2, paramtype2)`
5274 * Removes everything but the color information from the
5275 given `param2` value.
5276 * Returns `nil` if the given `paramtype2` does not contain color
5278 * `minetest.get_node_drops(node, toolname)`
5279 * Returns list of itemstrings that are dropped by `node` when dug
5281 * `node`: node as table or node name
5282 * `toolname`: name of the tool item (can be `nil`)
5283 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
5284 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
5285 * `input.width` = for example `3`
5286 * `input.items` = for example
5287 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
5288 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
5289 * `output.time` = a number, if unsuccessful: `0`
5290 * `output.replacements` = List of replacement `ItemStack`s that couldn't be
5291 placed in `decremented_input.items`. Replacements can be placed in
5292 `decremented_input` if the stack of the replaced item has a count of 1.
5293 * `decremented_input` = like `input`
5294 * `minetest.get_craft_recipe(output)`: returns input
5295 * returns last registered recipe for output item (node)
5296 * `output` is a node or item type such as `"default:torch"`
5297 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
5298 * `input.width` = for example `3`
5299 * `input.items` = for example
5300 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
5301 * `input.items` = `nil` if no recipe found
5302 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
5303 * returns indexed table with all registered recipes for query item (node)
5304 or `nil` if no recipe was found.
5305 * recipe entry table:
5306 * `method`: 'normal' or 'cooking' or 'fuel'
5307 * `width`: 0-3, 0 means shapeless recipe
5308 * `items`: indexed [1-9] table with recipe items
5309 * `output`: string with item name and quantity
5310 * Example query for `"default:gold_ingot"` will return table:
5313 [1]={method = "cooking", width = 3, output = "default:gold_ingot",
5314 items = {1 = "default:gold_lump"}},
5315 [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
5316 items = {1 = "default:goldblock"}}
5318 * `minetest.handle_node_drops(pos, drops, digger)`
5319 * `drops`: list of itemstrings
5320 * Handles drops from nodes after digging: Default action is to put them
5321 into digger's inventory.
5322 * Can be overridden to get different functionality (e.g. dropping items on
5324 * `minetest.itemstring_with_palette(item, palette_index)`: returns an item
5326 * Creates an item string which contains palette index information
5327 for hardware colorization. You can use the returned string
5328 as an output in a craft recipe.
5329 * `item`: the item stack which becomes colored. Can be in string,
5330 table and native form.
5331 * `palette_index`: this index is added to the item stack
5332 * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
5333 * Creates an item string which contains static color information
5334 for hardware colorization. Use this method if you wish to colorize
5335 an item that does not own a palette. You can use the returned string
5336 as an output in a craft recipe.
5337 * `item`: the item stack which becomes colored. Can be in string,
5338 table and native form.
5339 * `colorstring`: the new color of the item stack
5344 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
5345 returns `{{actor, pos, time, oldnode, newnode}, ...}`
5346 * Find who has done something to a node, or near a node
5347 * `actor`: `"player:<name>"`, also `"liquid"`.
5348 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns
5349 `boolean, log_messages`.
5350 * Revert latest actions of someone
5351 * `actor`: `"player:<name>"`, also `"liquid"`.
5353 Defaults for the `on_place` and `on_drop` item definition functions
5354 -------------------------------------------------------------------
5356 * `minetest.item_place_node(itemstack, placer, pointed_thing[, param2, prevent_after_place])`
5357 * Place item as a node
5358 * `param2` overrides `facedir` and wallmounted `param2`
5359 * `prevent_after_place`: if set to `true`, `after_place_node` is not called
5360 for the newly placed node to prevent a callback and placement loop
5361 * returns `itemstack, position`
5362 * `position`: the location the node was placed to. `nil` if nothing was placed.
5363 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
5365 * returns the leftover itemstack
5366 * **Note**: This function is deprecated and will never be called.
5367 * `minetest.item_place(itemstack, placer, pointed_thing[, param2])`
5368 * Wrapper that calls `minetest.item_place_node` if appropriate
5369 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
5370 * **Note**: is not called when wielded item overrides `on_place`
5371 * `param2` overrides facedir and wallmounted `param2`
5372 * returns `itemstack, position`
5373 * `position`: the location the node was placed to. `nil` if nothing was placed.
5374 * `minetest.item_drop(itemstack, dropper, pos)`
5376 * returns the leftover itemstack
5377 * `minetest.item_eat(hp_change[, replace_with_item])`
5378 * Returns `function(itemstack, user, pointed_thing)` as a
5379 function wrapper for `minetest.do_item_eat`.
5380 * `replace_with_item` is the itemstring which is added to the inventory.
5381 If the player is eating a stack, then replace_with_item goes to a
5384 Defaults for the `on_punch` and `on_dig` node definition callbacks
5385 ------------------------------------------------------------------
5387 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
5388 * Calls functions registered by `minetest.register_on_punchnode()`
5389 * `minetest.node_dig(pos, node, digger)`
5390 * Checks if node can be dug, puts item into inventory, removes node
5391 * Calls functions registered by `minetest.registered_on_dignodes()`
5396 * `minetest.sound_play(spec, parameters, [ephemeral])`: returns a handle
5397 * `spec` is a `SimpleSoundSpec`
5398 * `parameters` is a sound parameter table
5399 * `ephemeral` is a boolean (default: false)
5400 Ephemeral sounds will not return a handle and can't be stopped or faded.
5401 It is recommend to use this for short sounds that happen in response to
5402 player actions (e.g. door closing).
5403 * `minetest.sound_stop(handle)`
5404 * `handle` is a handle returned by `minetest.sound_play`
5405 * `minetest.sound_fade(handle, step, gain)`
5406 * `handle` is a handle returned by `minetest.sound_play`
5407 * `step` determines how fast a sound will fade.
5408 The gain will change by this much per second,
5409 until it reaches the target gain.
5410 Note: Older versions used a signed step. This is deprecated, but old
5411 code will still work. (the client uses abs(step) to correct it)
5412 * `gain` the target gain for the fade.
5413 Fading to zero will delete the sound.
5418 * `minetest.after(time, func, ...)` : returns job table to use as below.
5419 * Call the function `func` after `time` seconds, may be fractional
5420 * Optional: Variable number of arguments that are passed to `func`
5423 * Cancels the job function from being called
5428 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for
5429 server shutdown. Will display `message` to clients.
5430 * `reconnect` == true displays a reconnect button
5431 * `delay` adds an optional delay (in seconds) before shutdown.
5432 Negative delay cancels the current active shutdown.
5433 Zero delay triggers an immediate shutdown.
5434 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
5435 * `minetest.get_server_status(name, joined)`
5436 * Returns the server status string when a player joins or when the command
5437 `/status` is called. Returns `nil` or an empty string when the message is
5439 * `joined`: Boolean value, indicates whether the function was called when
5441 * This function may be overwritten by mods to customize the status message.
5442 * `minetest.get_server_uptime()`: returns the server uptime in seconds
5443 * `minetest.remove_player(name)`: remove player from database (if they are not
5445 * As auth data is not removed, minetest.player_exists will continue to
5446 return true. Call the below method as well if you want to remove auth
5448 * Returns a code (0: successful, 1: no such player, 2: player is connected)
5449 * `minetest.remove_player_auth(name)`: remove player authentication data
5450 * Returns boolean indicating success (false if player nonexistant)
5451 * `minetest.dynamic_add_media(filepath, callback)`
5452 * `filepath`: path to a media file on the filesystem
5453 * `callback`: function with arguments `name`, where name is a player name
5454 (previously there was no callback argument; omitting it is deprecated)
5455 * Adds the file to the media sent to clients by the server on startup
5456 and also pushes this file to already connected clients.
5457 The file must be a supported image, sound or model format. It must not be
5458 modified, deleted, moved or renamed after calling this function.
5459 The list of dynamically added media is not persisted.
5460 * Returns false on error, true if the request was accepted
5461 * The given callback will be called for every player as soon as the
5462 media is available on the client.
5463 Old clients that lack support for this feature will not see the media
5464 unless they reconnect to the server. (callback won't be called)
5465 * Since media transferred this way currently does not use client caching
5466 or HTTP transfers, dynamic media should not be used with big files.
5471 * `minetest.get_ban_list()`: returns a list of all bans formatted as string
5472 * `minetest.get_ban_description(ip_or_name)`: returns list of bans matching
5473 IP address or name formatted as string
5474 * `minetest.ban_player(name)`: ban the IP of a currently connected player
5475 * Returns boolean indicating success
5476 * `minetest.unban_player_or_ip(ip_or_name)`: remove ban record matching
5478 * `minetest.kick_player(name, [reason])`: disconnect a player with an optional
5480 * Returns boolean indicating success (false if player nonexistant)
5485 * `minetest.add_particle(particle definition)`
5486 * Deprecated: `minetest.add_particle(pos, velocity, acceleration,
5487 expirationtime, size, collisiondetection, texture, playername)`
5489 * `minetest.add_particlespawner(particlespawner definition)`
5490 * Add a `ParticleSpawner`, an object that spawns an amount of particles
5491 over `time` seconds.
5492 * Returns an `id`, and -1 if adding didn't succeed
5493 * Deprecated: `minetest.add_particlespawner(amount, time,
5497 minexptime, maxexptime,
5499 collisiondetection, texture, playername)`
5501 * `minetest.delete_particlespawner(id, player)`
5502 * Delete `ParticleSpawner` with `id` (return value from
5503 `minetest.add_particlespawner`).
5504 * If playername is specified, only deletes on the player's client,
5505 otherwise on all clients.
5510 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
5511 * Create a schematic from the volume of map specified by the box formed by
5513 * Apply the specified probability and per-node force-place to the specified
5514 nodes according to the `probability_list`.
5515 * `probability_list` is an array of tables containing two fields, `pos`
5517 * `pos` is the 3D vector specifying the absolute coordinates of the
5518 node being modified,
5519 * `prob` is an integer value from `0` to `255` that encodes
5520 probability and per-node force-place. Probability has levels
5521 0-127, then 128 may be added to encode per-node force-place.
5522 For probability stated as 0-255, divide by 2 and round down to
5523 get values 0-127, then add 128 to apply per-node force-place.
5524 * If there are two or more entries with the same pos value, the
5526 * If `pos` is not inside the box formed by `p1` and `p2`, it is
5528 * If `probability_list` equals `nil`, no probabilities are applied.
5529 * Apply the specified probability to the specified horizontal slices
5530 according to the `slice_prob_list`.
5531 * `slice_prob_list` is an array of tables containing two fields, `ypos`
5533 * `ypos` indicates the y position of the slice with a probability
5534 applied, the lowest slice being `ypos = 0`.
5535 * If slice probability list equals `nil`, no slice probabilities
5537 * Saves schematic in the Minetest Schematic format to filename.
5539 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement, flags)`
5540 * Place the schematic specified by schematic (see [Schematic specifier]) at
5542 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
5543 * If the `rotation` parameter is omitted, the schematic is not rotated.
5544 * `replacements` = `{["old_name"] = "convert_to", ...}`
5545 * `force_placement` is a boolean indicating whether nodes other than `air`
5546 and `ignore` are replaced by the schematic.
5547 * Returns nil if the schematic could not be loaded.
5548 * **Warning**: Once you have loaded a schematic from a file, it will be
5549 cached. Future calls will always use the cached version and the
5550 replacement list defined for it, regardless of whether the file or the
5551 replacement list parameter have changed. The only way to load the file
5552 anew is to restart the server.
5553 * `flags` is a flag field with the available flags:
5558 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement, flags)`:
5559 * This function is analogous to minetest.place_schematic, but places a
5560 schematic onto the specified VoxelManip object `vmanip` instead of the
5562 * Returns false if any part of the schematic was cut-off due to the
5563 VoxelManip not containing the full area required, and true if the whole
5564 schematic was able to fit.
5565 * Returns nil if the schematic could not be loaded.
5566 * After execution, any external copies of the VoxelManip contents are
5568 * `flags` is a flag field with the available flags:
5573 * `minetest.serialize_schematic(schematic, format, options)`
5574 * Return the serialized schematic specified by schematic
5575 (see [Schematic specifier])
5576 * in the `format` of either "mts" or "lua".
5577 * "mts" - a string containing the binary MTS data used in the MTS file
5579 * "lua" - a string containing Lua code representing the schematic in table
5581 * `options` is a table containing the following optional parameters:
5582 * If `lua_use_comments` is true and `format` is "lua", the Lua code
5583 generated will have (X, Z) position comments for every X row
5584 generated in the schematic data for easier reading.
5585 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua",
5586 the Lua code generated will use that number of spaces as indentation
5587 instead of a tab character.
5589 * `minetest.read_schematic(schematic, options)`
5590 * Returns a Lua table representing the schematic (see: [Schematic specifier])
5591 * `schematic` is the schematic to read (see: [Schematic specifier])
5592 * `options` is a table containing the following optional parameters:
5593 * `write_yslice_prob`: string value:
5594 * `none`: no `write_yslice_prob` table is inserted,
5595 * `low`: only probabilities that are not 254 or 255 are written in
5596 the `write_ylisce_prob` table,
5597 * `all`: write all probabilities to the `write_yslice_prob` table.
5598 * The default for this option is `all`.
5599 * Any invalid value will be interpreted as `all`.
5604 * `minetest.request_http_api()`:
5605 * returns `HTTPApiTable` containing http functions if the calling mod has
5606 been granted access by being listed in the `secure.http_mods` or
5607 `secure.trusted_mods` setting, otherwise returns `nil`.
5608 * The returned table contains the functions `fetch`, `fetch_async` and
5609 `fetch_async_get` described below.
5610 * Only works at init time and must be called from the mod's main scope
5611 (not from a function).
5612 * Function only exists if minetest server was built with cURL support.
5613 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
5615 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
5616 * Performs given request asynchronously and calls callback upon completion
5617 * callback: `function(HTTPRequestResult res)`
5618 * Use this HTTP function if you are unsure, the others are for advanced use
5619 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
5620 * Performs given request asynchronously and returns handle for
5621 `HTTPApiTable.fetch_async_get`
5622 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
5623 * Return response data for given asynchronous HTTP request
5628 * `minetest.get_mod_storage()`:
5629 * returns reference to mod private `StorageRef`
5630 * must be called during mod load time
5635 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
5636 * `minetest.is_player(obj)`: boolean, whether `obj` is a player
5637 * `minetest.player_exists(name)`: boolean, whether player exists
5638 (regardless of online status)
5639 * `minetest.hud_replace_builtin(name, hud_definition)`
5640 * Replaces definition of a builtin hud element
5641 * `name`: `"breath"` or `"health"`
5642 * `hud_definition`: definition to replace builtin definition
5643 * `minetest.send_join_message(player_name)`
5644 * This function can be overridden by mods to change the join message.
5645 * `minetest.send_leave_message(player_name, timed_out)`
5646 * This function can be overridden by mods to change the leave message.
5647 * `minetest.hash_node_position(pos)`: returns an 48-bit integer
5648 * `pos`: table {x=number, y=number, z=number},
5649 * Gives a unique hash number for a node position (16+16+16=48bit)
5650 * `minetest.get_position_from_hash(hash)`: returns a position
5651 * Inverse transform of `minetest.hash_node_position`
5652 * `minetest.get_item_group(name, group)`: returns a rating
5653 * Get rating of a group of an item. (`0` means: not in group)
5654 * `minetest.get_node_group(name, group)`: returns a rating
5655 * Deprecated: An alias for the former.
5656 * `minetest.raillike_group(name)`: returns a rating
5657 * Returns rating of the connect_to_raillike group corresponding to name
5658 * If name is not yet the name of a connect_to_raillike group, a new group
5659 id is created, with that name.
5660 * `minetest.get_content_id(name)`: returns an integer
5661 * Gets the internal content ID of `name`
5662 * `minetest.get_name_from_content_id(content_id)`: returns a string
5663 * Gets the name of the content with that content ID
5664 * `minetest.parse_json(string[, nullvalue])`: returns something
5665 * Convert a string containing JSON data into the Lua equivalent
5666 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
5667 * On success returns a table, a string, a number, a boolean or `nullvalue`
5668 * On failure outputs an error message and returns `nil`
5669 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
5670 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error
5672 * Convert a Lua table into a JSON string
5673 * styled: Outputs in a human-readable format if this is set, defaults to
5675 * Unserializable things like functions and userdata will cause an error.
5676 * **Warning**: JSON is more strict than the Lua table format.
5677 1. You can only use strings and positive integers of at least one as
5679 2. You can not mix string and integer keys.
5680 This is due to the fact that JSON has two distinct array and object
5682 * Example: `write_json({10, {a = false}})`,
5683 returns `"[10, {\"a\": false}]"`
5684 * `minetest.serialize(table)`: returns a string
5685 * Convert a table containing tables, strings, numbers, booleans and `nil`s
5686 into string form readable by `minetest.deserialize`
5687 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
5688 * `minetest.deserialize(string[, safe])`: returns a table
5689 * Convert a string returned by `minetest.serialize` into a table
5690 * `string` is loaded in an empty sandbox environment.
5691 * Will load functions if safe is false or omitted. Although these functions
5692 cannot directly access the global environment, they could bypass this
5693 restriction with maliciously crafted Lua bytecode if mod security is
5695 * This function should not be used on untrusted data, regardless of the
5696 value of `safe`. It is fine to serialize then deserialize user-provided
5697 data, but directly providing user input to deserialize is always unsafe.
5698 * Example: `deserialize('return { ["foo"] = "bar" }')`,
5699 returns `{foo='bar'}`
5700 * Example: `deserialize('print("foo")')`, returns `nil`
5701 (function call fails), returns
5702 `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
5703 * `minetest.compress(data, method, ...)`: returns `compressed_data`
5704 * Compress a string of data.
5705 * `method` is a string identifying the compression method to be used.
5706 * Supported compression methods:
5707 * Deflate (zlib): `"deflate"`
5708 * `...` indicates method-specific arguments. Currently defined arguments
5710 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
5711 * `minetest.decompress(compressed_data, method, ...)`: returns data
5712 * Decompress a string of data (using ZLib).
5713 * See documentation on `minetest.compress()` for supported compression
5715 * `...` indicates method-specific arguments. Currently, no methods use this
5716 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
5717 * Each argument is a 8 Bit unsigned integer
5718 * Returns the ColorString from rgb or rgba values
5719 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
5720 * `minetest.encode_base64(string)`: returns string encoded in base64
5721 * Encodes a string in base64.
5722 * `minetest.decode_base64(string)`: returns string or nil for invalid base64
5723 * Decodes a string encoded in base64.
5724 * `minetest.is_protected(pos, name)`: returns boolean
5725 * Returning `true` restricts the player `name` from modifying (i.e. digging,
5726 placing) the node at position `pos`.
5727 * `name` will be `""` for non-players or unknown players.
5728 * This function should be overridden by protection mods. It is highly
5729 recommended to grant access to players with the `protection_bypass` privilege.
5730 * Cache and call the old version of this function if the position is
5731 not protected by the mod. This will allow using multiple protection mods.
5734 local old_is_protected = minetest.is_protected
5735 function minetest.is_protected(pos, name)
5736 if mymod:position_protected_from(pos, name) then
5739 return old_is_protected(pos, name)
5741 * `minetest.record_protection_violation(pos, name)`
5742 * This function calls functions registered with
5743 `minetest.register_on_protection_violation`.
5744 * `minetest.is_creative_enabled(name)`: returns boolean
5745 * Returning `true` means that Creative Mode is enabled for player `name`.
5746 * `name` will be `""` for non-players or if the player is unknown.
5747 * This function should be overridden by Creative Mode-related mods to
5748 implement a per-player Creative Mode.
5749 * By default, this function returns `true` if the setting
5750 `creative_mode` is `true` and `false` otherwise.
5751 * `minetest.is_area_protected(pos1, pos2, player_name, interval)`
5752 * Returns the position of the first node that `player_name` may not modify
5753 in the specified cuboid between `pos1` and `pos2`.
5754 * Returns `false` if no protections were found.
5755 * Applies `is_protected()` to a 3D lattice of points in the defined volume.
5756 The points are spaced evenly throughout the volume and have a spacing
5757 similar to, but no larger than, `interval`.
5758 * All corners and edges of the defined volume are checked.
5759 * `interval` defaults to 4.
5760 * `interval` should be carefully chosen and maximised to avoid an excessive
5761 number of points being checked.
5762 * Like `minetest.is_protected`, this function may be extended or
5763 overwritten by mods to provide a faster implementation to check the
5764 cuboid for intersections.
5765 * `minetest.rotate_and_place(itemstack, placer, pointed_thing[, infinitestacks,
5766 orient_flags, prevent_after_place])`
5767 * Attempt to predict the desired orientation of the facedir-capable node
5768 defined by `itemstack`, and place it accordingly (on-wall, on the floor,
5769 or hanging from the ceiling).
5770 * `infinitestacks`: if `true`, the itemstack is not changed. Otherwise the
5771 stacks are handled normally.
5772 * `orient_flags`: Optional table containing extra tweaks to the placement code:
5773 * `invert_wall`: if `true`, place wall-orientation on the ground and
5774 ground-orientation on the wall.
5775 * `force_wall` : if `true`, always place the node in wall orientation.
5776 * `force_ceiling`: if `true`, always place on the ceiling.
5777 * `force_floor`: if `true`, always place the node on the floor.
5778 * `force_facedir`: if `true`, forcefully reset the facedir to north
5779 when placing on the floor or ceiling.
5780 * The first four options are mutually-exclusive; the last in the list
5781 takes precedence over the first.
5782 * `prevent_after_place` is directly passed to `minetest.item_place_node`
5783 * Returns the new itemstack after placement
5784 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
5785 * calls `rotate_and_place()` with `infinitestacks` set according to the state
5786 of the creative mode setting, checks for "sneak" to set the `invert_wall`
5787 parameter and `prevent_after_place` set to `true`.
5789 * `minetest.calculate_knockback(player, hitter, time_from_last_punch,
5790 tool_capabilities, dir, distance, damage)`
5791 * Returns the amount of knockback applied on the punched player.
5792 * Arguments are equivalent to `register_on_punchplayer`, except the following:
5793 * `distance`: distance between puncher and punched player
5794 * This function can be overriden by mods that wish to modify this behaviour.
5795 * You may want to cache and call the old function to allow multiple mods to
5796 change knockback behaviour.
5798 * `minetest.forceload_block(pos[, transient])`
5799 * forceloads the position `pos`.
5800 * returns `true` if area could be forceloaded
5801 * If `transient` is `false` or absent, the forceload will be persistent
5802 (saved between server runs). If `true`, the forceload will be transient
5803 (not saved between server runs).
5805 * `minetest.forceload_free_block(pos[, transient])`
5806 * stops forceloading the position `pos`
5807 * If `transient` is `false` or absent, frees a persistent forceload.
5808 If `true`, frees a transient forceload.
5810 * `minetest.request_insecure_environment()`: returns an environment containing
5811 insecure functions if the calling mod has been listed as trusted in the
5812 `secure.trusted_mods` setting or security is disabled, otherwise returns
5814 * Only works at init time and must be called from the mod's main scope
5815 (ie: the init.lua of the mod, not from another Lua file or within a function).
5816 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE
5817 IT IN A LOCAL VARIABLE!**
5819 * `minetest.global_exists(name)`
5820 * Checks if a global variable has been set, without triggering a warning.
5825 * `minetest.env`: `EnvRef` of the server environment and world.
5826 * Any function in the minetest namespace can be called using the syntax
5827 `minetest.env:somefunction(somearguments)`
5828 instead of `minetest.somefunction(somearguments)`
5829 * Deprecated, but support is not to be dropped soon
5834 ### Registered definition tables
5836 * `minetest.registered_items`
5837 * Map of registered items, indexed by name
5838 * `minetest.registered_nodes`
5839 * Map of registered node definitions, indexed by name
5840 * `minetest.registered_craftitems`
5841 * Map of registered craft item definitions, indexed by name
5842 * `minetest.registered_tools`
5843 * Map of registered tool definitions, indexed by name
5844 * `minetest.registered_entities`
5845 * Map of registered entity prototypes, indexed by name
5846 * Values in this table may be modified directly.
5847 Note: changes to initial properties will only affect entities spawned afterwards,
5848 as they are only read when spawning.
5849 * `minetest.object_refs`
5850 * Map of object references, indexed by active object id
5851 * `minetest.luaentities`
5852 * Map of Lua entities, indexed by active object id
5853 * `minetest.registered_abms`
5854 * List of ABM definitions
5855 * `minetest.registered_lbms`
5856 * List of LBM definitions
5857 * `minetest.registered_aliases`
5858 * Map of registered aliases, indexed by name
5859 * `minetest.registered_ores`
5860 * Map of registered ore definitions, indexed by the `name` field.
5861 * If `name` is nil, the key is the object handle returned by
5862 `minetest.register_ore`.
5863 * `minetest.registered_biomes`
5864 * Map of registered biome definitions, indexed by the `name` field.
5865 * If `name` is nil, the key is the object handle returned by
5866 `minetest.register_biome`.
5867 * `minetest.registered_decorations`
5868 * Map of registered decoration definitions, indexed by the `name` field.
5869 * If `name` is nil, the key is the object handle returned by
5870 `minetest.register_decoration`.
5871 * `minetest.registered_schematics`
5872 * Map of registered schematic definitions, indexed by the `name` field.
5873 * If `name` is nil, the key is the object handle returned by
5874 `minetest.register_schematic`.
5875 * `minetest.registered_chatcommands`
5876 * Map of registered chat command definitions, indexed by name
5877 * `minetest.registered_privileges`
5878 * Map of registered privilege definitions, indexed by name
5879 * Registered privileges can be modified directly in this table.
5881 ### Registered callback tables
5883 All callbacks registered with [Global callback registration functions] are added
5884 to corresponding `minetest.registered_*` tables.
5892 Sorted alphabetically.
5897 A fast access data structure to store areas, and find areas near a given
5899 Every area has a `data` string attribute to store additional information.
5900 You can create an empty `AreaStore` by calling `AreaStore()`, or
5901 `AreaStore(type_name)`. The mod decides where to save and load AreaStore.
5902 If you chose the parameter-less constructor, a fast implementation will be
5903 automatically chosen for you.
5907 * `get_area(id, include_borders, include_data)`
5908 * Returns the area information about the specified ID.
5909 * Returned values are either of these:
5911 nil -- Area not found
5912 true -- Without `include_borders` and `include_data`
5914 min = pos, max = pos -- `include_borders == true`
5915 data = string -- `include_data == true`
5918 * `get_areas_for_pos(pos, include_borders, include_data)`
5919 * Returns all areas as table, indexed by the area ID.
5920 * Table values: see `get_area`.
5921 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`
5922 * Returns all areas that contain all nodes inside the area specified by `edge1`
5923 and `edge2` (inclusive).
5924 * `accept_overlap`: if `true`, areas are returned that have nodes in
5925 common (intersect) with the specified area.
5926 * Returns the same values as `get_areas_for_pos`.
5927 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store.
5928 * Returns the new area's ID, or nil if the insertion failed.
5929 * The (inclusive) positions `edge1` and `edge2` describe the area.
5930 * `data` is a string stored with the area.
5931 * `id` (optional): will be used as the internal area ID if it is an unique
5932 number between 0 and 2^32-2.
5933 * `reserve(count)`: reserves resources for at most `count` many contained
5935 Only needed for efficiency, and only some implementations profit.
5936 * `remove_area(id)`: removes the area with the given id from the store, returns
5938 * `set_cache_params(params)`: sets params for the included prefiltering cache.
5939 Calling invalidates the cache, so that its elements have to be newly
5941 * `params` is a table with the following fields:
5943 enabled = boolean, -- Whether to enable, default true
5944 block_radius = int, -- The radius (in nodes) of the areas the cache
5945 -- generates prefiltered lists for, minimum 16,
5947 limit = int, -- The cache size, minimum 20, default 1000
5948 * `to_string()`: Experimental. Returns area store serialized as a (binary)
5950 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to
5952 * `from_string(str)`: Experimental. Deserializes string and loads it into the
5954 Returns success and, optionally, an error message.
5955 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data
5961 An `InvRef` is a reference to an inventory.
5965 * `is_empty(listname)`: return `true` if list is empty
5966 * `get_size(listname)`: get size of a list
5967 * `set_size(listname, size)`: set size of a list
5968 * returns `false` on error (e.g. invalid `listname` or `size`)
5969 * `get_width(listname)`: get width of a list
5970 * `set_width(listname, width)`: set width of list; currently used for crafting
5971 * `get_stack(listname, i)`: get a copy of stack index `i` in list
5972 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
5973 * `get_list(listname)`: return full list
5974 * `set_list(listname, list)`: set full list (size will not change)
5975 * `get_lists()`: returns list of inventory lists
5976 * `set_lists(lists)`: sets inventory lists (size will not change)
5977 * `add_item(listname, stack)`: add item somewhere in list, returns leftover
5979 * `room_for_item(listname, stack):` returns `true` if the stack of items
5980 can be fully added to the list
5981 * `contains_item(listname, stack, [match_meta])`: returns `true` if
5982 the stack of items can be fully taken from the list.
5983 If `match_meta` is false, only the items' names are compared
5985 * `remove_item(listname, stack)`: take as many items as specified from the
5986 list, returns the items that were actually removed (as an `ItemStack`)
5987 -- note that any item metadata is ignored, so attempting to remove a specific
5988 unique item this way will likely remove the wrong one -- to do that use
5989 `set_stack` with an empty `ItemStack`.
5990 * `get_location()`: returns a location compatible to
5991 `minetest.get_inventory(location)`.
5992 * returns `{type="undefined"}` in case location is not known
5996 Detached & nodemeta inventories provide the following callbacks for move actions:
6000 The `allow_*` callbacks return how many items can be moved.
6002 * `allow_move`/`allow_metadata_inventory_move`: Moving items in the inventory
6003 * `allow_take`/`allow_metadata_inventory_take`: Taking items from the inventory
6004 * `allow_put`/`allow_metadata_inventory_put`: Putting items to the inventory
6008 The `on_*` callbacks are called after the items have been placed in the inventories.
6010 * `on_move`/`on_metadata_inventory_move`: Moving items in the inventory
6011 * `on_take`/`on_metadata_inventory_take`: Taking items from the inventory
6012 * `on_put`/`on_metadata_inventory_put`: Putting items to the inventory
6016 When a player tries to put an item to a place where another item is, the items are *swapped*.
6017 This means that all callbacks will be called twice (once for each action).
6022 An `ItemStack` is a stack of items.
6024 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
6025 an itemstring, a table or `nil`.
6029 * `is_empty()`: returns `true` if stack is empty.
6030 * `get_name()`: returns item name (e.g. `"default:stone"`).
6031 * `set_name(item_name)`: returns a boolean indicating whether the item was
6033 * `get_count()`: Returns number of items on the stack.
6034 * `set_count(count)`: returns a boolean indicating whether the item was cleared
6035 * `count`: number, unsigned 16 bit integer
6036 * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
6037 * `set_wear(wear)`: returns boolean indicating whether item was cleared
6038 * `wear`: number, unsigned 16 bit integer
6039 * `get_meta()`: returns ItemStackMetaRef. See section for more details
6040 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
6042 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
6043 * `get_description()`: returns the description shown in inventory list tooltips.
6044 * The engine uses the same as this function for item descriptions.
6045 * Fields for finding the description, in order:
6046 * `description` in item metadata (See [Item Metadata].)
6047 * `description` in item definition
6049 * `get_short_description()`: returns the short description.
6050 * Unlike the description, this does not include new lines.
6051 * The engine uses the same as this function for short item descriptions.
6052 * Fields for finding the short description, in order:
6053 * `short_description` in item metadata (See [Item Metadata].)
6054 * `short_description` in item definition
6055 * first line of the description (See `get_description()`.)
6056 * `clear()`: removes all items from the stack, making it empty.
6057 * `replace(item)`: replace the contents of this stack.
6058 * `item` can also be an itemstring or table.
6059 * `to_string()`: returns the stack in itemstring form.
6060 * `to_table()`: returns the stack in Lua table form.
6061 * `get_stack_max()`: returns the maximum size of the stack (depends on the
6063 * `get_free_space()`: returns `get_stack_max() - get_count()`.
6064 * `is_known()`: returns `true` if the item name refers to a defined item type.
6065 * `get_definition()`: returns the item definition table.
6066 * `get_tool_capabilities()`: returns the digging properties of the item,
6067 or those of the hand if none are defined for this item type
6068 * `add_wear(amount)`
6069 * Increases wear by `amount` if the item is a tool
6070 * `amount`: number, integer
6071 * `add_item(item)`: returns leftover `ItemStack`
6072 * Put some item or stack onto this stack
6073 * `item_fits(item)`: returns `true` if item or stack can be fully added to
6075 * `take_item(n)`: returns taken `ItemStack`
6076 * Take (and remove) up to `n` items from this stack
6077 * `n`: number, default: `1`
6078 * `peek_item(n)`: returns taken `ItemStack`
6079 * Copy (don't remove) up to `n` items from this stack
6080 * `n`: number, default: `1`
6085 ItemStack metadata: reference extra data and functionality stored in a stack.
6086 Can be obtained via `item:get_meta()`.
6090 * All methods in MetaDataRef
6091 * `set_tool_capabilities([tool_capabilities])`
6092 * Overrides the item's tool capabilities
6093 * A nil value will clear the override data and restore the original
6099 Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],
6100 and [`PlayerMetaRef`].
6104 * `contains(key)`: Returns true if key present, otherwise false.
6105 * Returns `nil` when the MetaData is inexistent.
6106 * `get(key)`: Returns `nil` if key not present, else the stored string.
6107 * `set_string(key, value)`: Value of `""` will delete the key.
6108 * `get_string(key)`: Returns `""` if key not present.
6109 * `set_int(key, value)`
6110 * `get_int(key)`: Returns `0` if key not present.
6111 * `set_float(key, value)`
6112 * `get_float(key)`: Returns `0` if key not present.
6113 * `to_table()`: returns `nil` or a table with keys:
6114 * `fields`: key-value storage
6115 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
6116 * `from_table(nil or {})`
6117 * Any non-table value will clear the metadata
6118 * See [Node Metadata] for an example
6119 * returns `true` on success
6121 * returns `true` if this metadata has the same key-value pairs as `other`
6126 An interface to use mod channels on client and server
6130 * `leave()`: leave the mod channel.
6131 * Server leaves channel `channel_name`.
6132 * No more incoming or outgoing messages can be sent to this channel from
6134 * This invalidate all future object usage.
6135 * Ensure you set mod_channel to nil after that to free Lua resources.
6136 * `is_writeable()`: returns true if channel is writeable and mod can send over
6138 * `send_all(message)`: Send `message` though the mod channel.
6139 * If mod channel is not writeable or invalid, message will be dropped.
6140 * Message size is limited to 65535 characters by protocol.
6145 Node metadata: reference extra data and functionality stored in a node.
6146 Can be obtained via `minetest.get_meta(pos)`.
6150 * All methods in MetaDataRef
6151 * `get_inventory()`: returns `InvRef`
6152 * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
6153 This will prevent them from being sent to the client. Note that the "private"
6154 status will only be remembered if an associated key-value pair exists,
6155 meaning it's best to call this when initializing all other meta (e.g.
6161 Node Timers: a high resolution persistent per-node timer.
6162 Can be gotten via `minetest.get_node_timer(pos)`.
6166 * `set(timeout,elapsed)`
6167 * set a timer's state
6168 * `timeout` is in seconds, and supports fractional values (0.1 etc)
6169 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
6170 * will trigger the node's `on_timer` function after `(timeout - elapsed)`
6174 * equivalent to `set(timeout,0)`
6177 * `get_timeout()`: returns current timeout in seconds
6178 * if `timeout` equals `0`, timer is inactive
6179 * `get_elapsed()`: returns current elapsed time in seconds
6180 * the node's `on_timer` function will be called after `(timeout - elapsed)`
6182 * `is_started()`: returns boolean state of timer
6183 * returns `true` if timer is started, otherwise `false`
6188 Moving things in the game are generally these.
6189 This is basically a reference to a C++ `ServerActiveObject`.
6191 ### Advice on handling `ObjectRefs`
6193 When you receive an `ObjectRef` as a callback argument or from another API
6194 function, it is possible to store the reference somewhere and keep it around.
6195 It will keep functioning until the object is unloaded or removed.
6197 However, doing this is **NOT** recommended as there is (intentionally) no method
6198 to test if a previously acquired `ObjectRef` is still valid.
6199 Instead, `ObjectRefs` should be "let go" of as soon as control is returned from
6200 Lua back to the engine.
6201 Doing so is much less error-prone and you will never need to wonder if the
6202 object you are working with still exists.
6207 * `get_pos()`: returns `{x=num, y=num, z=num}`
6208 * `set_pos(pos)`: `pos`=`{x=num, y=num, z=num}`
6209 * `get_velocity()`: returns the velocity, a vector.
6210 * `add_velocity(vel)`
6211 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
6212 * In comparison to using get_velocity, adding the velocity and then using
6213 set_velocity, add_velocity is supposed to avoid synchronization problems.
6214 Additionally, players also do not support set_velocity.
6216 * Does not apply during free_move.
6217 * Note that since the player speed is normalized at each move step,
6218 increasing e.g. Y velocity beyond what would usually be achieved
6219 (see: physics overrides) will cause existing X/Z velocity to be reduced.
6220 * Example: `add_velocity({x=0, y=6.5, z=0})` is equivalent to
6221 pressing the jump key (assuming default settings)
6222 * `move_to(pos, continuous=false)`
6223 * Does an interpolated move for Lua entities for visually smooth transitions.
6224 * If `continuous` is true, the Lua entity will not be moved to the current
6225 position before starting the interpolated move.
6226 * For players this does the same as `set_pos`,`continuous` is ignored.
6227 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
6228 * `puncher` = another `ObjectRef`,
6229 * `time_from_last_punch` = time since last punch action of the puncher
6230 * `direction`: can be `nil`
6231 * `right_click(clicker)`; `clicker` is another `ObjectRef`
6232 * `get_hp()`: returns number of health points
6233 * `set_hp(hp, reason)`: set number of health points
6234 * See reason in register_on_player_hpchange
6235 * Is limited to the range of 0 ... 65535 (2^16 - 1)
6236 * For players: HP are also limited by `hp_max` specified in the player's
6238 * `get_inventory()`: returns an `InvRef` for players, otherwise returns `nil`
6239 * `get_wield_list()`: returns the name of the inventory list the wielded item
6241 * `get_wield_index()`: returns the index of the wielded item
6242 * `get_wielded_item()`: returns an `ItemStack`
6243 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if
6245 * `set_armor_groups({group1=rating, group2=rating, ...})`
6246 * `get_armor_groups()`: returns a table with the armor group ratings
6247 * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
6248 * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
6249 * `frame_speed`: number, default: `15.0`
6250 * `frame_blend`: number, default: `0.0`
6251 * `frame_loop`: boolean, default: `true`
6252 * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and
6254 * `set_animation_frame_speed(frame_speed)`
6255 * `frame_speed`: number, default: `15.0`
6256 * `set_attach(parent[, bone, position, rotation, forced_visible])`
6257 * `bone`: string. Default is `""`, the root bone
6258 * `position`: `{x=num, y=num, z=num}`, relative, default `{x=0, y=0, z=0}`
6259 * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees.
6260 Default `{x=0, y=0, z=0}`
6261 * `forced_visible`: Boolean to control whether the attached entity
6262 should appear in first person. Default `false`.
6263 * `get_attach()`: returns parent, bone, position, rotation, forced_visible,
6264 or nil if it isn't attached.
6265 * `get_children()`: returns a list of ObjectRefs that are attached to the
6268 * `set_bone_position([bone, position, rotation])`
6269 * `bone`: string. Default is `""`, the root bone
6270 * `position`: `{x=num, y=num, z=num}`, relative, `default {x=0, y=0, z=0}`
6271 * `rotation`: `{x=num, y=num, z=num}`, default `{x=0, y=0, z=0}`
6272 * `get_bone_position(bone)`: returns position and rotation of the bone
6273 * `set_properties(object property table)`
6274 * `get_properties()`: returns object property table
6275 * `is_player()`: returns true for players, false otherwise
6276 * `get_nametag_attributes()`
6277 * returns a table with the attributes of the nametag of an object
6279 color = {a=0..255, r=0..255, g=0..255, b=0..255},
6282 * `set_nametag_attributes(attributes)`
6283 * sets the attributes of the nametag of an object
6287 text = "My Nametag",
6290 #### Lua entity only (no-op for other objects)
6292 * `remove()`: remove object
6293 * The object is removed after returning from Lua. However the `ObjectRef`
6294 itself instantly becomes unusable with all further method calls having
6295 no effect and returning `nil`.
6296 * `set_velocity(vel)`
6297 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
6298 * `set_acceleration(acc)`
6300 * `get_acceleration()`: returns the acceleration, a vector
6301 * `set_rotation(rot)`
6302 * `rot` is a vector (radians). X is pitch (elevation), Y is yaw (heading)
6303 and Z is roll (bank).
6304 * `get_rotation()`: returns the rotation, a vector (radians)
6305 * `set_yaw(yaw)`: sets the yaw in radians (heading).
6306 * `get_yaw()`: returns number in radians
6307 * `set_texture_mod(mod)`
6308 * Set a texture modifier to the base texture, for sprites and meshes.
6309 * When calling `set_texture_mod` again, the previous one is discarded.
6310 * `mod` the texture modifier. See [Texture modifiers].
6311 * `get_texture_mod()` returns current texture modifier
6312 * `set_sprite(start_frame, num_frames, framelength, select_x_by_camera)`
6313 * Specifies and starts a sprite animation
6314 * Animations iterate along the frame `y` position.
6315 * `start_frame`: {x=column number, y=row number}, the coordinate of the
6316 first frame, default: `{x=0, y=0}`
6317 * `num_frames`: Total frames in the texture, default: `1`
6318 * `framelength`: Time per animated frame in seconds, default: `0.2`
6319 * `select_x_by_camera`: Only for visual = `sprite`. Changes the frame `x`
6320 position according to the view direction. default: `false`.
6321 * First column: subject facing the camera
6322 * Second column: subject looking to the left
6323 * Third column: subject backing the camera
6324 * Fourth column: subject looking to the right
6325 * Fifth column: subject viewed from above
6326 * Sixth column: subject viewed from below
6327 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
6330 #### Player only (no-op for other objects)
6332 * `get_player_name()`: returns `""` if is not a player
6333 * `get_player_velocity()`: **DEPRECATED**, use get_velocity() instead.
6334 table {x, y, z} representing the player's instantaneous velocity in nodes/s
6335 * `add_player_velocity(vel)`: **DEPRECATED**, use add_velocity(vel) instead.
6336 * `get_look_dir()`: get camera direction as a unit vector
6337 * `get_look_vertical()`: pitch in radians
6338 * Angle ranges between -pi/2 and pi/2, which are straight up and down
6340 * `get_look_horizontal()`: yaw in radians
6341 * Angle is counter-clockwise from the +z direction.
6342 * `set_look_vertical(radians)`: sets look pitch
6343 * radians: Angle from looking forward, where positive is downwards.
6344 * `set_look_horizontal(radians)`: sets look yaw
6345 * radians: Angle from the +z direction, where positive is counter-clockwise.
6346 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use
6347 `get_look_vertical`.
6348 * Angle ranges between -pi/2 and pi/2, which are straight down and up
6350 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use
6351 `get_look_horizontal`.
6352 * Angle is counter-clockwise from the +x direction.
6353 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use
6354 `set_look_vertical`.
6355 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use
6356 `set_look_horizontal`.
6357 * `get_breath()`: returns player's breath
6358 * `set_breath(value)`: sets player's breath
6360 * `0`: player is drowning
6361 * max: bubbles bar is not shown
6362 * See [Object properties] for more information
6363 * Is limited to range 0 ... 65535 (2^16 - 1)
6364 * `set_fov(fov, is_multiplier, transition_time)`: Sets player's FOV
6366 * `is_multiplier`: Set to `true` if the FOV value is a multiplier.
6367 Defaults to `false`.
6368 * `transition_time`: If defined, enables smooth FOV transition.
6369 Interpreted as the time (in seconds) to reach target FOV.
6370 If set to 0, FOV change is instantaneous. Defaults to 0.
6371 * Set `fov` to 0 to clear FOV override.
6372 * `get_fov()`: Returns the following:
6373 * Server-sent FOV value. Returns 0 if an FOV override doesn't exist.
6374 * Boolean indicating whether the FOV value is a multiplier.
6375 * Time (in seconds) taken for the FOV transition. Set by `set_fov`.
6376 * `set_attribute(attribute, value)`: DEPRECATED, use get_meta() instead
6377 * Sets an extra attribute with value on player.
6378 * `value` must be a string, or a number which will be converted to a
6380 * If `value` is `nil`, remove attribute from player.
6381 * `get_attribute(attribute)`: DEPRECATED, use get_meta() instead
6382 * Returns value (a string) for extra attribute.
6383 * Returns `nil` if no attribute found.
6384 * `get_meta()`: Returns a PlayerMetaRef.
6385 * `set_inventory_formspec(formspec)`
6386 * Redefine player's inventory form
6387 * Should usually be called in `on_joinplayer`
6388 * `get_inventory_formspec()`: returns a formspec string
6389 * `set_formspec_prepend(formspec)`:
6390 * the formspec string will be added to every formspec shown to the user,
6391 except for those with a no_prepend[] tag.
6392 * This should be used to set style elements such as background[] and
6393 bgcolor[], any non-style elements (eg: label) may result in weird behaviour.
6394 * Only affects formspecs shown after this is called.
6395 * `get_formspec_prepend(formspec)`: returns a formspec string.
6396 * `get_player_control()`: returns table with player pressed keys
6397 * The table consists of fields with the following boolean values
6398 representing the pressed keys: `up`, `down`, `left`, `right`, `jump`,
6399 `aux1`, `sneak`, `dig`, `place`, `LMB`, `RMB`, and `zoom`.
6400 * The fields `LMB` and `RMB` are equal to `dig` and `place` respectively,
6401 and exist only to preserve backwards compatibility.
6402 * `get_player_control_bits()`: returns integer with bit packed player pressed
6414 * `set_physics_override(override_table)`
6415 * `override_table` is a table with the following fields:
6416 * `speed`: multiplier to default walking speed value (default: `1`)
6417 * `jump`: multiplier to default jump value (default: `1`)
6418 * `gravity`: multiplier to default gravity value (default: `1`)
6419 * `sneak`: whether player can sneak (default: `true`)
6420 * `sneak_glitch`: whether player can use the new move code replications
6421 of the old sneak side-effects: sneak ladders and 2 node sneak jump
6423 * `new_move`: use new move/sneak code. When `false` the exact old code
6424 is used for the specific old sneak behaviour (default: `true`)
6425 * `get_physics_override()`: returns the table given to `set_physics_override`
6426 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
6428 * `hud_remove(id)`: remove the HUD element of the specified id
6429 * `hud_change(id, stat, value)`: change a value of a previously added HUD
6431 * element `stat` values:
6432 `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
6433 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
6434 * `hud_set_flags(flags)`: sets specified HUD flags of player.
6435 * `flags`: A table with the following fields set to boolean values
6443 * If a flag equals `nil`, the flag is not modified
6444 * `minimap`: Modifies the client's permission to view the minimap.
6445 The client may locally elect to not view the minimap.
6446 * `minimap_radar` is only usable when `minimap` is true
6447 * `hud_get_flags()`: returns a table of player HUD flags with boolean values.
6448 * See `hud_set_flags` for a list of flags that can be toggled.
6449 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
6450 * `count`: number of items, must be between `1` and `32`
6451 * `hud_get_hotbar_itemcount`: returns number of visible items
6452 * `hud_set_hotbar_image(texturename)`
6453 * sets background image for hotbar
6454 * `hud_get_hotbar_image`: returns texturename
6455 * `hud_set_hotbar_selected_image(texturename)`
6456 * sets image for selected item of hotbar
6457 * `hud_get_hotbar_selected_image`: returns texturename
6458 * `set_minimap_modes({mode, mode, ...}, selected_mode)`
6459 * Overrides the available minimap modes (and toggle order), and changes the
6461 * `mode` is a table consisting of up to four fields:
6462 * `type`: Available type:
6463 * `off`: Minimap off
6464 * `surface`: Minimap in surface mode
6465 * `radar`: Minimap in radar mode
6466 * `texture`: Texture to be displayed instead of terrain map
6467 (texture is centered around 0,0 and can be scaled).
6468 Texture size is limited to 512 x 512 pixel.
6469 * `label`: Optional label to display on minimap mode toggle
6470 The translation must be handled within the mod.
6471 * `size`: Sidelength or diameter, in number of nodes, of the terrain
6472 displayed in minimap
6473 * `texture`: Only for texture type, name of the texture to display
6474 * `scale`: Only for texture type, scale of the texture map in nodes per
6475 pixel (for example a `scale` of 2 means each pixel represents a 2x2
6477 * `selected_mode` is the mode index to be selected after modes have been changed
6478 (0 is the first mode).
6479 * `set_sky(sky_parameters)`
6480 * The presence of the function `set_sun`, `set_moon` or `set_stars` indicates
6481 whether `set_sky` accepts this format. Check the legacy format otherwise.
6482 * `sky_parameters` is a table with the following optional fields:
6483 * `base_color`: ColorSpec, changes fog in "skybox" and "plain".
6484 * `type`: Available types:
6485 * `"regular"`: Uses 0 textures, `base_color` ignored
6486 * `"skybox"`: Uses 6 textures, `base_color` used as fog.
6487 * `"plain"`: Uses 0 textures, `base_color` used as both fog and sky.
6488 * `textures`: A table containing up to six textures in the following
6489 order: Y+ (top), Y- (bottom), X- (west), X+ (east), Z+ (north), Z- (south).
6490 * `clouds`: Boolean for whether clouds appear. (default: `true`)
6491 * `sky_color`: A table containing the following values, alpha is ignored:
6492 * `day_sky`: ColorSpec, for the top half of the `"regular"`
6493 sky during the day. (default: `#8cbafa`)
6494 * `day_horizon`: ColorSpec, for the bottom half of the
6495 `"regular"` sky during the day. (default: `#9bc1f0`)
6496 * `dawn_sky`: ColorSpec, for the top half of the `"regular"`
6497 sky during dawn/sunset. (default: `#b4bafa`)
6498 The resulting sky color will be a darkened version of the ColorSpec.
6499 Warning: The darkening of the ColorSpec is subject to change.
6500 * `dawn_horizon`: ColorSpec, for the bottom half of the `"regular"`
6501 sky during dawn/sunset. (default: `#bac1f0`)
6502 The resulting sky color will be a darkened version of the ColorSpec.
6503 Warning: The darkening of the ColorSpec is subject to change.
6504 * `night_sky`: ColorSpec, for the top half of the `"regular"`
6505 sky during the night. (default: `#006aff`)
6506 The resulting sky color will be a dark version of the ColorSpec.
6507 Warning: The darkening of the ColorSpec is subject to change.
6508 * `night_horizon`: ColorSpec, for the bottom half of the `"regular"`
6509 sky during the night. (default: `#4090ff`)
6510 The resulting sky color will be a dark version of the ColorSpec.
6511 Warning: The darkening of the ColorSpec is subject to change.
6512 * `indoors`: ColorSpec, for when you're either indoors or
6513 underground. Only applies to the `"regular"` sky.
6514 (default: `#646464`)
6515 * `fog_sun_tint`: ColorSpec, changes the fog tinting for the sun
6516 at sunrise and sunset.
6517 * `fog_moon_tint`: ColorSpec, changes the fog tinting for the moon
6518 at sunrise and sunset.
6519 * `fog_tint_type`: string, changes which mode the directional fog
6520 abides by, `"custom"` uses `sun_tint` and `moon_tint`, while
6521 `"default"` uses the classic Minetest sun and moon tinting.
6522 Will use tonemaps, if set to `"default"`. (default: `"default"`)
6523 * `set_sky(base_color, type, {texture names}, clouds)`
6524 * Deprecated. Use `set_sky(sky_parameters)`
6525 * `base_color`: ColorSpec, defaults to white
6526 * `type`: Available types:
6527 * `"regular"`: Uses 0 textures, `bgcolor` ignored
6528 * `"skybox"`: Uses 6 textures, `bgcolor` used
6529 * `"plain"`: Uses 0 textures, `bgcolor` used
6530 * `clouds`: Boolean for whether clouds appear in front of `"skybox"` or
6531 `"plain"` custom skyboxes (default: `true`)
6532 * `get_sky()`: returns base_color, type, table of textures, clouds.
6533 * `get_sky_color()`: returns a table with the `sky_color` parameters as in
6535 * `set_sun(sun_parameters)`:
6536 * `sun_parameters` is a table with the following optional fields:
6537 * `visible`: Boolean for whether the sun is visible.
6539 * `texture`: A regular texture for the sun. Setting to `""`
6540 will re-enable the mesh sun. (default: `"sun.png"`)
6541 * `tonemap`: A 512x1 texture containing the tonemap for the sun
6542 (default: `"sun_tonemap.png"`)
6543 * `sunrise`: A regular texture for the sunrise texture.
6544 (default: `"sunrisebg.png"`)
6545 * `sunrise_visible`: Boolean for whether the sunrise texture is visible.
6547 * `scale`: Float controlling the overall size of the sun. (default: `1`)
6548 * `get_sun()`: returns a table with the current sun parameters as in
6550 * `set_moon(moon_parameters)`:
6551 * `moon_parameters` is a table with the following optional fields:
6552 * `visible`: Boolean for whether the moon is visible.
6554 * `texture`: A regular texture for the moon. Setting to `""`
6555 will re-enable the mesh moon. (default: `"moon.png"`)
6556 * `tonemap`: A 512x1 texture containing the tonemap for the moon
6557 (default: `"moon_tonemap.png"`)
6558 * `scale`: Float controlling the overall size of the moon (default: `1`)
6559 * `get_moon()`: returns a table with the current moon parameters as in
6561 * `set_stars(star_parameters)`:
6562 * `star_parameters` is a table with the following optional fields:
6563 * `visible`: Boolean for whether the stars are visible.
6565 * `count`: Integer number to set the number of stars in
6566 the skybox. Only applies to `"skybox"` and `"regular"` sky types.
6568 * `star_color`: ColorSpec, sets the colors of the stars,
6569 alpha channel is used to set overall star brightness.
6570 (default: `#ebebff69`)
6571 * `scale`: Float controlling the overall size of the stars (default: `1`)
6572 * `get_stars()`: returns a table with the current stars parameters as in
6574 * `set_clouds(cloud_parameters)`: set cloud parameters
6575 * `cloud_parameters` is a table with the following optional fields:
6576 * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
6577 * `color`: basic cloud color with alpha channel, ColorSpec
6578 (default `#fff0f0e5`).
6579 * `ambient`: cloud color lower bound, use for a "glow at night" effect.
6580 ColorSpec (alpha ignored, default `#000000`)
6581 * `height`: cloud height, i.e. y of cloud base (default per conf,
6583 * `thickness`: cloud thickness in nodes (default `16`)
6584 * `speed`: 2D cloud speed + direction in nodes per second
6585 (default `{x=0, z=-2}`).
6586 * `get_clouds()`: returns a table with the current cloud parameters as in
6588 * `override_day_night_ratio(ratio or nil)`
6589 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific
6591 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
6592 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
6593 * `set_local_animation(idle, walk, dig, walk_while_dig, frame_speed)`:
6594 set animation for player model in third person view.
6595 * Every animation equals to a `{x=starting frame, y=ending frame}` table.
6596 * `frame_speed` sets the animations frame speed. Default is 30.
6597 * `get_local_animation()`: returns idle, walk, dig, walk_while_dig tables and
6599 * `set_eye_offset([firstperson, thirdperson])`: defines offset vectors for
6600 camera per player. An argument defaults to `{x=0, y=0, z=0}` if unspecified.
6601 * in first person view
6602 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
6603 * `get_eye_offset()`: returns first and third person offsets.
6604 * `send_mapblock(blockpos)`:
6605 * Sends a server-side loaded mapblock to the player.
6606 * Returns `false` if failed.
6607 * Resource intensive - use sparsely
6608 * To get blockpos, integer divide pos by 16
6613 A 32-bit pseudorandom number generator.
6614 Uses PCG32, an algorithm of the permuted congruential generator family,
6615 offering very strong randomness.
6617 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
6621 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
6622 * `next(min, max)`: return next integer random number [`min`...`max`]
6623 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed
6624 random number [`min`...`max`].
6625 * This is only a rough approximation of a normal distribution with:
6626 * `mean = (max - min) / 2`, and
6627 * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
6628 * Increasing `num_trials` improves accuracy of the approximation
6633 A perlin noise generator.
6634 It can be created via `PerlinNoise()` or `minetest.get_perlin()`.
6635 For `minetest.get_perlin()`, the actual seed used is the noiseparams seed
6636 plus the world seed, to create world-specific noise.
6638 `PerlinNoise(noiseparams)`
6639 `PerlinNoise(seed, octaves, persistence, spread)` (Deprecated).
6641 `minetest.get_perlin(noiseparams)`
6642 `minetest.get_perlin(seeddiff, octaves, persistence, spread)` (Deprecated).
6646 * `get_2d(pos)`: returns 2D noise value at `pos={x=,y=}`
6647 * `get_3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
6652 A fast, bulk perlin noise generator.
6654 It can be created via `PerlinNoiseMap(noiseparams, size)` or
6655 `minetest.get_perlin_map(noiseparams, size)`.
6656 For `minetest.get_perlin_map()`, the actual seed used is the noiseparams seed
6657 plus the world seed, to create world-specific noise.
6659 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
6660 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
6663 For each of the functions with an optional `buffer` parameter: If `buffer` is
6664 not nil, this table will be used to store the result instead of creating a new
6669 * `get_2d_map(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
6670 with values starting at `pos={x=,y=}`
6671 * `get_3d_map(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>`
6672 3D array of 3D noise with values starting at `pos={x=,y=,z=}`.
6673 * `get_2d_map_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element
6674 array of 2D noise with values starting at `pos={x=,y=}`
6675 * `get_3d_map_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
6676 * `calc_2d_map(pos)`: Calculates the 2d noise map starting at `pos`. The result
6677 is stored internally.
6678 * `calc_3d_map(pos)`: Calculates the 3d noise map starting at `pos`. The result
6679 is stored internally.
6680 * `get_map_slice(slice_offset, slice_size, buffer)`: In the form of an array,
6681 returns a slice of the most recently computed noise results. The result slice
6682 begins at coordinates `slice_offset` and takes a chunk of `slice_size`.
6683 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer
6685 `noisevals = noise:get_map_slice({y=20}, {y=2})`
6686 It is important to note that `slice_offset` offset coordinates begin at 1,
6687 and are relative to the starting position of the most recently calculated
6689 To grab a single vertical column of noise starting at map coordinates
6690 x = 1023, y=1000, z = 1000:
6691 `noise:calc_3d_map({x=1000, y=1000, z=1000})`
6692 `noisevals = noise:get_map_slice({x=24, z=1}, {x=1, z=1})`
6698 Uses the same method of storage as the deprecated player attribute API, so
6699 data there will also be in player meta.
6700 Can be obtained using `player:get_meta()`.
6704 * All methods in MetaDataRef
6709 A 16-bit pseudorandom number generator.
6710 Uses a well-known LCG algorithm introduced by K&R.
6712 It can be created via `PseudoRandom(seed)`.
6716 * `next()`: return next integer random number [`0`...`32767`]
6717 * `next(min, max)`: return next integer random number [`min`...`max`]
6718 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
6719 due to the simple implementation making bad distribution otherwise.
6724 A raycast on the map. It works with selection boxes.
6725 Can be used as an iterator in a for loop as:
6727 local ray = Raycast(...)
6728 for pointed_thing in ray do
6732 The map is loaded as the ray advances. If the map is modified after the
6733 `Raycast` is created, the changes may or may not have an effect on the object.
6735 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
6736 `minetest.raycast(pos1, pos2, objects, liquids)` where:
6738 * `pos1`: start of the ray
6739 * `pos2`: end of the ray
6740 * `objects`: if false, only nodes will be returned. Default is true.
6741 * `liquids`: if false, liquid nodes won't be returned. Default is false.
6745 * `next()`: returns a `pointed_thing` with exact pointing location
6746 * Returns the next thing pointed by the ray or nil.
6751 Interface for the operating system's crypto-secure PRNG.
6753 It can be created via `SecureRandom()`. The constructor returns nil if a
6754 secure random device cannot be found on the system.
6758 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many
6759 random bytes, as a string.
6764 An interface to read config files in the format of `minetest.conf`.
6766 It can be created via `Settings(filename)`.
6770 * `get(key)`: returns a value
6771 * `get_bool(key, [default])`: returns a boolean
6772 * `default` is the value returned if `key` is not found.
6773 * Returns `nil` if `key` is not found and `default` not specified.
6774 * `get_np_group(key)`: returns a NoiseParams table
6776 * Returns `{flag = true/false, ...}` according to the set flags.
6777 * Is currently limited to mapgen flags `mg_flags` and mapgen-specific
6778 flags like `mgv5_spflags`.
6780 * Setting names can't contain whitespace or any of `="{}#`.
6781 * Setting values can't contain the sequence `\n"""`.
6782 * Setting names starting with "secure." can't be set on the main settings
6783 object (`minetest.settings`).
6784 * `set_bool(key, value)`
6785 * See documentation for set() above.
6786 * `set_np_group(key, value)`
6787 * `value` is a NoiseParams table.
6788 * Also, see documentation for set() above.
6789 * `remove(key)`: returns a boolean (`true` for success)
6790 * `get_names()`: returns `{key1,...}`
6791 * `write()`: returns a boolean (`true` for success)
6792 * Writes changes to file.
6793 * `to_table()`: returns `{[key1]=value1,...}`
6797 The settings have the format `key = value`. Example:
6809 Mod metadata: per mod metadata, saved automatically.
6810 Can be obtained via `minetest.get_mod_storage()` during load time.
6812 WARNING: This storage backend is incaptable to save raw binary data due
6813 to restrictions of JSON.
6817 * All methods in MetaDataRef
6828 Used by `ObjectRef` methods. Part of an Entity definition.
6829 These properties are not persistent, but are applied automatically to the
6830 corresponding Lua entity using the given registration fields.
6831 Player properties need to be saved manually.
6835 -- For players only. Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`.
6838 -- For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`.
6841 -- For players only. Zoom FOV in degrees.
6842 -- Note that zoom loads and/or generates world beyond the server's
6843 -- maximum send and generate distances, so acts like a telescope.
6844 -- Smaller zoom_fov values increase the distance loaded/generated.
6845 -- Defaults to 15 in creative mode, 0 in survival mode.
6846 -- zoom_fov = 0 disables zooming for the player.
6849 -- For players only. Camera height above feet position in nodes.
6850 -- Defaults to 1.625.
6853 -- Collide with `walkable` nodes.
6855 collide_with_objects = true,
6856 -- Collide with other objects if physical = true
6858 collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5}, -- Default
6859 selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
6860 -- Selection box uses collision box dimensions when not set.
6861 -- For both boxes: {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from
6865 -- Overrides selection box when false
6867 visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem" / "item",
6868 -- "cube" is a node-sized cube.
6869 -- "sprite" is a flat texture always facing the player.
6870 -- "upright_sprite" is a vertical flat texture.
6871 -- "mesh" uses the defined mesh model.
6872 -- "wielditem" is used for dropped items.
6873 -- (see builtin/game/item_entity.lua).
6874 -- For this use 'wield_item = itemname' (Deprecated: 'textures = {itemname}').
6875 -- If the item has a 'wield_image' the object will be an extrusion of
6877 -- If 'itemname' is a cubic node or nodebox the object will appear
6878 -- identical to 'itemname'.
6879 -- If 'itemname' is a plantlike node the object will be an extrusion
6881 -- Otherwise for non-node items, the object will be an extrusion of
6882 -- 'inventory_image'.
6883 -- If 'itemname' contains a ColorString or palette index (e.g. from
6884 -- `minetest.itemstring_with_palette()`), the entity will inherit the color.
6885 -- "item" is similar to "wielditem" but ignores the 'wield_image' parameter.
6887 visual_size = {x = 1, y = 1, z = 1},
6888 -- Multipliers for the visual size. If `z` is not specified, `x` will be used
6889 -- to scale the entity along both horizontal axes.
6892 -- File name of mesh when using "mesh" visual
6895 -- Number of required textures depends on visual.
6896 -- "cube" uses 6 textures just like a node, but all 6 must be defined.
6897 -- "sprite" uses 1 texture.
6898 -- "upright_sprite" uses 2 textures: {front, back}.
6899 -- "wielditem" expects 'textures = {itemname}' (see 'visual' above).
6902 -- Number of required colors depends on visual
6904 use_texture_alpha = false,
6905 -- Use texture's alpha channel.
6906 -- Excludes "upright_sprite" and "wielditem".
6907 -- Note: currently causes visual issues when viewed through other
6908 -- semi-transparent materials such as water.
6910 spritediv = {x = 1, y = 1},
6911 -- Used with spritesheet textures for animation and/or frame selection
6912 -- according to position relative to player.
6913 -- Defines the number of columns and rows in the spritesheet:
6916 initial_sprite_basepos = {x = 0, y = 0},
6917 -- Used with spritesheet textures.
6918 -- Defines the {column, row} position of the initially used frame in the
6922 -- If false, object is invisible and can't be pointed.
6924 makes_footstep_sound = false,
6925 -- If true, is able to make footstep sounds of nodes
6926 -- (see node sound definition for details).
6928 automatic_rotate = 0,
6929 -- Set constant rotation in radians per second, positive or negative.
6930 -- Object rotates along the local Y-axis, and works with set_rotation.
6931 -- Set to 0 to disable constant rotation.
6934 -- If positive number, object will climb upwards when it moves
6935 -- horizontally against a `walkable` node, if the height difference
6936 -- is within `stepheight`.
6938 automatic_face_movement_dir = 0.0,
6939 -- Automatically set yaw to movement direction, offset in degrees.
6940 -- 'false' to disable.
6942 automatic_face_movement_max_rotation_per_sec = -1,
6943 -- Limit automatic rotation to this value in degrees per second.
6944 -- No limit if value <= 0.
6946 backface_culling = true,
6947 -- Set to false to disable backface_culling for model
6950 -- Add this much extra lighting when calculating texture color.
6951 -- Value < 0 disables light's effect on texture color.
6952 -- For faking self-lighting, UI style entities, or programmatic coloring
6956 -- The name to display on the head of the object. By default empty.
6957 -- If the object is a player, a nil or empty nametag is replaced by the player's name.
6958 -- For all other objects, a nil or empty string removes the nametag.
6959 -- To hide a nametag, set its color alpha to zero. That will disable it entirely.
6962 nametag_color = <ColorSpec>,
6963 -- Sets color of nametag
6966 -- By default empty, text to be shown when pointed at object
6969 -- If false, never save this object statically. It will simply be
6970 -- deleted when the block gets unloaded.
6971 -- The get_staticdata() callback is never called then.
6972 -- Defaults to 'true'.
6974 damage_texture_modifier = "^[brighten",
6975 -- Texture modifier to be applied for a short duration when object is hit
6978 -- Setting this to 'false' disables diffuse lighting of entity
6980 show_on_minimap = false,
6981 -- Defaults to true for players, false for other entities.
6982 -- If set to true the entity will show as a marker on the minimap.
6988 Used by `minetest.register_entity`.
6991 initial_properties = {
6993 mesh = "boats_boat.obj",
6996 -- A table of object properties, see the `Object properties` section.
6997 -- Object properties being read directly from the entity definition
6998 -- table is deprecated. Define object properties in this
6999 -- `initial_properties` table instead.
7001 on_activate = function(self, staticdata, dtime_s),
7003 on_step = function(self, dtime, moveresult),
7004 -- Called every server step
7005 -- dtime: Elapsed time
7006 -- moveresult: Table with collision info (only available if physical=true)
7008 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
7010 on_rightclick = function(self, clicker),
7012 get_staticdata = function(self),
7013 -- Called sometimes; the string returned is passed to on_activate when
7014 -- the entity is re-activated from static state
7016 _custom_field = whatever,
7017 -- You can define arbitrary member variables here (see Item definition
7018 -- for more info) by using a '_' prefix
7021 Collision info passed to `on_step`:
7024 touching_ground = boolean,
7026 standing_on_object = boolean,
7029 type = string, -- "node" or "object",
7030 axis = string, -- "x", "y" or "z"
7031 node_pos = vector, -- if type is "node"
7032 object = ObjectRef, -- if type is "object"
7033 old_velocity = vector,
7034 new_velocity = vector,
7040 ABM (ActiveBlockModifier) definition
7041 ------------------------------------
7043 Used by `minetest.register_abm`.
7046 label = "Lava cooling",
7047 -- Descriptive label for profiling purposes (optional).
7048 -- Definitions with identical labels will be listed as one.
7050 nodenames = {"default:lava_source"},
7051 -- Apply `action` function to these nodes.
7052 -- `group:groupname` can also be used here.
7054 neighbors = {"default:water_source", "default:water_flowing"},
7055 -- Only apply `action` to nodes that have one of, or any
7056 -- combination of, these neighbors.
7057 -- If left out or empty, any neighbor will do.
7058 -- `group:groupname` can also be used here.
7061 -- Operation interval in seconds
7064 -- Chance of triggering `action` per-node per-interval is 1.0 / this
7068 -- If true, catch-up behaviour is enabled: The `chance` value is
7069 -- temporarily reduced when returning to an area to simulate time lost
7070 -- by the area being unattended. Note that the `chance` value can often
7073 action = function(pos, node, active_object_count, active_object_count_wider),
7074 -- Function triggered for each qualifying node.
7075 -- `active_object_count` is number of active objects in the node's
7077 -- `active_object_count_wider` is number of active objects in the node's
7078 -- mapblock plus all 26 neighboring mapblocks. If any neighboring
7079 -- mapblocks are unloaded an estmate is calculated for them based on
7080 -- loaded mapblocks.
7083 LBM (LoadingBlockModifier) definition
7084 -------------------------------------
7086 Used by `minetest.register_lbm`.
7088 A loading block modifier (LBM) is used to define a function that is called for
7089 specific nodes (defined by `nodenames`) when a mapblock which contains such nodes
7093 label = "Upgrade legacy doors",
7094 -- Descriptive label for profiling purposes (optional).
7095 -- Definitions with identical labels will be listed as one.
7097 name = "modname:replace_legacy_door",
7099 nodenames = {"default:lava_source"},
7100 -- List of node names to trigger the LBM on.
7101 -- Also non-registered nodes will work.
7102 -- Groups (as of group:groupname) will work as well.
7104 run_at_every_load = false,
7105 -- Whether to run the LBM's action every time a block gets loaded,
7106 -- and not only the first time the block gets loaded after the LBM
7109 action = function(pos, node),
7116 * `{name="image.png", animation={Tile Animation definition}}`
7117 * `{name="image.png", backface_culling=bool, align_style="node"/"world"/"user", scale=int}`
7118 * backface culling enabled by default for most nodes
7119 * align style determines whether the texture will be rotated with the node
7120 or kept aligned with its surroundings. "user" means that client
7121 setting will be used, similar to `glasslike_framed_optional`.
7122 Note: supported by solid nodes and nodeboxes only.
7123 * scale is used to make texture span several (exactly `scale`) nodes,
7124 instead of just one, in each direction. Works for world-aligned
7126 Note that as the effect is applied on per-mapblock basis, `16` should
7127 be equally divisible by `scale` or you may get wrong results.
7128 * `{name="image.png", color=ColorSpec}`
7129 * the texture's color will be multiplied with this color.
7130 * the tile's color overrides the owning node's color in all cases.
7131 * deprecated, yet still supported field names:
7134 Tile animation definition
7135 -------------------------
7138 type = "vertical_frames",
7141 -- Width of a frame in pixels
7144 -- Height of a frame in pixels
7154 -- Width in number of frames
7157 -- Height in number of frames
7160 -- Length of a single frame
7166 Used by `minetest.register_node`, `minetest.register_craftitem`, and
7167 `minetest.register_tool`.
7170 description = "Steel Axe",
7171 -- Can contain new lines. "\n" has to be used as new line character.
7172 -- See also: `get_description` in [`ItemStack`]
7174 short_description = "Steel Axe",
7175 -- Must not contain new lines.
7176 -- Defaults to the first line of description.
7177 -- See also: `get_short_description` in [`ItemStack`]
7180 -- key = name, value = rating; rating = 1..3.
7181 -- If rating not applicable, use 1.
7182 -- e.g. {wool = 1, fluffy = 3}
7183 -- {soil = 2, outerspace = 1, crumbly = 1}
7184 -- {bendy = 2, snappy = 1},
7185 -- {hard = 1, metal = 1, spikes = 1}
7187 inventory_image = "default_tool_steelaxe.png",
7189 inventory_overlay = "overlay.png",
7190 -- An overlay which does not get colorized
7197 -- An image file containing the palette of a node.
7198 -- You can set the currently used color as the "palette_index" field of
7199 -- the item stack metadata.
7200 -- The palette is always stretched to fit indices between 0 and 255, to
7201 -- ensure compatibility with "colorfacedir" and "colorwallmounted" nodes.
7203 color = "0xFFFFFFFF",
7204 -- The color of the item. The palette overrides this.
7206 wield_scale = {x = 1, y = 1, z = 1},
7208 -- The default value of 99 may be configured by
7209 -- users using the setting "default_stack_max"
7214 liquids_pointable = false,
7217 -- When used for nodes: Defines amount of light emitted by node.
7218 -- Otherwise: Defines texture glow when viewed as a dropped item
7219 -- To set the maximum (14), use the value 'minetest.LIGHT_MAX'.
7220 -- A value outside the range 0 to minetest.LIGHT_MAX causes undefined
7223 -- See "Tools" section for an example including explanation
7224 tool_capabilities = {
7225 full_punch_interval = 1.0,
7229 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00},
7230 uses = 20, maxlevel = 2},
7232 damage_groups = {groupname = damage},
7233 -- Damage values must be between -32768 and 32767 (2^15)
7235 punch_attack_uses = nil,
7236 -- Amount of uses this tool has for attacking players and entities
7237 -- by punching them (0 = infinite uses).
7238 -- For compatibility, this is automatically set from the first
7239 -- suitable groupcap using the forumla "uses * 3^(maxlevel - 1)".
7240 -- It is recommend to set this explicitly instead of relying on the
7241 -- fallback behavior.
7244 node_placement_prediction = nil,
7245 -- If nil and item is node, prediction is made automatically.
7246 -- If nil and item is not a node, no prediction is made.
7247 -- If "" and item is anything, no prediction is made.
7248 -- Otherwise should be name of node which the client immediately places
7249 -- on ground when the player places the item. Server will always update
7250 -- actual result to client in a short moment.
7252 node_dig_prediction = "air",
7253 -- if "", no prediction is made.
7254 -- if "air", node is removed.
7255 -- Otherwise should be name of node which the client immediately places
7256 -- upon digging. Server will always update actual result shortly.
7259 -- Definition of items sounds to be played at various events.
7260 -- All fields in this table are optional.
7262 breaks = <SimpleSoundSpec>,
7263 -- When tool breaks due to wear. Ignored for non-tools
7265 eat = <SimpleSoundSpec>,
7266 -- When item is eaten with `minetest.do_item_eat`
7269 on_place = function(itemstack, placer, pointed_thing),
7270 -- Shall place item and return the leftover itemstack.
7271 -- The placer may be any ObjectRef or nil.
7272 -- default: minetest.item_place
7274 on_secondary_use = function(itemstack, user, pointed_thing),
7275 -- Same as on_place but called when not pointing at a node.
7276 -- The user may be any ObjectRef or nil.
7279 on_drop = function(itemstack, dropper, pos),
7280 -- Shall drop item and return the leftover itemstack.
7281 -- The dropper may be any ObjectRef or nil.
7282 -- default: minetest.item_drop
7284 on_use = function(itemstack, user, pointed_thing),
7286 -- Function must return either nil if no item shall be removed from
7287 -- inventory, or an itemstack to replace the original itemstack.
7288 -- e.g. itemstack:take_item(); return itemstack
7289 -- Otherwise, the function is free to do what it wants.
7290 -- The user may be any ObjectRef or nil.
7291 -- The default functions handle regular use cases.
7293 after_use = function(itemstack, user, node, digparams),
7295 -- If defined, should return an itemstack and will be called instead of
7296 -- wearing out the tool. If returns nil, does nothing.
7297 -- If after_use doesn't exist, it is the same as:
7298 -- function(itemstack, user, node, digparams)
7299 -- itemstack:add_wear(digparams.wear)
7302 -- The user may be any ObjectRef or nil.
7304 _custom_field = whatever,
7305 -- Add your own custom fields. By convention, all custom field names
7306 -- should start with `_` to avoid naming collisions with future engine
7313 Used by `minetest.register_node`.
7316 -- <all fields allowed in item definitions>,
7318 drawtype = "normal", -- See "Node drawtypes"
7321 -- Supported for drawtypes "plantlike", "signlike", "torchlike",
7322 -- "firelike", "mesh", "nodebox", "allfaces".
7323 -- For plantlike and firelike, the image will start at the bottom of the
7324 -- node. For torchlike, the image will start at the surface to which the
7325 -- node "attaches". For the other drawtypes the image will be centered
7328 tiles = {tile definition 1, def2, def3, def4, def5, def6},
7329 -- Textures of node; +Y, -Y, +X, -X, +Z, -Z
7330 -- Old field name was 'tile_images'.
7331 -- List can be shortened to needed length.
7333 overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6},
7334 -- Same as `tiles`, but these textures are drawn on top of the base
7335 -- tiles. You can use this to colorize only specific parts of your
7336 -- texture. If the texture name is an empty string, that overlay is not
7337 -- drawn. Since such tiles are drawn twice, it is not recommended to use
7338 -- overlays on very common nodes.
7340 special_tiles = {tile definition 1, Tile definition 2},
7341 -- Special textures of node; used rarely.
7342 -- Old field name was 'special_materials'.
7343 -- List can be shortened to needed length.
7346 -- The node's original color will be multiplied with this color.
7347 -- If the node has a palette, then this setting only has an effect in
7348 -- the inventory and on the wield item.
7350 use_texture_alpha = ...,
7351 -- Specifies how the texture's alpha channel will be used for rendering.
7353 -- * "opaque": Node is rendered opaque regardless of alpha channel
7354 -- * "clip": A given pixel is either fully see-through or opaque
7355 -- depending on the alpha channel being below/above 50% in value
7356 -- * "blend": The alpha channel specifies how transparent a given pixel
7357 -- of the rendered node is
7358 -- The default is "opaque" for drawtypes normal, liquid and flowingliquid;
7359 -- "clip" otherwise.
7360 -- If set to a boolean value (deprecated): true either sets it to blend
7361 -- or clip, false sets it to clip or opaque mode depending on the drawtype.
7363 palette = "palette.png",
7364 -- The node's `param2` is used to select a pixel from the image.
7365 -- Pixels are arranged from left to right and from top to bottom.
7366 -- The node's color will be multiplied with the selected pixel's color.
7367 -- Tiles can override this behavior.
7368 -- Only when `paramtype2` supports palettes.
7370 post_effect_color = "green#0F",
7371 -- Screen tint if player is inside node, see "ColorSpec"
7373 paramtype = "none", -- See "Nodes"
7375 paramtype2 = "none", -- See "Nodes"
7377 place_param2 = nil, -- Force value for param2 when player places node
7379 is_ground_content = true,
7380 -- If false, the cave generator and dungeon generator will not carve
7381 -- through this node.
7382 -- Specifically, this stops mod-added nodes being removed by caves and
7383 -- dungeons when those generate in a neighbor mapchunk and extend out
7384 -- beyond the edge of that mapchunk.
7386 sunlight_propagates = false,
7387 -- If true, sunlight will go infinitely through this node
7389 walkable = true, -- If true, objects collide with node
7391 pointable = true, -- If true, can be pointed at
7393 diggable = true, -- If false, can never be dug
7395 climbable = false, -- If true, can be climbed on (ladder)
7397 buildable_to = false, -- If true, placed nodes can replace this node
7400 -- If true, liquids flow into and replace this node.
7401 -- Warning: making a liquid node 'floodable' will cause problems.
7403 liquidtype = "none", -- "none" / "source" / "flowing"
7405 liquid_alternative_flowing = "", -- Flowing version of source liquid
7407 liquid_alternative_source = "", -- Source version of flowing liquid
7409 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
7411 liquid_renewable = true,
7412 -- If true, a new liquid source can be created by placing two or more
7416 -- Only valid for "nodebox" drawtype with 'type = "leveled"'.
7417 -- Allows defining the nodebox height without using param2.
7418 -- The nodebox height is 'leveled' / 64 nodes.
7419 -- The maximum value of 'leveled' is `leveled_max`.
7422 -- Maximum value for `leveled` (0-127), enforced in
7423 -- `minetest.set_node_level` and `minetest.add_node_level`.
7424 -- Values above 124 might causes collision detection issues.
7426 liquid_range = 8, -- Number of flowing nodes around source (max. 8)
7429 -- Player will take this amount of damage if no bubbles are left
7431 damage_per_second = 0,
7432 -- If player is inside node, this damage is caused
7434 node_box = {type="regular"}, -- See "Node boxes"
7436 connects_to = nodenames,
7437 -- Used for nodebox nodes with the type == "connected".
7438 -- Specifies to what neighboring nodes connections will be drawn.
7439 -- e.g. `{"group:fence", "default:wood"}` or `"default:stone"`
7441 connect_sides = { "top", "bottom", "front", "left", "back", "right" },
7442 -- Tells connected nodebox nodes to connect only to these sides of this
7446 -- File name of mesh when using "mesh" drawtype
7451 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
7452 -- Node box format: see [Node boxes]
7455 -- Custom selection box definition. Multiple boxes can be defined.
7456 -- If "nodebox" drawtype is used and selection_box is nil, then node_box
7457 -- definition is used for the selection box.
7462 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
7463 -- Node box format: see [Node boxes]
7466 -- Custom collision box definition. Multiple boxes can be defined.
7467 -- If "nodebox" drawtype is used and collision_box is nil, then node_box
7468 -- definition is used for the collision box.
7470 -- Support maps made in and before January 2012
7471 legacy_facedir_simple = false,
7472 legacy_wallmounted = false,
7475 -- Valid for drawtypes:
7476 -- mesh, nodebox, plantlike, allfaces_optional, liquid, flowingliquid.
7477 -- 1 - wave node like plants (node top moves side-to-side, bottom is fixed)
7478 -- 2 - wave node like leaves (whole node moves side-to-side)
7479 -- 3 - wave node like liquids (whole node moves up and down)
7480 -- Not all models will properly wave.
7481 -- plantlike drawtype can only wave like plants.
7482 -- allfaces_optional drawtype can only wave like leaves.
7483 -- liquid, flowingliquid drawtypes can only wave like liquids.
7486 -- Definition of node sounds to be played at various events.
7487 -- All fields in this table are optional.
7489 footstep = <SimpleSoundSpec>,
7490 -- If walkable, played when object walks on it. If node is
7491 -- climbable or a liquid, played when object moves through it
7493 dig = <SimpleSoundSpec> or "__group",
7494 -- While digging node.
7495 -- If `"__group"`, then the sound will be
7496 -- `default_dig_<groupname>`, where `<groupname>` is the
7497 -- name of the tool's digging group with the fastest digging time.
7498 -- In case of a tie, one of the sounds will be played (but we
7499 -- cannot predict which one)
7500 -- Default value: `"__group"`
7502 dug = <SimpleSoundSpec>,
7505 place = <SimpleSoundSpec>,
7506 -- Node was placed. Also played after falling
7508 place_failed = <SimpleSoundSpec>,
7509 -- When node placement failed.
7510 -- Note: This happens if the _built-in_ node placement failed.
7511 -- This sound will still be played if the node is placed in the
7512 -- `on_place` callback manually.
7514 fall = <SimpleSoundSpec>,
7515 -- When node starts to fall or is detached
7519 -- Name of dropped item when dug.
7520 -- Default dropped item is the node itself.
7521 -- Using a table allows multiple items, drop chances and tool filtering.
7522 -- Tool filtering was undocumented until recently, tool filtering by string
7523 -- matching is deprecated.
7526 -- Maximum number of item lists to drop.
7527 -- The entries in 'items' are processed in order. For each:
7528 -- Tool filtering is applied, chance of drop is applied, if both are
7529 -- successful the entire item list is dropped.
7530 -- Entry processing continues until the number of dropped item lists
7531 -- equals 'max_items'.
7532 -- Therefore, entries should progress from low to high drop chance.
7536 -- 1 in 1000 chance of dropping a diamond.
7537 -- Default rarity is '1'.
7539 items = {"default:diamond"},
7542 -- Only drop if using a tool whose name is identical to one
7544 tools = {"default:shovel_mese", "default:shovel_diamond"},
7546 items = {"default:dirt"},
7547 -- Whether all items in the dropped item list inherit the
7548 -- hardware coloring palette color from the dug node.
7549 -- Default is 'false'.
7550 inherit_color = true,
7553 -- Only drop if using a tool whose name contains
7554 -- "default:shovel_" (this tool filtering by string matching
7556 tools = {"~default:shovel_"},
7558 -- The item list dropped.
7559 items = {"default:sand", "default:desert_sand"},
7564 on_construct = function(pos),
7565 -- Node constructor; called after adding node.
7566 -- Can set up metadata and stuff like that.
7567 -- Not called for bulk node placement (i.e. schematics and VoxelManip).
7570 on_destruct = function(pos),
7571 -- Node destructor; called before removing node.
7572 -- Not called for bulk node placement.
7575 after_destruct = function(pos, oldnode),
7576 -- Node destructor; called after removing node.
7577 -- Not called for bulk node placement.
7580 on_flood = function(pos, oldnode, newnode),
7581 -- Called when a liquid (newnode) is about to flood oldnode, if it has
7582 -- `floodable = true` in the nodedef. Not called for bulk node placement
7583 -- (i.e. schematics and VoxelManip) or air nodes. If return true the
7584 -- node is not flooded, but on_flood callback will most likely be called
7585 -- over and over again every liquid update interval.
7587 -- Warning: making a liquid node 'floodable' will cause problems.
7589 preserve_metadata = function(pos, oldnode, oldmeta, drops),
7590 -- Called when oldnode is about be converted to an item, but before the
7591 -- node is deleted from the world or the drops are added. This is
7592 -- generally the result of either the node being dug or an attached node
7593 -- becoming detached.
7594 -- oldmeta is the NodeMetaRef of the oldnode before deletion.
7595 -- drops is a table of ItemStacks, so any metadata to be preserved can
7596 -- be added directly to one or more of the dropped items. See
7597 -- "ItemStackMetaRef".
7600 after_place_node = function(pos, placer, itemstack, pointed_thing),
7601 -- Called after constructing node when node was placed using
7602 -- minetest.item_place_node / minetest.place_node.
7603 -- If return true no item is taken from itemstack.
7604 -- `placer` may be any valid ObjectRef or nil.
7607 after_dig_node = function(pos, oldnode, oldmetadata, digger),
7608 -- oldmetadata is in table format.
7609 -- Called after destructing node when node was dug using
7610 -- minetest.node_dig / minetest.dig_node.
7613 can_dig = function(pos, [player]),
7614 -- Returns true if node can be dug, or false if not.
7617 on_punch = function(pos, node, puncher, pointed_thing),
7618 -- default: minetest.node_punch
7619 -- Called when puncher (an ObjectRef) punches the node at pos.
7620 -- By default calls minetest.register_on_punchnode callbacks.
7622 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing),
7624 -- Called when clicker (an ObjectRef) "rightclicks"
7625 -- ("rightclick" here stands for the placement key) while pointing at
7626 -- the node at pos with 'node' being the node table.
7627 -- itemstack will hold clicker's wielded item.
7628 -- Shall return the leftover itemstack.
7629 -- Note: pointed_thing can be nil, if a mod calls this function.
7630 -- This function does not get triggered by clients <=0.4.16 if the
7631 -- "formspec" node metadata field is set.
7633 on_dig = function(pos, node, digger),
7634 -- default: minetest.node_dig
7635 -- By default checks privileges, wears out tool and removes node.
7636 -- return true if the node was dug successfully, false otherwise.
7637 -- Deprecated: returning nil is the same as returning true.
7639 on_timer = function(pos, elapsed),
7641 -- called by NodeTimers, see minetest.get_node_timer and NodeTimerRef.
7642 -- elapsed is the total time passed since the timer was started.
7643 -- return true to run the timer for another cycle with the same timeout
7646 on_receive_fields = function(pos, formname, fields, sender),
7647 -- fields = {name1 = value1, name2 = value2, ...}
7648 -- Called when an UI form (e.g. sign text input) returns data.
7649 -- See minetest.register_on_player_receive_fields for more info.
7652 allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7653 -- Called when a player wants to move items inside the inventory.
7654 -- Return value: number of items allowed to move.
7656 allow_metadata_inventory_put = function(pos, listname, index, stack, player),
7657 -- Called when a player wants to put something into the inventory.
7658 -- Return value: number of items allowed to put.
7659 -- Return value -1: Allow and don't modify item count in inventory.
7661 allow_metadata_inventory_take = function(pos, listname, index, stack, player),
7662 -- Called when a player wants to take something out of the inventory.
7663 -- Return value: number of items allowed to take.
7664 -- Return value -1: Allow and don't modify item count in inventory.
7666 on_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7667 on_metadata_inventory_put = function(pos, listname, index, stack, player),
7668 on_metadata_inventory_take = function(pos, listname, index, stack, player),
7669 -- Called after the actual action has happened, according to what was
7673 on_blast = function(pos, intensity),
7674 -- intensity: 1.0 = mid range of regular TNT.
7675 -- If defined, called when an explosion touches the node, instead of
7676 -- removing the node.
7678 mod_origin = "modname",
7679 -- stores which mod actually registered a node
7680 -- if it can not find a source, returns "??"
7681 -- useful for getting what mod truly registered something
7682 -- example: if a node is registered as ":othermodname:nodename",
7683 -- nodename will show "othermodname", but mod_orgin will say "modname"
7689 Used by `minetest.register_craft`.
7694 output = 'default:pick_stone',
7696 {'default:cobble', 'default:cobble', 'default:cobble'},
7697 {'', 'default:stick', ''},
7698 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
7700 replacements = <list of item pairs>,
7701 -- replacements: replace one input item with another item on crafting
7709 output = 'mushrooms:mushroom_stew',
7712 "mushrooms:mushroom_brown",
7713 "mushrooms:mushroom_red",
7715 replacements = <list of item pairs>,
7721 type = "toolrepair",
7722 additional_wear = -0.02,
7725 Note: Tools with group `disable_repair=1` will not repairable by this recipe.
7731 output = "default:glass",
7732 recipe = "default:sand",
7740 recipe = "bucket:bucket_lava",
7742 replacements = {{"bucket:bucket_lava", "bucket:bucket_empty"}},
7748 Used by `minetest.register_ore`.
7750 See [Ores] section above for essential information.
7753 ore_type = "scatter",
7755 ore = "default:stone_with_coal",
7758 -- Facedir rotation. Default is 0 (unchanged rotation)
7760 wherein = "default:stone",
7761 -- A list of nodenames is supported too
7763 clust_scarcity = 8 * 8 * 8,
7764 -- Ore has a 1 out of clust_scarcity chance of spawning in a node.
7765 -- If the desired average distance between ores is 'd', set this to
7769 -- Number of ores in a cluster
7772 -- Size of the bounding box of the cluster.
7773 -- In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27
7774 -- nodes are coal ore.
7778 -- Lower and upper limits for ore
7781 -- Attributes for the ore generation, see 'Ore attributes' section above
7783 noise_threshold = 0.5,
7784 -- If noise is above this threshold, ore is placed. Not needed for a
7785 -- uniform distribution.
7790 spread = {x = 100, y = 100, z = 100},
7795 -- NoiseParams structure describing one of the perlin noises used for
7796 -- ore distribution.
7797 -- Needed by "sheet", "puff", "blob" and "vein" ores.
7798 -- Omit from "scatter" ore for a uniform ore distribution.
7799 -- Omit from "stratum" ore for a simple horizontal strata from y_min to
7802 biomes = {"desert", "rainforest"},
7803 -- List of biomes in which this ore occurs.
7804 -- Occurs in all biomes if this is omitted, and ignored if the Mapgen
7805 -- being used does not support biomes.
7806 -- Can be a list of (or a single) biome names, IDs, or definitions.
7808 -- Type-specific parameters
7811 column_height_min = 1,
7812 column_height_max = 16,
7813 column_midpoint_factor = 0.5,
7819 spread = {x = 100, y = 100, z = 100},
7827 spread = {x = 100, y = 100, z = 100},
7834 random_factor = 1.0,
7837 np_stratum_thickness = {
7840 spread = {x = 100, y = 100, z = 100},
7845 stratum_thickness = 8,
7851 Used by `minetest.register_biome`.
7853 The maximum number of biomes that can be used is 65535. However, using an
7854 excessive number of biomes will slow down map generation. Depending on desired
7855 performance and computing power the practical limit is much lower.
7860 node_dust = "default:snow",
7861 -- Node dropped onto upper surface after all else is generated
7863 node_top = "default:dirt_with_snow",
7865 -- Node forming surface layer of biome and thickness of this layer
7867 node_filler = "default:permafrost",
7869 -- Node forming lower layer of biome and thickness of this layer
7871 node_stone = "default:bluestone",
7872 -- Node that replaces all stone nodes between roughly y_min and y_max.
7874 node_water_top = "default:ice",
7875 depth_water_top = 10,
7876 -- Node forming a surface layer in seawater with the defined thickness
7879 -- Node that replaces all seawater nodes not in the surface layer
7881 node_river_water = "default:ice",
7882 -- Node that replaces river water in mapgens that use
7883 -- default:river_water
7885 node_riverbed = "default:gravel",
7887 -- Node placed under river water and thickness of this layer
7889 node_cave_liquid = "default:lava_source",
7890 node_cave_liquid = {"default:water_source", "default:lava_source"},
7891 -- Nodes placed inside 50% of the medium size caves.
7892 -- Multiple nodes can be specified, each cave will use a randomly
7893 -- chosen node from the list.
7894 -- If this field is left out or 'nil', cave liquids fall back to
7895 -- classic behaviour of lava and water distributed using 3D noise.
7896 -- For no cave liquid, specify "air".
7898 node_dungeon = "default:cobble",
7899 -- Node used for primary dungeon structure.
7900 -- If absent, dungeon nodes fall back to the 'mapgen_cobble' mapgen
7901 -- alias, if that is also absent, dungeon nodes fall back to the biome
7903 -- If present, the following two nodes are also used.
7905 node_dungeon_alt = "default:mossycobble",
7906 -- Node used for randomly-distributed alternative structure nodes.
7907 -- If alternative structure nodes are not wanted leave this absent for
7908 -- performance reasons.
7910 node_dungeon_stair = "stairs:stair_cobble",
7911 -- Node used for dungeon stairs.
7912 -- If absent, stairs fall back to 'node_dungeon'.
7916 -- Upper and lower limits for biome.
7917 -- Alternatively you can use xyz limits as shown below.
7919 max_pos = {x = 31000, y = 128, z = 31000},
7920 min_pos = {x = -31000, y = 9, z = -31000},
7921 -- xyz limits for biome, an alternative to using 'y_min' and 'y_max'.
7922 -- Biome is limited to a cuboid defined by these positions.
7923 -- Any x, y or z field left undefined defaults to -31000 in 'min_pos' or
7924 -- 31000 in 'max_pos'.
7927 -- Vertical distance in nodes above 'y_max' over which the biome will
7928 -- blend with the biome above.
7929 -- Set to 0 for no vertical blend. Defaults to 0.
7932 humidity_point = 50,
7933 -- Characteristic temperature and humidity for the biome.
7934 -- These values create 'biome points' on a voronoi diagram with heat and
7935 -- humidity as axes. The resulting voronoi cells determine the
7936 -- distribution of the biomes.
7937 -- Heat and humidity have average values of 50, vary mostly between
7938 -- 0 and 100 but can exceed these values.
7941 Decoration definition
7942 ---------------------
7944 See [Decoration types]. Used by `minetest.register_decoration`.
7947 deco_type = "simple",
7949 place_on = "default:dirt_with_grass",
7950 -- Node (or list of nodes) that the decoration can be placed on
7953 -- Size of the square divisions of the mapchunk being generated.
7954 -- Determines the resolution of noise variation if used.
7955 -- If the chunk size is not evenly divisible by sidelen, sidelen is made
7956 -- equal to the chunk size.
7959 -- The value determines 'decorations per surface node'.
7960 -- Used only if noise_params is not specified.
7961 -- If >= 10.0 complete coverage is enabled and decoration placement uses
7962 -- a different and much faster method.
7967 spread = {x = 100, y = 100, z = 100},
7974 -- NoiseParams structure describing the perlin noise used for decoration
7976 -- A noise value is calculated for each square division and determines
7977 -- 'decorations per surface node' within each division.
7978 -- If the noise value >= 10.0 complete coverage is enabled and
7979 -- decoration placement uses a different and much faster method.
7981 biomes = {"Oceanside", "Hills", "Plains"},
7982 -- List of biomes in which this decoration occurs. Occurs in all biomes
7983 -- if this is omitted, and ignored if the Mapgen being used does not
7985 -- Can be a list of (or a single) biome names, IDs, or definitions.
7989 -- Lower and upper limits for decoration.
7990 -- These parameters refer to the Y co-ordinate of the 'place_on' node.
7992 spawn_by = "default:water",
7993 -- Node (or list of nodes) that the decoration only spawns next to.
7994 -- Checks two horizontal planes of 8 neighbouring nodes (including
7995 -- diagonal neighbours), one plane level with the 'place_on' node and a
7996 -- plane one node above that.
7999 -- Number of spawn_by nodes that must be surrounding the decoration
8000 -- position to occur.
8001 -- If absent or -1, decorations occur next to any nodes.
8003 flags = "liquid_surface, force_placement, all_floors, all_ceilings",
8004 -- Flags for all decoration types.
8005 -- "liquid_surface": Instead of placement on the highest solid surface
8006 -- in a mapchunk column, placement is on the highest liquid surface.
8007 -- Placement is disabled if solid nodes are found above the liquid
8009 -- "force_placement": Nodes other than "air" and "ignore" are replaced
8010 -- by the decoration.
8011 -- "all_floors", "all_ceilings": Instead of placement on the highest
8012 -- surface in a mapchunk the decoration is placed on all floor and/or
8013 -- ceiling surfaces, for example in caves and dungeons.
8014 -- Ceiling decorations act as an inversion of floor decorations so the
8015 -- effect of 'place_offset_y' is inverted.
8016 -- Y-slice probabilities do not function correctly for ceiling
8017 -- schematic decorations as the behaviour is unchanged.
8018 -- If a single decoration registration has both flags the floor and
8019 -- ceiling decorations will be aligned vertically.
8021 ----- Simple-type parameters
8023 decoration = "default:grass",
8024 -- The node name used as the decoration.
8025 -- If instead a list of strings, a randomly selected node from the list
8026 -- is placed as the decoration.
8029 -- Decoration height in nodes.
8030 -- If height_max is not 0, this is the lower limit of a randomly
8034 -- Upper limit of the randomly selected height.
8035 -- If absent, the parameter 'height' is used as a constant.
8038 -- Param2 value of decoration nodes.
8039 -- If param2_max is not 0, this is the lower limit of a randomly
8043 -- Upper limit of the randomly selected param2.
8044 -- If absent, the parameter 'param2' is used as a constant.
8047 -- Y offset of the decoration base node relative to the standard base
8049 -- Can be positive or negative. Default is 0.
8050 -- Effect is inverted for "all_ceilings" decorations.
8051 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
8052 -- to the 'place_on' node.
8054 ----- Schematic-type parameters
8056 schematic = "foobar.mts",
8057 -- If schematic is a string, it is the filepath relative to the current
8058 -- working directory of the specified Minetest schematic file.
8059 -- Could also be the ID of a previously registered schematic.
8062 size = {x = 4, y = 6, z = 4},
8064 {name = "default:cobble", param1 = 255, param2 = 0},
8065 {name = "default:dirt_with_grass", param1 = 255, param2 = 0},
8066 {name = "air", param1 = 255, param2 = 0},
8070 {ypos = 2, prob = 128},
8071 {ypos = 5, prob = 64},
8075 -- Alternative schematic specification by supplying a table. The fields
8076 -- size and data are mandatory whereas yslice_prob is optional.
8077 -- See 'Schematic specifier' for details.
8079 replacements = {["oldname"] = "convert_to", ...},
8081 flags = "place_center_x, place_center_y, place_center_z",
8082 -- Flags for schematic decorations. See 'Schematic attributes'.
8085 -- Rotation can be "0", "90", "180", "270", or "random"
8088 -- If the flag 'place_center_y' is set this parameter is ignored.
8089 -- Y offset of the schematic base node layer relative to the 'place_on'
8091 -- Can be positive or negative. Default is 0.
8092 -- Effect is inverted for "all_ceilings" decorations.
8093 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
8094 -- to the 'place_on' node.
8097 Chat command definition
8098 -----------------------
8100 Used by `minetest.register_chatcommand`.
8103 params = "<name> <privilege>", -- Short parameter description
8105 description = "Remove privilege from player", -- Full description
8107 privs = {privs=true}, -- Require the "privs" privilege to run
8109 func = function(name, param),
8110 -- Called when command is run. Returns boolean success and text output.
8111 -- Special case: The help message is shown to the player if `func`
8112 -- returns false without a text output.
8115 Note that in params, use of symbols is as follows:
8117 * `<>` signifies a placeholder to be replaced when the command is used. For
8118 example, when a player name is needed: `<name>`
8119 * `[]` signifies param is optional and not required when the command is used.
8120 For example, if you require param1 but param2 is optional:
8121 `<param1> [<param2>]`
8122 * `|` signifies exclusive or. The command requires one param from the options
8123 provided. For example: `<param1> | <param2>`
8124 * `()` signifies grouping. For example, when param1 and param2 are both
8125 required, or only param3 is required: `(<param1> <param2>) | <param3>`
8127 Privilege definition
8128 --------------------
8130 Used by `minetest.register_privilege`.
8134 -- Privilege description
8136 give_to_singleplayer = true,
8137 -- Whether to grant the privilege to singleplayer.
8139 give_to_admin = true,
8140 -- Whether to grant the privilege to the server admin.
8141 -- Uses value of 'give_to_singleplayer' by default.
8143 on_grant = function(name, granter_name),
8144 -- Called when given to player 'name' by 'granter_name'.
8145 -- 'granter_name' will be nil if the priv was granted by a mod.
8147 on_revoke = function(name, revoker_name),
8148 -- Called when taken from player 'name' by 'revoker_name'.
8149 -- 'revoker_name' will be nil if the priv was revoked by a mod.
8151 -- Note that the above two callbacks will be called twice if a player is
8152 -- responsible, once with the player name, and then with a nil player
8154 -- Return true in the above callbacks to stop register_on_priv_grant or
8155 -- revoke being called.
8158 Detached inventory callbacks
8159 ----------------------------
8161 Used by `minetest.create_detached_inventory`.
8164 allow_move = function(inv, from_list, from_index, to_list, to_index, count, player),
8165 -- Called when a player wants to move items inside the inventory.
8166 -- Return value: number of items allowed to move.
8168 allow_put = function(inv, listname, index, stack, player),
8169 -- Called when a player wants to put something into the inventory.
8170 -- Return value: number of items allowed to put.
8171 -- Return value -1: Allow and don't modify item count in inventory.
8173 allow_take = function(inv, listname, index, stack, player),
8174 -- Called when a player wants to take something out of the inventory.
8175 -- Return value: number of items allowed to take.
8176 -- Return value -1: Allow and don't modify item count in inventory.
8178 on_move = function(inv, from_list, from_index, to_list, to_index, count, player),
8179 on_put = function(inv, listname, index, stack, player),
8180 on_take = function(inv, listname, index, stack, player),
8181 -- Called after the actual action has happened, according to what was
8191 Used by `Player:hud_add`. Returned by `Player:hud_get`.
8194 hud_elem_type = "image", -- See HUD element types
8195 -- Type of element, can be "image", "text", "statbar", "inventory",
8196 -- "compass" or "minimap"
8198 position = {x=0.5, y=0.5},
8199 -- Left corner position of element
8203 scale = {x = 2, y = 2},
8212 -- Selected item in inventory. 0 for no item selected.
8215 -- Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
8217 alignment = {x=0, y=0},
8219 offset = {x=0, y=0},
8221 size = { x=100, y=100 },
8222 -- Size of element in pixels
8225 -- Z index : lower z-index HUDs are displayed behind higher z-index HUDs
8231 Used by `minetest.add_particle`.
8234 pos = {x=0, y=0, z=0},
8235 velocity = {x=0, y=0, z=0},
8236 acceleration = {x=0, y=0, z=0},
8237 -- Spawn particle at pos with velocity and acceleration
8240 -- Disappears after expirationtime seconds
8243 -- Scales the visual size of the particle texture.
8244 -- If `node` is set, size can be set to 0 to spawn a randomly-sized
8245 -- particle (just like actual node dig particles).
8247 collisiondetection = false,
8248 -- If true collides with `walkable` nodes and, depending on the
8249 -- `object_collision` field, objects too.
8251 collision_removal = false,
8252 -- If true particle is removed when it collides.
8253 -- Requires collisiondetection = true to have any effect.
8255 object_collision = false,
8256 -- If true particle collides with objects that are defined as
8257 -- `physical = true,` and `collide_with_objects = true,`.
8258 -- Requires collisiondetection = true to have any effect.
8261 -- If true faces player using y axis only
8263 texture = "image.png",
8264 -- The texture of the particle
8266 playername = "singleplayer",
8267 -- Optional, if specified spawns particle only on the player's client
8269 animation = {Tile Animation definition},
8270 -- Optional, specifies how to animate the particle texture
8273 -- Optional, specify particle self-luminescence in darkness.
8276 node = {name = "ignore", param2 = 0},
8277 -- Optional, if specified the particle will have the same appearance as
8278 -- node dig particles for the given node.
8279 -- `texture` and `animation` will be ignored if this is set.
8282 -- Optional, only valid in combination with `node`
8283 -- If set to a valid number 1-6, specifies the tile from which the
8284 -- particle texture is picked.
8285 -- Otherwise, the default behavior is used. (currently: any random tile)
8289 `ParticleSpawner` definition
8290 ----------------------------
8292 Used by `minetest.add_particlespawner`.
8296 -- Number of particles spawned over the time period `time`.
8299 -- Lifespan of spawner in seconds.
8300 -- If time is 0 spawner has infinite lifespan and spawns the `amount` on
8301 -- a per-second basis.
8303 minpos = {x=0, y=0, z=0},
8304 maxpos = {x=0, y=0, z=0},
8305 minvel = {x=0, y=0, z=0},
8306 maxvel = {x=0, y=0, z=0},
8307 minacc = {x=0, y=0, z=0},
8308 maxacc = {x=0, y=0, z=0},
8313 -- The particles' properties are random values between the min and max
8315 -- applies to: pos, velocity, acceleration, expirationtime, size
8316 -- If `node` is set, min and maxsize can be set to 0 to spawn
8317 -- randomly-sized particles (just like actual node dig particles).
8319 collisiondetection = false,
8320 -- If true collide with `walkable` nodes and, depending on the
8321 -- `object_collision` field, objects too.
8323 collision_removal = false,
8324 -- If true particles are removed when they collide.
8325 -- Requires collisiondetection = true to have any effect.
8327 object_collision = false,
8328 -- If true particles collide with objects that are defined as
8329 -- `physical = true,` and `collide_with_objects = true,`.
8330 -- Requires collisiondetection = true to have any effect.
8332 attached = ObjectRef,
8333 -- If defined, particle positions, velocities and accelerations are
8334 -- relative to this object's position and yaw
8337 -- If true face player using y axis only
8339 texture = "image.png",
8340 -- The texture of the particle
8342 playername = "singleplayer",
8343 -- Optional, if specified spawns particles only on the player's client
8345 animation = {Tile Animation definition},
8346 -- Optional, specifies how to animate the particles' texture
8349 -- Optional, specify particle self-luminescence in darkness.
8352 node = {name = "ignore", param2 = 0},
8353 -- Optional, if specified the particles will have the same appearance as
8354 -- node dig particles for the given node.
8355 -- `texture` and `animation` will be ignored if this is set.
8358 -- Optional, only valid in combination with `node`
8359 -- If set to a valid number 1-6, specifies the tile from which the
8360 -- particle texture is picked.
8361 -- Otherwise, the default behavior is used. (currently: any random tile)
8364 `HTTPRequest` definition
8365 ------------------------
8367 Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
8370 url = "http://example.org",
8373 -- Timeout for connection in seconds. Default is 3 seconds.
8375 method = "GET", "POST", "PUT" or "DELETE"
8376 -- The http method to use. Defaults to "GET".
8378 data = "Raw request data string" OR {field1 = "data1", field2 = "data2"},
8379 -- Data for the POST, PUT or DELETE request.
8380 -- Accepts both a string and a table. If a table is specified, encodes
8381 -- table as x-www-form-urlencoded key-value pairs.
8383 user_agent = "ExampleUserAgent",
8384 -- Optional, if specified replaces the default minetest user agent with
8387 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
8388 -- Optional, if specified adds additional headers to the HTTP request.
8389 -- You must make sure that the header strings follow HTTP specification
8393 -- Optional, if true performs a multipart HTTP request.
8394 -- Default is false.
8395 -- Post only, data must be array
8397 post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
8398 -- Deprecated, use `data` instead. Forces `method = "POST"`.
8401 `HTTPRequestResult` definition
8402 ------------------------------
8404 Passed to `HTTPApiTable.fetch` callback. Returned by
8405 `HTTPApiTable.fetch_async_get`.
8409 -- If true, the request has finished (either succeeded, failed or timed
8413 -- If true, the request was successful
8416 -- If true, the request timed out
8424 Authentication handler definition
8425 ---------------------------------
8427 Used by `minetest.register_authentication_handler`.
8430 get_auth = function(name),
8431 -- Get authentication data for existing player `name` (`nil` if player
8433 -- Returns following structure:
8434 -- `{password=<string>, privileges=<table>, last_login=<number or nil>}`
8436 create_auth = function(name, password),
8437 -- Create new auth data for player `name`.
8438 -- Note that `password` is not plain-text but an arbitrary
8439 -- representation decided by the engine.
8441 delete_auth = function(name),
8442 -- Delete auth data of player `name`.
8443 -- Returns boolean indicating success (false if player is nonexistent).
8445 set_password = function(name, password),
8446 -- Set password of player `name` to `password`.
8447 -- Auth data should be created if not present.
8449 set_privileges = function(name, privileges),
8450 -- Set privileges of player `name`.
8451 -- `privileges` is in table form, auth data should be created if not
8454 reload = function(),
8455 -- Reload authentication data from the storage location.
8456 -- Returns boolean indicating success.
8458 record_login = function(name),
8459 -- Called when player joins, used for keeping track of last_login
8461 iterate = function(),
8462 -- Returns an iterator (use with `for` loops) for all player names
8463 -- currently in the auth database