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.
259 Although it is discouraged, a mod can overwrite a media file of any mod that it
260 depends on by supplying a file with an equal name.
265 Registered names should generally be in this format:
269 `<whatever>` can have these characters:
273 This is to prevent conflicting names from corrupting maps and is
274 enforced by the mod loader.
276 Registered names can be overridden by prefixing the name with `:`. This can
277 be used for overriding the registrations of some other mod.
279 The `:` prefix can also be used for maintaining backwards compatibility.
283 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
284 So the name should be `experimental:tnt`.
286 Any mod can redefine `experimental:tnt` by using the name
290 when registering it. That mod is required to have `experimental` as a
299 Aliases of itemnames can be added by using
300 `minetest.register_alias(alias, original_name)` or
301 `minetest.register_alias_force(alias, original_name)`.
303 This adds an alias `alias` for the item called `original_name`.
304 From now on, you can use `alias` to refer to the item `original_name`.
306 The only difference between `minetest.register_alias` and
307 `minetest.register_alias_force` is that if an item named `alias` already exists,
308 `minetest.register_alias` will do nothing while
309 `minetest.register_alias_force` will unregister it.
311 This can be used for maintaining backwards compatibility.
313 This can also set quick access names for things, e.g. if
314 you have an item called `epiclylongmodname:stuff`, you could do
316 minetest.register_alias("stuff", "epiclylongmodname:stuff")
318 and be able to use `/giveme stuff`.
323 In a game, a certain number of these must be set to tell core mapgens which
324 of the game's nodes are to be used for core mapgen generation. For example:
326 minetest.register_alias("mapgen_stone", "default:stone")
328 ### Aliases for non-V6 mapgens
330 #### Essential aliases
333 * mapgen_water_source
334 * mapgen_river_water_source
336 `mapgen_river_water_source` is required for mapgens with sloping rivers where
337 it is necessary to have a river liquid node with a short `liquid_range` and
338 `liquid_renewable = false` to avoid flooding.
340 #### Optional aliases
344 Fallback lava node used if cave liquids are not defined in biome definitions.
345 Deprecated for non-V6 mapgens, define cave liquids in biome definitions instead.
349 Fallback node used if dungeon nodes are not defined in biome definitions.
350 Deprecated for non-V6 mapgens, define dungeon nodes in biome definitions instead.
352 ### Aliases needed for Mapgen V6
355 * mapgen_water_source
358 * mapgen_dirt_with_grass
361 * mapgen_desert_stone
363 * mapgen_dirt_with_snow
372 * mapgen_jungleleaves
375 * mapgen_pine_needles
378 * mapgen_stair_cobble
380 * mapgen_stair_desert_stone
382 ### Setting the node used in Mapgen Singlenode
384 By default the world is filled with air nodes. To set a different node use, for
387 minetest.register_alias("mapgen_singlenode", "default:stone")
395 Mods should generally prefix their textures with `modname_`, e.g. given
396 the mod name `foomod`, a texture could be called:
400 Textures are referred to by their complete name, or alternatively by
401 stripping out the file extension:
403 * e.g. `foomod_foothing.png`
404 * e.g. `foomod_foothing`
410 There are various texture modifiers that can be used
411 to let the client generate textures on-the-fly.
412 The modifiers are applied directly in sRGB colorspace,
413 i.e. without gamma-correction.
415 ### Texture overlaying
417 Textures can be overlaid by putting a `^` between them.
421 default_dirt.png^default_grass_side.png
423 `default_grass_side.png` is overlaid over `default_dirt.png`.
424 The texture with the lower resolution will be automatically upscaled to
425 the higher resolution texture.
429 Textures can be grouped together by enclosing them in `(` and `)`.
431 Example: `cobble.png^(thing1.png^thing2.png)`
433 A texture for `thing1.png^thing2.png` is created and the resulting
434 texture is overlaid on top of `cobble.png`.
438 Modifiers that accept texture names (e.g. `[combine`) accept escaping to allow
439 passing complex texture names as arguments. Escaping is done with backslash and
440 is required for `^` and `:`.
442 Example: `cobble.png^[lowpart:50:color.png\^[mask\:trans.png`
444 The lower 50 percent of `color.png^[mask:trans.png` are overlaid
445 on top of `cobble.png`.
447 ### Advanced texture modifiers
453 * `[crack:<t>:<n>:<p>`
454 * `[cracko:<t>:<n>:<p>`
458 * `<t>`: tile count (in each direction)
459 * `<n>`: animation frame count
460 * `<p>`: current animation frame
462 Draw a step of the crack animation on the texture.
463 `crack` draws it normally, while `cracko` lays it over, keeping transparent
468 default_cobble.png^[crack:10:1
470 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
476 * `<file>`: texture to combine
478 Creates a texture of size `<w>` times `<h>` and blits the listed files to their
479 specified coordinates.
483 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
485 #### `[resize:<w>x<h>`
487 Resizes the texture to the given dimensions.
491 default_sandstone.png^[resize:16x16
495 Makes the base image transparent according to the given ratio.
497 `r` must be between 0 (transparent) and 255 (opaque).
501 default_sandstone.png^[opacity:127
503 #### `[invert:<mode>`
505 Inverts the given channels of the base image.
506 Mode may contain the characters "r", "g", "b", "a".
507 Only the channels that are mentioned in the mode string will be inverted.
511 default_apple.png^[invert:rgb
515 Brightens the texture.
519 tnt_tnt_side.png^[brighten
523 Makes the texture completely opaque.
527 default_leaves.png^[noalpha
529 #### `[makealpha:<r>,<g>,<b>`
531 Convert one color to transparency.
535 default_cobble.png^[makealpha:128,128,128
539 * `<t>`: transformation(s) to apply
541 Rotates and/or flips the image.
543 `<t>` can be a number (between 0 and 7) or a transform name.
544 Rotations are counter-clockwise.
547 1 R90 rotate by 90 degrees
548 2 R180 rotate by 180 degrees
549 3 R270 rotate by 270 degrees
551 5 FXR90 flip X then rotate by 90 degrees
553 7 FYR90 flip Y then rotate by 90 degrees
557 default_stone.png^[transformFXR90
559 #### `[inventorycube{<top>{<left>{<right>`
561 Escaping does not apply here and `^` is replaced by `&` in texture names
564 Create an inventory cube texture using the side textures.
568 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
570 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
571 `dirt.png^grass_side.png` textures
573 #### `[lowpart:<percent>:<file>`
575 Blit the lower `<percent>`% part of `<file>` on the texture.
579 base.png^[lowpart:25:overlay.png
581 #### `[verticalframe:<t>:<n>`
583 * `<t>`: animation frame count
584 * `<n>`: current animation frame
586 Crops the texture to a frame of a vertical animation.
590 default_torch_animated.png^[verticalframe:16:8
594 Apply a mask to the base image.
596 The mask is applied using binary AND.
598 #### `[sheet:<w>x<h>:<x>,<y>`
600 Retrieves a tile at position x,y from the base image
601 which it assumes to be a tilesheet with dimensions w,h.
603 #### `[colorize:<color>:<ratio>`
605 Colorize the textures with the given color.
606 `<color>` is specified as a `ColorString`.
607 `<ratio>` is an int ranging from 0 to 255 or the word "`alpha`". If
608 it is an int, then it specifies how far to interpolate between the
609 colors where 0 is only the texture color and 255 is only `<color>`. If
610 omitted, the alpha of `<color>` will be used as the ratio. If it is
611 the word "`alpha`", then each texture pixel will contain the RGB of
612 `<color>` and the alpha of `<color>` multiplied by the alpha of the
615 #### `[multiply:<color>`
617 Multiplies texture colors with the given color.
618 `<color>` is specified as a `ColorString`.
619 Result is more like what you'd expect if you put a color on top of another
620 color, meaning white surfaces get a lot of your new color while black parts
621 don't change very much.
626 The goal of hardware coloring is to simplify the creation of
627 colorful nodes. If your textures use the same pattern, and they only
628 differ in their color (like colored wool blocks), you can use hardware
629 coloring instead of creating and managing many texture files.
630 All of these methods use color multiplication (so a white-black texture
631 with red coloring will result in red-black color).
635 This method is useful if you wish to create nodes/items with
636 the same texture, in different colors, each in a new node/item definition.
640 When you register an item or node, set its `color` field (which accepts a
641 `ColorSpec`) to the desired color.
643 An `ItemStack`'s static color can be overwritten by the `color` metadata
644 field. If you set that field to a `ColorString`, that color will be used.
648 Each tile may have an individual static color, which overwrites every
649 other coloring method. To disable the coloring of a face,
650 set its color to white (because multiplying with white does nothing).
651 You can set the `color` property of the tiles in the node's definition
652 if the tile is in table format.
656 For nodes and items which can have many colors, a palette is more
657 suitable. A palette is a texture, which can contain up to 256 pixels.
658 Each pixel is one possible color for the node/item.
659 You can register one node/item, which can have up to 256 colors.
661 #### Palette indexing
663 When using palettes, you always provide a pixel index for the given
664 node or `ItemStack`. The palette is read from left to right and from
665 top to bottom. If the palette has less than 256 pixels, then it is
666 stretched to contain exactly 256 pixels (after arranging the pixels
667 to one line). The indexing starts from 0.
671 * 16x16 palette, index = 0: the top left corner
672 * 16x16 palette, index = 4: the fifth pixel in the first row
673 * 16x16 palette, index = 16: the pixel below the top left corner
674 * 16x16 palette, index = 255: the bottom right corner
675 * 2 (width) x 4 (height) palette, index = 31: the top left corner.
676 The palette has 8 pixels, so each pixel is stretched to 32 pixels,
677 to ensure the total 256 pixels.
678 * 2x4 palette, index = 32: the top right corner
679 * 2x4 palette, index = 63: the top right corner
680 * 2x4 palette, index = 64: the pixel below the top left corner
682 #### Using palettes with items
684 When registering an item, set the item definition's `palette` field to
685 a texture. You can also use texture modifiers.
687 The `ItemStack`'s color depends on the `palette_index` field of the
688 stack's metadata. `palette_index` is an integer, which specifies the
689 index of the pixel to use.
691 #### Linking palettes with nodes
693 When registering a node, set the item definition's `palette` field to
694 a texture. You can also use texture modifiers.
695 The node's color depends on its `param2`, so you also must set an
696 appropriate `paramtype2`:
698 * `paramtype2 = "color"` for nodes which use their full `param2` for
699 palette indexing. These nodes can have 256 different colors.
700 The palette should contain 256 pixels.
701 * `paramtype2 = "colorwallmounted"` for nodes which use the first
702 five bits (most significant) of `param2` for palette indexing.
703 The remaining three bits are describing rotation, as in `wallmounted`
704 paramtype2. Division by 8 yields the palette index (without stretching the
705 palette). These nodes can have 32 different colors, and the palette
706 should contain 32 pixels.
708 * `param2 = 17` is 2 * 8 + 1, so the rotation is 1 and the third (= 2 + 1)
709 pixel will be picked from the palette.
710 * `param2 = 35` is 4 * 8 + 3, so the rotation is 3 and the fifth (= 4 + 1)
711 pixel will be picked from the palette.
712 * `paramtype2 = "colorfacedir"` for nodes which use the first
713 three bits of `param2` for palette indexing. The remaining
714 five bits are describing rotation, as in `facedir` paramtype2.
715 Division by 32 yields the palette index (without stretching the
716 palette). These nodes can have 8 different colors, and the
717 palette should contain 8 pixels.
719 * `param2 = 17` is 0 * 32 + 17, so the rotation is 17 and the
720 first (= 0 + 1) pixel will be picked from the palette.
721 * `param2 = 35` is 1 * 32 + 3, so the rotation is 3 and the
722 second (= 1 + 1) pixel will be picked from the palette.
724 To colorize a node on the map, set its `param2` value (according
725 to the node's paramtype2).
727 ### Conversion between nodes in the inventory and on the map
729 Static coloring is the same for both cases, there is no need
732 If the `ItemStack`'s metadata contains the `color` field, it will be
733 lost on placement, because nodes on the map can only use palettes.
735 If the `ItemStack`'s metadata contains the `palette_index` field, it is
736 automatically transferred between node and item forms by the engine,
737 when a player digs or places a colored node.
738 You can disable this feature by setting the `drop` field of the node
739 to itself (without metadata).
740 To transfer the color to a special drop, you need a drop table.
744 minetest.register_node("mod:stone", {
745 description = "Stone",
746 tiles = {"default_stone.png"},
747 paramtype2 = "color",
748 palette = "palette.png",
751 -- assume that mod:cobblestone also has the same palette
752 {items = {"mod:cobblestone"}, inherit_color = true },
757 ### Colored items in craft recipes
759 Craft recipes only support item strings, but fortunately item strings
760 can also contain metadata. Example craft recipe registration:
762 minetest.register_craft({
763 output = minetest.itemstring_with_palette("wool:block", 3),
771 To set the `color` field, you can use `minetest.itemstring_with_color`.
773 Metadata field filtering in the `recipe` field are not supported yet,
774 so the craft output is independent of the color of the ingredients.
779 Sometimes hardware coloring is not enough, because it affects the
780 whole tile. Soft texture overlays were added to Minetest to allow
781 the dynamic coloring of only specific parts of the node's texture.
782 For example a grass block may have colored grass, while keeping the
785 These overlays are 'soft', because unlike texture modifiers, the layers
786 are not merged in the memory, but they are simply drawn on top of each
787 other. This allows different hardware coloring, but also means that
788 tiles with overlays are drawn slower. Using too much overlays might
791 For inventory and wield images you can specify overlays which
792 hardware coloring does not modify. You have to set `inventory_overlay`
793 and `wield_overlay` fields to an image name.
795 To define a node overlay, simply set the `overlay_tiles` field of the node
796 definition. These tiles are defined in the same way as plain tiles:
797 they can have a texture name, color etc.
798 To skip one face, set that overlay tile to an empty string.
800 Example (colored grass block):
802 minetest.register_node("default:dirt_with_grass", {
803 description = "Dirt with Grass",
804 -- Regular tiles, as usual
805 -- The dirt tile disables palette coloring
806 tiles = {{name = "default_grass.png"},
807 {name = "default_dirt.png", color = "white"}},
808 -- Overlay tiles: define them in the same style
809 -- The top and bottom tile does not have overlay
810 overlay_tiles = {"", "",
811 {name = "default_grass_side.png"}},
812 -- Global color, used in inventory
814 -- Palette in the world
815 paramtype2 = "color",
816 palette = "default_foilage.png",
825 Only Ogg Vorbis files are supported.
827 For positional playing of sounds, only single-channel (mono) files are
828 supported. Otherwise OpenAL will play them non-positionally.
830 Mods should generally prefix their sounds with `modname_`, e.g. given
831 the mod name "`foomod`", a sound could be called:
835 Sounds are referred to by their name with a dot, a single digit and the
836 file extension stripped out. When a sound is played, the actual sound file
837 is chosen randomly from the matching sounds.
839 When playing the sound `foomod_foosound`, the sound is chosen randomly
840 from the available ones of the following files:
842 * `foomod_foosound.ogg`
843 * `foomod_foosound.0.ogg`
844 * `foomod_foosound.1.ogg`
846 * `foomod_foosound.9.ogg`
848 Examples of sound parameter tables:
850 -- Play locationless on all clients
852 gain = 1.0, -- default
853 fade = 0.0, -- default, change to a value > 0 to fade the sound in
854 pitch = 1.0, -- default
856 -- Play locationless to one player
859 gain = 1.0, -- default
860 fade = 0.0, -- default, change to a value > 0 to fade the sound in
861 pitch = 1.0, -- default
863 -- Play locationless to one player, looped
866 gain = 1.0, -- default
869 -- Play at a location
871 pos = {x = 1, y = 2, z = 3},
872 gain = 1.0, -- default
873 max_hear_distance = 32, -- default, uses an euclidean metric
875 -- Play connected to an object, looped
877 object = <an ObjectRef>,
878 gain = 1.0, -- default
879 max_hear_distance = 32, -- default, uses an euclidean metric
882 -- Play at a location, heard by anyone *but* the given player
884 pos = {x = 32, y = 0, z = 100},
885 max_hear_distance = 40,
886 exclude_player = name,
889 Looped sounds must either be connected to an object or played locationless to
890 one player using `to_player = name`.
892 A positional sound will only be heard by players that are within
893 `max_hear_distance` of the sound position, at the start of the sound.
895 `exclude_player = name` can be applied to locationless, positional and object-
896 bound sounds to exclude a single player from hearing them.
901 Specifies a sound name, gain (=volume) and pitch.
902 This is either a string or a table.
904 In string form, you just specify the sound name or
905 the empty string for no sound.
907 Table form has the following fields:
910 * `gain`: Volume (`1.0` = 100%)
911 * `pitch`: Pitch (`1.0` = 100%)
913 `gain` and `pitch` are optional and default to `1.0`.
919 * `"default_place_node"`: Play e.g. `default_place_node.ogg`
920 * `{name = "default_place_node"}`: Same as above
921 * `{name = "default_place_node", gain = 0.5}`: 50% volume
922 * `{name = "default_place_node", gain = 0.9, pitch = 1.1}`: 90% volume, 110% pitch
927 These sound files are played back by the engine if provided.
929 * `player_damage`: Played when the local player takes damage (gain = 0.5)
930 * `player_falling_damage`: Played when the local player takes
931 damage by falling (gain = 0.5)
932 * `player_jump`: Played when the local player jumps
933 * `default_dig_<groupname>`: Default node digging sound
934 (see node sound definition for details)
936 Registered definitions
937 ======================
939 Anything added using certain [Registration functions] gets added to one or more
940 of the global [Registered definition tables].
942 Note that in some cases you will stumble upon things that are not contained
943 in these tables (e.g. when a mod has been removed). Always check for
944 existence before trying to access the fields.
948 All nodes register with `minetest.register_node` get added to the table
949 `minetest.registered_nodes`.
951 If you want to check the drawtype of a node, you could do:
953 local function get_nodedef_field(nodename, fieldname)
954 if not minetest.registered_nodes[nodename] then
957 return minetest.registered_nodes[nodename][fieldname]
959 local drawtype = get_nodedef_field(nodename, "drawtype")
967 Nodes are the bulk data of the world: cubes and other things that take the
968 space of a cube. Huge amounts of them are handled efficiently, but they
971 The definition of a node is stored and can be accessed by using
973 minetest.registered_nodes[node.name]
975 See [Registered definitions].
977 Nodes are passed by value between Lua and the engine.
978 They are represented by a table:
980 {name="name", param1=num, param2=num}
982 `param1` and `param2` are 8-bit integers ranging from 0 to 255. The engine uses
983 them for certain automated functions. If you don't use these functions, you can
984 use them to store arbitrary values.
989 The functions of `param1` and `param2` are determined by certain fields in the
992 The function of `param1` is determined by `paramtype` in node definition.
993 `param1` is reserved for the engine when `paramtype != "none"`.
995 * `paramtype = "light"`
996 * The value stores light with and without sun in its upper and lower 4 bits
998 * Required by a light source node to enable spreading its light.
999 * Required by the following drawtypes as they determine their visual
1000 brightness from their internal light value:
1010 * `paramtype = "none"`
1011 * `param1` will not be used by the engine and can be used to store
1014 The function of `param2` is determined by `paramtype2` in node definition.
1015 `param2` is reserved for the engine when `paramtype2 != "none"`.
1017 * `paramtype2 = "flowingliquid"`
1018 * Used by `drawtype = "flowingliquid"` and `liquidtype = "flowing"`
1019 * The liquid level and a flag of the liquid are stored in `param2`
1020 * Bits 0-2: Liquid level (0-7). The higher, the more liquid is in this node;
1021 see `minetest.get_node_level`, `minetest.set_node_level` and `minetest.add_node_level`
1022 to access/manipulate the content of this field
1023 * Bit 3: If set, liquid is flowing downwards (no graphical effect)
1024 * `paramtype2 = "wallmounted"`
1025 * Supported drawtypes: "torchlike", "signlike", "normal", "nodebox", "mesh"
1026 * The rotation of the node is stored in `param2`
1027 * You can make this value by using `minetest.dir_to_wallmounted()`
1028 * Values range 0 - 5
1029 * The value denotes at which direction the node is "mounted":
1030 0 = y+, 1 = y-, 2 = x+, 3 = x-, 4 = z+, 5 = z-
1031 * `paramtype2 = "facedir"`
1032 * Supported drawtypes: "normal", "nodebox", "mesh"
1033 * The rotation of the node is stored in `param2`. Furnaces and chests are
1034 rotated this way. Can be made by using `minetest.dir_to_facedir()`.
1035 * Values range 0 - 23
1036 * facedir / 4 = axis direction:
1037 0 = y+, 1 = z+, 2 = z-, 3 = x+, 4 = x-, 5 = y-
1038 * facedir modulo 4 = rotation around that axis
1039 * `paramtype2 = "leveled"`
1040 * Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
1042 * The level of the top face of the nodebox is stored in `param2`.
1043 * The other faces are defined by 'fixed = {}' like 'type = "fixed"'
1045 * The nodebox height is (`param2` / 64) nodes.
1046 * The maximum accepted value of `param2` is 127.
1048 * The height of the 'plantlike' section is stored in `param2`.
1049 * The height is (`param2` / 16) nodes.
1050 * `paramtype2 = "degrotate"`
1051 * Valid for `plantlike` and `mesh` drawtypes. The rotation of the node is
1053 * Values range 0–239. The value stored in `param2` is multiplied by 1.5 to
1054 get the actual rotation in degrees of the node.
1055 * `paramtype2 = "meshoptions"`
1056 * Only valid for "plantlike" drawtype. `param2` encodes the shape and
1057 optional modifiers of the "plant". `param2` is a bitfield.
1058 * Bits 0 to 2 select the shape.
1059 Use only one of the values below:
1060 * 0 = a "x" shaped plant (ordinary plant)
1061 * 1 = a "+" shaped plant (just rotated 45 degrees)
1062 * 2 = a "*" shaped plant with 3 faces instead of 2
1063 * 3 = a "#" shaped plant with 4 faces instead of 2
1064 * 4 = a "#" shaped plant with 4 faces that lean outwards
1065 * 5-7 are unused and reserved for future meshes.
1066 * Bits 3 to 7 are used to enable any number of optional modifiers.
1067 Just add the corresponding value(s) below to `param2`:
1068 * 8 - Makes the plant slightly vary placement horizontally
1069 * 16 - Makes the plant mesh 1.4x larger
1070 * 32 - Moves each face randomly a small bit down (1/8 max)
1071 * values 64 and 128 (bits 6-7) are reserved for future use.
1072 * Example: `param2 = 0` selects a normal "x" shaped plant
1073 * Example: `param2 = 17` selects a "+" shaped plant, 1.4x larger (1+16)
1074 * `paramtype2 = "color"`
1075 * `param2` tells which color is picked from the palette.
1076 The palette should have 256 pixels.
1077 * `paramtype2 = "colorfacedir"`
1078 * Same as `facedir`, but with colors.
1079 * The first three bits of `param2` tells which color is picked from the
1080 palette. The palette should have 8 pixels.
1081 * `paramtype2 = "colorwallmounted"`
1082 * Same as `wallmounted`, but with colors.
1083 * The first five bits of `param2` tells which color is picked from the
1084 palette. The palette should have 32 pixels.
1085 * `paramtype2 = "glasslikeliquidlevel"`
1086 * Only valid for "glasslike_framed" or "glasslike_framed_optional"
1088 * `param2` values 0-63 define 64 levels of internal liquid, 0 being empty
1090 * Liquid texture is defined using `special_tiles = {"modname_tilename.png"}`
1091 * `paramtype2 = "colordegrotate"`
1092 * Same as `degrotate`, but with colors.
1093 * The first (most-significant) three bits of `param2` tells which color
1094 is picked from the palette. The palette should have 8 pixels.
1095 * Remaining 5 bits store rotation in range 0–23 (i.e. in 15° steps)
1096 * `paramtype2 = "none"`
1097 * `param2` will not be used by the engine and can be used to store
1100 Nodes can also contain extra data. See [Node Metadata].
1105 There are a bunch of different looking node types.
1107 Look for examples in `games/devtest` or `games/minetest_game`.
1110 * A node-sized cube.
1112 * Invisible, uses no texture.
1114 * The cubic source node for a liquid.
1116 * The flowing version of a liquid, appears with various heights and slopes.
1118 * Often used for partially-transparent nodes.
1119 * Only external sides of textures are visible.
1120 * `glasslike_framed`
1121 * All face-connected nodes are drawn as one volume within a surrounding
1123 * The frame appearance is generated from the edges of the first texture
1124 specified in `tiles`. The width of the edges used are 1/16th of texture
1125 size: 1 pixel for 16x16, 2 pixels for 32x32 etc.
1126 * The glass 'shine' (or other desired detail) on each node face is supplied
1127 by the second texture specified in `tiles`.
1128 * `glasslike_framed_optional`
1129 * This switches between the above 2 drawtypes according to the menu setting
1132 * Often used for partially-transparent nodes.
1133 * External and internal sides of textures are visible.
1134 * `allfaces_optional`
1135 * Often used for leaves nodes.
1136 * This switches between `normal`, `glasslike` and `allfaces` according to
1137 the menu setting: Opaque Leaves / Simple Leaves / Fancy Leaves.
1138 * With 'Simple Leaves' selected, the texture specified in `special_tiles`
1139 is used instead, if present. This allows a visually thicker texture to be
1140 used to compensate for how `glasslike` reduces visual thickness.
1142 * A single vertical texture.
1143 * If placed on top of a node, uses the first texture specified in `tiles`.
1144 * If placed against the underside of a node, uses the second texture
1145 specified in `tiles`.
1146 * If placed on the side of a node, uses the third texture specified in
1147 `tiles` and is perpendicular to that node.
1149 * A single texture parallel to, and mounted against, the top, underside or
1152 * Two vertical and diagonal textures at right-angles to each other.
1153 * See `paramtype2 = "meshoptions"` above for other options.
1155 * When above a flat surface, appears as 6 textures, the central 2 as
1156 `plantlike` plus 4 more surrounding those.
1157 * If not above a surface the central 2 do not appear, but the texture
1158 appears against the faces of surrounding nodes if they are present.
1160 * A 3D model suitable for a wooden fence.
1161 * One placed node appears as a single vertical post.
1162 * Adjacently-placed nodes cause horizontal bars to appear between them.
1164 * Often used for tracks for mining carts.
1165 * Requires 4 textures to be specified in `tiles`, in order: Straight,
1166 curved, t-junction, crossing.
1167 * Each placed node automatically switches to a suitable rotated texture
1168 determined by the adjacent `raillike` nodes, in order to create a
1169 continuous track network.
1170 * Becomes a sloping node if placed against stepped nodes.
1172 * Often used for stairs and slabs.
1173 * Allows defining nodes consisting of an arbitrary number of boxes.
1174 * See [Node boxes] below for more information.
1176 * Uses models for nodes.
1177 * Tiles should hold model materials textures.
1178 * Only static meshes are implemented.
1179 * For supported model formats see Irrlicht engine documentation.
1180 * `plantlike_rooted`
1181 * Enables underwater `plantlike` without air bubbles around the nodes.
1182 * Consists of a base cube at the co-ordinates of the node plus a
1183 `plantlike` extension above with a height of `param2 / 16` nodes.
1184 * The `plantlike` extension visually passes through any nodes above the
1185 base cube without affecting them.
1186 * The base cube texture tiles are defined as normal, the `plantlike`
1187 extension uses the defined special tile, for example:
1188 `special_tiles = {{name = "default_papyrus.png"}},`
1190 `*_optional` drawtypes need less rendering time if deactivated
1191 (always client-side).
1196 Node selection boxes are defined using "node boxes".
1198 A nodebox is defined as any of:
1201 -- A normal cube; the default in most things
1205 -- A fixed box (or boxes) (facedir param2 is used, if applicable)
1207 fixed = box OR {box1, box2, ...}
1210 -- A variable height box (or boxes) with the top face position defined
1211 -- by the node parameter 'leveled = ', or if 'paramtype2 == "leveled"'
1213 -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
1215 fixed = box OR {box1, box2, ...}
1218 -- A box like the selection box for torches
1219 -- (wallmounted param2 is used, if applicable)
1220 type = "wallmounted",
1226 -- A node that has optional boxes depending on neighbouring nodes'
1227 -- presence and type. See also `connects_to`.
1229 fixed = box OR {box1, box2, ...}
1230 connect_top = box OR {box1, box2, ...}
1231 connect_bottom = box OR {box1, box2, ...}
1232 connect_front = box OR {box1, box2, ...}
1233 connect_left = box OR {box1, box2, ...}
1234 connect_back = box OR {box1, box2, ...}
1235 connect_right = box OR {box1, box2, ...}
1236 -- The following `disconnected_*` boxes are the opposites of the
1237 -- `connect_*` ones above, i.e. when a node has no suitable neighbour
1238 -- on the respective side, the corresponding disconnected box is drawn.
1239 disconnected_top = box OR {box1, box2, ...}
1240 disconnected_bottom = box OR {box1, box2, ...}
1241 disconnected_front = box OR {box1, box2, ...}
1242 disconnected_left = box OR {box1, box2, ...}
1243 disconnected_back = box OR {box1, box2, ...}
1244 disconnected_right = box OR {box1, box2, ...}
1245 disconnected = box OR {box1, box2, ...} -- when there is *no* neighbour
1246 disconnected_sides = box OR {box1, box2, ...} -- when there are *no*
1247 -- neighbours to the sides
1250 A `box` is defined as:
1252 {x1, y1, z1, x2, y2, z2}
1254 A box of a regular node would look like:
1256 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
1258 To avoid collision issues, keep each value within the range of +/- 1.45.
1259 This also applies to leveled nodeboxes, where the final height shall not
1260 exceed this soft limit.
1264 Map terminology and coordinates
1265 ===============================
1267 Nodes, mapblocks, mapchunks
1268 ---------------------------
1270 A 'node' is the fundamental cubic unit of a world and appears to a player as
1271 roughly 1x1x1 meters in size.
1273 A 'mapblock' (often abbreviated to 'block') is 16x16x16 nodes and is the
1274 fundamental region of a world that is stored in the world database, sent to
1275 clients and handled by many parts of the engine.
1276 'mapblock' is preferred terminology to 'block' to help avoid confusion with
1277 'node', however 'block' often appears in the API.
1279 A 'mapchunk' (sometimes abbreviated to 'chunk') is usually 5x5x5 mapblocks
1280 (80x80x80 nodes) and is the volume of world generated in one operation by
1282 The size in mapblocks has been chosen to optimise map generation.
1287 ### Orientation of axes
1289 For node and mapblock coordinates, +X is East, +Y is up, +Z is North.
1291 ### Node coordinates
1293 Almost all positions used in the API use node coordinates.
1295 ### Mapblock coordinates
1297 Occasionally the API uses 'blockpos' which refers to mapblock coordinates that
1298 specify a particular mapblock.
1299 For example blockpos (0,0,0) specifies the mapblock that extends from
1300 node position (0,0,0) to node position (15,15,15).
1302 #### Converting node position to the containing blockpos
1304 To calculate the blockpos of the mapblock that contains the node at 'nodepos',
1307 * blockpos = math.floor(nodepos / 16)
1309 #### Converting blockpos to min/max node positions
1311 To calculate the min/max node positions contained in the mapblock at 'blockpos',
1315 nodepos = blockpos * 16
1317 nodepos = blockpos * 16 + 15
1328 The position field is used for all element types.
1330 To account for differing resolutions, the position coordinates are the
1331 percentage of the screen, ranging in value from `0` to `1`.
1333 The name field is not yet used, but should contain a description of what the
1334 HUD element represents.
1336 The `direction` field is the direction in which something is drawn.
1337 `0` draws from left to right, `1` draws from right to left, `2` draws from
1338 top to bottom, and `3` draws from bottom to top.
1340 The `alignment` field specifies how the item will be aligned. It is a table
1341 where `x` and `y` range from `-1` to `1`, with `0` being central. `-1` is
1342 moved to the left/up, and `1` is to the right/down. Fractional values can be
1345 The `offset` field specifies a pixel offset from the position. Contrary to
1346 position, the offset is not scaled to screen size. This allows for some
1347 precisely positioned items in the HUD.
1349 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
1352 The `z_index` field specifies the order of HUD elements from back to front.
1353 Lower z-index elements are displayed behind higher z-index elements. Elements
1354 with same z-index are displayed in an arbitrary order. Default 0.
1355 Supports negative values. By convention, the following values are recommended:
1357 * -400: Graphical effects, such as vignette
1358 * -300: Name tags, waypoints
1360 * -100: Things that block the player's view, e.g. masks
1361 * 0: Default. For standard in-game HUD elements like crosshair, hotbar,
1362 minimap, builtin statbars, etc.
1363 * 100: Temporary text messages or notification icons
1364 * 1000: Full-screen effects such as full-black screen or credits.
1365 This includes effects that cover the entire screen
1366 * Other: If your HUD element doesn't fit into any category, pick a number
1367 between the suggested values
1371 Below are the specific uses for fields in each type; fields not listed for that
1376 Displays an image on the HUD.
1378 * `scale`: The scale of the image, with 1 being the original texture size.
1379 Only the X coordinate scale is used (positive values).
1380 Negative values represent that percentage of the screen it
1381 should take; e.g. `x=-100` means 100% (width).
1382 * `text`: The name of the texture that is displayed.
1383 * `alignment`: The alignment of the image.
1384 * `offset`: offset in pixels from position.
1388 Displays text on the HUD.
1390 * `scale`: Defines the bounding rectangle of the text.
1391 A value such as `{x=100, y=100}` should work.
1392 * `text`: The text to be displayed in the HUD element.
1393 * `number`: An integer containing the RGB value of the color used to draw the
1394 text. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1395 * `alignment`: The alignment of the text.
1396 * `offset`: offset in pixels from position.
1397 * `size`: size of the text.
1398 The player-set font size is multiplied by size.x (y value isn't used).
1402 Displays a horizontal bar made up of half-images with an optional background.
1404 * `text`: The name of the texture to use.
1405 * `text2`: Optional texture name to enable a background / "off state"
1406 texture (useful to visualize the maximal value). Both textures
1407 must have the same size.
1408 * `number`: The number of half-textures that are displayed.
1409 If odd, will end with a vertically center-split texture.
1410 * `item`: Same as `number` but for the "off state" texture
1411 * `direction`: To which direction the images will extend to
1412 * `offset`: offset in pixels from position.
1413 * `size`: If used, will force full-image size to this value (override texture
1418 * `text`: The name of the inventory list to be displayed.
1419 * `number`: Number of items in the inventory to be displayed.
1420 * `item`: Position of item that is selected.
1422 * `offset`: offset in pixels from position.
1426 Displays distance to selected world position.
1428 * `name`: The name of the waypoint.
1429 * `text`: Distance suffix. Can be blank.
1430 * `precision`: Waypoint precision, integer >= 0. Defaults to 10.
1431 If set to 0, distance is not shown. Shown value is `floor(distance*precision)/precision`.
1432 When the precision is an integer multiple of 10, there will be `log_10(precision)` digits after the decimal point.
1433 `precision = 1000`, for example, will show 3 decimal places (eg: `0.999`).
1434 `precision = 2` will show multiples of `0.5`; precision = 5 will show multiples of `0.2` and so on:
1435 `precision = n` will show multiples of `1/n`
1436 * `number:` An integer containing the RGB value of the color used to draw the
1438 * `world_pos`: World position of the waypoint.
1439 * `offset`: offset in pixels from position.
1440 * `alignment`: The alignment of the waypoint.
1442 ### `image_waypoint`
1444 Same as `image`, but does not accept a `position`; the position is instead determined by `world_pos`, the world position of the waypoint.
1446 * `scale`: The scale of the image, with 1 being the original texture size.
1447 Only the X coordinate scale is used (positive values).
1448 Negative values represent that percentage of the screen it
1449 should take; e.g. `x=-100` means 100% (width).
1450 * `text`: The name of the texture that is displayed.
1451 * `alignment`: The alignment of the image.
1452 * `world_pos`: World position of the waypoint.
1453 * `offset`: offset in pixels from position.
1457 Displays an image oriented or translated according to current heading direction.
1459 * `size`: The size of this element. Negative values represent percentage
1460 of the screen; e.g. `x=-100` means 100% (width).
1461 * `scale`: Scale of the translated image (used only for dir = 2 or dir = 3).
1462 * `text`: The name of the texture to use.
1463 * `alignment`: The alignment of the image.
1464 * `offset`: Offset in pixels from position.
1465 * `dir`: How the image is rotated/translated:
1466 * 0 - Rotate as heading direction
1467 * 1 - Rotate in reverse direction
1468 * 2 - Translate as landscape direction
1469 * 3 - Translate in reverse direction
1471 If translation is chosen, texture is repeated horizontally to fill the whole element.
1475 Displays a minimap on the HUD.
1477 * `size`: Size of the minimap to display. Minimap should be a square to avoid
1479 * `alignment`: The alignment of the minimap.
1480 * `offset`: offset in pixels from position.
1482 Representations of simple things
1483 ================================
1488 {x=num, y=num, z=num}
1490 For helper functions see [Spatial Vectors].
1495 * `{type="nothing"}`
1496 * `{type="node", under=pos, above=pos}`
1497 * Indicates a pointed node selection box.
1498 * `under` refers to the node position behind the pointed face.
1499 * `above` refers to the node position in front of the pointed face.
1500 * `{type="object", ref=ObjectRef}`
1502 Exact pointing location (currently only `Raycast` supports these fields):
1504 * `pointed_thing.intersection_point`: The absolute world coordinates of the
1505 point on the selection box which is pointed at. May be in the selection box
1506 if the pointer is in the box too.
1507 * `pointed_thing.box_id`: The ID of the pointed selection box (counting starts
1509 * `pointed_thing.intersection_normal`: Unit vector, points outwards of the
1510 selected selection box. This specifies which face is pointed at.
1511 Is a null vector `{x = 0, y = 0, z = 0}` when the pointer is inside the
1517 Flag Specifier Format
1518 =====================
1520 Flags using the standardized flag specifier format can be specified in either
1521 of two ways, by string or table.
1523 The string format is a comma-delimited set of flag names; whitespace and
1524 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1525 flag, and specifying a flag prefixed by the string `"no"` explicitly
1526 clears the flag from whatever the default may be.
1528 In addition to the standard string flag format, the schematic flags field can
1529 also be a table of flag names to boolean values representing whether or not the
1530 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1531 is present, mapped to a boolean of any value, the specified flag is unset.
1533 E.g. A flag field of value
1535 {place_center_x = true, place_center_y=false, place_center_z=true}
1539 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1541 which is equivalent to
1543 "place_center_x, noplace_center_y, place_center_z"
1547 "place_center_x, place_center_z"
1549 since, by default, no schematic attributes are set.
1560 There are three kinds of items: nodes, tools and craftitems.
1562 * Node: Can be placed in the world's voxel grid
1563 * Tool: Has a wear property but cannot be stacked. The default use action is to
1564 dig nodes or hit objects according to its tool capabilities.
1565 * Craftitem: Cannot dig nodes or be placed
1570 All item stacks have an amount between 0 and 65535. It is 1 by
1571 default. Tool item stacks can not have an amount greater than 1.
1573 Tools use a wear (damage) value ranging from 0 to 65535. The
1574 value 0 is the default and is used for unworn tools. The values
1575 1 to 65535 are used for worn tools, where a higher value stands for
1576 a higher wear. Non-tools always have a wear value of 0.
1581 Items and item stacks can exist in three formats: Serializes, table format
1584 When an item must be passed to a function, it can usually be in any of
1589 This is called "stackstring" or "itemstring". It is a simple string with
1590 1-3 components: the full item identifier, an optional amount and an optional
1593 <identifier> [<amount>[ <wear>]]
1597 * `'default:apple'`: 1 apple
1598 * `'default:dirt 5'`: 5 dirt
1599 * `'default:pick_stone'`: a new stone pickaxe
1600 * `'default:pick_wood 1 21323'`: a wooden pickaxe, ca. 1/3 worn out
1608 {name="default:dirt", count=5, wear=0, metadata=""}
1610 A wooden pick about 1/3 worn out:
1612 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1616 {name="default:apple", count=1, wear=0, metadata=""}
1620 A native C++ format with many helper methods. Useful for converting
1621 between formats. See the [Class reference] section for details.
1629 In a number of places, there is a group table. Groups define the
1630 properties of a thing (item, node, armor of entity, capabilities of
1631 tool) in such a way that the engine and other mods can can interact with
1632 the thing without actually knowing what the thing is.
1637 Groups are stored in a table, having the group names with keys and the
1638 group ratings as values. Group ratings are integer values within the
1639 range [-32767, 32767]. For example:
1642 groups = {crumbly=3, soil=1}
1644 -- A more special dirt-kind of thing
1645 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1647 Groups always have a rating associated with them. If there is no
1648 useful meaning for a rating for an enabled group, it shall be `1`.
1650 When not defined, the rating of a group defaults to `0`. Thus when you
1651 read groups, you must interpret `nil` and `0` as the same value, `0`.
1653 You can read the rating of a group for an item or a node by using
1655 minetest.get_item_group(itemname, groupname)
1660 Groups of items can define what kind of an item it is (e.g. wool).
1665 In addition to the general item things, groups are used to define whether
1666 a node is destroyable and how long it takes to destroy by a tool.
1671 For entities, groups are, as of now, used only for calculating damage.
1672 The rating is the percentage of damage caused by tools with this damage group.
1673 See [Entity damage mechanism].
1675 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1676 object.set_armor_groups({fleshy=30, cracky=80})
1681 Groups in tools define which groups of nodes and entities they are
1684 Groups in crafting recipes
1685 --------------------------
1687 An example: Make meat soup from any meat, any water and any bowl:
1690 output = 'food:meat_soup_raw',
1696 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1699 Another example: Make red wool from white wool and red dye:
1703 output = 'wool:red',
1704 recipe = {'wool:white', 'group:dye,basecolor_red'},
1710 The asterisk `(*)` after a group name describes that there is no engine
1711 functionality bound to it, and implementation is left up as a suggestion
1714 ### Node, item and tool groups
1716 * `not_in_creative_inventory`: (*) Special group for inventory mods to indicate
1717 that the item should be hidden in item lists.
1720 ### Node-only groups
1722 * `attached_node`: if the node under it is not a walkable block the node will be
1723 dropped as an item. If the node is wallmounted the wallmounted direction is
1725 * `bouncy`: value is bounce speed in percent
1726 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1727 connect to each other
1728 * `dig_immediate`: Player can always pick up node without reducing tool wear
1729 * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
1730 * `3`: the node always gets the digging time 0 seconds (torch)
1731 * `disable_jump`: Player (and possibly other things) cannot jump from node
1732 or if their feet are in the node. Note: not supported for `new_move = false`
1733 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1734 * `falling_node`: if there is no walkable block under the node it will fall
1735 * `float`: the node will not fall through liquids
1736 * `level`: Can be used to give an additional sense of progression in the game.
1737 * A larger level will cause e.g. a weapon of a lower level make much less
1738 damage, and get worn out much faster, or not be able to get drops
1739 from destroyed nodes.
1740 * `0` is something that is directly accessible at the start of gameplay
1741 * There is no upper limit
1742 * See also: `leveldiff` in [Tools]
1743 * `slippery`: Players and items will slide on the node.
1744 Slipperiness rises steadily with `slippery` value, starting at 1.
1747 ### Tool-only groups
1749 * `disable_repair`: If set to 1 for a tool, it cannot be repaired using the
1750 `"toolrepair"` crafting recipe
1753 ### `ObjectRef` groups
1755 * `immortal`: Skips all damage and breath handling for an object. This group
1756 will also hide the integrated HUD status bars for players. It is
1757 automatically set to all players when damage is disabled on the server and
1758 cannot be reset (subject to change).
1759 * `punch_operable`: For entities; disables the regular damage mechanism for
1760 players punching it by hand or a non-tool item, so that it can do something
1761 else than take damage.
1765 Known damage and digging time defining groups
1766 ---------------------------------------------
1768 * `crumbly`: dirt, sand
1769 * `cracky`: tough but crackable stuff like stone.
1770 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1771 plants, wire, sheets of metal
1772 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1773 * `fleshy`: Living things like animals and the player. This could imply
1774 some blood effects when hitting.
1775 * `explody`: Especially prone to explosions
1776 * `oddly_breakable_by_hand`:
1777 Can be added to nodes that shouldn't logically be breakable by the
1778 hand but are. Somewhat similar to `dig_immediate`, but times are more
1779 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1780 speed of a tool if the tool can dig at a faster speed than this
1781 suggests for the hand.
1783 Examples of custom groups
1784 -------------------------
1786 Item groups are often used for defining, well, _groups of items_.
1788 * `meat`: any meat-kind of a thing (rating might define the size or healing
1789 ability or be irrelevant -- it is not defined as of yet)
1790 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1792 * `flammable`: can be set on fire. Rating might define the intensity of the
1793 fire, affecting e.g. the speed of the spreading of an open fire.
1794 * `wool`: any wool (any origin, any color)
1795 * `metal`: any metal
1796 * `weapon`: any weapon
1797 * `heavy`: anything considerably heavy
1799 Digging time calculation specifics
1800 ----------------------------------
1802 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1803 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1804 faster digging time.
1806 The `level` group is used to limit the toughness of nodes a tool can dig
1807 and to scale the digging times / damage to a greater extent.
1809 **Please do understand this**, otherwise you cannot use the system to it's
1812 Tools define their properties by a list of parameters for groups. They
1813 cannot dig other groups; thus it is important to use a standard bunch of
1814 groups to enable interaction with tools.
1827 * Full punch interval
1828 * Maximum drop level
1829 * For an arbitrary list of groups:
1830 * Uses (until the tool breaks)
1831 * Maximum level (usually `0`, `1`, `2` or `3`)
1835 ### Full punch interval
1837 When used as a weapon, the tool will do full damage if this time is spent
1838 between punches. If e.g. half the time is spent, the tool will do half
1841 ### Maximum drop level
1843 Suggests the maximum level of node, when dug with the tool, that will drop
1844 it's useful item. (e.g. iron ore to drop a lump of iron).
1846 This is not automated; it is the responsibility of the node definition
1851 Determines how many uses the tool has when it is used for digging a node,
1852 of this group, of the maximum level. For lower leveled nodes, the use count
1853 is multiplied by `3^leveldiff`.
1854 `leveldiff` is the difference of the tool's `maxlevel` `groupcaps` and the
1855 node's `level` group. The node cannot be dug if `leveldiff` is less than zero.
1857 * `uses=10, leveldiff=0`: actual uses: 10
1858 * `uses=10, leveldiff=1`: actual uses: 30
1859 * `uses=10, leveldiff=2`: actual uses: 90
1863 Tells what is the maximum level of a node of this group that the tool will
1868 List of digging times for different ratings of the group, for nodes of the
1871 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1872 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1873 for this group, and unable to dig the rating `1`, which is the toughest.
1874 Unless there is a matching group that enables digging otherwise.
1876 If the result digging time is 0, a delay of 0.15 seconds is added between
1877 digging nodes; If the player releases LMB after digging, this delay is set to 0,
1878 i.e. players can more quickly click the nodes away instead of holding LMB.
1882 List of damage for groups of entities. See [Entity damage mechanism].
1884 Example definition of the capabilities of a tool
1885 ------------------------------------------------
1887 tool_capabilities = {
1888 full_punch_interval=1.5,
1891 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1893 damage_groups = {fleshy=2},
1896 This makes the tool be able to dig nodes that fulfil both of these:
1898 * Have the `crumbly` group
1899 * Have a `level` group less or equal to `2`
1901 Table of resulting digging times:
1903 crumbly 0 1 2 3 4 <- level
1905 1 0.80 1.60 1.60 - -
1906 2 0.60 1.20 1.20 - -
1907 3 0.40 0.80 0.80 - -
1909 level diff: 2 1 0 -1 -2
1911 Table of resulting tool uses:
1920 * At `crumbly==0`, the node is not diggable.
1921 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1922 easy nodes to be quickly breakable.
1923 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1928 Entity damage mechanism
1929 =======================
1934 foreach group in cap.damage_groups:
1935 damage += cap.damage_groups[group]
1936 * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
1937 * (object.armor_groups[group] / 100.0)
1938 -- Where object.armor_groups[group] is 0 for inexistent values
1941 Client predicts damage based on damage groups. Because of this, it is able to
1942 give an immediate response when an entity is damaged or dies; the response is
1943 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1945 Currently a smoke puff will appear when an entity dies.
1947 The group `immortal` completely disables normal damage.
1949 Entities can define a special armor group, which is `punch_operable`. This
1950 group disables the regular damage mechanism for players punching it by hand or
1951 a non-tool item, so that it can do something else than take damage.
1953 On the Lua side, every punch calls:
1955 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction,
1958 This should never be called directly, because damage is usually not handled by
1961 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1962 accessed unless absolutely required, to encourage interoperability.
1963 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1964 * `tool_capabilities` can be `nil`.
1965 * `direction` is a unit vector, pointing from the source of the punch to
1967 * `damage` damage that will be done to entity
1968 Return value of this function will determine if damage is done by this function
1969 (retval true) or shall be done by engine (retval false)
1971 To punch an entity/object in Lua, call:
1973 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1975 * Return value is tool wear.
1976 * Parameters are equal to the above callback.
1977 * If `direction` equals `nil` and `puncher` does not equal `nil`, `direction`
1978 will be automatically filled in based on the location of `puncher`.
1989 The instance of a node in the world normally only contains the three values
1990 mentioned in [Nodes]. However, it is possible to insert extra data into a node.
1991 It is called "node metadata"; See `NodeMetaRef`.
1993 Node metadata contains two things:
1998 Some of the values in the key-value store are handled specially:
2000 * `formspec`: Defines a right-click inventory menu. See [Formspec].
2001 * `infotext`: Text shown on the screen when the node is pointed at
2005 local meta = minetest.get_meta(pos)
2006 meta:set_string("formspec",
2008 "list[context;main;0,0;8,4;]"..
2009 "list[current_player;main;0,5;8,4;]")
2010 meta:set_string("infotext", "Chest");
2011 local inv = meta:get_inventory()
2012 inv:set_size("main", 8*4)
2013 print(dump(meta:to_table()))
2016 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
2017 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
2018 [10] = "", [11] = "", [12] = "", [13] = "",
2019 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
2020 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
2021 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
2022 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
2026 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
2034 Item stacks can store metadata too. See [`ItemStackMetaRef`].
2036 Item metadata only contains a key-value store.
2038 Some of the values in the key-value store are handled specially:
2040 * `description`: Set the item stack's description.
2041 See also: `get_description` in [`ItemStack`]
2042 * `short_description`: Set the item stack's short description.
2043 See also: `get_short_description` in [`ItemStack`]
2044 * `color`: A `ColorString`, which sets the stack's color.
2045 * `palette_index`: If the item has a palette, this is used to get the
2046 current color from the palette.
2050 local meta = stack:get_meta()
2051 meta:set_string("key", "value")
2052 print(dump(meta:to_table()))
2060 Formspec defines a menu. This supports inventories and some of the
2061 typical widgets like buttons, checkboxes, text input fields, etc.
2062 It is a string, with a somewhat strange format.
2064 A formspec is made out of formspec elements, which includes widgets
2065 like buttons but also can be used to set stuff like background color.
2067 Many formspec elements have a `name`, which is a unique identifier which
2068 is used when the server receives user input. You must not use the name
2069 "quit" for formspec elements.
2071 Spaces and newlines can be inserted between the blocks, as is used in the
2074 Position and size units are inventory slots unless the new coordinate system
2075 is enabled. `X` and `Y` position the formspec element relative to the top left
2076 of the menu or container. `W` and `H` are its width and height values.
2078 If the new system is enabled, all elements have unified coordinates for all
2079 elements with no padding or spacing in between. This is highly recommended
2080 for new forms. See `real_coordinates[<bool>]` and `Migrating to Real
2083 Inventories with a `player:<name>` inventory location are only sent to the
2084 player named `<name>`.
2086 When displaying text which can contain formspec code, e.g. text set by a player,
2087 use `minetest.formspec_escape`.
2088 For coloured text you can use `minetest.colorize`.
2090 Since formspec version 3, elements drawn in the order they are defined. All
2091 background elements are drawn before all other elements.
2093 **WARNING**: do _not_ use a element name starting with `key_`; those names are
2094 reserved to pass key press events to formspec!
2096 **WARNING**: Minetest allows you to add elements to every single formspec instance
2097 using `player:set_formspec_prepend()`, which may be the reason backgrounds are
2098 appearing when you don't expect them to, or why things are styled differently
2099 to normal. See [`no_prepend[]`] and [Styling Formspecs].
2107 list[context;main;0,0;8,4;]
2108 list[current_player;main;0,5;8,4;]
2113 list[context;fuel;2,3;1,1;]
2114 list[context;src;2,1;1,1;]
2115 list[context;dst;5,1;2,2;]
2116 list[current_player;main;0,5;8,4;]
2118 ### Minecraft-like player inventory
2121 image[1,0.6;1,2;player.png]
2122 list[current_player;main;0,3.5;8,4;]
2123 list[current_player;craft;3,0;3,3;]
2124 list[current_player;craftpreview;7,1;1,1;]
2129 * FORMSPEC VERSION 1:
2131 * FORMSPEC VERSION 2:
2132 * Forced real coordinates
2133 * background9[]: 9-slice scaling parameters
2134 * FORMSPEC VERSION 3:
2135 * Formspec elements are drawn in the order of definition
2136 * bgcolor[]: use 3 parameters (bgcolor, formspec (now an enum), fbgcolor)
2137 * box[] and image[] elements enable clipping by default
2138 * new element: scroll_container[]
2139 * FORMSPEC VERSION 4:
2140 * Allow dropdown indexing events
2145 ### `formspec_version[<version>]`
2147 * Set the formspec version to a certain number. If not specified,
2148 version 1 is assumed.
2149 * Must be specified before `size` element.
2150 * Clients older than this version can neither show newer elements nor display
2151 elements with new arguments correctly.
2152 * Available since feature `formspec_version_element`.
2153 * See also: [Version History]
2155 ### `size[<W>,<H>,<fixed_size>]`
2157 * Define the size of the menu in inventory slots
2158 * `fixed_size`: `true`/`false` (optional)
2159 * deprecated: `invsize[<W>,<H>;]`
2161 ### `position[<X>,<Y>]`
2163 * Must be used after `size` element.
2164 * Defines the position on the game window of the formspec's `anchor` point.
2165 * For X and Y, 0.0 and 1.0 represent opposite edges of the game window,
2167 * [0.0, 0.0] sets the position to the top left corner of the game window.
2168 * [1.0, 1.0] sets the position to the bottom right of the game window.
2169 * Defaults to the center of the game window [0.5, 0.5].
2171 ### `anchor[<X>,<Y>]`
2173 * Must be used after both `size` and `position` (if present) elements.
2174 * Defines the location of the anchor point within the formspec.
2175 * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec,
2177 * [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
2178 * [1.0, 0.0] sets the anchor to the top right of the formspec.
2179 * Defaults to the center of the formspec [0.5, 0.5].
2181 * `position` and `anchor` elements need suitable values to avoid a formspec
2182 extending off the game window due to particular game window sizes.
2186 * Must be used after the `size`, `position`, and `anchor` elements (if present).
2187 * Disables player:set_formspec_prepend() from applying to this formspec.
2189 ### `real_coordinates[<bool>]`
2191 * INFORMATION: Enable it automatically using `formspec_version` version 2 or newer.
2192 * When set to true, all following formspec elements will use the new coordinate system.
2193 * If used immediately after `size`, `position`, `anchor`, and `no_prepend` elements
2194 (if present), the form size will use the new coordinate system.
2195 * **Note**: Formspec prepends are not affected by the coordinates in the main form.
2196 They must enable it explicitly.
2197 * For information on converting forms to the new coordinate system, see `Migrating
2198 to Real Coordinates`.
2200 ### `container[<X>,<Y>]`
2202 * Start of a container block, moves all physical elements in the container by
2204 * Must have matching `container_end`
2205 * Containers can be nested, in which case the offsets are added
2206 (child containers are relative to parent containers)
2208 ### `container_end[]`
2210 * End of a container, following elements are no longer relative to this
2213 ### `scroll_container[<X>,<Y>;<W>,<H>;<scrollbar name>;<orientation>;<scroll factor>]`
2215 * Start of a scroll_container block. All contained elements will ...
2216 * take the scroll_container coordinate as position origin,
2217 * be additionally moved by the current value of the scrollbar with the name
2218 `scrollbar name` times `scroll factor` along the orientation `orientation` and
2219 * be clipped to the rectangle defined by `X`, `Y`, `W` and `H`.
2220 * `orientation`: possible values are `vertical` and `horizontal`.
2221 * `scroll factor`: optional, defaults to `0.1`.
2222 * Nesting is possible.
2223 * Some elements might work a little different if they are in a scroll_container.
2224 * Note: If you want the scroll_container to actually work, you also need to add a
2225 scrollbar element with the specified name. Furthermore, it is highly recommended
2226 to use a scrollbaroptions element on this scrollbar.
2228 ### `scroll_container_end[]`
2230 * End of a scroll_container, following elements are no longer bound to this
2233 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
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 by default. Also see
2239 [Styling Formspecs] for changing the size of slots and spacing.
2241 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
2243 * Show an inventory list if it has been sent to the client. Nothing will
2244 be shown if the inventory list is of size 0.
2245 * **Note**: With the new coordinate system, the spacing between inventory
2246 slots is one-fourth the size of an inventory slot.
2248 ### `listring[<inventory location>;<list name>]`
2250 * Allows to create a ring of inventory lists
2251 * Shift-clicking on items in one element of the ring
2252 will send them to the next inventory list inside the ring
2253 * The first occurrence of an element inside the ring will
2254 determine the inventory where items will be sent to
2258 * Shorthand for doing `listring[<inventory location>;<list name>]`
2259 for the last two inventory lists added by list[...]
2261 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
2263 * Sets background color of slots as `ColorString`
2264 * Sets background color of slots on mouse hovering
2266 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
2268 * Sets background color of slots as `ColorString`
2269 * Sets background color of slots on mouse hovering
2270 * Sets color of slots border
2272 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
2274 * Sets background color of slots as `ColorString`
2275 * Sets background color of slots on mouse hovering
2276 * Sets color of slots border
2277 * Sets default background color of tooltips
2278 * Sets default font color of tooltips
2280 ### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2282 * Adds tooltip for an element
2283 * `bgcolor` tooltip background color as `ColorString` (optional)
2284 * `fontcolor` tooltip font color as `ColorString` (optional)
2286 ### `tooltip[<X>,<Y>;<W>,<H>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2288 * Adds tooltip for an area. Other tooltips will take priority when present.
2289 * `bgcolor` tooltip background color as `ColorString` (optional)
2290 * `fontcolor` tooltip font color as `ColorString` (optional)
2292 ### `image[<X>,<Y>;<W>,<H>;<texture name>]`
2296 ### `animated_image[<X>,<Y>;<W>,<H>;<name>;<texture name>;<frame count>;<frame duration>;<frame start>]`
2298 * Show an animated image. The image is drawn like a "vertical_frames" tile
2299 animation (See [Tile animation definition]), but uses a frame count/duration
2301 * `name`: Element name to send when an event occurs. The event value is the index of the current frame.
2302 * `texture name`: The image to use.
2303 * `frame count`: The number of frames animating the image.
2304 * `frame duration`: Milliseconds between each frame. `0` means the frames don't advance.
2305 * `frame start` (Optional): The index of the frame to start on. Default `1`.
2307 ### `model[<X>,<Y>;<W>,<H>;<name>;<mesh>;<textures>;<rotation X,Y>;<continuous>;<mouse control>;<frame loop range>;<animation speed>]`
2309 * Show a mesh model.
2310 * `name`: Element name that can be used for styling
2311 * `mesh`: The mesh model to use.
2312 * `textures`: The mesh textures to use according to the mesh materials.
2313 Texture names must be separated by commas.
2314 * `rotation {X,Y}` (Optional): Initial rotation of the camera.
2315 The axes are euler angles in degrees.
2316 * `continuous` (Optional): Whether the rotation is continuous. Default `false`.
2317 * `mouse control` (Optional): Whether the model can be controlled with the mouse. Default `true`.
2318 * `frame loop range` (Optional): Range of the animation frames.
2319 * Defaults to the full range of all available frames.
2320 * Syntax: `<begin>,<end>`
2321 * `animation speed` (Optional): Sets the animation speed. Default 0 FPS.
2323 ### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
2325 * Show an inventory image of registered item/node
2327 ### `bgcolor[<bgcolor>;<fullscreen>;<fbgcolor>]`
2329 * Sets background color of formspec.
2330 * `bgcolor` and `fbgcolor` (optional) are `ColorString`s, they define the color
2331 of the non-fullscreen and the fullscreen background.
2332 * `fullscreen` (optional) can be one of the following:
2333 * `false`: Only the non-fullscreen background color is drawn. (default)
2334 * `true`: Only the fullscreen background color is drawn.
2335 * `both`: The non-fullscreen and the fullscreen background color are drawn.
2336 * `neither`: No background color is drawn.
2337 * Note: Leave a parameter empty to not modify the value.
2338 * Note: `fbgcolor`, leaving parameters empty and values for `fullscreen` that
2339 are not bools are only available since formspec version 3.
2341 ### `background[<X>,<Y>;<W>,<H>;<texture name>]`
2343 * Example for formspec 8x4 in 16x resolution: image shall be sized
2344 8 times 16px times 4 times 16px.
2346 ### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
2348 * Example for formspec 8x4 in 16x resolution:
2349 image shall be sized 8 times 16px times 4 times 16px
2350 * If `auto_clip` is `true`, the background is clipped to the formspec size
2351 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2353 ### `background9[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>;<middle>]`
2355 * 9-sliced background. See https://en.wikipedia.org/wiki/9-slice_scaling
2356 * Middle is a rect which defines the middle of the 9-slice.
2357 * `x` - The middle will be x pixels from all sides.
2358 * `x,y` - The middle will be x pixels from the horizontal and y from the vertical.
2359 * `x,y,x2,y2` - The middle will start at x,y, and end at x2, y2. Negative x2 and y2 values
2360 will be added to the width and height of the texture, allowing it to be used as the
2361 distance from the far end.
2362 * All numbers in middle are integers.
2363 * Example for formspec 8x4 in 16x resolution:
2364 image shall be sized 8 times 16px times 4 times 16px
2365 * If `auto_clip` is `true`, the background is clipped to the formspec size
2366 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2367 * Available since formspec version 2
2369 ### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
2371 * Textual password style field; will be sent to server when a button is clicked
2372 * When enter is pressed in field, fields.key_enter_field will be sent with the
2374 * With the old coordinate system, fields are a set height, but will be vertically
2375 centred on `H`. With the new coordinate system, `H` will modify the height.
2376 * `name` is the name of the field as returned in fields to `on_receive_fields`
2377 * `label`, if not blank, will be text printed on the top left above the field
2378 * See `field_close_on_enter` to stop enter closing the formspec
2380 ### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2382 * Textual field; will be sent to server when a button is clicked
2383 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2384 the name of this field.
2385 * With the old coordinate system, fields are a set height, but will be vertically
2386 centred on `H`. With the new coordinate system, `H` will modify the height.
2387 * `name` is the name of the field as returned in fields to `on_receive_fields`
2388 * `label`, if not blank, will be text printed on the top left above the field
2389 * `default` is the default value of the field
2390 * `default` may contain variable references such as `${text}` which
2391 will fill the value from the metadata value `text`
2392 * **Note**: no extra text or more than a single variable is supported ATM.
2393 * See `field_close_on_enter` to stop enter closing the formspec
2395 ### `field[<name>;<label>;<default>]`
2397 * As above, but without position/size units
2398 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2399 the name of this field.
2400 * Special field for creating simple forms, such as sign text input
2401 * Must be used without a `size[]` element
2402 * A "Proceed" button will be added automatically
2403 * See `field_close_on_enter` to stop enter closing the formspec
2405 ### `field_close_on_enter[<name>;<close_on_enter>]`
2407 * <name> is the name of the field
2408 * if <close_on_enter> is false, pressing enter in the field will submit the
2409 form but not close it.
2410 * defaults to true when not specified (ie: no tag for a field)
2412 ### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2414 * Same as fields above, but with multi-line input
2415 * If the text overflows, a vertical scrollbar is added.
2416 * If the name is empty, the textarea is read-only and
2417 the background is not shown, which corresponds to a multi-line label.
2419 ### `label[<X>,<Y>;<label>]`
2421 * The label formspec element displays the text set in `label`
2422 at the specified position.
2423 * **Note**: If the new coordinate system is enabled, labels are
2424 positioned from the center of the text, not the top.
2425 * The text is displayed directly without automatic line breaking,
2426 so label should not be used for big text chunks. Newlines can be
2427 used to make labels multiline.
2428 * **Note**: With the new coordinate system, newlines are spaced with
2429 half a coordinate. With the old system, newlines are spaced 2/5 of
2432 ### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]`
2433 * Displays a static formatted text with hyperlinks.
2434 * **Note**: This element is currently unstable and subject to change.
2435 * `x`, `y`, `w` and `h` work as per field
2436 * `name` is the name of the field as returned in fields to `on_receive_fields` in case of action in text.
2437 * `text` is the formatted text using `Markup Language` described below.
2439 ### `vertlabel[<X>,<Y>;<label>]`
2440 * Textual label drawn vertically
2441 * `label` is the text on the label
2442 * **Note**: If the new coordinate system is enabled, vertlabels are
2443 positioned from the center of the text, not the left.
2445 ### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
2447 * Clickable button. When clicked, fields will be sent.
2448 * With the old coordinate system, buttons are a set height, but will be vertically
2449 centred on `H`. With the new coordinate system, `H` will modify the height.
2450 * `label` is the text on the button
2452 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2454 * `texture name` is the filename of an image
2455 * **Note**: Height is supported on both the old and new coordinate systems
2458 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
2460 * `texture name` is the filename of an image
2461 * `noclip=true` means the image button doesn't need to be within specified
2463 * `drawborder`: draw button border or not
2464 * `pressed texture name` is the filename of an image on pressed state
2466 ### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
2468 * `item name` is the registered name of an item/node
2469 * The item description will be used as the tooltip. This can be overridden with
2472 ### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
2474 * When clicked, fields will be sent and the form will quit.
2475 * Same as `button` in all other respects.
2477 ### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2479 * When clicked, fields will be sent and the form will quit.
2480 * Same as `image_button` in all other respects.
2482 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
2484 * Scrollable item list showing arbitrary text elements
2485 * `name` fieldname sent to server on doubleclick value is current selected
2487 * `listelements` can be prepended by #color in hexadecimal format RRGGBB
2489 * if you want a listelement to start with "#" write "##".
2491 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
2493 * Scrollable itemlist showing arbitrary text elements
2494 * `name` fieldname sent to server on doubleclick value is current selected
2496 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
2497 * if you want a listelement to start with "#" write "##"
2498 * Index to be selected within textlist
2499 * `true`/`false`: draw transparent background
2500 * See also `minetest.explode_textlist_event`
2501 (main menu: `core.explode_textlist_event`).
2503 ### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2505 * Show a tab**header** at specific position (ignores formsize)
2506 * `X` and `Y`: position of the tabheader
2507 * *Note*: Width and height are automatically chosen with this syntax
2508 * `name` fieldname data is transferred to Lua
2509 * `caption 1`...: name shown on top of tab
2510 * `current_tab`: index of selected tab 1...
2511 * `transparent` (optional): if true, tabs are semi-transparent
2512 * `draw_border` (optional): if true, draw a thin line at tab base
2514 ### `tabheader[<X>,<Y>;<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2516 * Show a tab**header** at specific position (ignores formsize)
2517 * **Important note**: This syntax for tabheaders can only be used with the
2518 new coordinate system.
2519 * `X` and `Y`: position of the tabheader
2520 * `H`: height of the tabheader. Width is automatically determined with this syntax.
2521 * `name` fieldname data is transferred to Lua
2522 * `caption 1`...: name shown on top of tab
2523 * `current_tab`: index of selected tab 1...
2524 * `transparent` (optional): show transparent
2525 * `draw_border` (optional): draw border
2527 ### `tabheader[<X>,<Y>;<W>,<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2529 * Show a tab**header** at specific position (ignores formsize)
2530 * **Important note**: This syntax for tabheaders can only be used with the
2531 new coordinate system.
2532 * `X` and `Y`: position of the tabheader
2533 * `W` and `H`: width and height of the tabheader
2534 * `name` fieldname data is transferred to Lua
2535 * `caption 1`...: name shown on top of tab
2536 * `current_tab`: index of selected tab 1...
2537 * `transparent` (optional): show transparent
2538 * `draw_border` (optional): draw border
2540 ### `box[<X>,<Y>;<W>,<H>;<color>]`
2542 * Simple colored box
2543 * `color` is color specified as a `ColorString`.
2544 If the alpha component is left blank, the box will be semitransparent.
2545 If the color is not specified, the box will use the options specified by
2546 its style. If the color is specified, all styling options will be ignored.
2548 ### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
2550 * Show a dropdown field
2551 * **Important note**: There are two different operation modes:
2552 1. handle directly on change (only changed dropdown is submitted)
2553 2. read the value on pressing a button (all dropdown values are available)
2554 * `X` and `Y`: position of the dropdown
2555 * `W`: width of the dropdown. Height is automatically chosen with this syntax.
2556 * Fieldname data is transferred to Lua
2557 * Items to be shown in dropdown
2558 * Index of currently selected dropdown item
2559 * `index event` (optional, allowed parameter since formspec version 4): Specifies the
2560 event field value for selected items.
2561 * `true`: Selected item index
2562 * `false` (default): Selected item value
2564 ### `dropdown[<X>,<Y>;<W>,<H>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
2566 * Show a dropdown field
2567 * **Important note**: This syntax for dropdowns can only be used with the
2568 new coordinate system.
2569 * **Important note**: There are two different operation modes:
2570 1. handle directly on change (only changed dropdown is submitted)
2571 2. read the value on pressing a button (all dropdown values are available)
2572 * `X` and `Y`: position of the dropdown
2573 * `W` and `H`: width and height of the dropdown
2574 * Fieldname data is transferred to Lua
2575 * Items to be shown in dropdown
2576 * Index of currently selected dropdown item
2577 * `index event` (optional, allowed parameter since formspec version 4): Specifies the
2578 event field value for selected items.
2579 * `true`: Selected item index
2580 * `false` (default): Selected item value
2582 ### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
2585 * `name` fieldname data is transferred to Lua
2586 * `label` to be shown left of checkbox
2587 * `selected` (optional): `true`/`false`
2588 * **Note**: If the new coordinate system is enabled, checkboxes are
2589 positioned from the center of the checkbox, not the top.
2591 ### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
2593 * Show a scrollbar using options defined by the previous `scrollbaroptions[]`
2594 * There are two ways to use it:
2595 1. handle the changed event (only changed scrollbar is available)
2596 2. read the value on pressing a button (all scrollbars are available)
2597 * `orientation`: `vertical`/`horizontal`. Default horizontal.
2598 * Fieldname data is transferred to Lua
2599 * Value of this trackbar is set to (`0`-`1000`) by default
2600 * See also `minetest.explode_scrollbar_event`
2601 (main menu: `core.explode_scrollbar_event`).
2603 ### `scrollbaroptions[opt1;opt2;...]`
2604 * Sets options for all following `scrollbar[]` elements
2606 * Sets scrollbar minimum value, defaults to `0`.
2608 * Sets scrollbar maximum value, defaults to `1000`.
2609 If the max is equal to the min, the scrollbar will be disabled.
2611 * Sets scrollbar step value when the arrows are clicked or the mouse wheel is
2613 * If this is set to a negative number, the value will be reset to `10`.
2615 * Sets scrollbar step value used by page up and page down.
2616 * If this is set to a negative number, the value will be reset to `100`.
2618 * Sets size of the thumb on the scrollbar. Size is calculated in the number of
2619 units the thumb spans out of the range of the scrollbar values.
2620 * Example: If a scrollbar has a `min` of 1 and a `max` of 100, a thumbsize of 10
2621 would span a tenth of the scrollbar space.
2622 * If this is set to zero or less, the value will be reset to `1`.
2623 * `arrows=<show/hide/default>`
2624 * Whether to show the arrow buttons on the scrollbar. `default` hides the arrows
2625 when the scrollbar gets too small, but shows them otherwise.
2627 ### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
2629 * Show scrollable table using options defined by the previous `tableoptions[]`
2630 * Displays cells as defined by the previous `tablecolumns[]`
2631 * `name`: fieldname sent to server on row select or doubleclick
2632 * `cell 1`...`cell n`: cell contents given in row-major order
2633 * `selected idx`: index of row to be selected within table (first row = `1`)
2634 * See also `minetest.explode_table_event`
2635 (main menu: `core.explode_table_event`).
2637 ### `tableoptions[<opt 1>;<opt 2>;...]`
2639 * Sets options for `table[]`
2641 * default text color (`ColorString`), defaults to `#FFFFFF`
2642 * `background=#RRGGBB`
2643 * table background color (`ColorString`), defaults to `#000000`
2644 * `border=<true/false>`
2645 * should the table be drawn with a border? (default: `true`)
2646 * `highlight=#RRGGBB`
2647 * highlight background color (`ColorString`), defaults to `#466432`
2648 * `highlight_text=#RRGGBB`
2649 * highlight text color (`ColorString`), defaults to `#FFFFFF`
2650 * `opendepth=<value>`
2651 * all subtrees up to `depth < value` are open (default value = `0`)
2652 * only useful when there is a column of type "tree"
2654 ### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
2656 * Sets columns for `table[]`
2657 * Types: `text`, `image`, `color`, `indent`, `tree`
2658 * `text`: show cell contents as text
2659 * `image`: cell contents are an image index, use column options to define
2661 * `color`: cell contents are a ColorString and define color of following
2663 * `indent`: cell contents are a number and define indentation of following
2665 * `tree`: same as indent, but user can open and close subtrees
2669 * for `text` and `image`: content alignment within cells.
2670 Available values: `left` (default), `center`, `right`, `inline`
2672 * for `text` and `image`: minimum width in em (default: `0`)
2673 * for `indent` and `tree`: indent width in em (default: `1.5`)
2674 * `padding=<value>`: padding left of the column, in em (default `0.5`).
2675 Exception: defaults to 0 for indent columns
2676 * `tooltip=<value>`: tooltip text (default: empty)
2677 * `image` column options:
2678 * `0=<value>` sets image for image index 0
2679 * `1=<value>` sets image for image index 1
2680 * `2=<value>` sets image for image index 2
2681 * and so on; defined indices need not be contiguous empty or
2682 non-numeric cells are treated as `0`.
2683 * `color` column options:
2684 * `span=<value>`: number of following columns to affect
2685 (default: infinite).
2687 ### `style[<selector 1>,<selector 2>,...;<prop1>;<prop2>;...]`
2689 * Set the style for the element(s) matching `selector` by name.
2690 * `selector` can be one of:
2691 * `<name>` - An element name. Includes `*`, which represents every element.
2692 * `<name>:<state>` - An element name, a colon, and one or more states.
2693 * `state` is a list of states separated by the `+` character.
2694 * If a state is provided, the style will only take effect when the element is in that state.
2695 * All provided states must be active for the style to apply.
2696 * Note: this **must** be before the element is defined.
2697 * See [Styling Formspecs].
2700 ### `style_type[<selector 1>,<selector 2>,...;<prop1>;<prop2>;...]`
2702 * Set the style for the element(s) matching `selector` by type.
2703 * `selector` can be one of:
2704 * `<type>` - An element type. Includes `*`, which represents every element.
2705 * `<type>:<state>` - An element type, a colon, and one or more states.
2706 * `state` is a list of states separated by the `+` character.
2707 * If a state is provided, the style will only take effect when the element is in that state.
2708 * All provided states must be active for the style to apply.
2709 * See [Styling Formspecs].
2711 ### `set_focus[<name>;<force>]`
2713 * Sets the focus to the element with the same `name` parameter.
2714 * **Note**: This element must be placed before the element it focuses.
2715 * `force` (optional, default `false`): By default, focus is not applied for
2716 re-sent formspecs with the same name so that player-set focus is kept.
2717 `true` sets the focus to the specified element for every sent formspec.
2718 * The following elements have the ability to be focused:
2733 Migrating to Real Coordinates
2734 -----------------------------
2736 In the old system, positions included padding and spacing. Padding is a gap between
2737 the formspec window edges and content, and spacing is the gaps between items. For
2738 example, two `1x1` elements at `0,0` and `1,1` would have a spacing of `5/4` between them,
2739 and a padding of `3/8` from the formspec edge. It may be easiest to recreate old layouts
2740 in the new coordinate system from scratch.
2742 To recreate an old layout with padding, you'll need to pass the positions and sizes
2743 through the following formula to re-introduce padding:
2746 pos = (oldpos + 1)*spacing + padding
2752 You'll need to change the `size[]` tag like this:
2755 size = (oldsize-1)*spacing + padding*2 + 1
2758 A few elements had random offsets in the old system. Here is a table which shows these
2759 offsets when migrating:
2761 | Element | Position | Size | Notes
2762 |---------|------------|---------|-------
2763 | box | +0.3, +0.1 | 0, -0.4 |
2764 | button | | | Buttons now support height, so set h = 2 * 15/13 * 0.35, and reposition if h ~= 15/13 * 0.35 before
2765 | list | | | Spacing is now 0.25 for both directions, meaning lists will be taller in height
2766 | label | 0, +0.3 | | The first line of text is now positioned centered exactly at the position specified
2771 Formspec elements can be themed using the style elements:
2773 style[<name 1>,<name 2>,...;<prop1>;<prop2>;...]
2774 style[<name 1>:<state>,<name 2>:<state>,...;<prop1>;<prop2>;...]
2775 style_type[<type 1>,<type 2>,...;<prop1>;<prop2>;...]
2776 style_type[<type 1>:<state>,<type 2>:<state>,...;<prop1>;<prop2>;...]
2780 property_name=property_value
2784 style_type[button;bgcolor=#006699]
2785 style[world_delete;bgcolor=red;textcolor=yellow]
2786 button[4,3.95;2.6,1;world_delete;Delete]
2788 A name/type can optionally be a comma separated list of names/types, like so:
2790 world_delete,world_create,world_configure
2793 A `*` type can be used to select every element in the formspec.
2795 Any name/type in the list can also be accompanied by a `+`-separated list of states, like so:
2797 world_delete:hovered+pressed
2800 States allow you to apply styles in response to changes in the element, instead of applying at all times.
2802 Setting a property to nothing will reset it to the default value. For example:
2804 style_type[button;bgimg=button.png;bgimg_pressed=button_pressed.png;border=false]
2805 style[btn_exit;bgimg=;bgimg_pressed=;border=;bgcolor=red]
2808 ### Supported Element Types
2810 Some types may inherit styles from parent types.
2812 * animated_image, inherits from image
2815 * button_exit, inherits from button
2825 * pwdfield, inherits from field
2831 * vertlabel, inherits from label
2834 ### Valid Properties
2837 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2839 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2840 * Defaults to false in formspec_version version 3 or higher
2841 * **Note**: `colors`, `bordercolors`, and `borderwidths` accept multiple input types:
2842 * Single value (e.g. `#FF0`): All corners/borders.
2843 * Two values (e.g. `red,#FFAAFF`): top-left and bottom-right,top-right and bottom-left/
2844 top and bottom,left and right.
2845 * Four values (e.g. `blue,#A0F,green,#FFFA`): top-left/top and rotates clockwise.
2846 * These work similarly to CSS borders.
2847 * colors - `ColorString`. Sets the color(s) of the box corners. Default `black`.
2848 * bordercolors - `ColorString`. Sets the color(s) of the borders. Default `black`.
2849 * borderwidths - Integer. Sets the width(s) of the borders in pixels. If the width is
2850 negative, the border will extend inside the box, whereas positive extends outside
2851 the box. A width of zero results in no border; this is default.
2852 * button, button_exit, image_button, item_image_button
2853 * alpha - boolean, whether to draw alpha in bgimg. Default true.
2854 * bgcolor - color, sets button tint.
2855 * bgcolor_hovered - color when hovered. Defaults to a lighter bgcolor when not provided.
2856 * This is deprecated, use states instead.
2857 * bgcolor_pressed - color when pressed. Defaults to a darker bgcolor when not provided.
2858 * This is deprecated, use states instead.
2859 * bgimg - standard background image. Defaults to none.
2860 * bgimg_hovered - background image when hovered. Defaults to bgimg when not provided.
2861 * This is deprecated, use states instead.
2862 * bgimg_middle - Makes the bgimg textures render in 9-sliced mode and defines the middle rect.
2863 See background9[] documentation for more details. This property also pads the
2864 button's content when set.
2865 * bgimg_pressed - background image when pressed. Defaults to bgimg when not provided.
2866 * This is deprecated, use states instead.
2867 * font - Sets font type. This is a comma separated list of options. Valid options:
2868 * Main font type options. These cannot be combined with each other:
2869 * `normal`: Default font
2870 * `mono`: Monospaced font
2871 * Font modification options. If used without a main font type, `normal` is used:
2872 * `bold`: Makes font bold.
2873 * `italic`: Makes font italic.
2875 * font_size - Sets font size. Default is user-set. Can have multiple values:
2876 * `<number>`: Sets absolute font size to `number`.
2877 * `+<number>`/`-<number>`: Offsets default font size by `number` points.
2878 * `*<number>`: Multiplies default font size by `number`, similar to CSS `em`.
2879 * border - boolean, draw border. Set to false to hide the bevelled button pane. Default true.
2880 * content_offset - 2d vector, shifts the position of the button's content without resizing it.
2881 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2882 * padding - rect, adds space between the edges of the button and the content. This value is
2883 relative to bgimg_middle.
2884 * sound - a sound to be played when triggered.
2885 * textcolor - color, default white.
2887 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2888 * sound - a sound to be played when triggered.
2890 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2891 * sound - a sound to be played when the entry is changed.
2892 * field, pwdfield, textarea
2893 * border - set to false to hide the textbox background and border. Default true.
2894 * font - Sets font type. See button `font` property for more information.
2895 * font_size - Sets font size. See button `font_size` property for more information.
2896 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2897 * textcolor - color. Default white.
2899 * bgcolor - color, sets background color.
2900 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2901 * Default to false in formspec_version version 3 or higher
2903 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2904 * Default to false in formspec_version version 3 or higher
2906 * noclip - boolean, set to true to allow the element to exceed formspec bounds. Default to false.
2908 * font - Sets font type. See button `font` property for more information.
2909 * font_size - Sets font size. See button `font_size` property for more information.
2910 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2912 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2913 * size - 2d vector, sets the size of inventory slots in coordinates.
2914 * spacing - 2d vector, sets the space between inventory slots in coordinates.
2915 * image_button (additional properties)
2916 * fgimg - standard image. Defaults to none.
2917 * fgimg_hovered - image when hovered. Defaults to fgimg when not provided.
2918 * This is deprecated, use states instead.
2919 * fgimg_pressed - image when pressed. Defaults to fgimg when not provided.
2920 * This is deprecated, use states instead.
2921 * NOTE: The parameters of any given image_button will take precedence over fgimg/fgimg_pressed
2922 * sound - a sound to be played when triggered.
2924 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2926 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2927 * sound - a sound to be played when a different tab is selected.
2928 * textcolor - color. Default white.
2930 * font - Sets font type. See button `font` property for more information.
2931 * font_size - Sets font size. See button `font_size` property for more information.
2932 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2937 * default - Equivalent to providing no states
2938 * button, button_exit, image_button, item_image_button
2939 * hovered - Active when the mouse is hovering over the element
2940 * pressed - Active when the button is pressed
2945 Markup language used in `hypertext[]` elements uses tags that look like HTML tags.
2946 The markup language is currently unstable and subject to change. Use with caution.
2947 Some tags can enclose text, they open with `<tagname>` and close with `</tagname>`.
2948 Tags can have attributes, in that case, attributes are in the opening tag in
2949 form of a key/value separated with equal signs. Attribute values should not be quoted.
2951 These are the technically basic tags but see below for usual tags. Base tags are:
2953 `<style color=... font=... size=...>...</style>`
2955 Changes the style of the text.
2957 * `color`: Text color. Given color is a `colorspec`.
2958 * `size`: Text size.
2959 * `font`: Text font (`mono` or `normal`).
2961 `<global background=... margin=... valign=... color=... hovercolor=... size=... font=... halign=... >`
2966 * `background`: Text background, a `colorspec` or `none`.
2967 * `margin`: Page margins in pixel.
2968 * `valign`: Text vertical alignment (`top`, `middle`, `bottom`).
2970 Inheriting styles (affects child elements):
2971 * `color`: Default text color. Given color is a `colorspec`.
2972 * `hovercolor`: Color of <action> tags when mouse is over.
2973 * `size`: Default text size.
2974 * `font`: Default text font (`mono` or `normal`).
2975 * `halign`: Default text horizontal alignment (`left`, `right`, `center`, `justify`).
2977 This tag needs to be placed only once as it changes the global settings of the
2978 text. Anyway, if several tags are placed, each changed will be made in the order
2981 `<tag name=... color=... hovercolor=... font=... size=...>`
2983 Defines or redefines tag style. This can be used to define new tags.
2984 * `name`: Name of the tag to define or change.
2985 * `color`: Text color. Given color is a `colorspec`.
2986 * `hovercolor`: Text color when element hovered (only for `action` tags). Given color is a `colorspec`.
2987 * `size`: Text size.
2988 * `font`: Text font (`mono` or `normal`).
2990 Following tags are the usual tags for text layout. They are defined by default.
2991 Other tags can be added using `<tag ...>` tag.
2993 `<normal>...</normal>`: Normal size text
2995 `<big>...</big>`: Big text
2997 `<bigger>...</bigger>`: Bigger text
2999 `<center>...</center>`: Centered text
3001 `<left>...</left>`: Left-aligned text
3003 `<right>...</right>`: Right-aligned text
3005 `<justify>...</justify>`: Justified text
3007 `<mono>...</mono>`: Monospaced font
3009 `<b>...</b>`, `<i>...</i>`, `<u>...</u>`: Bold, italic, underline styles.
3011 `<action name=...>...</action>`
3013 Make that text a clickable text triggering an action.
3015 * `name`: Name of the action (mandatory).
3017 When clicked, the formspec is send to the server. The value of the text field
3018 sent to `on_player_receive_fields` will be "action:" concatenated to the action
3021 `<img name=... float=... width=... height=...>`
3023 Draws an image which is present in the client media cache.
3025 * `name`: Name of the texture (mandatory).
3026 * `float`: If present, makes the image floating (`left` or `right`).
3027 * `width`: Force image width instead of taking texture width.
3028 * `height`: Force image height instead of taking texture height.
3030 If only width or height given, texture aspect is kept.
3032 `<item name=... float=... width=... height=... rotate=...>`
3034 Draws an item image.
3036 * `name`: Item string of the item to draw (mandatory).
3037 * `float`: If present, makes the image floating (`left` or `right`).
3038 * `width`: Item image width.
3039 * `height`: Item image height.
3040 * `rotate`: Rotate item image if set to `yes` or `X,Y,Z`. X, Y and Z being
3041 rotation speeds in percent of standard speed (-1000 to 1000). Works only if
3042 `inventory_items_animations` is set to true.
3043 * `angle`: Angle in which the item image is shown. Value has `X,Y,Z` form.
3044 X, Y and Z being angles around each three axes. Works only if
3045 `inventory_items_animations` is set to true.
3053 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
3054 * `"current_player"`: Player to whom the menu is shown
3055 * `"player:<name>"`: Any player
3056 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
3057 * `"detached:<name>"`: A detached inventory
3059 Player Inventory lists
3060 ----------------------
3062 * `main`: list containing the default inventory
3063 * `craft`: list containing the craft input
3064 * `craftpreview`: list containing the craft prediction
3065 * `craftresult`: list containing the crafted output
3066 * `hand`: list containing an override for the empty hand
3067 * Is not created automatically, use `InvRef:set_size`
3068 * Is only used to enhance the empty hand's tool capabilities
3076 `#RGB` defines a color in hexadecimal format.
3078 `#RGBA` defines a color in hexadecimal format and alpha channel.
3080 `#RRGGBB` defines a color in hexadecimal format.
3082 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
3084 Named colors are also supported and are equivalent to
3085 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
3086 To specify the value of the alpha channel, append `#AA` to the end of the color
3087 name (e.g. `colorname#08`). For named colors the hexadecimal string
3088 representing the alpha value must (always) be two hexadecimal digits.
3093 A ColorSpec specifies a 32-bit color. It can be written in any of the following
3096 * table form: Each element ranging from 0..255 (a, if absent, defaults to 255):
3097 * `colorspec = {a=255, r=0, g=255, b=0}`
3098 * numerical form: The raw integer value of an ARGB8 quad:
3099 * `colorspec = 0xFF00FF00`
3100 * string form: A ColorString (defined above):
3101 * `colorspec = "green"`
3109 Most text can contain escape sequences, that can for example color the text.
3110 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
3111 The following functions provide escape sequences:
3113 * `minetest.get_color_escape_sequence(color)`:
3114 * `color` is a ColorString
3115 * The escape sequence sets the text color to `color`
3116 * `minetest.colorize(color, message)`:
3118 `minetest.get_color_escape_sequence(color) ..
3120 minetest.get_color_escape_sequence("#ffffff")`
3121 * `minetest.get_background_escape_sequence(color)`
3122 * `color` is a ColorString
3123 * The escape sequence sets the background of the whole text element to
3124 `color`. Only defined for item descriptions and tooltips.
3125 * `minetest.strip_foreground_colors(str)`
3126 * Removes foreground colors added by `get_color_escape_sequence`.
3127 * `minetest.strip_background_colors(str)`
3128 * Removes background colors added by `get_background_escape_sequence`.
3129 * `minetest.strip_colors(str)`
3130 * Removes all color escape sequences.
3137 A spatial vector is similar to a position, but instead using
3138 absolute world coordinates, it uses *relative* coordinates, relative to
3139 no particular point.
3141 Internally, it is implemented as a table with the 3 fields
3142 `x`, `y` and `z`. Example: `{x = 0, y = 1, z = 0}`.
3144 For the following functions, `v`, `v1`, `v2` are vectors,
3145 `p1`, `p2` are positions,
3146 `s` is a scalar (a number):
3148 * `vector.new(a[, b, c])`:
3150 * A copy of `a` if `a` is a vector.
3151 * `{x = a, y = b, z = c}`, if all of `a`, `b`, `c` are defined numbers.
3152 * `vector.direction(p1, p2)`:
3153 * Returns a vector of length 1 with direction `p1` to `p2`.
3154 * If `p1` and `p2` are identical, returns `{x = 0, y = 0, z = 0}`.
3155 * `vector.distance(p1, p2)`:
3156 * Returns zero or a positive number, the distance between `p1` and `p2`.
3157 * `vector.length(v)`:
3158 * Returns zero or a positive number, the length of vector `v`.
3159 * `vector.normalize(v)`:
3160 * Returns a vector of length 1 with direction of vector `v`.
3161 * If `v` has zero length, returns `{x = 0, y = 0, z = 0}`.
3162 * `vector.floor(v)`:
3163 * Returns a vector, each dimension rounded down.
3164 * `vector.round(v)`:
3165 * Returns a vector, each dimension rounded to nearest integer.
3166 * At a multiple of 0.5, rounds away from zero.
3167 * `vector.apply(v, func)`:
3168 * Returns a vector where the function `func` has been applied to each
3170 * `vector.equals(v1, v2)`:
3171 * Returns a boolean, `true` if the vectors are identical.
3172 * `vector.sort(v1, v2)`:
3173 * Returns in order minp, maxp vectors of the cuboid defined by `v1`, `v2`.
3174 * `vector.angle(v1, v2)`:
3175 * Returns the angle between `v1` and `v2` in radians.
3176 * `vector.dot(v1, v2)`:
3177 * Returns the dot product of `v1` and `v2`.
3178 * `vector.cross(v1, v2)`:
3179 * Returns the cross product of `v1` and `v2`.
3180 * `vector.offset(v, x, y, z)`:
3181 * Returns the sum of the vectors `v` and `{x = x, y = y, z = z}`.
3183 For the following functions `x` can be either a vector or a number:
3185 * `vector.add(v, x)`:
3187 * If `x` is a vector: Returns the sum of `v` and `x`.
3188 * If `x` is a number: Adds `x` to each component of `v`.
3189 * `vector.subtract(v, x)`:
3191 * If `x` is a vector: Returns the difference of `v` subtracted by `x`.
3192 * If `x` is a number: Subtracts `x` from each component of `v`.
3193 * `vector.multiply(v, s)`:
3194 * Returns a scaled vector.
3195 * Deprecated: If `s` is a vector: Returns the Schur product.
3196 * `vector.divide(v, s)`:
3197 * Returns a scaled vector.
3198 * Deprecated: If `s` is a vector: Returns the Schur quotient.
3200 For the following functions `a` is an angle in radians and `r` is a rotation
3201 vector ({x = <pitch>, y = <yaw>, z = <roll>}) where pitch, yaw and roll are
3204 * `vector.rotate(v, r)`:
3205 * Applies the rotation `r` to `v` and returns the result.
3206 * `vector.rotate({x = 0, y = 0, z = 1}, r)` and
3207 `vector.rotate({x = 0, y = 1, z = 0}, r)` return vectors pointing
3208 forward and up relative to an entity's rotation `r`.
3209 * `vector.rotate_around_axis(v1, v2, a)`:
3210 * Returns `v1` rotated around axis `v2` by `a` radians according to
3211 the right hand rule.
3212 * `vector.dir_to_rotation(direction[, up])`:
3213 * Returns a rotation vector for `direction` pointing forward using `up`
3215 * If `up` is omitted, the roll of the returned vector defaults to zero.
3216 * Otherwise `direction` and `up` need to be vectors in a 90 degree angle to each other.
3224 * `dump2(obj, name, dumped)`: returns a string which makes `obj`
3225 human-readable, handles reference loops.
3226 * `obj`: arbitrary variable
3227 * `name`: string, default: `"_"`
3228 * `dumped`: table, default: `{}`
3229 * `dump(obj, dumped)`: returns a string which makes `obj` human-readable
3230 * `obj`: arbitrary variable
3231 * `dumped`: table, default: `{}`
3232 * `math.hypot(x, y)`
3233 * Get the hypotenuse of a triangle with legs x and y.
3234 Useful for distance calculation.
3235 * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
3236 * Get the sign of a number.
3237 * tolerance: number, default: `0.0`
3238 * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
3240 * `math.factorial(x)`: returns the factorial of `x`
3241 * `math.round(x)`: Returns `x` rounded to the nearest integer.
3242 * At a multiple of 0.5, rounds away from zero.
3243 * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
3244 * `separator`: string, default: `","`
3245 * `include_empty`: boolean, default: `false`
3246 * `max_splits`: number, if it's negative, splits aren't limited,
3248 * `sep_is_pattern`: boolean, it specifies whether separator is a plain
3249 string or a pattern (regex), default: `false`
3250 * e.g. `"a,b":split","` returns `{"a","b"}`
3251 * `string:trim()`: returns the string without whitespace pre- and suffixes
3252 * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
3253 * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
3254 * Adds newlines to the string to keep it within the specified character
3256 * Note that the returned lines may be longer than the limit since it only
3257 splits at word borders.
3258 * `limit`: number, maximal amount of characters in one line
3259 * `as_table`: boolean, if set to true, a table of lines instead of a string
3260 is returned, default: `false`
3261 * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
3262 * `pos`: table {x=X, y=Y, z=Z}
3263 * Converts the position `pos` to a human-readable, printable string
3264 * `decimal_places`: number, if specified, the x, y and z values of
3265 the position are rounded to the given decimal place.
3266 * `minetest.string_to_pos(string)`: returns a position or `nil`
3267 * Same but in reverse.
3268 * If the string can't be parsed to a position, nothing is returned.
3269 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
3270 * Converts a string representing an area box into two positions
3271 * `minetest.formspec_escape(string)`: returns a string
3272 * escapes the characters "[", "]", "\", "," and ";", which can not be used
3274 * `minetest.is_yes(arg)`
3275 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
3276 * `minetest.is_nan(arg)`
3277 * returns true when the passed number represents NaN.
3278 * `minetest.get_us_time()`
3279 * returns time with microsecond precision. May not return wall time.
3280 * `table.copy(table)`: returns a table
3281 * returns a deep copy of `table`
3282 * `table.indexof(list, val)`: returns the smallest numerical index containing
3283 the value `val` in the table `list`. Non-numerical indices are ignored.
3284 If `val` could not be found, `-1` is returned. `list` must not have
3286 * `table.insert_all(table, other_table)`:
3287 * Appends all values in `other_table` to `table` - uses `#table + 1` to
3289 * `table.key_value_swap(t)`: returns a table with keys and values swapped
3290 * If multiple keys in `t` map to the same value, it is unspecified which
3291 value maps to that key.
3292 * `table.shuffle(table, [from], [to], [random_func])`:
3293 * Shuffles elements `from` to `to` in `table` in place
3294 * `from` defaults to `1`
3295 * `to` defaults to `#table`
3296 * `random_func` defaults to `math.random`. This function receives two
3297 integers as arguments and should return a random integer inclusively
3299 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
3301 * returns the exact position on the surface of a pointed node
3302 * `minetest.get_dig_params(groups, tool_capabilities)`: Simulates a tool
3304 Returns a table with the following fields:
3305 * `diggable`: `true` if node can be dug, `false` otherwise.
3306 * `time`: Time it would take to dig the node.
3307 * `wear`: How much wear would be added to the tool.
3308 `time` and `wear` are meaningless if node's not diggable
3310 * `groups`: Table of the node groups of the node that would be dug
3311 * `tool_capabilities`: Tool capabilities table of the tool
3312 * `minetest.get_hit_params(groups, tool_capabilities [, time_from_last_punch])`:
3313 Simulates an item that punches an object.
3314 Returns a table with the following fields:
3315 * `hp`: How much damage the punch would cause.
3316 * `wear`: How much wear would be added to the tool.
3318 * `groups`: Damage groups of the object
3319 * `tool_capabilities`: Tool capabilities table of the item
3320 * `time_from_last_punch`: time in seconds since last punch action
3328 Texts can be translated client-side with the help of `minetest.translate` and
3331 Translating a string
3332 --------------------
3334 Two functions are provided to translate strings: `minetest.translate` and
3335 `minetest.get_translator`.
3337 * `minetest.get_translator(textdomain)` is a simple wrapper around
3338 `minetest.translate`, and `minetest.get_translator(textdomain)(str, ...)` is
3339 equivalent to `minetest.translate(textdomain, str, ...)`.
3340 It is intended to be used in the following way, so that it avoids verbose
3341 repetitions of `minetest.translate`:
3343 local S = minetest.get_translator(textdomain)
3346 As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
3348 * `minetest.translate(textdomain, str, ...)` translates the string `str` with
3349 the given `textdomain` for disambiguation. The textdomain must match the
3350 textdomain specified in the translation file in order to get the string
3351 translated. This can be used so that a string is translated differently in
3353 It is advised to use the name of the mod as textdomain whenever possible, to
3354 avoid clashes with other mods.
3355 This function must be given a number of arguments equal to the number of
3356 arguments the translated string expects.
3357 Arguments are literal strings -- they will not be translated, so if you want
3358 them to be, they need to come as outputs of `minetest.translate` as well.
3360 For instance, suppose we want to translate "@1 Wool" with "@1" being replaced
3361 by the translation of "Red". We can do the following:
3363 local S = minetest.get_translator()
3364 S("@1 Wool", S("Red"))
3366 This will be displayed as "Red Wool" on old clients and on clients that do
3367 not have localization enabled. However, if we have for instance a translation
3368 file named `wool.fr.tr` containing the following:
3373 this will be displayed as "Laine Rouge" on clients with a French locale.
3375 Operations on translated strings
3376 --------------------------------
3378 The output of `minetest.translate` is a string, with escape sequences adding
3379 additional information to that string so that it can be translated on the
3380 different clients. In particular, you can't expect operations like string.length
3381 to work on them like you would expect them to, or string.gsub to work in the
3382 expected manner. However, string concatenation will still work as expected
3383 (note that you should only use this for things like formspecs; do not translate
3384 sentences by breaking them into parts; arguments should be used instead), and
3385 operations such as `minetest.colorize` which are also concatenation.
3387 Translation file format
3388 -----------------------
3390 A translation file has the suffix `.[lang].tr`, where `[lang]` is the language
3391 it corresponds to. It must be put into the `locale` subdirectory of the mod.
3392 The file should be a text file, with the following format:
3394 * Lines beginning with `# textdomain:` (the space is significant) can be used
3395 to specify the text domain of all following translations in the file.
3396 * All other empty lines or lines beginning with `#` are ignored.
3397 * Other lines should be in the format `original=translated`. Both `original`
3398 and `translated` can contain escape sequences beginning with `@` to insert
3399 arguments, literal `@`, `=` or newline (See [Escapes] below).
3400 There must be no extraneous whitespace around the `=` or at the beginning or
3401 the end of the line.
3406 Strings that need to be translated can contain several escapes, preceded by `@`.
3408 * `@@` acts as a literal `@`.
3409 * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated
3410 string that will be inlined when translated. Due to how translations are
3411 implemented, the original translation string **must** have its arguments in
3412 increasing order, without gaps or repetitions, starting from 1.
3413 * `@=` acts as a literal `=`. It is not required in strings given to
3414 `minetest.translate`, but is in translation files to avoid being confused
3415 with the `=` separating the original from the translation.
3416 * `@\n` (where the `\n` is a literal newline) acts as a literal newline.
3417 As with `@=`, this escape is not required in strings given to
3418 `minetest.translate`, but is in translation files.
3419 * `@n` acts as a literal newline as well.
3421 Server side translations
3422 ------------------------
3424 On some specific cases, server translation could be useful. For example, filter
3425 a list on labels and send results to client. A method is supplied to achieve
3428 `minetest.get_translated_string(lang_code, string)`: Translates `string` using
3429 translations for `lang_code` language. It gives the same result as if the string
3430 was translated by the client.
3432 The `lang_code` to use for a given player can be retrieved from
3433 the table returned by `minetest.get_player_information(name)`.
3435 IMPORTANT: This functionality should only be used for sorting, filtering or similar purposes.
3436 You do not need to use this to get translated strings to show up on the client.
3441 Perlin noise creates a continuously-varying value depending on the input values.
3442 Usually in Minetest the input values are either 2D or 3D co-ordinates in nodes.
3443 The result is used during map generation to create the terrain shape, vary heat
3444 and humidity to distribute biomes, vary the density of decorations or vary the
3447 Structure of perlin noise
3448 -------------------------
3450 An 'octave' is a simple noise generator that outputs a value between -1 and 1.
3451 The smooth wavy noise it generates has a single characteristic scale, almost
3452 like a 'wavelength', so on its own does not create fine detail.
3453 Due to this perlin noise combines several octaves to create variation on
3454 multiple scales. Each additional octave has a smaller 'wavelength' than the
3457 This combination results in noise varying very roughly between -2.0 and 2.0 and
3458 with an average value of 0.0, so `scale` and `offset` are then used to multiply
3459 and offset the noise variation.
3461 The final perlin noise variation is created as follows:
3463 noise = offset + scale * (octave1 +
3464 octave2 * persistence +
3465 octave3 * persistence ^ 2 +
3466 octave4 * persistence ^ 3 +
3472 Noise Parameters are commonly called `NoiseParams`.
3476 After the multiplication by `scale` this is added to the result and is the final
3477 step in creating the noise value.
3478 Can be positive or negative.
3482 Once all octaves have been combined, the result is multiplied by this.
3483 Can be positive or negative.
3487 For octave1, this is roughly the change of input value needed for a very large
3488 variation in the noise value generated by octave1. It is almost like a
3489 'wavelength' for the wavy noise variation.
3490 Each additional octave has a 'wavelength' that is smaller than the previous
3491 octave, to create finer detail. `spread` will therefore roughly be the typical
3492 size of the largest structures in the final noise variation.
3494 `spread` is a vector with values for x, y, z to allow the noise variation to be
3495 stretched or compressed in the desired axes.
3496 Values are positive numbers.
3500 This is a whole number that determines the entire pattern of the noise
3501 variation. Altering it enables different noise patterns to be created.
3502 With other parameters equal, different seeds produce different noise patterns
3503 and identical seeds produce identical noise patterns.
3505 For this parameter you can randomly choose any whole number. Usually it is
3506 preferable for this to be different from other seeds, but sometimes it is useful
3507 to be able to create identical noise patterns.
3509 In some noise APIs the world seed is added to the seed specified in noise
3510 parameters. This is done to make the resulting noise pattern vary in different
3511 worlds, and be 'world-specific'.
3515 The number of simple noise generators that are combined.
3516 A whole number, 1 or more.
3517 Each additional octave adds finer detail to the noise but also increases the
3518 noise calculation load.
3519 3 is a typical minimum for a high quality, complex and natural-looking noise
3520 variation. 1 octave has a slight 'gridlike' appearence.
3522 Choose the number of octaves according to the `spread` and `lacunarity`, and the
3523 size of the finest detail you require. For example:
3524 if `spread` is 512 nodes, `lacunarity` is 2.0 and finest detail required is 16
3525 nodes, octaves will be 6 because the 'wavelengths' of the octaves will be
3526 512, 256, 128, 64, 32, 16 nodes.
3527 Warning: If the 'wavelength' of any octave falls below 1 an error will occur.
3531 Each additional octave has an amplitude that is the amplitude of the previous
3532 octave multiplied by `persistence`, to reduce the amplitude of finer details,
3533 as is often helpful and natural to do so.
3534 Since this controls the balance of fine detail to large-scale detail
3535 `persistence` can be thought of as the 'roughness' of the noise.
3537 A positive or negative non-zero number, often between 0.3 and 1.0.
3538 A common medium value is 0.5, such that each octave has half the amplitude of
3539 the previous octave.
3540 This may need to be tuned when altering `lacunarity`; when doing so consider
3541 that a common medium value is 1 / lacunarity.
3545 Each additional octave has a 'wavelength' that is the 'wavelength' of the
3546 previous octave multiplied by 1 / lacunarity, to create finer detail.
3547 'lacunarity' is often 2.0 so 'wavelength' often halves per octave.
3549 A positive number no smaller than 1.0.
3550 Values below 2.0 create higher quality noise at the expense of requiring more
3551 octaves to cover a paticular range of 'wavelengths'.
3555 Leave this field unset for no special handling.
3556 Currently supported are `defaults`, `eased` and `absvalue`:
3560 Specify this if you would like to keep auto-selection of eased/not-eased while
3561 specifying some other flags.
3565 Maps noise gradient values onto a quintic S-curve before performing
3566 interpolation. This results in smooth, rolling noise.
3567 Disable this (`noeased`) for sharp-looking noise with a slightly gridded
3569 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is
3571 Easing a 3D noise significantly increases the noise calculation load, so use
3576 The absolute value of each octave's noise variation is used when combining the
3577 octaves. The final perlin noise variation is created as follows:
3579 noise = offset + scale * (abs(octave1) +
3580 abs(octave2) * persistence +
3581 abs(octave3) * persistence ^ 2 +
3582 abs(octave4) * persistence ^ 3 +
3587 For 2D or 3D perlin noise or perlin noise maps:
3592 spread = {x = 500, y = 500, z = 500},
3597 flags = "defaults, absvalue",
3600 For 2D noise the Z component of `spread` is still defined but is ignored.
3601 A single noise parameter table can be used for 2D or 3D noise.
3612 These tell in what manner the ore is generated.
3614 All default ores are of the uniformly-distributed scatter type.
3618 Randomly chooses a location and generates a cluster of ore.
3620 If `noise_params` is specified, the ore will be placed if the 3D perlin noise
3621 at that point is greater than the `noise_threshold`, giving the ability to
3622 create a non-equal distribution of ore.
3626 Creates a sheet of ore in a blob shape according to the 2D perlin noise
3627 described by `noise_params` and `noise_threshold`. This is essentially an
3628 improved version of the so-called "stratus" ore seen in some unofficial mods.
3630 This sheet consists of vertical columns of uniform randomly distributed height,
3631 varying between the inclusive range `column_height_min` and `column_height_max`.
3632 If `column_height_min` is not specified, this parameter defaults to 1.
3633 If `column_height_max` is not specified, this parameter defaults to `clust_size`
3634 for reverse compatibility. New code should prefer `column_height_max`.
3636 The `column_midpoint_factor` parameter controls the position of the column at
3637 which ore emanates from.
3638 If 1, columns grow upward. If 0, columns grow downward. If 0.5, columns grow
3639 equally starting from each direction.
3640 `column_midpoint_factor` is a decimal number ranging in value from 0 to 1. If
3641 this parameter is not specified, the default is 0.5.
3643 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this
3648 Creates a sheet of ore in a cloud-like puff shape.
3650 As with the `sheet` ore type, the size and shape of puffs are described by
3651 `noise_params` and `noise_threshold` and are placed at random vertical
3652 positions within the currently generated chunk.
3654 The vertical top and bottom displacement of each puff are determined by the
3655 noise parameters `np_puff_top` and `np_puff_bottom`, respectively.
3659 Creates a deformed sphere of ore according to 3d perlin noise described by
3660 `noise_params`. The maximum size of the blob is `clust_size`, and
3661 `clust_scarcity` has the same meaning as with the `scatter` type.
3665 Creates veins of ore varying in density by according to the intersection of two
3666 instances of 3d perlin noise with different seeds, both described by
3669 `random_factor` varies the influence random chance has on placement of an ore
3670 inside the vein, which is `1` by default. Note that modifying this parameter
3671 may require adjusting `noise_threshold`.
3673 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
3676 This ore type is difficult to control since it is sensitive to small changes.
3677 The following is a decent set of parameters to work from:
3682 spread = {x=200, y=200, z=200},
3689 noise_threshold = 1.6
3691 **WARNING**: Use this ore type *very* sparingly since it is ~200x more
3692 computationally expensive than any other ore.
3696 Creates a single undulating ore stratum that is continuous across mapchunk
3697 borders and horizontally spans the world.
3699 The 2D perlin noise described by `noise_params` defines the Y co-ordinate of
3700 the stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
3701 defines the stratum's vertical thickness (in units of nodes). Due to being
3702 continuous across mapchunk borders the stratum's vertical thickness is
3705 If the noise parameter `noise_params` is omitted the ore will occur from y_min
3706 to y_max in a simple horizontal stratum.
3708 A parameter `stratum_thickness` can be provided instead of the noise parameter
3709 `np_stratum_thickness`, to create a constant thickness.
3711 Leaving out one or both noise parameters makes the ore generation less
3712 intensive, useful when adding multiple strata.
3714 `y_min` and `y_max` define the limits of the ore generation and for performance
3715 reasons should be set as close together as possible but without clipping the
3716 stratum's Y variation.
3718 Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
3719 solid-ore stratum would require a `clust_scarcity` of 1.
3721 The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
3722 `random_factor` are ignored by this ore type.
3727 See section [Flag Specifier Format].
3729 Currently supported flags:
3730 `puff_cliffs`, `puff_additive_composition`.
3734 If set, puff ore generation will not taper down large differences in
3735 displacement when approaching the edge of a puff. This flag has no effect for
3736 ore types other than `puff`.
3738 ### `puff_additive_composition`
3740 By default, when noise described by `np_puff_top` or `np_puff_bottom` results
3741 in a negative displacement, the sub-column at that point is not generated. With
3742 this attribute set, puff ore generation will instead generate the absolute
3743 difference in noise displacement values. This flag has no effect for ore types
3752 The varying types of decorations that can be placed.
3757 Creates a 1 times `H` times 1 column of a specified node (or a random node from
3758 a list, if a decoration list is specified). Can specify a certain node it must
3759 spawn next to, such as water or lava, for example. Can also generate a
3760 decoration of random height between a specified lower and upper bound.
3761 This type of decoration is intended for placement of grass, flowers, cacti,
3762 papyri, waterlilies and so on.
3767 Copies a box of `MapNodes` from a specified schematic file (or raw description).
3768 Can specify a probability of a node randomly appearing when placed.
3769 This decoration type is intended to be used for multi-node sized discrete
3770 structures, such as trees, cave spikes, rocks, and so on.
3779 --------------------
3781 A schematic specifier identifies a schematic by either a filename to a
3782 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
3783 in the form of a table. This table specifies the following fields:
3785 * The `size` field is a 3D vector containing the dimensions of the provided
3786 schematic. (required field)
3787 * The `yslice_prob` field is a table of {ypos, prob} slice tables. A slice table
3788 sets the probability of a particular horizontal slice of the schematic being
3789 placed. (optional field)
3790 `ypos` = 0 for the lowest horizontal slice of a schematic.
3791 The default of `prob` is 255.
3792 * The `data` field is a flat table of MapNode tables making up the schematic,
3793 in the order of `[z [y [x]]]`. (required field)
3794 Each MapNode table contains:
3795 * `name`: the name of the map node to place (required)
3796 * `prob` (alias `param1`): the probability of this node being placed
3798 * `param2`: the raw param2 value of the node being placed onto the map
3800 * `force_place`: boolean representing if the node should forcibly overwrite
3801 any previous contents (default: false)
3803 About probability values:
3805 * A probability value of `0` or `1` means that node will never appear
3807 * A probability value of `254` or `255` means the node will always appear
3809 * If the probability value `p` is greater than `1`, then there is a
3810 `(p / 256 * 100)` percent chance that node will appear when the schematic is
3813 Schematic attributes
3814 --------------------
3816 See section [Flag Specifier Format].
3818 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
3821 * `place_center_x`: Placement of this decoration is centered along the X axis.
3822 * `place_center_y`: Placement of this decoration is centered along the Y axis.
3823 * `place_center_z`: Placement of this decoration is centered along the Z axis.
3824 * `force_placement`: Schematic nodes other than "ignore" will replace existing
3830 Lua Voxel Manipulator
3831 =====================
3836 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator'
3837 facility. The purpose of this object is for fast, low-level, bulk access to
3838 reading and writing Map content. As such, setting map nodes through VoxelManip
3839 will lack many of the higher level features and concepts you may be used to
3840 with other methods of setting nodes. For example, nodes will not have their
3841 construction and destruction callbacks run, and no rollback information is
3844 It is important to note that VoxelManip is designed for speed, and *not* ease
3845 of use or flexibility. If your mod requires a map manipulation facility that
3846 will handle 100% of all edge cases, or the use of high level node placement
3847 features, perhaps `minetest.set_node()` is better suited for the job.
3849 In addition, VoxelManip might not be faster, or could even be slower, for your
3850 specific use case. VoxelManip is most effective when setting large areas of map
3851 at once - for example, if only setting a 3x3x3 node area, a
3852 `minetest.set_node()` loop may be more optimal. Always profile code using both
3853 methods of map manipulation to determine which is most appropriate for your
3856 A recent simple test of setting cubic areas showed that `minetest.set_node()`
3857 is faster than a VoxelManip for a 3x3x3 node cube or smaller.
3862 A VoxelManip object can be created any time using either:
3863 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
3865 If the optional position parameters are present for either of these routines,
3866 the specified region will be pre-loaded into the VoxelManip object on creation.
3867 Otherwise, the area of map you wish to manipulate must first be loaded into the
3868 VoxelManip object using `VoxelManip:read_from_map()`.
3870 Note that `VoxelManip:read_from_map()` returns two position vectors. The region
3871 formed by these positions indicate the minimum and maximum (respectively)
3872 positions of the area actually loaded in the VoxelManip, which may be larger
3873 than the area requested. For convenience, the loaded area coordinates can also
3874 be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
3876 Now that the VoxelManip object is populated with map data, your mod can fetch a
3877 copy of this data using either of two methods. `VoxelManip:get_node_at()`,
3878 which retrieves an individual node in a MapNode formatted table at the position
3879 requested is the simplest method to use, but also the slowest.
3881 Nodes in a VoxelManip object may also be read in bulk to a flat array table
3884 * `VoxelManip:get_data()` for node content (in Content ID form, see section
3886 * `VoxelManip:get_light_data()` for node light levels, and
3887 * `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
3889 See section [Flat array format] for more details.
3891 It is very important to understand that the tables returned by any of the above
3892 three functions represent a snapshot of the VoxelManip's internal state at the
3893 time of the call. This copy of the data will not magically update itself if
3894 another function modifies the internal VoxelManip state.
3895 Any functions that modify a VoxelManip's contents work on the VoxelManip's
3896 internal state unless otherwise explicitly stated.
3898 Once the bulk data has been edited to your liking, the internal VoxelManip
3899 state can be set using:
3901 * `VoxelManip:set_data()` for node content (in Content ID form, see section
3903 * `VoxelManip:set_light_data()` for node light levels, and
3904 * `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
3906 The parameter to each of the above three functions can use any table at all in
3907 the same flat array format as produced by `get_data()` etc. and is not required
3908 to be a table retrieved from `get_data()`.
3910 Once the internal VoxelManip state has been modified to your liking, the
3911 changes can be committed back to the map by calling `VoxelManip:write_to_map()`
3913 ### Flat array format
3916 `Nx = p2.X - p1.X + 1`,
3917 `Ny = p2.Y - p1.Y + 1`, and
3918 `Nz = p2.Z - p1.Z + 1`.
3920 Then, for a loaded region of p1..p2, this array ranges from `1` up to and
3921 including the value of the expression `Nx * Ny * Nz`.
3923 Positions offset from p1 are present in the array with the format of:
3926 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
3927 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
3929 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
3930 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
3932 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
3934 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
3937 and the array index for a position p contained completely in p1..p2 is:
3939 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
3941 Note that this is the same "flat 3D array" format as
3942 `PerlinNoiseMap:get3dMap_flat()`.
3943 VoxelArea objects (see section [`VoxelArea`]) can be used to simplify calculation
3944 of the index for a single point in a flat VoxelManip array.
3948 A Content ID is a unique integer identifier for a specific node type.
3949 These IDs are used by VoxelManip in place of the node name string for
3950 `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
3951 `minetest.get_content_id()` to look up the Content ID for the specified node
3952 name, and `minetest.get_name_from_content_id()` to look up the node name string
3953 for a given Content ID.
3954 After registration of a node, its Content ID will remain the same throughout
3955 execution of the mod.
3956 Note that the node being queried needs to have already been been registered.
3958 The following builtin node types have their Content IDs defined as constants:
3960 * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
3961 * `minetest.CONTENT_AIR`: ID for "air" nodes
3962 * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
3964 ### Mapgen VoxelManip objects
3966 Inside of `on_generated()` callbacks, it is possible to retrieve the same
3967 VoxelManip object used by the core's Map Generator (commonly abbreviated
3968 Mapgen). Most of the rules previously described still apply but with a few
3971 * The Mapgen VoxelManip object is retrieved using:
3972 `minetest.get_mapgen_object("voxelmanip")`
3973 * This VoxelManip object already has the region of map just generated loaded
3974 into it; it's not necessary to call `VoxelManip:read_from_map()` before using
3975 a Mapgen VoxelManip.
3976 * The `on_generated()` callbacks of some mods may place individual nodes in the
3977 generated area using non-VoxelManip map modification methods. Because the
3978 same Mapgen VoxelManip object is passed through each `on_generated()`
3979 callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3980 consistency with the current map state. For this reason, calling any of the
3981 following functions:
3982 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3983 will also update the Mapgen VoxelManip object's internal state active on the
3985 * After modifying the Mapgen VoxelManip object's internal buffer, it may be
3986 necessary to update lighting information using either:
3987 `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3989 ### Other API functions operating on a VoxelManip
3991 If any VoxelManip contents were set to a liquid node,
3992 `VoxelManip:update_liquids()` must be called for these liquid nodes to begin
3993 flowing. It is recommended to call this function only after having written all
3994 buffered data back to the VoxelManip object, save for special situations where
3995 the modder desires to only have certain liquid nodes begin flowing.
3997 The functions `minetest.generate_ores()` and `minetest.generate_decorations()`
3998 will generate all registered decorations and ores throughout the full area
3999 inside of the specified VoxelManip object.
4001 `minetest.place_schematic_on_vmanip()` is otherwise identical to
4002 `minetest.place_schematic()`, except instead of placing the specified schematic
4003 directly on the map at the specified position, it will place the schematic
4004 inside the VoxelManip.
4008 * Attempting to read data from a VoxelManip object before map is read will
4009 result in a zero-length array table for `VoxelManip:get_data()`, and an
4010 "ignore" node at any position for `VoxelManip:get_node_at()`.
4011 * If either a region of map has not yet been generated or is out-of-bounds of
4012 the map, that region is filled with "ignore" nodes.
4013 * Other mods, or the core itself, could possibly modify the area of map
4014 currently loaded into a VoxelManip object. With the exception of Mapgen
4015 VoxelManips (see above section), the internal buffers are not updated. For
4016 this reason, it is strongly encouraged to complete the usage of a particular
4017 VoxelManip object in the same callback it had been created.
4018 * If a VoxelManip object will be used often, such as in an `on_generated()`
4019 callback, consider passing a file-scoped table as the optional parameter to
4020 `VoxelManip:get_data()`, which serves as a static buffer the function can use
4021 to write map data to instead of returning a new table each call. This greatly
4022 enhances performance by avoiding unnecessary memory allocations.
4027 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object
4028 containing the region formed by `p1` and `p2`.
4029 * returns actual emerged `pmin`, actual emerged `pmax`
4030 * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to
4032 * **important**: data must be set using `VoxelManip:set_data()` before
4034 * if `light` is true, then lighting is automatically recalculated.
4035 The default value is true.
4036 If `light` is false, no light calculations happen, and you should correct
4037 all modified blocks with `minetest.fix_light()` as soon as possible.
4038 Keep in mind that modifying the map where light is incorrect can cause
4040 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
4041 the `VoxelManip` at that position
4042 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
4044 * `get_data([buffer])`: Retrieves the node content data loaded into the
4045 `VoxelManip` object.
4046 * returns raw node data in the form of an array of node content IDs
4047 * if the param `buffer` is present, this table will be used to store the
4049 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
4050 * `update_map()`: Does nothing, kept for compatibility.
4051 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to
4053 * `light` is a table, `{day=<0...15>, night=<0...15>}`
4054 * To be used only by a `VoxelManip` object from
4055 `minetest.get_mapgen_object`.
4056 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4058 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
4059 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4061 * Each value is the bitwise combination of day and night light values
4063 * `light = day + (night * 16)`
4064 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
4065 in the `VoxelManip`.
4066 * expects lighting data in the same format that `get_light_data()` returns
4067 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the
4068 `VoxelManip` object.
4069 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4071 * If the param `buffer` is present, this table will be used to store the
4073 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in
4075 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the
4077 * To be used only by a `VoxelManip` object from
4078 `minetest.get_mapgen_object`.
4079 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4080 area if left out or nil. For almost all uses these should be left out
4081 or nil to use the default.
4082 * `propagate_shadow` is an optional boolean deciding whether shadows in a
4083 generated mapchunk above are propagated down into the mapchunk, defaults
4084 to `true` if left out.
4085 * `update_liquids()`: Update liquid flow
4086 * `was_modified()`: Returns `true` or `false` if the data in the voxel
4087 manipulator had been modified since the last read from map, due to a call to
4088 `minetest.set_data()` on the loaded area elsewhere.
4089 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
4094 A helper class for voxel areas.
4095 It can be created via `VoxelArea:new{MinEdge = pmin, MaxEdge = pmax}`.
4096 The coordinates are *inclusive*, like most other things in Minetest.
4100 * `getExtent()`: returns a 3D vector containing the size of the area formed by
4101 `MinEdge` and `MaxEdge`.
4102 * `getVolume()`: returns the volume of the area formed by `MinEdge` and
4104 * `index(x, y, z)`: returns the index of an absolute position in a flat array
4106 * `x`, `y` and `z` must be integers to avoid an incorrect index result.
4107 * The position (x, y, z) is not checked for being inside the area volume,
4108 being outside can cause an incorrect index result.
4109 * Useful for things like `VoxelManip`, raw Schematic specifiers,
4110 `PerlinNoiseMap:get2d`/`3dMap`, and so on.
4111 * `indexp(p)`: same functionality as `index(x, y, z)` but takes a vector.
4112 * As with `index(x, y, z)`, the components of `p` must be integers, and `p`
4113 is not checked for being inside the area volume.
4114 * `position(i)`: returns the absolute position vector corresponding to index
4116 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by
4117 `MinEdge` and `MaxEdge`.
4118 * `containsp(p)`: same as above, except takes a vector
4119 * `containsi(i)`: same as above, except takes an index `i`
4120 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns
4122 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of
4124 * `iterp(minp, maxp)`: same as above, except takes a vector
4126 ### Y stride and z stride of a flat array
4128 For a particular position in a voxel area, whose flat array index is known,
4129 it is often useful to know the index of a neighboring or nearby position.
4130 The table below shows the changes of index required for 1 node movements along
4131 the axes in a voxel area:
4133 Movement Change of index
4143 local area = VoxelArea:new{MinEdge = emin, MaxEdge = emax}
4145 The values of `ystride` and `zstride` can be obtained using `area.ystride` and
4154 A mapgen object is a construct used in map generation. Mapgen objects can be
4155 used by an `on_generate` callback to speed up operations by avoiding
4156 unnecessary recalculations, these can be retrieved using the
4157 `minetest.get_mapgen_object()` function. If the requested Mapgen object is
4158 unavailable, or `get_mapgen_object()` was called outside of an `on_generate()`
4159 callback, `nil` is returned.
4161 The following Mapgen objects are currently available:
4165 This returns three values; the `VoxelManip` object to be used, minimum and
4166 maximum emerged position, in that order. All mapgens support this object.
4170 Returns an array containing the y coordinates of the ground levels of nodes in
4171 the most recently generated chunk by the current mapgen.
4175 Returns an array containing the biome IDs of nodes in the most recently
4176 generated chunk by the current mapgen.
4180 Returns an array containing the temperature values of nodes in the most
4181 recently generated chunk by the current mapgen.
4185 Returns an array containing the humidity values of nodes in the most recently
4186 generated chunk by the current mapgen.
4190 Returns a table mapping requested generation notification types to arrays of
4191 positions at which the corresponding generated structures are located within
4192 the current chunk. To set the capture of positions of interest to be recorded
4193 on generate, use `minetest.set_gen_notify()`.
4194 For decorations, the returned positions are the ground surface 'place_on'
4195 nodes, not the decorations themselves. A 'simple' type decoration is often 1
4196 node above the returned position and possibly displaced by 'place_offset_y'.
4198 Possible fields of the table returned are:
4204 * `large_cave_begin`
4208 Decorations have a key in the format of `"decoration#id"`, where `id` is the
4209 numeric unique decoration ID as returned by `minetest.get_decoration_id`.
4217 Functions receive a "luaentity" as `self`:
4219 * It has the member `.name`, which is the registered name `("mod:thing")`
4220 * It has the member `.object`, which is an `ObjectRef` pointing to the object
4221 * The original prototype stuff is visible directly via a metatable
4225 * `on_activate(self, staticdata, dtime_s)`
4226 * Called when the object is instantiated.
4227 * `dtime_s` is the time passed since the object was unloaded, which can be
4228 used for updating the entity state.
4229 * `on_deactivate(self)
4230 * Called when the object is about to get removed or unloaded.
4231 * `on_step(self, dtime)`
4232 * Called on every server tick, after movement and collision processing.
4233 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
4235 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)`
4236 * Called when somebody punches the object.
4237 * Note that you probably want to handle most punches using the automatic
4239 * `puncher`: an `ObjectRef` (can be `nil`)
4240 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4242 * `tool_capabilities`: capability table of used tool (can be `nil`)
4243 * `dir`: unit vector of direction of punch. Always defined. Points from the
4244 puncher to the punched.
4245 * `damage`: damage that will be done to entity.
4246 * Can return `true` to prevent the default damage mechanism.
4247 * `on_death(self, killer)`
4248 * Called when the object dies.
4249 * `killer`: an `ObjectRef` (can be `nil`)
4250 * `on_rightclick(self, clicker)`
4251 * `on_attach_child(self, child)`
4252 * `child`: an `ObjectRef` of the child that attaches
4253 * `on_detach_child(self, child)`
4254 * `child`: an `ObjectRef` of the child that detaches
4255 * `on_detach(self, parent)`
4256 * `parent`: an `ObjectRef` (can be `nil`) from where it got detached
4257 * This happens before the parent object is removed from the world
4258 * `get_staticdata(self)`
4259 * Should return a string that will be passed to `on_activate` when the
4260 object is instantiated the next time.
4272 axiom, --string initial tree axiom
4273 rules_a, --string rules set A
4274 rules_b, --string rules set B
4275 rules_c, --string rules set C
4276 rules_d, --string rules set D
4277 trunk, --string trunk node name
4278 leaves, --string leaves node name
4279 leaves2, --string secondary leaves node name
4280 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
4281 angle, --num angle in deg
4282 iterations, --num max # of iterations, usually 2 -5
4283 random_level, --num factor to lower nr of iterations, usually 0 - 3
4284 trunk_type, --string single/double/crossed) type of trunk: 1 node,
4285 -- 2x2 nodes or 3x3 in cross shape
4286 thin_branches, --boolean true -> use thin (1 node) branches
4287 fruit, --string fruit node name
4288 fruit_chance, --num chance (0-100) to replace leaves with fruit node
4289 seed, --num random seed, if no seed is provided, the engine
4293 Key for special L-System symbols used in axioms
4294 -----------------------------------------------
4296 * `G`: move forward one unit with the pen up
4297 * `F`: move forward one unit with the pen down drawing trunks and branches
4298 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
4299 * `T`: move forward one unit with the pen down drawing trunks only
4300 * `R`: move forward one unit with the pen down placing fruit
4301 * `A`: replace with rules set A
4302 * `B`: replace with rules set B
4303 * `C`: replace with rules set C
4304 * `D`: replace with rules set D
4305 * `a`: replace with rules set A, chance 90%
4306 * `b`: replace with rules set B, chance 80%
4307 * `c`: replace with rules set C, chance 70%
4308 * `d`: replace with rules set D, chance 60%
4309 * `+`: yaw the turtle right by `angle` parameter
4310 * `-`: yaw the turtle left by `angle` parameter
4311 * `&`: pitch the turtle down by `angle` parameter
4312 * `^`: pitch the turtle up by `angle` parameter
4313 * `/`: roll the turtle to the right by `angle` parameter
4314 * `*`: roll the turtle to the left by `angle` parameter
4315 * `[`: save in stack current state info
4316 * `]`: recover from stack state info
4321 Spawn a small apple tree:
4323 pos = {x=230,y=20,z=4}
4326 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
4327 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
4328 trunk="default:tree",
4329 leaves="default:leaves",
4333 trunk_type="single",
4336 fruit="default:apple"
4338 minetest.spawn_tree(pos,apple_tree)
4343 'minetest' namespace reference
4344 ==============================
4349 * `minetest.get_current_modname()`: returns the currently loading mod's name,
4351 * `minetest.get_modpath(modname)`: returns the directory path for a mod,
4352 e.g. `"/home/user/.minetest/usermods/modname"`.
4353 * Returns nil if the mod is not enabled or does not exist (not installed).
4354 * Works regardless of whether the mod has been loaded yet.
4355 * Useful for loading additional `.lua` modules or static data from a mod,
4356 or checking if a mod is enabled.
4357 * `minetest.get_modnames()`: returns a list of enabled mods, sorted alphabetically.
4358 * Does not include disabled mods, even if they are installed.
4359 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
4360 * Useful for storing custom data
4361 * `minetest.is_singleplayer()`
4362 * `minetest.features`: Table containing API feature flags
4365 glasslike_framed = true, -- 0.4.7
4366 nodebox_as_selectionbox = true, -- 0.4.7
4367 get_all_craft_recipes_works = true, -- 0.4.7
4368 -- The transparency channel of textures can optionally be used on
4370 use_texture_alpha = true,
4371 -- Tree and grass ABMs are no longer done from C++ (0.4.8)
4372 no_legacy_abms = true,
4373 -- Texture grouping is possible using parentheses (0.4.11)
4374 texture_names_parens = true,
4375 -- Unique Area ID for AreaStore:insert_area (0.4.14)
4376 area_store_custom_ids = true,
4377 -- add_entity supports passing initial staticdata to on_activate
4379 add_entity_with_staticdata = true,
4380 -- Chat messages are no longer predicted (0.4.16)
4381 no_chat_message_prediction = true,
4382 -- The transparency channel of textures can optionally be used on
4383 -- objects (ie: players and lua entities) (5.0.0)
4384 object_use_texture_alpha = true,
4385 -- Object selectionbox is settable independently from collisionbox
4387 object_independent_selectionbox = true,
4388 -- Specifies whether binary data can be uploaded or downloaded using
4389 -- the HTTP API (5.1.0)
4390 httpfetch_binary_data = true,
4391 -- Whether formspec_version[<version>] may be used (5.1.0)
4392 formspec_version_element = true,
4393 -- Whether AreaStore's IDs are kept on save/load (5.1.0)
4394 area_store_persistent_ids = true,
4395 -- Whether minetest.find_path is functional (5.2.0)
4396 pathfinder_works = true,
4397 -- Whether Collision info is available to an objects' on_step (5.3.0)
4398 object_step_has_moveresult = true,
4399 -- Whether get_velocity() and add_velocity() can be used on players (5.4.0)
4400 direct_velocity_on_players = true,
4401 -- nodedef's use_texture_alpha accepts new string modes (5.4.0)
4402 use_texture_alpha_string_modes = true,
4403 -- degrotate param2 rotates in units of 1.5° instead of 2°
4404 -- thus changing the range of values from 0-179 to 0-240 (5.5.0)
4405 degrotate_240_steps = true,
4408 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
4409 * `arg`: string or table in format `{foo=true, bar=true}`
4410 * `missing_features`: `{foo=true, bar=true}`
4411 * `minetest.get_player_information(player_name)`: Table containing information
4412 about a player. Example return value:
4415 address = "127.0.0.1", -- IP address of client
4416 ip_version = 4, -- IPv4 / IPv6
4417 connection_uptime = 200, -- seconds since client connected
4418 protocol_version = 32, -- protocol version used by client
4419 formspec_version = 2, -- supported formspec version
4420 lang_code = "fr" -- Language code used for translation
4421 -- the following keys can be missing if no stats have been collected yet
4422 min_rtt = 0.01, -- minimum round trip time
4423 max_rtt = 0.2, -- maximum round trip time
4424 avg_rtt = 0.02, -- average round trip time
4425 min_jitter = 0.01, -- minimum packet time jitter
4426 max_jitter = 0.5, -- maximum packet time jitter
4427 avg_jitter = 0.03, -- average packet time jitter
4428 -- the following information is available in a debug build only!!!
4429 -- DO NOT USE IN MODS
4430 --ser_vers = 26, -- serialization version used by client
4431 --major = 0, -- major version number
4432 --minor = 4, -- minor version number
4433 --patch = 10, -- patch version number
4434 --vers_string = "0.4.9-git", -- full version string
4435 --state = "Active" -- current client state
4438 * `minetest.mkdir(path)`: returns success.
4439 * Creates a directory specified by `path`, creating parent directories
4440 if they don't exist.
4441 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
4443 * nil: return all entries,
4444 * true: return only subdirectory names, or
4445 * false: return only file names.
4446 * `minetest.safe_file_write(path, content)`: returns boolean indicating success
4447 * Replaces contents of file at path with new contents in a safe (atomic)
4448 way. Use this instead of below code when writing e.g. database files:
4449 `local f = io.open(path, "wb"); f:write(content); f:close()`
4450 * `minetest.get_version()`: returns a table containing components of the
4451 engine version. Components:
4452 * `project`: Name of the project, eg, "Minetest"
4453 * `string`: Simple version, eg, "1.2.3-dev"
4454 * `hash`: Full git version (only set if available),
4455 eg, "1.2.3-dev-01234567-dirty".
4456 Use this for informational purposes only. The information in the returned
4457 table does not represent the capabilities of the engine, nor is it
4458 reliable or verifiable. Compatible forks will have a different name and
4459 version entirely. To check for the presence of engine features, test
4460 whether the functions exported by the wanted features exist. For example:
4461 `if minetest.check_for_falling then ... end`.
4462 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
4463 * `data`: string of data to hash
4464 * `raw`: return raw bytes instead of hex digits, default: false
4469 * `minetest.debug(...)`
4470 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
4471 * `minetest.log([level,] text)`
4472 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
4473 `"info"`, or `"verbose"`. Default is `"none"`.
4475 Registration functions
4476 ----------------------
4478 Call these functions only at load time!
4482 * `minetest.register_node(name, node definition)`
4483 * `minetest.register_craftitem(name, item definition)`
4484 * `minetest.register_tool(name, item definition)`
4485 * `minetest.override_item(name, redefinition)`
4486 * Overrides fields of an item registered with register_node/tool/craftitem.
4487 * Note: Item must already be defined, (opt)depend on the mod defining it.
4488 * Example: `minetest.override_item("default:mese",
4489 {light_source=minetest.LIGHT_MAX})`
4490 * `minetest.unregister_item(name)`
4491 * Unregisters the item from the engine, and deletes the entry with key
4492 `name` from `minetest.registered_items` and from the associated item table
4493 according to its nature: `minetest.registered_nodes`, etc.
4494 * `minetest.register_entity(name, entity definition)`
4495 * `minetest.register_abm(abm definition)`
4496 * `minetest.register_lbm(lbm definition)`
4497 * `minetest.register_alias(alias, original_name)`
4498 * Also use this to set the 'mapgen aliases' needed in a game for the core
4499 mapgens. See [Mapgen aliases] section above.
4500 * `minetest.register_alias_force(alias, original_name)`
4501 * `minetest.register_ore(ore definition)`
4502 * Returns an integer object handle uniquely identifying the registered
4504 * The order of ore registrations determines the order of ore generation.
4505 * `minetest.register_biome(biome definition)`
4506 * Returns an integer object handle uniquely identifying the registered
4507 biome on success. To get the biome ID, use `minetest.get_biome_id`.
4508 * `minetest.unregister_biome(name)`
4509 * Unregisters the biome from the engine, and deletes the entry with key
4510 `name` from `minetest.registered_biomes`.
4511 * Warning: This alters the biome to biome ID correspondences, so any
4512 decorations or ores using the 'biomes' field must afterwards be cleared
4514 * `minetest.register_decoration(decoration definition)`
4515 * Returns an integer object handle uniquely identifying the registered
4516 decoration on success. To get the decoration ID, use
4517 `minetest.get_decoration_id`.
4518 * The order of decoration registrations determines the order of decoration
4520 * `minetest.register_schematic(schematic definition)`
4521 * Returns an integer object handle uniquely identifying the registered
4522 schematic on success.
4523 * If the schematic is loaded from a file, the `name` field is set to the
4525 * If the function is called when loading the mod, and `name` is a relative
4526 path, then the current mod path will be prepended to the schematic
4528 * `minetest.clear_registered_biomes()`
4529 * Clears all biomes currently registered.
4530 * Warning: Clearing and re-registering biomes alters the biome to biome ID
4531 correspondences, so any decorations or ores using the 'biomes' field must
4532 afterwards be cleared and re-registered.
4533 * `minetest.clear_registered_decorations()`
4534 * Clears all decorations currently registered.
4535 * `minetest.clear_registered_ores()`
4536 * Clears all ores currently registered.
4537 * `minetest.clear_registered_schematics()`
4538 * Clears all schematics currently registered.
4542 * `minetest.register_craft(recipe)`
4543 * Check recipe table syntax for different types below.
4544 * `minetest.clear_craft(recipe)`
4545 * Will erase existing craft based either on output item or on input recipe.
4546 * Specify either output or input only. If you specify both, input will be
4547 ignored. For input use the same recipe table syntax as for
4548 `minetest.register_craft(recipe)`. For output specify only the item,
4550 * Returns false if no erase candidate could be found, otherwise returns true.
4551 * **Warning**! The type field ("shaped", "cooking" or any other) will be
4552 ignored if the recipe contains output. Erasing is then done independently
4553 from the crafting method.
4554 * `minetest.register_chatcommand(cmd, chatcommand definition)`
4555 * `minetest.override_chatcommand(name, redefinition)`
4556 * Overrides fields of a chatcommand registered with `register_chatcommand`.
4557 * `minetest.unregister_chatcommand(name)`
4558 * Unregisters a chatcommands registered with `register_chatcommand`.
4559 * `minetest.register_privilege(name, definition)`
4560 * `definition` can be a description or a definition table (see [Privilege
4562 * If it is a description, the priv will be granted to singleplayer and admin
4564 * To allow players with `basic_privs` to grant, see the `basic_privs`
4565 minetest.conf setting.
4566 * `minetest.register_authentication_handler(authentication handler definition)`
4567 * Registers an auth handler that overrides the builtin one.
4568 * This function can be called by a single mod once only.
4570 Global callback registration functions
4571 --------------------------------------
4573 Call these functions only at load time!
4575 * `minetest.register_globalstep(function(dtime))`
4576 * Called every server step, usually interval of 0.1s
4577 * `minetest.register_on_mods_loaded(function())`
4578 * Called after mods have finished loading and before the media is cached or the
4580 * `minetest.register_on_shutdown(function())`
4581 * Called before server shutdown
4582 * **Warning**: If the server terminates abnormally (i.e. crashes), the
4583 registered callbacks **will likely not be run**. Data should be saved at
4584 semi-frequent intervals as well as on server shutdown.
4585 * `minetest.register_on_placenode(function(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
4586 * Called when a node has been placed
4587 * If return `true` no item is taken from `itemstack`
4588 * `placer` may be any valid ObjectRef or nil.
4589 * **Not recommended**; use `on_construct` or `after_place_node` in node
4590 definition whenever possible.
4591 * `minetest.register_on_dignode(function(pos, oldnode, digger))`
4592 * Called when a node has been dug.
4593 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node
4594 definition whenever possible.
4595 * `minetest.register_on_punchnode(function(pos, node, puncher, pointed_thing))`
4596 * Called when a node is punched
4597 * `minetest.register_on_generated(function(minp, maxp, blockseed))`
4598 * Called after generating a piece of world. Modifying nodes inside the area
4599 is a bit faster than usually.
4600 * `minetest.register_on_newplayer(function(ObjectRef))`
4601 * Called when a new player enters the world for the first time
4602 * `minetest.register_on_punchplayer(function(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
4603 * Called when a player is punched
4604 * Note: This callback is invoked even if the punched player is dead.
4605 * `player`: ObjectRef - Player that was punched
4606 * `hitter`: ObjectRef - Player that hit
4607 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4609 * `tool_capabilities`: Capability table of used tool (can be nil)
4610 * `dir`: Unit vector of direction of punch. Always defined. Points from
4611 the puncher to the punched.
4612 * `damage`: Number that represents the damage calculated by the engine
4613 * should return `true` to prevent the default damage mechanism
4614 * `minetest.register_on_rightclickplayer(function(player, clicker))`
4615 * Called when a player is right-clicked
4616 * `player`: ObjectRef - Player that was right-clicked
4617 * `clicker`: ObjectRef - Object that right-clicked, may or may not be a player
4618 * `minetest.register_on_player_hpchange(function(player, hp_change, reason), modifier)`
4619 * Called when the player gets damaged or healed
4620 * `player`: ObjectRef of the player
4621 * `hp_change`: the amount of change. Negative when it is damage.
4622 * `reason`: a PlayerHPChangeReason table.
4623 * The `type` field will have one of the following values:
4624 * `set_hp`: A mod or the engine called `set_hp` without
4625 giving a type - use this for custom damage types.
4626 * `punch`: Was punched. `reason.object` will hold the puncher, or nil if none.
4628 * `node_damage`: `damage_per_second` from a neighbouring node.
4629 `reason.node` will hold the node name or nil.
4632 * Any of the above types may have additional fields from mods.
4633 * `reason.from` will be `mod` or `engine`.
4634 * `modifier`: when true, the function should return the actual `hp_change`.
4635 Note: modifiers only get a temporary `hp_change` that can be modified by later modifiers.
4636 Modifiers can return true as a second argument to stop the execution of further functions.
4637 Non-modifiers receive the final HP change calculated by the modifiers.
4638 * `minetest.register_on_dieplayer(function(ObjectRef, reason))`
4639 * Called when a player dies
4640 * `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
4641 * `minetest.register_on_respawnplayer(function(ObjectRef))`
4642 * Called when player is to be respawned
4643 * Called _before_ repositioning of player occurs
4644 * return true in func to disable regular player placement
4645 * `minetest.register_on_prejoinplayer(function(name, ip))`
4646 * Called when a client connects to the server, prior to authentication
4647 * If it returns a string, the client is disconnected with that string as
4649 * `minetest.register_on_joinplayer(function(ObjectRef, last_login))`
4650 * Called when a player joins the game
4651 * `last_login`: The timestamp of the previous login, or nil if player is new
4652 * `minetest.register_on_leaveplayer(function(ObjectRef, timed_out))`
4653 * Called when a player leaves the game
4654 * `timed_out`: True for timeout, false for other reasons.
4655 * `minetest.register_on_authplayer(function(name, ip, is_success))`
4656 * Called when a client attempts to log into an account.
4657 * `name`: The name of the account being authenticated.
4658 * `ip`: The IP address of the client
4659 * `is_success`: Whether the client was successfully authenticated
4660 * For newly registered accounts, `is_success` will always be true
4661 * `minetest.register_on_auth_fail(function(name, ip))`
4662 * Deprecated: use `minetest.register_on_authplayer(name, ip, is_success)` instead.
4663 * `minetest.register_on_cheat(function(ObjectRef, cheat))`
4664 * Called when a player cheats
4665 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
4667 * `interacted_too_far`
4668 * `interacted_with_self`
4669 * `interacted_while_dead`
4670 * `finished_unknown_dig`
4673 * `minetest.register_on_chat_message(function(name, message))`
4674 * Called always when a player says something
4675 * Return `true` to mark the message as handled, which means that it will
4676 not be sent to other players.
4677 * `minetest.register_on_chatcommand(function(name, command, params))`
4678 * Called always when a chatcommand is triggered, before `minetest.registered_chatcommands`
4679 is checked to see if the command exists, but after the input is parsed.
4680 * Return `true` to mark the command as handled, which means that the default
4681 handlers will be prevented.
4682 * `minetest.register_on_player_receive_fields(function(player, formname, fields))`
4683 * Called when the server received input from `player` in a formspec with
4684 the given `formname`. Specifically, this is called on any of the
4686 * a button was pressed,
4687 * Enter was pressed while the focus was on a text field
4688 * a checkbox was toggled,
4689 * something was selected in a dropdown list,
4690 * a different tab was selected,
4691 * selection was changed in a textlist or table,
4692 * an entry was double-clicked in a textlist or table,
4693 * a scrollbar was moved, or
4694 * the form was actively closed by the player.
4695 * Fields are sent for formspec elements which define a field. `fields`
4696 is a table containing each formspecs element value (as string), with
4697 the `name` parameter as index for each. The value depends on the
4698 formspec element type:
4699 * `animated_image`: Returns the index of the current frame.
4700 * `button` and variants: If pressed, contains the user-facing button
4701 text as value. If not pressed, is `nil`
4702 * `field`, `textarea` and variants: Text in the field
4703 * `dropdown`: Either the index or value, depending on the `index event`
4705 * `tabheader`: Tab index, starting with `"1"` (only if tab changed)
4706 * `checkbox`: `"true"` if checked, `"false"` if unchecked
4707 * `textlist`: See `minetest.explode_textlist_event`
4708 * `table`: See `minetest.explode_table_event`
4709 * `scrollbar`: See `minetest.explode_scrollbar_event`
4710 * Special case: `["quit"]="true"` is sent when the user actively
4711 closed the form by mouse click, keypress or through a button_exit[]
4713 * Special case: `["key_enter"]="true"` is sent when the user pressed
4714 the Enter key and the focus was either nowhere (causing the formspec
4715 to be closed) or on a button. If the focus was on a text field,
4716 additionally, the index `key_enter_field` contains the name of the
4717 text field. See also: `field_close_on_enter`.
4718 * Newest functions are called first
4719 * If function returns `true`, remaining functions are not called
4720 * `minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv))`
4721 * Called when `player` crafts something
4722 * `itemstack` is the output
4723 * `old_craft_grid` contains the recipe (Note: the one in the inventory is
4725 * `craft_inv` is the inventory with the crafting grid
4726 * Return either an `ItemStack`, to replace the output, or `nil`, to not
4728 * `minetest.register_craft_predict(function(itemstack, player, old_craft_grid, craft_inv))`
4729 * The same as before, except that it is called before the player crafts, to
4730 make craft prediction, and it should not change anything.
4731 * `minetest.register_allow_player_inventory_action(function(player, action, inventory, inventory_info))`
4732 * Determines how much of a stack may be taken, put or moved to a
4734 * `player` (type `ObjectRef`) is the player who modified the inventory
4735 `inventory` (type `InvRef`).
4736 * List of possible `action` (string) values and their
4737 `inventory_info` (table) contents:
4738 * `move`: `{from_list=string, to_list=string, from_index=number, to_index=number, count=number}`
4739 * `put`: `{listname=string, index=number, stack=ItemStack}`
4740 * `take`: Same as `put`
4741 * Return a numeric value to limit the amount of items to be taken, put or
4742 moved. A value of `-1` for `take` will make the source stack infinite.
4743 * `minetest.register_on_player_inventory_action(function(player, action, inventory, inventory_info))`
4744 * Called after a take, put or move event from/to/in a player inventory
4745 * Function arguments: see `minetest.register_allow_player_inventory_action`
4746 * Does not accept or handle any return value.
4747 * `minetest.register_on_protection_violation(function(pos, name))`
4748 * Called by `builtin` and mods when a player violates protection at a
4749 position (eg, digs a node or punches a protected entity).
4750 * The registered functions can be called using
4751 `minetest.record_protection_violation`.
4752 * The provided function should check that the position is protected by the
4753 mod calling this function before it prints a message, if it does, to
4754 allow for multiple protection mods.
4755 * `minetest.register_on_item_eat(function(hp_change, replace_with_item, itemstack, user, pointed_thing))`
4756 * Called when an item is eaten, by `minetest.item_eat`
4757 * Return `itemstack` to cancel the default item eat response (i.e.: hp increase).
4758 * `minetest.register_on_priv_grant(function(name, granter, priv))`
4759 * Called when `granter` grants the priv `priv` to `name`.
4760 * Note that the callback will be called twice if it's done by a player,
4761 once with granter being the player name, and again with granter being nil.
4762 * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
4763 * Called when `revoker` revokes the priv `priv` from `name`.
4764 * Note that the callback will be called twice if it's done by a player,
4765 once with revoker being the player name, and again with revoker being nil.
4766 * `minetest.register_can_bypass_userlimit(function(name, ip))`
4767 * Called when `name` user connects with `ip`.
4768 * Return `true` to by pass the player limit
4769 * `minetest.register_on_modchannel_message(function(channel_name, sender, message))`
4770 * Called when an incoming mod channel message is received
4771 * You should have joined some channels to receive events.
4772 * If message comes from a server mod, `sender` field is an empty string.
4777 * `minetest.settings`: Settings object containing all of the settings from the
4778 main config file (`minetest.conf`).
4779 * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
4780 parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
4785 * `minetest.string_to_privs(str[, delim])`:
4786 * Converts string representation of privs into table form
4787 * `delim`: String separating the privs. Defaults to `","`.
4788 * Returns `{ priv1 = true, ... }`
4789 * `minetest.privs_to_string(privs[, delim])`:
4790 * Returns the string representation of `privs`
4791 * `delim`: String to delimit privs. Defaults to `","`.
4792 * `minetest.get_player_privs(name) -> {priv1=true,...}`
4793 * `minetest.check_player_privs(player_or_name, ...)`:
4794 returns `bool, missing_privs`
4795 * A quickhand for checking privileges.
4796 * `player_or_name`: Either a Player object or the name of a player.
4797 * `...` is either a list of strings, e.g. `"priva", "privb"` or
4798 a table, e.g. `{ priva = true, privb = true }`.
4800 * `minetest.check_password_entry(name, entry, password)`
4801 * Returns true if the "password entry" for a player with name matches given
4802 password, false otherwise.
4803 * The "password entry" is the password representation generated by the
4804 engine as returned as part of a `get_auth()` call on the auth handler.
4805 * Only use this function for making it possible to log in via password from
4806 external protocols such as IRC, other uses are frowned upon.
4807 * `minetest.get_password_hash(name, raw_password)`
4808 * Convert a name-password pair to a password hash that Minetest can use.
4809 * The returned value alone is not a good basis for password checks based
4810 on comparing the password hash in the database with the password hash
4811 from the function, with an externally provided password, as the hash
4812 in the db might use the new SRP verifier format.
4813 * For this purpose, use `minetest.check_password_entry` instead.
4814 * `minetest.get_player_ip(name)`: returns an IP address string for the player
4816 * The player needs to be online for this to be successful.
4818 * `minetest.get_auth_handler()`: Return the currently active auth handler
4819 * See the [Authentication handler definition]
4820 * Use this to e.g. get the authentication data for a player:
4821 `local auth_data = minetest.get_auth_handler().get_auth(playername)`
4822 * `minetest.notify_authentication_modified(name)`
4823 * Must be called by the authentication handler for privilege changes.
4824 * `name`: string; if omitted, all auth data should be considered modified
4825 * `minetest.set_player_password(name, password_hash)`: Set password hash of
4827 * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player
4829 * `minetest.auth_reload()`
4830 * See `reload()` in authentication handler definition
4832 `minetest.set_player_password`, `minetest.set_player_privs`,
4833 `minetest.get_player_privs` and `minetest.auth_reload` call the authentication
4839 * `minetest.chat_send_all(text)`
4840 * `minetest.chat_send_player(name, text)`
4841 * `minetest.format_chat_message(name, message)`
4842 * Used by the server to format a chat message, based on the setting `chat_message_format`.
4843 Refer to the documentation of the setting for a list of valid placeholders.
4844 * Takes player name and message, and returns the formatted string to be sent to players.
4845 * Can be redefined by mods if required, for things like colored names or messages.
4846 * **Only** the first occurrence of each placeholder will be replaced.
4851 * `minetest.set_node(pos, node)`
4852 * `minetest.add_node(pos, node)`: alias to `minetest.set_node`
4853 * Set node at position `pos`
4854 * `node`: table `{name=string, param1=number, param2=number}`
4855 * If param1 or param2 is omitted, it's set to `0`.
4856 * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
4857 * `minetest.bulk_set_node({pos1, pos2, pos3, ...}, node)`
4858 * Set node on all positions set in the first argument.
4859 * e.g. `minetest.bulk_set_node({{x=0, y=1, z=1}, {x=1, y=2, z=2}}, {name="default:stone"})`
4860 * For node specification or position syntax see `minetest.set_node` call
4861 * Faster than set_node due to single call, but still considerably slower
4862 than Lua Voxel Manipulators (LVM) for large numbers of nodes.
4863 Unlike LVMs, this will call node callbacks. It also allows setting nodes
4864 in spread out positions which would cause LVMs to waste memory.
4865 For setting a cube, this is 1.3x faster than set_node whereas LVM is 20
4867 * `minetest.swap_node(pos, node)`
4868 * Set node at position, but don't remove metadata
4869 * `minetest.remove_node(pos)`
4870 * By default it does the same as `minetest.set_node(pos, {name="air"})`
4871 * `minetest.get_node(pos)`
4872 * Returns the node at the given position as table in the format
4873 `{name="node_name", param1=0, param2=0}`,
4874 returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
4875 * `minetest.get_node_or_nil(pos)`
4876 * Same as `get_node` but returns `nil` for unloaded areas.
4877 * `minetest.get_node_light(pos, timeofday)`
4878 * Gets the light value at the given position. Note that the light value
4879 "inside" the node at the given position is returned, so you usually want
4880 to get the light value of a neighbor.
4881 * `pos`: The position where to measure the light.
4882 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
4883 * Returns a number between `0` and `15` or `nil`
4884 * `nil` is returned e.g. when the map isn't loaded at `pos`
4885 * `minetest.get_natural_light(pos[, timeofday])`
4886 * Figures out the sunlight (or moonlight) value at pos at the given time of
4888 * `pos`: The position of the node
4889 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
4890 * Returns a number between `0` and `15` or `nil`
4891 * This function tests 203 nodes in the worst case, which happens very
4893 * `minetest.get_artificial_light(param1)`
4894 * Calculates the artificial light (light from e.g. torches) value from the
4896 * `param1`: The param1 value of a `paramtype = "light"` node.
4897 * Returns a number between `0` and `15`
4898 * Currently it's the same as `math.floor(param1 / 16)`, except that it
4899 ensures compatibility.
4900 * `minetest.place_node(pos, node)`
4901 * Place node with the same effects that a player would cause
4902 * `minetest.dig_node(pos)`
4903 * Dig node with the same effects that a player would cause
4904 * Returns `true` if successful, `false` on failure (e.g. protected location)
4905 * `minetest.punch_node(pos)`
4906 * Punch node with the same effects that a player would cause
4907 * `minetest.spawn_falling_node(pos)`
4908 * Change node into falling node
4909 * Returns `true` if successful, `false` on failure
4911 * `minetest.find_nodes_with_meta(pos1, pos2)`
4912 * Get a table of positions of nodes that have metadata within a region
4914 * `minetest.get_meta(pos)`
4915 * Get a `NodeMetaRef` at that position
4916 * `minetest.get_node_timer(pos)`
4917 * Get `NodeTimerRef`
4919 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at
4921 * Returns `ObjectRef`, or `nil` if failed
4922 * `minetest.add_item(pos, item)`: Spawn item
4923 * Returns `ObjectRef`, or `nil` if failed
4924 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
4925 * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of
4927 * `radius`: using an euclidean metric
4928 * `minetest.get_objects_in_area(pos1, pos2)`: returns a list of
4930 * `pos1` and `pos2` are the min and max positions of the area to search.
4931 * `minetest.set_timeofday(val)`
4932 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
4933 * `minetest.get_timeofday()`
4934 * `minetest.get_gametime()`: returns the time, in seconds, since the world was
4936 * `minetest.get_day_count()`: returns number days elapsed since world was
4938 * accounts for time changes.
4939 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns
4941 * `radius`: using a maximum metric
4942 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4943 * `search_center` is an optional boolean (default: `false`)
4944 If true `pos` is also checked for the nodes
4945 * `minetest.find_nodes_in_area(pos1, pos2, nodenames, [grouped])`
4946 * `pos1` and `pos2` are the min and max positions of the area to search.
4947 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4948 * If `grouped` is true the return value is a table indexed by node name
4949 which contains lists of positions.
4950 * If `grouped` is false or absent the return values are as follows:
4951 first value: Table with all node positions
4952 second value: Table with the count of each node with the node name
4954 * Area volume is limited to 4,096,000 nodes
4955 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
4957 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4958 * Return value: Table with all node positions with a node air above
4959 * Area volume is limited to 4,096,000 nodes
4960 * `minetest.get_perlin(noiseparams)`
4961 * Return world-specific perlin noise.
4962 * The actual seed used is the noiseparams seed plus the world seed.
4963 * `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
4964 * Deprecated: use `minetest.get_perlin(noiseparams)` instead.
4965 * Return world-specific perlin noise.
4966 * `minetest.get_voxel_manip([pos1, pos2])`
4967 * Return voxel manipulator object.
4968 * Loads the manipulator from the map if positions are passed.
4969 * `minetest.set_gen_notify(flags, {deco_ids})`
4970 * Set the types of on-generate notifications that should be collected.
4971 * `flags` is a flag field with the available flags:
4979 * The second parameter is a list of IDs of decorations which notification
4981 * `minetest.get_gen_notify()`
4982 * Returns a flagstring and a table with the `deco_id`s.
4983 * `minetest.get_decoration_id(decoration_name)`
4984 * Returns the decoration ID number for the provided decoration name string,
4985 or `nil` on failure.
4986 * `minetest.get_mapgen_object(objectname)`
4987 * Return requested mapgen object if available (see [Mapgen objects])
4988 * `minetest.get_heat(pos)`
4989 * Returns the heat at the position, or `nil` on failure.
4990 * `minetest.get_humidity(pos)`
4991 * Returns the humidity at the position, or `nil` on failure.
4992 * `minetest.get_biome_data(pos)`
4993 * Returns a table containing:
4994 * `biome` the biome id of the biome at that position
4995 * `heat` the heat at the position
4996 * `humidity` the humidity at the position
4997 * Or returns `nil` on failure.
4998 * `minetest.get_biome_id(biome_name)`
4999 * Returns the biome id, as used in the biomemap Mapgen object and returned
5000 by `minetest.get_biome_data(pos)`, for a given biome_name string.
5001 * `minetest.get_biome_name(biome_id)`
5002 * Returns the biome name string for the provided biome id, or `nil` on
5004 * If no biomes have been registered, such as in mgv6, returns `default`.
5005 * `minetest.get_mapgen_params()`
5006 * Deprecated: use `minetest.get_mapgen_setting(name)` instead.
5007 * Returns a table containing:
5013 * `minetest.set_mapgen_params(MapgenParams)`
5014 * Deprecated: use `minetest.set_mapgen_setting(name, value, override)`
5016 * Set map generation parameters.
5017 * Function cannot be called after the registration period; only
5018 initialization and `on_mapgen_init`.
5019 * Takes a table as an argument with the fields:
5025 * Leave field unset to leave that parameter unchanged.
5026 * `flags` contains a comma-delimited string of flags to set, or if the
5027 prefix `"no"` is attached, clears instead.
5028 * `flags` is in the same format and has the same options as `mg_flags` in
5030 * `minetest.get_mapgen_setting(name)`
5031 * Gets the *active* mapgen setting (or nil if none exists) in string
5032 format with the following order of precedence:
5033 1) Settings loaded from map_meta.txt or overrides set during mod
5035 2) Settings set by mods without a metafile override
5036 3) Settings explicitly set in the user config file, minetest.conf
5037 4) Settings set as the user config default
5038 * `minetest.get_mapgen_setting_noiseparams(name)`
5039 * Same as above, but returns the value as a NoiseParams table if the
5040 setting `name` exists and is a valid NoiseParams.
5041 * `minetest.set_mapgen_setting(name, value, [override_meta])`
5042 * Sets a mapgen param to `value`, and will take effect if the corresponding
5043 mapgen setting is not already present in map_meta.txt.
5044 * `override_meta` is an optional boolean (default: `false`). If this is set
5045 to true, the setting will become the active setting regardless of the map
5047 * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`.
5048 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
5049 * Same as above, except value is a NoiseParams table.
5050 * `minetest.set_noiseparams(name, noiseparams, set_default)`
5051 * Sets the noiseparams setting of `name` to the noiseparams table specified
5053 * `set_default` is an optional boolean (default: `true`) that specifies
5054 whether the setting should be applied to the default config or current
5056 * `minetest.get_noiseparams(name)`
5057 * Returns a table of the noiseparams for name.
5058 * `minetest.generate_ores(vm, pos1, pos2)`
5059 * Generate all registered ores within the VoxelManip `vm` and in the area
5060 from `pos1` to `pos2`.
5061 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
5062 * `minetest.generate_decorations(vm, pos1, pos2)`
5063 * Generate all registered decorations within the VoxelManip `vm` and in the
5064 area from `pos1` to `pos2`.
5065 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
5066 * `minetest.clear_objects([options])`
5067 * Clear all objects in the environment
5068 * Takes an optional table as an argument with the field `mode`.
5069 * mode = `"full"` : Load and go through every mapblock, clearing
5071 * mode = `"quick"`: Clear objects immediately in loaded mapblocks,
5072 clear objects in unloaded mapblocks only when the
5073 mapblocks are next activated.
5074 * `minetest.load_area(pos1[, pos2])`
5075 * Load the mapblocks containing the area from `pos1` to `pos2`.
5076 `pos2` defaults to `pos1` if not specified.
5077 * This function does not trigger map generation.
5078 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
5079 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be
5080 asynchronously fetched from memory, loaded from disk, or if inexistent,
5082 * If `callback` is a valid Lua function, this will be called for each block
5084 * The function signature of callback is:
5085 `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
5086 * `blockpos` is the *block* coordinates of the block that had been
5088 * `action` could be one of the following constant values:
5089 * `minetest.EMERGE_CANCELLED`
5090 * `minetest.EMERGE_ERRORED`
5091 * `minetest.EMERGE_FROM_MEMORY`
5092 * `minetest.EMERGE_FROM_DISK`
5093 * `minetest.EMERGE_GENERATED`
5094 * `calls_remaining` is the number of callbacks to be expected after
5096 * `param` is the user-defined parameter passed to emerge_area (or
5097 nil if the parameter was absent).
5098 * `minetest.delete_area(pos1, pos2)`
5099 * delete all mapblocks in the area from pos1 to pos2, inclusive
5100 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
5101 * Checks if there is anything other than air between pos1 and pos2.
5102 * Returns false if something is blocking the sight.
5103 * Returns the position of the blocking node when `false`
5104 * `pos1`: First position
5105 * `pos2`: Second position
5106 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
5107 * Creates a `Raycast` object.
5108 * `pos1`: start of the ray
5109 * `pos2`: end of the ray
5110 * `objects`: if false, only nodes will be returned. Default is `true`.
5111 * `liquids`: if false, liquid nodes won't be returned. Default is `false`.
5112 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
5113 * returns table containing path that can be walked on
5114 * returns a table of 3D points representing a path from `pos1` to `pos2` or
5116 * Reasons for failure:
5117 * No path exists at all
5118 * No path exists within `searchdistance` (see below)
5119 * Start or end pos is buried in land
5120 * `pos1`: start position
5121 * `pos2`: end position
5122 * `searchdistance`: maximum distance from the search positions to search in.
5123 In detail: Path must be completely inside a cuboid. The minimum
5124 `searchdistance` of 1 will confine search between `pos1` and `pos2`.
5125 Larger values will increase the size of this cuboid in all directions
5126 * `max_jump`: maximum height difference to consider walkable
5127 * `max_drop`: maximum height difference to consider droppable
5128 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`.
5129 Difference between `"A*"` and `"A*_noprefetch"` is that
5130 `"A*"` will pre-calculate the cost-data, the other will calculate it
5132 * `minetest.spawn_tree (pos, {treedef})`
5133 * spawns L-system tree at given `pos` with definition in `treedef` table
5134 * `minetest.transforming_liquid_add(pos)`
5135 * add node to liquid update queue
5136 * `minetest.get_node_max_level(pos)`
5137 * get max available level for leveled node
5138 * `minetest.get_node_level(pos)`
5139 * get level of leveled node (water, snow)
5140 * `minetest.set_node_level(pos, level)`
5141 * set level of leveled node, default `level` equals `1`
5142 * if `totallevel > maxlevel`, returns rest (`total-max`).
5143 * `minetest.add_node_level(pos, level)`
5144 * increase level of leveled node by level, default `level` equals `1`
5145 * if `totallevel > maxlevel`, returns rest (`total-max`)
5146 * `level` must be between -127 and 127
5147 * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
5148 * resets the light in a cuboid-shaped part of
5149 the map and removes lighting bugs.
5150 * Loads the area if it is not loaded.
5151 * `pos1` is the corner of the cuboid with the least coordinates
5152 (in node coordinates), inclusive.
5153 * `pos2` is the opposite corner of the cuboid, inclusive.
5154 * The actual updated cuboid might be larger than the specified one,
5155 because only whole map blocks can be updated.
5156 The actual updated area consists of those map blocks that intersect
5157 with the given cuboid.
5158 * However, the neighborhood of the updated area might change
5159 as well, as light can spread out of the cuboid, also light
5161 * returns `false` if the area is not fully generated,
5163 * `minetest.check_single_for_falling(pos)`
5164 * causes an unsupported `group:falling_node` node to fall and causes an
5165 unattached `group:attached_node` node to fall.
5166 * does not spread these updates to neighbours.
5167 * `minetest.check_for_falling(pos)`
5168 * causes an unsupported `group:falling_node` node to fall and causes an
5169 unattached `group:attached_node` node to fall.
5170 * spread these updates to neighbours and can cause a cascade
5172 * `minetest.get_spawn_level(x, z)`
5173 * Returns a player spawn y co-ordinate for the provided (x, z)
5174 co-ordinates, or `nil` for an unsuitable spawn point.
5175 * For most mapgens a 'suitable spawn point' is one with y between
5176 `water_level` and `water_level + 16`, and in mgv7 well away from rivers,
5177 so `nil` will be returned for many (x, z) co-ordinates.
5178 * The spawn level returned is for a player spawn in unmodified terrain.
5179 * The spawn level is intentionally above terrain level to cope with
5180 full-node biome 'dust' nodes.
5185 You can find mod channels communication scheme in `doc/mod_channels.png`.
5187 * `minetest.mod_channel_join(channel_name)`
5188 * Server joins channel `channel_name`, and creates it if necessary. You
5189 should listen for incoming messages with
5190 `minetest.register_on_modchannel_message`
5195 `minetest.get_inventory(location)`: returns an `InvRef`
5198 * `{type="player", name="celeron55"}`
5199 * `{type="node", pos={x=, y=, z=}}`
5200 * `{type="detached", name="creative"}`
5201 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns
5203 * `callbacks`: See [Detached inventory callbacks]
5204 * `player_name`: Make detached inventory available to one player
5205 exclusively, by default they will be sent to every player (even if not
5207 Note that this parameter is mostly just a workaround and will be removed
5209 * Creates a detached inventory. If it already exists, it is cleared.
5210 * `minetest.remove_detached_inventory(name)`
5211 * Returns a `boolean` indicating whether the removal succeeded.
5212 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
5213 returns left over ItemStack.
5214 * See `minetest.item_eat` and `minetest.register_on_item_eat`
5219 * `minetest.show_formspec(playername, formname, formspec)`
5220 * `playername`: name of player to show formspec
5221 * `formname`: name passed to `on_player_receive_fields` callbacks.
5222 It should follow the `"modname:<whatever>"` naming convention
5223 * `formspec`: formspec to display
5224 * `minetest.close_formspec(playername, formname)`
5225 * `playername`: name of player to close formspec
5226 * `formname`: has to exactly match the one given in `show_formspec`, or the
5227 formspec will not close.
5228 * calling `show_formspec(playername, formname, "")` is equal to this
5230 * to close a formspec regardless of the formname, call
5231 `minetest.close_formspec(playername, "")`.
5232 **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
5233 * `minetest.formspec_escape(string)`: returns a string
5234 * escapes the characters "[", "]", "\", "," and ";", which can not be used
5236 * `minetest.explode_table_event(string)`: returns a table
5237 * returns e.g. `{type="CHG", row=1, column=2}`
5239 * `"INV"`: no row selected
5241 * `"DCL"`: double-click
5242 * `minetest.explode_textlist_event(string)`: returns a table
5243 * returns e.g. `{type="CHG", index=1}`
5245 * `"INV"`: no row selected
5247 * `"DCL"`: double-click
5248 * `minetest.explode_scrollbar_event(string)`: returns a table
5249 * returns e.g. `{type="CHG", value=500}`
5251 * `"INV"`: something failed
5252 * `"CHG"`: has been changed
5253 * `"VAL"`: not changed
5258 * `minetest.inventorycube(img1, img2, img3)`
5259 * Returns a string for making an image of a cube (useful as an item image)
5260 * `minetest.get_pointed_thing_position(pointed_thing, above)`
5261 * Returns the position of a `pointed_thing` or `nil` if the `pointed_thing`
5262 does not refer to a node or entity.
5263 * If the optional `above` parameter is true and the `pointed_thing` refers
5264 to a node, then it will return the `above` position of the `pointed_thing`.
5265 * `minetest.dir_to_facedir(dir, is6d)`
5266 * Convert a vector to a facedir value, used in `param2` for
5267 `paramtype2="facedir"`.
5268 * passing something non-`nil`/`false` for the optional second parameter
5269 causes it to take the y component into account.
5270 * `minetest.facedir_to_dir(facedir)`
5271 * Convert a facedir back into a vector aimed directly out the "back" of a
5273 * `minetest.dir_to_wallmounted(dir)`
5274 * Convert a vector to a wallmounted value, used for
5275 `paramtype2="wallmounted"`.
5276 * `minetest.wallmounted_to_dir(wallmounted)`
5277 * Convert a wallmounted value back into a vector aimed directly out the
5279 * `minetest.dir_to_yaw(dir)`
5280 * Convert a vector into a yaw (angle)
5281 * `minetest.yaw_to_dir(yaw)`
5282 * Convert yaw (angle) to a vector
5283 * `minetest.is_colored_paramtype(ptype)`
5284 * Returns a boolean. Returns `true` if the given `paramtype2` contains
5285 color information (`color`, `colorwallmounted` or `colorfacedir`).
5286 * `minetest.strip_param2_color(param2, paramtype2)`
5287 * Removes everything but the color information from the
5288 given `param2` value.
5289 * Returns `nil` if the given `paramtype2` does not contain color
5291 * `minetest.get_node_drops(node, toolname)`
5292 * Returns list of itemstrings that are dropped by `node` when dug
5294 * `node`: node as table or node name
5295 * `toolname`: name of the tool item (can be `nil`)
5296 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
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 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
5302 * `output.time` = a number, if unsuccessful: `0`
5303 * `output.replacements` = List of replacement `ItemStack`s that couldn't be
5304 placed in `decremented_input.items`. Replacements can be placed in
5305 `decremented_input` if the stack of the replaced item has a count of 1.
5306 * `decremented_input` = like `input`
5307 * `minetest.get_craft_recipe(output)`: returns input
5308 * returns last registered recipe for output item (node)
5309 * `output` is a node or item type such as `"default:torch"`
5310 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
5311 * `input.width` = for example `3`
5312 * `input.items` = for example
5313 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
5314 * `input.items` = `nil` if no recipe found
5315 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
5316 * returns indexed table with all registered recipes for query item (node)
5317 or `nil` if no recipe was found.
5318 * recipe entry table:
5319 * `method`: 'normal' or 'cooking' or 'fuel'
5320 * `width`: 0-3, 0 means shapeless recipe
5321 * `items`: indexed [1-9] table with recipe items
5322 * `output`: string with item name and quantity
5323 * Example query for `"default:gold_ingot"` will return table:
5326 [1]={method = "cooking", width = 3, output = "default:gold_ingot",
5327 items = {1 = "default:gold_lump"}},
5328 [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
5329 items = {1 = "default:goldblock"}}
5331 * `minetest.handle_node_drops(pos, drops, digger)`
5332 * `drops`: list of itemstrings
5333 * Handles drops from nodes after digging: Default action is to put them
5334 into digger's inventory.
5335 * Can be overridden to get different functionality (e.g. dropping items on
5337 * `minetest.itemstring_with_palette(item, palette_index)`: returns an item
5339 * Creates an item string which contains palette index information
5340 for hardware colorization. You can use the returned string
5341 as an output in a craft recipe.
5342 * `item`: the item stack which becomes colored. Can be in string,
5343 table and native form.
5344 * `palette_index`: this index is added to the item stack
5345 * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
5346 * Creates an item string which contains static color information
5347 for hardware colorization. Use this method if you wish to colorize
5348 an item that does not own a palette. You can use the returned string
5349 as an output in a craft recipe.
5350 * `item`: the item stack which becomes colored. Can be in string,
5351 table and native form.
5352 * `colorstring`: the new color of the item stack
5357 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
5358 returns `{{actor, pos, time, oldnode, newnode}, ...}`
5359 * Find who has done something to a node, or near a node
5360 * `actor`: `"player:<name>"`, also `"liquid"`.
5361 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns
5362 `boolean, log_messages`.
5363 * Revert latest actions of someone
5364 * `actor`: `"player:<name>"`, also `"liquid"`.
5366 Defaults for the `on_place` and `on_drop` item definition functions
5367 -------------------------------------------------------------------
5369 * `minetest.item_place_node(itemstack, placer, pointed_thing[, param2, prevent_after_place])`
5370 * Place item as a node
5371 * `param2` overrides `facedir` and wallmounted `param2`
5372 * `prevent_after_place`: if set to `true`, `after_place_node` is not called
5373 for the newly placed node to prevent a callback and placement loop
5374 * returns `itemstack, position`
5375 * `position`: the location the node was placed to. `nil` if nothing was placed.
5376 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
5378 * returns the leftover itemstack
5379 * **Note**: This function is deprecated and will never be called.
5380 * `minetest.item_place(itemstack, placer, pointed_thing[, param2])`
5381 * Wrapper that calls `minetest.item_place_node` if appropriate
5382 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
5383 * **Note**: is not called when wielded item overrides `on_place`
5384 * `param2` overrides facedir and wallmounted `param2`
5385 * returns `itemstack, position`
5386 * `position`: the location the node was placed to. `nil` if nothing was placed.
5387 * `minetest.item_drop(itemstack, dropper, pos)`
5389 * returns the leftover itemstack
5390 * `minetest.item_eat(hp_change[, replace_with_item])`
5391 * Returns `function(itemstack, user, pointed_thing)` as a
5392 function wrapper for `minetest.do_item_eat`.
5393 * `replace_with_item` is the itemstring which is added to the inventory.
5394 If the player is eating a stack, then replace_with_item goes to a
5397 Defaults for the `on_punch` and `on_dig` node definition callbacks
5398 ------------------------------------------------------------------
5400 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
5401 * Calls functions registered by `minetest.register_on_punchnode()`
5402 * `minetest.node_dig(pos, node, digger)`
5403 * Checks if node can be dug, puts item into inventory, removes node
5404 * Calls functions registered by `minetest.registered_on_dignodes()`
5409 * `minetest.sound_play(spec, parameters, [ephemeral])`: returns a handle
5410 * `spec` is a `SimpleSoundSpec`
5411 * `parameters` is a sound parameter table
5412 * `ephemeral` is a boolean (default: false)
5413 Ephemeral sounds will not return a handle and can't be stopped or faded.
5414 It is recommend to use this for short sounds that happen in response to
5415 player actions (e.g. door closing).
5416 * `minetest.sound_stop(handle)`
5417 * `handle` is a handle returned by `minetest.sound_play`
5418 * `minetest.sound_fade(handle, step, gain)`
5419 * `handle` is a handle returned by `minetest.sound_play`
5420 * `step` determines how fast a sound will fade.
5421 The gain will change by this much per second,
5422 until it reaches the target gain.
5423 Note: Older versions used a signed step. This is deprecated, but old
5424 code will still work. (the client uses abs(step) to correct it)
5425 * `gain` the target gain for the fade.
5426 Fading to zero will delete the sound.
5431 * `minetest.after(time, func, ...)` : returns job table to use as below.
5432 * Call the function `func` after `time` seconds, may be fractional
5433 * Optional: Variable number of arguments that are passed to `func`
5436 * Cancels the job function from being called
5441 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for
5442 server shutdown. Will display `message` to clients.
5443 * `reconnect` == true displays a reconnect button
5444 * `delay` adds an optional delay (in seconds) before shutdown.
5445 Negative delay cancels the current active shutdown.
5446 Zero delay triggers an immediate shutdown.
5447 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
5448 * `minetest.get_server_status(name, joined)`
5449 * Returns the server status string when a player joins or when the command
5450 `/status` is called. Returns `nil` or an empty string when the message is
5452 * `joined`: Boolean value, indicates whether the function was called when
5454 * This function may be overwritten by mods to customize the status message.
5455 * `minetest.get_server_uptime()`: returns the server uptime in seconds
5456 * `minetest.remove_player(name)`: remove player from database (if they are not
5458 * As auth data is not removed, minetest.player_exists will continue to
5459 return true. Call the below method as well if you want to remove auth
5461 * Returns a code (0: successful, 1: no such player, 2: player is connected)
5462 * `minetest.remove_player_auth(name)`: remove player authentication data
5463 * Returns boolean indicating success (false if player nonexistant)
5464 * `minetest.dynamic_add_media(filepath, callback)`
5465 * `filepath`: path to a media file on the filesystem
5466 * `callback`: function with arguments `name`, where name is a player name
5467 (previously there was no callback argument; omitting it is deprecated)
5468 * Adds the file to the media sent to clients by the server on startup
5469 and also pushes this file to already connected clients.
5470 The file must be a supported image, sound or model format. It must not be
5471 modified, deleted, moved or renamed after calling this function.
5472 The list of dynamically added media is not persisted.
5473 * Returns false on error, true if the request was accepted
5474 * The given callback will be called for every player as soon as the
5475 media is available on the client.
5476 Old clients that lack support for this feature will not see the media
5477 unless they reconnect to the server. (callback won't be called)
5478 * Since media transferred this way currently does not use client caching
5479 or HTTP transfers, dynamic media should not be used with big files.
5484 * `minetest.get_ban_list()`: returns a list of all bans formatted as string
5485 * `minetest.get_ban_description(ip_or_name)`: returns list of bans matching
5486 IP address or name formatted as string
5487 * `minetest.ban_player(name)`: ban the IP of a currently connected player
5488 * Returns boolean indicating success
5489 * `minetest.unban_player_or_ip(ip_or_name)`: remove ban record matching
5491 * `minetest.kick_player(name, [reason])`: disconnect a player with an optional
5493 * Returns boolean indicating success (false if player nonexistant)
5498 * `minetest.add_particle(particle definition)`
5499 * Deprecated: `minetest.add_particle(pos, velocity, acceleration,
5500 expirationtime, size, collisiondetection, texture, playername)`
5502 * `minetest.add_particlespawner(particlespawner definition)`
5503 * Add a `ParticleSpawner`, an object that spawns an amount of particles
5504 over `time` seconds.
5505 * Returns an `id`, and -1 if adding didn't succeed
5506 * Deprecated: `minetest.add_particlespawner(amount, time,
5510 minexptime, maxexptime,
5512 collisiondetection, texture, playername)`
5514 * `minetest.delete_particlespawner(id, player)`
5515 * Delete `ParticleSpawner` with `id` (return value from
5516 `minetest.add_particlespawner`).
5517 * If playername is specified, only deletes on the player's client,
5518 otherwise on all clients.
5523 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
5524 * Create a schematic from the volume of map specified by the box formed by
5526 * Apply the specified probability and per-node force-place to the specified
5527 nodes according to the `probability_list`.
5528 * `probability_list` is an array of tables containing two fields, `pos`
5530 * `pos` is the 3D vector specifying the absolute coordinates of the
5531 node being modified,
5532 * `prob` is an integer value from `0` to `255` that encodes
5533 probability and per-node force-place. Probability has levels
5534 0-127, then 128 may be added to encode per-node force-place.
5535 For probability stated as 0-255, divide by 2 and round down to
5536 get values 0-127, then add 128 to apply per-node force-place.
5537 * If there are two or more entries with the same pos value, the
5539 * If `pos` is not inside the box formed by `p1` and `p2`, it is
5541 * If `probability_list` equals `nil`, no probabilities are applied.
5542 * Apply the specified probability to the specified horizontal slices
5543 according to the `slice_prob_list`.
5544 * `slice_prob_list` is an array of tables containing two fields, `ypos`
5546 * `ypos` indicates the y position of the slice with a probability
5547 applied, the lowest slice being `ypos = 0`.
5548 * If slice probability list equals `nil`, no slice probabilities
5550 * Saves schematic in the Minetest Schematic format to filename.
5552 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement, flags)`
5553 * Place the schematic specified by schematic (see [Schematic specifier]) at
5555 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
5556 * If the `rotation` parameter is omitted, the schematic is not rotated.
5557 * `replacements` = `{["old_name"] = "convert_to", ...}`
5558 * `force_placement` is a boolean indicating whether nodes other than `air`
5559 and `ignore` are replaced by the schematic.
5560 * Returns nil if the schematic could not be loaded.
5561 * **Warning**: Once you have loaded a schematic from a file, it will be
5562 cached. Future calls will always use the cached version and the
5563 replacement list defined for it, regardless of whether the file or the
5564 replacement list parameter have changed. The only way to load the file
5565 anew is to restart the server.
5566 * `flags` is a flag field with the available flags:
5571 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement, flags)`:
5572 * This function is analogous to minetest.place_schematic, but places a
5573 schematic onto the specified VoxelManip object `vmanip` instead of the
5575 * Returns false if any part of the schematic was cut-off due to the
5576 VoxelManip not containing the full area required, and true if the whole
5577 schematic was able to fit.
5578 * Returns nil if the schematic could not be loaded.
5579 * After execution, any external copies of the VoxelManip contents are
5581 * `flags` is a flag field with the available flags:
5586 * `minetest.serialize_schematic(schematic, format, options)`
5587 * Return the serialized schematic specified by schematic
5588 (see [Schematic specifier])
5589 * in the `format` of either "mts" or "lua".
5590 * "mts" - a string containing the binary MTS data used in the MTS file
5592 * "lua" - a string containing Lua code representing the schematic in table
5594 * `options` is a table containing the following optional parameters:
5595 * If `lua_use_comments` is true and `format` is "lua", the Lua code
5596 generated will have (X, Z) position comments for every X row
5597 generated in the schematic data for easier reading.
5598 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua",
5599 the Lua code generated will use that number of spaces as indentation
5600 instead of a tab character.
5602 * `minetest.read_schematic(schematic, options)`
5603 * Returns a Lua table representing the schematic (see: [Schematic specifier])
5604 * `schematic` is the schematic to read (see: [Schematic specifier])
5605 * `options` is a table containing the following optional parameters:
5606 * `write_yslice_prob`: string value:
5607 * `none`: no `write_yslice_prob` table is inserted,
5608 * `low`: only probabilities that are not 254 or 255 are written in
5609 the `write_ylisce_prob` table,
5610 * `all`: write all probabilities to the `write_yslice_prob` table.
5611 * The default for this option is `all`.
5612 * Any invalid value will be interpreted as `all`.
5617 * `minetest.request_http_api()`:
5618 * returns `HTTPApiTable` containing http functions if the calling mod has
5619 been granted access by being listed in the `secure.http_mods` or
5620 `secure.trusted_mods` setting, otherwise returns `nil`.
5621 * The returned table contains the functions `fetch`, `fetch_async` and
5622 `fetch_async_get` described below.
5623 * Only works at init time and must be called from the mod's main scope
5624 (not from a function).
5625 * Function only exists if minetest server was built with cURL support.
5626 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
5628 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
5629 * Performs given request asynchronously and calls callback upon completion
5630 * callback: `function(HTTPRequestResult res)`
5631 * Use this HTTP function if you are unsure, the others are for advanced use
5632 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
5633 * Performs given request asynchronously and returns handle for
5634 `HTTPApiTable.fetch_async_get`
5635 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
5636 * Return response data for given asynchronous HTTP request
5641 * `minetest.get_mod_storage()`:
5642 * returns reference to mod private `StorageRef`
5643 * must be called during mod load time
5648 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
5649 * `minetest.is_player(obj)`: boolean, whether `obj` is a player
5650 * `minetest.player_exists(name)`: boolean, whether player exists
5651 (regardless of online status)
5652 * `minetest.hud_replace_builtin(name, hud_definition)`
5653 * Replaces definition of a builtin hud element
5654 * `name`: `"breath"` or `"health"`
5655 * `hud_definition`: definition to replace builtin definition
5656 * `minetest.send_join_message(player_name)`
5657 * This function can be overridden by mods to change the join message.
5658 * `minetest.send_leave_message(player_name, timed_out)`
5659 * This function can be overridden by mods to change the leave message.
5660 * `minetest.hash_node_position(pos)`: returns an 48-bit integer
5661 * `pos`: table {x=number, y=number, z=number},
5662 * Gives a unique hash number for a node position (16+16+16=48bit)
5663 * `minetest.get_position_from_hash(hash)`: returns a position
5664 * Inverse transform of `minetest.hash_node_position`
5665 * `minetest.get_item_group(name, group)`: returns a rating
5666 * Get rating of a group of an item. (`0` means: not in group)
5667 * `minetest.get_node_group(name, group)`: returns a rating
5668 * Deprecated: An alias for the former.
5669 * `minetest.raillike_group(name)`: returns a rating
5670 * Returns rating of the connect_to_raillike group corresponding to name
5671 * If name is not yet the name of a connect_to_raillike group, a new group
5672 id is created, with that name.
5673 * `minetest.get_content_id(name)`: returns an integer
5674 * Gets the internal content ID of `name`
5675 * `minetest.get_name_from_content_id(content_id)`: returns a string
5676 * Gets the name of the content with that content ID
5677 * `minetest.parse_json(string[, nullvalue])`: returns something
5678 * Convert a string containing JSON data into the Lua equivalent
5679 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
5680 * On success returns a table, a string, a number, a boolean or `nullvalue`
5681 * On failure outputs an error message and returns `nil`
5682 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
5683 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error
5685 * Convert a Lua table into a JSON string
5686 * styled: Outputs in a human-readable format if this is set, defaults to
5688 * Unserializable things like functions and userdata will cause an error.
5689 * **Warning**: JSON is more strict than the Lua table format.
5690 1. You can only use strings and positive integers of at least one as
5692 2. You can not mix string and integer keys.
5693 This is due to the fact that JSON has two distinct array and object
5695 * Example: `write_json({10, {a = false}})`,
5696 returns `"[10, {\"a\": false}]"`
5697 * `minetest.serialize(table)`: returns a string
5698 * Convert a table containing tables, strings, numbers, booleans and `nil`s
5699 into string form readable by `minetest.deserialize`
5700 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
5701 * `minetest.deserialize(string[, safe])`: returns a table
5702 * Convert a string returned by `minetest.serialize` into a table
5703 * `string` is loaded in an empty sandbox environment.
5704 * Will load functions if safe is false or omitted. Although these functions
5705 cannot directly access the global environment, they could bypass this
5706 restriction with maliciously crafted Lua bytecode if mod security is
5708 * This function should not be used on untrusted data, regardless of the
5709 value of `safe`. It is fine to serialize then deserialize user-provided
5710 data, but directly providing user input to deserialize is always unsafe.
5711 * Example: `deserialize('return { ["foo"] = "bar" }')`,
5712 returns `{foo='bar'}`
5713 * Example: `deserialize('print("foo")')`, returns `nil`
5714 (function call fails), returns
5715 `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
5716 * `minetest.compress(data, method, ...)`: returns `compressed_data`
5717 * Compress a string of data.
5718 * `method` is a string identifying the compression method to be used.
5719 * Supported compression methods:
5720 * Deflate (zlib): `"deflate"`
5721 * `...` indicates method-specific arguments. Currently defined arguments
5723 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
5724 * `minetest.decompress(compressed_data, method, ...)`: returns data
5725 * Decompress a string of data (using ZLib).
5726 * See documentation on `minetest.compress()` for supported compression
5728 * `...` indicates method-specific arguments. Currently, no methods use this
5729 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
5730 * Each argument is a 8 Bit unsigned integer
5731 * Returns the ColorString from rgb or rgba values
5732 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
5733 * `minetest.encode_base64(string)`: returns string encoded in base64
5734 * Encodes a string in base64.
5735 * `minetest.decode_base64(string)`: returns string or nil for invalid base64
5736 * Decodes a string encoded in base64.
5737 * `minetest.is_protected(pos, name)`: returns boolean
5738 * Returning `true` restricts the player `name` from modifying (i.e. digging,
5739 placing) the node at position `pos`.
5740 * `name` will be `""` for non-players or unknown players.
5741 * This function should be overridden by protection mods. It is highly
5742 recommended to grant access to players with the `protection_bypass` privilege.
5743 * Cache and call the old version of this function if the position is
5744 not protected by the mod. This will allow using multiple protection mods.
5747 local old_is_protected = minetest.is_protected
5748 function minetest.is_protected(pos, name)
5749 if mymod:position_protected_from(pos, name) then
5752 return old_is_protected(pos, name)
5754 * `minetest.record_protection_violation(pos, name)`
5755 * This function calls functions registered with
5756 `minetest.register_on_protection_violation`.
5757 * `minetest.is_creative_enabled(name)`: returns boolean
5758 * Returning `true` means that Creative Mode is enabled for player `name`.
5759 * `name` will be `""` for non-players or if the player is unknown.
5760 * This function should be overridden by Creative Mode-related mods to
5761 implement a per-player Creative Mode.
5762 * By default, this function returns `true` if the setting
5763 `creative_mode` is `true` and `false` otherwise.
5764 * `minetest.is_area_protected(pos1, pos2, player_name, interval)`
5765 * Returns the position of the first node that `player_name` may not modify
5766 in the specified cuboid between `pos1` and `pos2`.
5767 * Returns `false` if no protections were found.
5768 * Applies `is_protected()` to a 3D lattice of points in the defined volume.
5769 The points are spaced evenly throughout the volume and have a spacing
5770 similar to, but no larger than, `interval`.
5771 * All corners and edges of the defined volume are checked.
5772 * `interval` defaults to 4.
5773 * `interval` should be carefully chosen and maximised to avoid an excessive
5774 number of points being checked.
5775 * Like `minetest.is_protected`, this function may be extended or
5776 overwritten by mods to provide a faster implementation to check the
5777 cuboid for intersections.
5778 * `minetest.rotate_and_place(itemstack, placer, pointed_thing[, infinitestacks,
5779 orient_flags, prevent_after_place])`
5780 * Attempt to predict the desired orientation of the facedir-capable node
5781 defined by `itemstack`, and place it accordingly (on-wall, on the floor,
5782 or hanging from the ceiling).
5783 * `infinitestacks`: if `true`, the itemstack is not changed. Otherwise the
5784 stacks are handled normally.
5785 * `orient_flags`: Optional table containing extra tweaks to the placement code:
5786 * `invert_wall`: if `true`, place wall-orientation on the ground and
5787 ground-orientation on the wall.
5788 * `force_wall` : if `true`, always place the node in wall orientation.
5789 * `force_ceiling`: if `true`, always place on the ceiling.
5790 * `force_floor`: if `true`, always place the node on the floor.
5791 * `force_facedir`: if `true`, forcefully reset the facedir to north
5792 when placing on the floor or ceiling.
5793 * The first four options are mutually-exclusive; the last in the list
5794 takes precedence over the first.
5795 * `prevent_after_place` is directly passed to `minetest.item_place_node`
5796 * Returns the new itemstack after placement
5797 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
5798 * calls `rotate_and_place()` with `infinitestacks` set according to the state
5799 of the creative mode setting, checks for "sneak" to set the `invert_wall`
5800 parameter and `prevent_after_place` set to `true`.
5802 * `minetest.calculate_knockback(player, hitter, time_from_last_punch,
5803 tool_capabilities, dir, distance, damage)`
5804 * Returns the amount of knockback applied on the punched player.
5805 * Arguments are equivalent to `register_on_punchplayer`, except the following:
5806 * `distance`: distance between puncher and punched player
5807 * This function can be overriden by mods that wish to modify this behaviour.
5808 * You may want to cache and call the old function to allow multiple mods to
5809 change knockback behaviour.
5811 * `minetest.forceload_block(pos[, transient])`
5812 * forceloads the position `pos`.
5813 * returns `true` if area could be forceloaded
5814 * If `transient` is `false` or absent, the forceload will be persistent
5815 (saved between server runs). If `true`, the forceload will be transient
5816 (not saved between server runs).
5818 * `minetest.forceload_free_block(pos[, transient])`
5819 * stops forceloading the position `pos`
5820 * If `transient` is `false` or absent, frees a persistent forceload.
5821 If `true`, frees a transient forceload.
5823 * `minetest.request_insecure_environment()`: returns an environment containing
5824 insecure functions if the calling mod has been listed as trusted in the
5825 `secure.trusted_mods` setting or security is disabled, otherwise returns
5827 * Only works at init time and must be called from the mod's main scope
5828 (ie: the init.lua of the mod, not from another Lua file or within a function).
5829 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE
5830 IT IN A LOCAL VARIABLE!**
5832 * `minetest.global_exists(name)`
5833 * Checks if a global variable has been set, without triggering a warning.
5838 * `minetest.env`: `EnvRef` of the server environment and world.
5839 * Any function in the minetest namespace can be called using the syntax
5840 `minetest.env:somefunction(somearguments)`
5841 instead of `minetest.somefunction(somearguments)`
5842 * Deprecated, but support is not to be dropped soon
5847 ### Registered definition tables
5849 * `minetest.registered_items`
5850 * Map of registered items, indexed by name
5851 * `minetest.registered_nodes`
5852 * Map of registered node definitions, indexed by name
5853 * `minetest.registered_craftitems`
5854 * Map of registered craft item definitions, indexed by name
5855 * `minetest.registered_tools`
5856 * Map of registered tool definitions, indexed by name
5857 * `minetest.registered_entities`
5858 * Map of registered entity prototypes, indexed by name
5859 * Values in this table may be modified directly.
5860 Note: changes to initial properties will only affect entities spawned afterwards,
5861 as they are only read when spawning.
5862 * `minetest.object_refs`
5863 * Map of object references, indexed by active object id
5864 * `minetest.luaentities`
5865 * Map of Lua entities, indexed by active object id
5866 * `minetest.registered_abms`
5867 * List of ABM definitions
5868 * `minetest.registered_lbms`
5869 * List of LBM definitions
5870 * `minetest.registered_aliases`
5871 * Map of registered aliases, indexed by name
5872 * `minetest.registered_ores`
5873 * Map of registered ore definitions, indexed by the `name` field.
5874 * If `name` is nil, the key is the object handle returned by
5875 `minetest.register_ore`.
5876 * `minetest.registered_biomes`
5877 * Map of registered biome definitions, indexed by the `name` field.
5878 * If `name` is nil, the key is the object handle returned by
5879 `minetest.register_biome`.
5880 * `minetest.registered_decorations`
5881 * Map of registered decoration definitions, indexed by the `name` field.
5882 * If `name` is nil, the key is the object handle returned by
5883 `minetest.register_decoration`.
5884 * `minetest.registered_schematics`
5885 * Map of registered schematic definitions, indexed by the `name` field.
5886 * If `name` is nil, the key is the object handle returned by
5887 `minetest.register_schematic`.
5888 * `minetest.registered_chatcommands`
5889 * Map of registered chat command definitions, indexed by name
5890 * `minetest.registered_privileges`
5891 * Map of registered privilege definitions, indexed by name
5892 * Registered privileges can be modified directly in this table.
5894 ### Registered callback tables
5896 All callbacks registered with [Global callback registration functions] are added
5897 to corresponding `minetest.registered_*` tables.
5905 Sorted alphabetically.
5910 A fast access data structure to store areas, and find areas near a given
5912 Every area has a `data` string attribute to store additional information.
5913 You can create an empty `AreaStore` by calling `AreaStore()`, or
5914 `AreaStore(type_name)`. The mod decides where to save and load AreaStore.
5915 If you chose the parameter-less constructor, a fast implementation will be
5916 automatically chosen for you.
5920 * `get_area(id, include_borders, include_data)`
5921 * Returns the area information about the specified ID.
5922 * Returned values are either of these:
5924 nil -- Area not found
5925 true -- Without `include_borders` and `include_data`
5927 min = pos, max = pos -- `include_borders == true`
5928 data = string -- `include_data == true`
5931 * `get_areas_for_pos(pos, include_borders, include_data)`
5932 * Returns all areas as table, indexed by the area ID.
5933 * Table values: see `get_area`.
5934 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`
5935 * Returns all areas that contain all nodes inside the area specified by `edge1`
5936 and `edge2` (inclusive).
5937 * `accept_overlap`: if `true`, areas are returned that have nodes in
5938 common (intersect) with the specified area.
5939 * Returns the same values as `get_areas_for_pos`.
5940 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store.
5941 * Returns the new area's ID, or nil if the insertion failed.
5942 * The (inclusive) positions `edge1` and `edge2` describe the area.
5943 * `data` is a string stored with the area.
5944 * `id` (optional): will be used as the internal area ID if it is an unique
5945 number between 0 and 2^32-2.
5946 * `reserve(count)`: reserves resources for at most `count` many contained
5948 Only needed for efficiency, and only some implementations profit.
5949 * `remove_area(id)`: removes the area with the given id from the store, returns
5951 * `set_cache_params(params)`: sets params for the included prefiltering cache.
5952 Calling invalidates the cache, so that its elements have to be newly
5954 * `params` is a table with the following fields:
5956 enabled = boolean, -- Whether to enable, default true
5957 block_radius = int, -- The radius (in nodes) of the areas the cache
5958 -- generates prefiltered lists for, minimum 16,
5960 limit = int, -- The cache size, minimum 20, default 1000
5961 * `to_string()`: Experimental. Returns area store serialized as a (binary)
5963 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to
5965 * `from_string(str)`: Experimental. Deserializes string and loads it into the
5967 Returns success and, optionally, an error message.
5968 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data
5974 An `InvRef` is a reference to an inventory.
5978 * `is_empty(listname)`: return `true` if list is empty
5979 * `get_size(listname)`: get size of a list
5980 * `set_size(listname, size)`: set size of a list
5981 * returns `false` on error (e.g. invalid `listname` or `size`)
5982 * `get_width(listname)`: get width of a list
5983 * `set_width(listname, width)`: set width of list; currently used for crafting
5984 * `get_stack(listname, i)`: get a copy of stack index `i` in list
5985 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
5986 * `get_list(listname)`: return full list
5987 * `set_list(listname, list)`: set full list (size will not change)
5988 * `get_lists()`: returns list of inventory lists
5989 * `set_lists(lists)`: sets inventory lists (size will not change)
5990 * `add_item(listname, stack)`: add item somewhere in list, returns leftover
5992 * `room_for_item(listname, stack):` returns `true` if the stack of items
5993 can be fully added to the list
5994 * `contains_item(listname, stack, [match_meta])`: returns `true` if
5995 the stack of items can be fully taken from the list.
5996 If `match_meta` is false, only the items' names are compared
5998 * `remove_item(listname, stack)`: take as many items as specified from the
5999 list, returns the items that were actually removed (as an `ItemStack`)
6000 -- note that any item metadata is ignored, so attempting to remove a specific
6001 unique item this way will likely remove the wrong one -- to do that use
6002 `set_stack` with an empty `ItemStack`.
6003 * `get_location()`: returns a location compatible to
6004 `minetest.get_inventory(location)`.
6005 * returns `{type="undefined"}` in case location is not known
6009 Detached & nodemeta inventories provide the following callbacks for move actions:
6013 The `allow_*` callbacks return how many items can be moved.
6015 * `allow_move`/`allow_metadata_inventory_move`: Moving items in the inventory
6016 * `allow_take`/`allow_metadata_inventory_take`: Taking items from the inventory
6017 * `allow_put`/`allow_metadata_inventory_put`: Putting items to the inventory
6021 The `on_*` callbacks are called after the items have been placed in the inventories.
6023 * `on_move`/`on_metadata_inventory_move`: Moving items in the inventory
6024 * `on_take`/`on_metadata_inventory_take`: Taking items from the inventory
6025 * `on_put`/`on_metadata_inventory_put`: Putting items to the inventory
6029 When a player tries to put an item to a place where another item is, the items are *swapped*.
6030 This means that all callbacks will be called twice (once for each action).
6035 An `ItemStack` is a stack of items.
6037 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
6038 an itemstring, a table or `nil`.
6042 * `is_empty()`: returns `true` if stack is empty.
6043 * `get_name()`: returns item name (e.g. `"default:stone"`).
6044 * `set_name(item_name)`: returns a boolean indicating whether the item was
6046 * `get_count()`: Returns number of items on the stack.
6047 * `set_count(count)`: returns a boolean indicating whether the item was cleared
6048 * `count`: number, unsigned 16 bit integer
6049 * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
6050 * `set_wear(wear)`: returns boolean indicating whether item was cleared
6051 * `wear`: number, unsigned 16 bit integer
6052 * `get_meta()`: returns ItemStackMetaRef. See section for more details
6053 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
6055 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
6056 * `get_description()`: returns the description shown in inventory list tooltips.
6057 * The engine uses this when showing item descriptions in tooltips.
6058 * Fields for finding the description, in order:
6059 * `description` in item metadata (See [Item Metadata].)
6060 * `description` in item definition
6062 * `get_short_description()`: returns the short description or nil.
6063 * Unlike the description, this does not include new lines.
6064 * Fields for finding the short description, in order:
6065 * `short_description` in item metadata (See [Item Metadata].)
6066 * `short_description` in item definition
6067 * first line of the description (From item meta or def, see `get_description()`.)
6068 * Returns nil if none of the above are set
6069 * `clear()`: removes all items from the stack, making it empty.
6070 * `replace(item)`: replace the contents of this stack.
6071 * `item` can also be an itemstring or table.
6072 * `to_string()`: returns the stack in itemstring form.
6073 * `to_table()`: returns the stack in Lua table form.
6074 * `get_stack_max()`: returns the maximum size of the stack (depends on the
6076 * `get_free_space()`: returns `get_stack_max() - get_count()`.
6077 * `is_known()`: returns `true` if the item name refers to a defined item type.
6078 * `get_definition()`: returns the item definition table.
6079 * `get_tool_capabilities()`: returns the digging properties of the item,
6080 or those of the hand if none are defined for this item type
6081 * `add_wear(amount)`
6082 * Increases wear by `amount` if the item is a tool
6083 * `amount`: number, integer
6084 * `add_item(item)`: returns leftover `ItemStack`
6085 * Put some item or stack onto this stack
6086 * `item_fits(item)`: returns `true` if item or stack can be fully added to
6088 * `take_item(n)`: returns taken `ItemStack`
6089 * Take (and remove) up to `n` items from this stack
6090 * `n`: number, default: `1`
6091 * `peek_item(n)`: returns taken `ItemStack`
6092 * Copy (don't remove) up to `n` items from this stack
6093 * `n`: number, default: `1`
6098 ItemStack metadata: reference extra data and functionality stored in a stack.
6099 Can be obtained via `item:get_meta()`.
6103 * All methods in MetaDataRef
6104 * `set_tool_capabilities([tool_capabilities])`
6105 * Overrides the item's tool capabilities
6106 * A nil value will clear the override data and restore the original
6112 Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],
6113 and [`PlayerMetaRef`].
6117 * `contains(key)`: Returns true if key present, otherwise false.
6118 * Returns `nil` when the MetaData is inexistent.
6119 * `get(key)`: Returns `nil` if key not present, else the stored string.
6120 * `set_string(key, value)`: Value of `""` will delete the key.
6121 * `get_string(key)`: Returns `""` if key not present.
6122 * `set_int(key, value)`
6123 * `get_int(key)`: Returns `0` if key not present.
6124 * `set_float(key, value)`
6125 * `get_float(key)`: Returns `0` if key not present.
6126 * `to_table()`: returns `nil` or a table with keys:
6127 * `fields`: key-value storage
6128 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
6129 * `from_table(nil or {})`
6130 * Any non-table value will clear the metadata
6131 * See [Node Metadata] for an example
6132 * returns `true` on success
6134 * returns `true` if this metadata has the same key-value pairs as `other`
6139 An interface to use mod channels on client and server
6143 * `leave()`: leave the mod channel.
6144 * Server leaves channel `channel_name`.
6145 * No more incoming or outgoing messages can be sent to this channel from
6147 * This invalidate all future object usage.
6148 * Ensure you set mod_channel to nil after that to free Lua resources.
6149 * `is_writeable()`: returns true if channel is writeable and mod can send over
6151 * `send_all(message)`: Send `message` though the mod channel.
6152 * If mod channel is not writeable or invalid, message will be dropped.
6153 * Message size is limited to 65535 characters by protocol.
6158 Node metadata: reference extra data and functionality stored in a node.
6159 Can be obtained via `minetest.get_meta(pos)`.
6163 * All methods in MetaDataRef
6164 * `get_inventory()`: returns `InvRef`
6165 * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
6166 This will prevent them from being sent to the client. Note that the "private"
6167 status will only be remembered if an associated key-value pair exists,
6168 meaning it's best to call this when initializing all other meta (e.g.
6174 Node Timers: a high resolution persistent per-node timer.
6175 Can be gotten via `minetest.get_node_timer(pos)`.
6179 * `set(timeout,elapsed)`
6180 * set a timer's state
6181 * `timeout` is in seconds, and supports fractional values (0.1 etc)
6182 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
6183 * will trigger the node's `on_timer` function after `(timeout - elapsed)`
6187 * equivalent to `set(timeout,0)`
6190 * `get_timeout()`: returns current timeout in seconds
6191 * if `timeout` equals `0`, timer is inactive
6192 * `get_elapsed()`: returns current elapsed time in seconds
6193 * the node's `on_timer` function will be called after `(timeout - elapsed)`
6195 * `is_started()`: returns boolean state of timer
6196 * returns `true` if timer is started, otherwise `false`
6201 Moving things in the game are generally these.
6202 This is basically a reference to a C++ `ServerActiveObject`.
6204 ### Advice on handling `ObjectRefs`
6206 When you receive an `ObjectRef` as a callback argument or from another API
6207 function, it is possible to store the reference somewhere and keep it around.
6208 It will keep functioning until the object is unloaded or removed.
6210 However, doing this is **NOT** recommended as there is (intentionally) no method
6211 to test if a previously acquired `ObjectRef` is still valid.
6212 Instead, `ObjectRefs` should be "let go" of as soon as control is returned from
6213 Lua back to the engine.
6214 Doing so is much less error-prone and you will never need to wonder if the
6215 object you are working with still exists.
6220 * `get_pos()`: returns `{x=num, y=num, z=num}`
6221 * `set_pos(pos)`: `pos`=`{x=num, y=num, z=num}`
6222 * `get_velocity()`: returns the velocity, a vector.
6223 * `add_velocity(vel)`
6224 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
6225 * In comparison to using get_velocity, adding the velocity and then using
6226 set_velocity, add_velocity is supposed to avoid synchronization problems.
6227 Additionally, players also do not support set_velocity.
6229 * Does not apply during free_move.
6230 * Note that since the player speed is normalized at each move step,
6231 increasing e.g. Y velocity beyond what would usually be achieved
6232 (see: physics overrides) will cause existing X/Z velocity to be reduced.
6233 * Example: `add_velocity({x=0, y=6.5, z=0})` is equivalent to
6234 pressing the jump key (assuming default settings)
6235 * `move_to(pos, continuous=false)`
6236 * Does an interpolated move for Lua entities for visually smooth transitions.
6237 * If `continuous` is true, the Lua entity will not be moved to the current
6238 position before starting the interpolated move.
6239 * For players this does the same as `set_pos`,`continuous` is ignored.
6240 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
6241 * `puncher` = another `ObjectRef`,
6242 * `time_from_last_punch` = time since last punch action of the puncher
6243 * `direction`: can be `nil`
6244 * `right_click(clicker)`; `clicker` is another `ObjectRef`
6245 * `get_hp()`: returns number of health points
6246 * `set_hp(hp, reason)`: set number of health points
6247 * See reason in register_on_player_hpchange
6248 * Is limited to the range of 0 ... 65535 (2^16 - 1)
6249 * For players: HP are also limited by `hp_max` specified in the player's
6251 * `get_inventory()`: returns an `InvRef` for players, otherwise returns `nil`
6252 * `get_wield_list()`: returns the name of the inventory list the wielded item
6254 * `get_wield_index()`: returns the index of the wielded item
6255 * `get_wielded_item()`: returns an `ItemStack`
6256 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if
6258 * `set_armor_groups({group1=rating, group2=rating, ...})`
6259 * `get_armor_groups()`: returns a table with the armor group ratings
6260 * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
6261 * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
6262 * `frame_speed`: number, default: `15.0`
6263 * `frame_blend`: number, default: `0.0`
6264 * `frame_loop`: boolean, default: `true`
6265 * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and
6267 * `set_animation_frame_speed(frame_speed)`
6268 * `frame_speed`: number, default: `15.0`
6269 * `set_attach(parent[, bone, position, rotation, forced_visible])`
6270 * `bone`: string. Default is `""`, the root bone
6271 * `position`: `{x=num, y=num, z=num}`, relative, default `{x=0, y=0, z=0}`
6272 * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees.
6273 Default `{x=0, y=0, z=0}`
6274 * `forced_visible`: Boolean to control whether the attached entity
6275 should appear in first person. Default `false`.
6276 * `get_attach()`: returns parent, bone, position, rotation, forced_visible,
6277 or nil if it isn't attached.
6278 * `get_children()`: returns a list of ObjectRefs that are attached to the
6281 * `set_bone_position([bone, position, rotation])`
6282 * `bone`: string. Default is `""`, the root bone
6283 * `position`: `{x=num, y=num, z=num}`, relative, `default {x=0, y=0, z=0}`
6284 * `rotation`: `{x=num, y=num, z=num}`, default `{x=0, y=0, z=0}`
6285 * `get_bone_position(bone)`: returns position and rotation of the bone
6286 * `set_properties(object property table)`
6287 * `get_properties()`: returns object property table
6288 * `is_player()`: returns true for players, false otherwise
6289 * `get_nametag_attributes()`
6290 * returns a table with the attributes of the nametag of an object
6293 color = {a=0..255, r=0..255, g=0..255, b=0..255},
6294 bgcolor = {a=0..255, r=0..255, g=0..255, b=0..255},
6296 * `set_nametag_attributes(attributes)`
6297 * sets the attributes of the nametag of an object
6300 text = "My Nametag",
6303 bgcolor = ColorSpec or false,
6304 -- ^ Sets background color of nametag
6305 -- `false` will cause the background to be set automatically based on user settings
6309 #### Lua entity only (no-op for other objects)
6311 * `remove()`: remove object
6312 * The object is removed after returning from Lua. However the `ObjectRef`
6313 itself instantly becomes unusable with all further method calls having
6314 no effect and returning `nil`.
6315 * `set_velocity(vel)`
6316 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
6317 * `set_acceleration(acc)`
6319 * `get_acceleration()`: returns the acceleration, a vector
6320 * `set_rotation(rot)`
6321 * `rot` is a vector (radians). X is pitch (elevation), Y is yaw (heading)
6322 and Z is roll (bank).
6323 * `get_rotation()`: returns the rotation, a vector (radians)
6324 * `set_yaw(yaw)`: sets the yaw in radians (heading).
6325 * `get_yaw()`: returns number in radians
6326 * `set_texture_mod(mod)`
6327 * Set a texture modifier to the base texture, for sprites and meshes.
6328 * When calling `set_texture_mod` again, the previous one is discarded.
6329 * `mod` the texture modifier. See [Texture modifiers].
6330 * `get_texture_mod()` returns current texture modifier
6331 * `set_sprite(start_frame, num_frames, framelength, select_x_by_camera)`
6332 * Specifies and starts a sprite animation
6333 * Animations iterate along the frame `y` position.
6334 * `start_frame`: {x=column number, y=row number}, the coordinate of the
6335 first frame, default: `{x=0, y=0}`
6336 * `num_frames`: Total frames in the texture, default: `1`
6337 * `framelength`: Time per animated frame in seconds, default: `0.2`
6338 * `select_x_by_camera`: Only for visual = `sprite`. Changes the frame `x`
6339 position according to the view direction. default: `false`.
6340 * First column: subject facing the camera
6341 * Second column: subject looking to the left
6342 * Third column: subject backing the camera
6343 * Fourth column: subject looking to the right
6344 * Fifth column: subject viewed from above
6345 * Sixth column: subject viewed from below
6346 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
6349 #### Player only (no-op for other objects)
6351 * `get_player_name()`: returns `""` if is not a player
6352 * `get_player_velocity()`: **DEPRECATED**, use get_velocity() instead.
6353 table {x, y, z} representing the player's instantaneous velocity in nodes/s
6354 * `add_player_velocity(vel)`: **DEPRECATED**, use add_velocity(vel) instead.
6355 * `get_look_dir()`: get camera direction as a unit vector
6356 * `get_look_vertical()`: pitch in radians
6357 * Angle ranges between -pi/2 and pi/2, which are straight up and down
6359 * `get_look_horizontal()`: yaw in radians
6360 * Angle is counter-clockwise from the +z direction.
6361 * `set_look_vertical(radians)`: sets look pitch
6362 * radians: Angle from looking forward, where positive is downwards.
6363 * `set_look_horizontal(radians)`: sets look yaw
6364 * radians: Angle from the +z direction, where positive is counter-clockwise.
6365 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use
6366 `get_look_vertical`.
6367 * Angle ranges between -pi/2 and pi/2, which are straight down and up
6369 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use
6370 `get_look_horizontal`.
6371 * Angle is counter-clockwise from the +x direction.
6372 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use
6373 `set_look_vertical`.
6374 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use
6375 `set_look_horizontal`.
6376 * `get_breath()`: returns player's breath
6377 * `set_breath(value)`: sets player's breath
6379 * `0`: player is drowning
6380 * max: bubbles bar is not shown
6381 * See [Object properties] for more information
6382 * Is limited to range 0 ... 65535 (2^16 - 1)
6383 * `set_fov(fov, is_multiplier, transition_time)`: Sets player's FOV
6385 * `is_multiplier`: Set to `true` if the FOV value is a multiplier.
6386 Defaults to `false`.
6387 * `transition_time`: If defined, enables smooth FOV transition.
6388 Interpreted as the time (in seconds) to reach target FOV.
6389 If set to 0, FOV change is instantaneous. Defaults to 0.
6390 * Set `fov` to 0 to clear FOV override.
6391 * `get_fov()`: Returns the following:
6392 * Server-sent FOV value. Returns 0 if an FOV override doesn't exist.
6393 * Boolean indicating whether the FOV value is a multiplier.
6394 * Time (in seconds) taken for the FOV transition. Set by `set_fov`.
6395 * `set_attribute(attribute, value)`: DEPRECATED, use get_meta() instead
6396 * Sets an extra attribute with value on player.
6397 * `value` must be a string, or a number which will be converted to a
6399 * If `value` is `nil`, remove attribute from player.
6400 * `get_attribute(attribute)`: DEPRECATED, use get_meta() instead
6401 * Returns value (a string) for extra attribute.
6402 * Returns `nil` if no attribute found.
6403 * `get_meta()`: Returns a PlayerMetaRef.
6404 * `set_inventory_formspec(formspec)`
6405 * Redefine player's inventory form
6406 * Should usually be called in `on_joinplayer`
6407 * `get_inventory_formspec()`: returns a formspec string
6408 * `set_formspec_prepend(formspec)`:
6409 * the formspec string will be added to every formspec shown to the user,
6410 except for those with a no_prepend[] tag.
6411 * This should be used to set style elements such as background[] and
6412 bgcolor[], any non-style elements (eg: label) may result in weird behaviour.
6413 * Only affects formspecs shown after this is called.
6414 * `get_formspec_prepend(formspec)`: returns a formspec string.
6415 * `get_player_control()`: returns table with player pressed keys
6416 * The table consists of fields with the following boolean values
6417 representing the pressed keys: `up`, `down`, `left`, `right`, `jump`,
6418 `aux1`, `sneak`, `dig`, `place`, `LMB`, `RMB`, and `zoom`.
6419 * The fields `LMB` and `RMB` are equal to `dig` and `place` respectively,
6420 and exist only to preserve backwards compatibility.
6421 * `get_player_control_bits()`: returns integer with bit packed player pressed
6433 * `set_physics_override(override_table)`
6434 * `override_table` is a table with the following fields:
6435 * `speed`: multiplier to default walking speed value (default: `1`)
6436 * `jump`: multiplier to default jump value (default: `1`)
6437 * `gravity`: multiplier to default gravity value (default: `1`)
6438 * `sneak`: whether player can sneak (default: `true`)
6439 * `sneak_glitch`: whether player can use the new move code replications
6440 of the old sneak side-effects: sneak ladders and 2 node sneak jump
6442 * `new_move`: use new move/sneak code. When `false` the exact old code
6443 is used for the specific old sneak behaviour (default: `true`)
6444 * `get_physics_override()`: returns the table given to `set_physics_override`
6445 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
6447 * `hud_remove(id)`: remove the HUD element of the specified id
6448 * `hud_change(id, stat, value)`: change a value of a previously added HUD
6450 * element `stat` values:
6451 `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
6452 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
6453 * `hud_set_flags(flags)`: sets specified HUD flags of player.
6454 * `flags`: A table with the following fields set to boolean values
6462 * If a flag equals `nil`, the flag is not modified
6463 * `minimap`: Modifies the client's permission to view the minimap.
6464 The client may locally elect to not view the minimap.
6465 * `minimap_radar` is only usable when `minimap` is true
6466 * `hud_get_flags()`: returns a table of player HUD flags with boolean values.
6467 * See `hud_set_flags` for a list of flags that can be toggled.
6468 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
6469 * `count`: number of items, must be between `1` and `32`
6470 * `hud_get_hotbar_itemcount`: returns number of visible items
6471 * `hud_set_hotbar_image(texturename)`
6472 * sets background image for hotbar
6473 * `hud_get_hotbar_image`: returns texturename
6474 * `hud_set_hotbar_selected_image(texturename)`
6475 * sets image for selected item of hotbar
6476 * `hud_get_hotbar_selected_image`: returns texturename
6477 * `set_minimap_modes({mode, mode, ...}, selected_mode)`
6478 * Overrides the available minimap modes (and toggle order), and changes the
6480 * `mode` is a table consisting of up to four fields:
6481 * `type`: Available type:
6482 * `off`: Minimap off
6483 * `surface`: Minimap in surface mode
6484 * `radar`: Minimap in radar mode
6485 * `texture`: Texture to be displayed instead of terrain map
6486 (texture is centered around 0,0 and can be scaled).
6487 Texture size is limited to 512 x 512 pixel.
6488 * `label`: Optional label to display on minimap mode toggle
6489 The translation must be handled within the mod.
6490 * `size`: Sidelength or diameter, in number of nodes, of the terrain
6491 displayed in minimap
6492 * `texture`: Only for texture type, name of the texture to display
6493 * `scale`: Only for texture type, scale of the texture map in nodes per
6494 pixel (for example a `scale` of 2 means each pixel represents a 2x2
6496 * `selected_mode` is the mode index to be selected after modes have been changed
6497 (0 is the first mode).
6498 * `set_sky(sky_parameters)`
6499 * The presence of the function `set_sun`, `set_moon` or `set_stars` indicates
6500 whether `set_sky` accepts this format. Check the legacy format otherwise.
6501 * `sky_parameters` is a table with the following optional fields:
6502 * `base_color`: ColorSpec, changes fog in "skybox" and "plain".
6503 * `type`: Available types:
6504 * `"regular"`: Uses 0 textures, `base_color` ignored
6505 * `"skybox"`: Uses 6 textures, `base_color` used as fog.
6506 * `"plain"`: Uses 0 textures, `base_color` used as both fog and sky.
6507 * `textures`: A table containing up to six textures in the following
6508 order: Y+ (top), Y- (bottom), X- (west), X+ (east), Z+ (north), Z- (south).
6509 * `clouds`: Boolean for whether clouds appear. (default: `true`)
6510 * `sky_color`: A table containing the following values, alpha is ignored:
6511 * `day_sky`: ColorSpec, for the top half of the `"regular"`
6512 sky during the day. (default: `#8cbafa`)
6513 * `day_horizon`: ColorSpec, for the bottom half of the
6514 `"regular"` sky during the day. (default: `#9bc1f0`)
6515 * `dawn_sky`: ColorSpec, for the top half of the `"regular"`
6516 sky during dawn/sunset. (default: `#b4bafa`)
6517 The resulting sky color will be a darkened version of the ColorSpec.
6518 Warning: The darkening of the ColorSpec is subject to change.
6519 * `dawn_horizon`: ColorSpec, for the bottom half of the `"regular"`
6520 sky during dawn/sunset. (default: `#bac1f0`)
6521 The resulting sky color will be a darkened version of the ColorSpec.
6522 Warning: The darkening of the ColorSpec is subject to change.
6523 * `night_sky`: ColorSpec, for the top half of the `"regular"`
6524 sky during the night. (default: `#006aff`)
6525 The resulting sky color will be a dark version of the ColorSpec.
6526 Warning: The darkening of the ColorSpec is subject to change.
6527 * `night_horizon`: ColorSpec, for the bottom half of the `"regular"`
6528 sky during the night. (default: `#4090ff`)
6529 The resulting sky color will be a dark version of the ColorSpec.
6530 Warning: The darkening of the ColorSpec is subject to change.
6531 * `indoors`: ColorSpec, for when you're either indoors or
6532 underground. Only applies to the `"regular"` sky.
6533 (default: `#646464`)
6534 * `fog_sun_tint`: ColorSpec, changes the fog tinting for the sun
6535 at sunrise and sunset.
6536 * `fog_moon_tint`: ColorSpec, changes the fog tinting for the moon
6537 at sunrise and sunset.
6538 * `fog_tint_type`: string, changes which mode the directional fog
6539 abides by, `"custom"` uses `sun_tint` and `moon_tint`, while
6540 `"default"` uses the classic Minetest sun and moon tinting.
6541 Will use tonemaps, if set to `"default"`. (default: `"default"`)
6542 * `set_sky(base_color, type, {texture names}, clouds)`
6543 * Deprecated. Use `set_sky(sky_parameters)`
6544 * `base_color`: ColorSpec, defaults to white
6545 * `type`: Available types:
6546 * `"regular"`: Uses 0 textures, `bgcolor` ignored
6547 * `"skybox"`: Uses 6 textures, `bgcolor` used
6548 * `"plain"`: Uses 0 textures, `bgcolor` used
6549 * `clouds`: Boolean for whether clouds appear in front of `"skybox"` or
6550 `"plain"` custom skyboxes (default: `true`)
6551 * `get_sky()`: returns base_color, type, table of textures, clouds.
6552 * `get_sky_color()`: returns a table with the `sky_color` parameters as in
6554 * `set_sun(sun_parameters)`:
6555 * `sun_parameters` is a table with the following optional fields:
6556 * `visible`: Boolean for whether the sun is visible.
6558 * `texture`: A regular texture for the sun. Setting to `""`
6559 will re-enable the mesh sun. (default: `"sun.png"`)
6560 * `tonemap`: A 512x1 texture containing the tonemap for the sun
6561 (default: `"sun_tonemap.png"`)
6562 * `sunrise`: A regular texture for the sunrise texture.
6563 (default: `"sunrisebg.png"`)
6564 * `sunrise_visible`: Boolean for whether the sunrise texture is visible.
6566 * `scale`: Float controlling the overall size of the sun. (default: `1`)
6567 * `get_sun()`: returns a table with the current sun parameters as in
6569 * `set_moon(moon_parameters)`:
6570 * `moon_parameters` is a table with the following optional fields:
6571 * `visible`: Boolean for whether the moon is visible.
6573 * `texture`: A regular texture for the moon. Setting to `""`
6574 will re-enable the mesh moon. (default: `"moon.png"`)
6575 * `tonemap`: A 512x1 texture containing the tonemap for the moon
6576 (default: `"moon_tonemap.png"`)
6577 * `scale`: Float controlling the overall size of the moon (default: `1`)
6578 * `get_moon()`: returns a table with the current moon parameters as in
6580 * `set_stars(star_parameters)`:
6581 * `star_parameters` is a table with the following optional fields:
6582 * `visible`: Boolean for whether the stars are visible.
6584 * `count`: Integer number to set the number of stars in
6585 the skybox. Only applies to `"skybox"` and `"regular"` sky types.
6587 * `star_color`: ColorSpec, sets the colors of the stars,
6588 alpha channel is used to set overall star brightness.
6589 (default: `#ebebff69`)
6590 * `scale`: Float controlling the overall size of the stars (default: `1`)
6591 * `get_stars()`: returns a table with the current stars parameters as in
6593 * `set_clouds(cloud_parameters)`: set cloud parameters
6594 * `cloud_parameters` is a table with the following optional fields:
6595 * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
6596 * `color`: basic cloud color with alpha channel, ColorSpec
6597 (default `#fff0f0e5`).
6598 * `ambient`: cloud color lower bound, use for a "glow at night" effect.
6599 ColorSpec (alpha ignored, default `#000000`)
6600 * `height`: cloud height, i.e. y of cloud base (default per conf,
6602 * `thickness`: cloud thickness in nodes (default `16`)
6603 * `speed`: 2D cloud speed + direction in nodes per second
6604 (default `{x=0, z=-2}`).
6605 * `get_clouds()`: returns a table with the current cloud parameters as in
6607 * `override_day_night_ratio(ratio or nil)`
6608 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific
6610 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
6611 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
6612 * `set_local_animation(idle, walk, dig, walk_while_dig, frame_speed)`:
6613 set animation for player model in third person view.
6614 * Every animation equals to a `{x=starting frame, y=ending frame}` table.
6615 * `frame_speed` sets the animations frame speed. Default is 30.
6616 * `get_local_animation()`: returns idle, walk, dig, walk_while_dig tables and
6618 * `set_eye_offset([firstperson, thirdperson])`: defines offset vectors for
6619 camera per player. An argument defaults to `{x=0, y=0, z=0}` if unspecified.
6620 * in first person view
6621 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
6622 * `get_eye_offset()`: returns first and third person offsets.
6623 * `send_mapblock(blockpos)`:
6624 * Sends a server-side loaded mapblock to the player.
6625 * Returns `false` if failed.
6626 * Resource intensive - use sparsely
6627 * To get blockpos, integer divide pos by 16
6632 A 32-bit pseudorandom number generator.
6633 Uses PCG32, an algorithm of the permuted congruential generator family,
6634 offering very strong randomness.
6636 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
6640 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
6641 * `next(min, max)`: return next integer random number [`min`...`max`]
6642 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed
6643 random number [`min`...`max`].
6644 * This is only a rough approximation of a normal distribution with:
6645 * `mean = (max - min) / 2`, and
6646 * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
6647 * Increasing `num_trials` improves accuracy of the approximation
6652 A perlin noise generator.
6653 It can be created via `PerlinNoise()` or `minetest.get_perlin()`.
6654 For `minetest.get_perlin()`, the actual seed used is the noiseparams seed
6655 plus the world seed, to create world-specific noise.
6657 `PerlinNoise(noiseparams)`
6658 `PerlinNoise(seed, octaves, persistence, spread)` (Deprecated).
6660 `minetest.get_perlin(noiseparams)`
6661 `minetest.get_perlin(seeddiff, octaves, persistence, spread)` (Deprecated).
6665 * `get_2d(pos)`: returns 2D noise value at `pos={x=,y=}`
6666 * `get_3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
6671 A fast, bulk perlin noise generator.
6673 It can be created via `PerlinNoiseMap(noiseparams, size)` or
6674 `minetest.get_perlin_map(noiseparams, size)`.
6675 For `minetest.get_perlin_map()`, the actual seed used is the noiseparams seed
6676 plus the world seed, to create world-specific noise.
6678 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
6679 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
6682 For each of the functions with an optional `buffer` parameter: If `buffer` is
6683 not nil, this table will be used to store the result instead of creating a new
6688 * `get_2d_map(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
6689 with values starting at `pos={x=,y=}`
6690 * `get_3d_map(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>`
6691 3D array of 3D noise with values starting at `pos={x=,y=,z=}`.
6692 * `get_2d_map_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element
6693 array of 2D noise with values starting at `pos={x=,y=}`
6694 * `get_3d_map_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
6695 * `calc_2d_map(pos)`: Calculates the 2d noise map starting at `pos`. The result
6696 is stored internally.
6697 * `calc_3d_map(pos)`: Calculates the 3d noise map starting at `pos`. The result
6698 is stored internally.
6699 * `get_map_slice(slice_offset, slice_size, buffer)`: In the form of an array,
6700 returns a slice of the most recently computed noise results. The result slice
6701 begins at coordinates `slice_offset` and takes a chunk of `slice_size`.
6702 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer
6704 `noisevals = noise:get_map_slice({y=20}, {y=2})`
6705 It is important to note that `slice_offset` offset coordinates begin at 1,
6706 and are relative to the starting position of the most recently calculated
6708 To grab a single vertical column of noise starting at map coordinates
6709 x = 1023, y=1000, z = 1000:
6710 `noise:calc_3d_map({x=1000, y=1000, z=1000})`
6711 `noisevals = noise:get_map_slice({x=24, z=1}, {x=1, z=1})`
6717 Uses the same method of storage as the deprecated player attribute API, so
6718 data there will also be in player meta.
6719 Can be obtained using `player:get_meta()`.
6723 * All methods in MetaDataRef
6728 A 16-bit pseudorandom number generator.
6729 Uses a well-known LCG algorithm introduced by K&R.
6731 It can be created via `PseudoRandom(seed)`.
6735 * `next()`: return next integer random number [`0`...`32767`]
6736 * `next(min, max)`: return next integer random number [`min`...`max`]
6737 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
6738 due to the simple implementation making bad distribution otherwise.
6743 A raycast on the map. It works with selection boxes.
6744 Can be used as an iterator in a for loop as:
6746 local ray = Raycast(...)
6747 for pointed_thing in ray do
6751 The map is loaded as the ray advances. If the map is modified after the
6752 `Raycast` is created, the changes may or may not have an effect on the object.
6754 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
6755 `minetest.raycast(pos1, pos2, objects, liquids)` where:
6757 * `pos1`: start of the ray
6758 * `pos2`: end of the ray
6759 * `objects`: if false, only nodes will be returned. Default is true.
6760 * `liquids`: if false, liquid nodes won't be returned. Default is false.
6764 * `next()`: returns a `pointed_thing` with exact pointing location
6765 * Returns the next thing pointed by the ray or nil.
6770 Interface for the operating system's crypto-secure PRNG.
6772 It can be created via `SecureRandom()`. The constructor returns nil if a
6773 secure random device cannot be found on the system.
6777 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many
6778 random bytes, as a string.
6783 An interface to read config files in the format of `minetest.conf`.
6785 It can be created via `Settings(filename)`.
6789 * `get(key)`: returns a value
6790 * `get_bool(key, [default])`: returns a boolean
6791 * `default` is the value returned if `key` is not found.
6792 * Returns `nil` if `key` is not found and `default` not specified.
6793 * `get_np_group(key)`: returns a NoiseParams table
6795 * Returns `{flag = true/false, ...}` according to the set flags.
6796 * Is currently limited to mapgen flags `mg_flags` and mapgen-specific
6797 flags like `mgv5_spflags`.
6799 * Setting names can't contain whitespace or any of `="{}#`.
6800 * Setting values can't contain the sequence `\n"""`.
6801 * Setting names starting with "secure." can't be set on the main settings
6802 object (`minetest.settings`).
6803 * `set_bool(key, value)`
6804 * See documentation for set() above.
6805 * `set_np_group(key, value)`
6806 * `value` is a NoiseParams table.
6807 * Also, see documentation for set() above.
6808 * `remove(key)`: returns a boolean (`true` for success)
6809 * `get_names()`: returns `{key1,...}`
6810 * `write()`: returns a boolean (`true` for success)
6811 * Writes changes to file.
6812 * `to_table()`: returns `{[key1]=value1,...}`
6816 The settings have the format `key = value`. Example:
6828 Mod metadata: per mod metadata, saved automatically.
6829 Can be obtained via `minetest.get_mod_storage()` during load time.
6831 WARNING: This storage backend is incaptable to save raw binary data due
6832 to restrictions of JSON.
6836 * All methods in MetaDataRef
6847 Used by `ObjectRef` methods. Part of an Entity definition.
6848 These properties are not persistent, but are applied automatically to the
6849 corresponding Lua entity using the given registration fields.
6850 Player properties need to be saved manually.
6854 -- For players only. Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`.
6857 -- For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`.
6860 -- For players only. Zoom FOV in degrees.
6861 -- Note that zoom loads and/or generates world beyond the server's
6862 -- maximum send and generate distances, so acts like a telescope.
6863 -- Smaller zoom_fov values increase the distance loaded/generated.
6864 -- Defaults to 15 in creative mode, 0 in survival mode.
6865 -- zoom_fov = 0 disables zooming for the player.
6868 -- For players only. Camera height above feet position in nodes.
6869 -- Defaults to 1.625.
6872 -- Collide with `walkable` nodes.
6874 collide_with_objects = true,
6875 -- Collide with other objects if physical = true
6877 collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5}, -- Default
6878 selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
6879 -- Selection box uses collision box dimensions when not set.
6880 -- For both boxes: {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from
6884 -- Overrides selection box when false
6886 visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem" / "item",
6887 -- "cube" is a node-sized cube.
6888 -- "sprite" is a flat texture always facing the player.
6889 -- "upright_sprite" is a vertical flat texture.
6890 -- "mesh" uses the defined mesh model.
6891 -- "wielditem" is used for dropped items.
6892 -- (see builtin/game/item_entity.lua).
6893 -- For this use 'wield_item = itemname' (Deprecated: 'textures = {itemname}').
6894 -- If the item has a 'wield_image' the object will be an extrusion of
6896 -- If 'itemname' is a cubic node or nodebox the object will appear
6897 -- identical to 'itemname'.
6898 -- If 'itemname' is a plantlike node the object will be an extrusion
6900 -- Otherwise for non-node items, the object will be an extrusion of
6901 -- 'inventory_image'.
6902 -- If 'itemname' contains a ColorString or palette index (e.g. from
6903 -- `minetest.itemstring_with_palette()`), the entity will inherit the color.
6904 -- "item" is similar to "wielditem" but ignores the 'wield_image' parameter.
6906 visual_size = {x = 1, y = 1, z = 1},
6907 -- Multipliers for the visual size. If `z` is not specified, `x` will be used
6908 -- to scale the entity along both horizontal axes.
6911 -- File name of mesh when using "mesh" visual
6914 -- Number of required textures depends on visual.
6915 -- "cube" uses 6 textures just like a node, but all 6 must be defined.
6916 -- "sprite" uses 1 texture.
6917 -- "upright_sprite" uses 2 textures: {front, back}.
6918 -- "wielditem" expects 'textures = {itemname}' (see 'visual' above).
6921 -- Number of required colors depends on visual
6923 use_texture_alpha = false,
6924 -- Use texture's alpha channel.
6925 -- Excludes "upright_sprite" and "wielditem".
6926 -- Note: currently causes visual issues when viewed through other
6927 -- semi-transparent materials such as water.
6929 spritediv = {x = 1, y = 1},
6930 -- Used with spritesheet textures for animation and/or frame selection
6931 -- according to position relative to player.
6932 -- Defines the number of columns and rows in the spritesheet:
6935 initial_sprite_basepos = {x = 0, y = 0},
6936 -- Used with spritesheet textures.
6937 -- Defines the {column, row} position of the initially used frame in the
6941 -- If false, object is invisible and can't be pointed.
6943 makes_footstep_sound = false,
6944 -- If true, is able to make footstep sounds of nodes
6945 -- (see node sound definition for details).
6947 automatic_rotate = 0,
6948 -- Set constant rotation in radians per second, positive or negative.
6949 -- Object rotates along the local Y-axis, and works with set_rotation.
6950 -- Set to 0 to disable constant rotation.
6953 -- If positive number, object will climb upwards when it moves
6954 -- horizontally against a `walkable` node, if the height difference
6955 -- is within `stepheight`.
6957 automatic_face_movement_dir = 0.0,
6958 -- Automatically set yaw to movement direction, offset in degrees.
6959 -- 'false' to disable.
6961 automatic_face_movement_max_rotation_per_sec = -1,
6962 -- Limit automatic rotation to this value in degrees per second.
6963 -- No limit if value <= 0.
6965 backface_culling = true,
6966 -- Set to false to disable backface_culling for model
6969 -- Add this much extra lighting when calculating texture color.
6970 -- Value < 0 disables light's effect on texture color.
6971 -- For faking self-lighting, UI style entities, or programmatic coloring
6975 -- The name to display on the head of the object. By default empty.
6976 -- If the object is a player, a nil or empty nametag is replaced by the player's name.
6977 -- For all other objects, a nil or empty string removes the nametag.
6978 -- To hide a nametag, set its color alpha to zero. That will disable it entirely.
6980 nametag_color = <ColorSpec>,
6981 -- Sets text color of nametag
6983 nametag_bgcolor = <ColorSpec>,
6984 -- Sets background color of nametag
6985 -- `false` will cause the background to be set automatically based on user settings.
6989 -- By default empty, text to be shown when pointed at object
6992 -- If false, never save this object statically. It will simply be
6993 -- deleted when the block gets unloaded.
6994 -- The get_staticdata() callback is never called then.
6995 -- Defaults to 'true'.
6997 damage_texture_modifier = "^[brighten",
6998 -- Texture modifier to be applied for a short duration when object is hit
7001 -- Setting this to 'false' disables diffuse lighting of entity
7003 show_on_minimap = false,
7004 -- Defaults to true for players, false for other entities.
7005 -- If set to true the entity will show as a marker on the minimap.
7011 Used by `minetest.register_entity`.
7014 initial_properties = {
7016 mesh = "boats_boat.obj",
7019 -- A table of object properties, see the `Object properties` section.
7020 -- Object properties being read directly from the entity definition
7021 -- table is deprecated. Define object properties in this
7022 -- `initial_properties` table instead.
7024 on_activate = function(self, staticdata, dtime_s),
7026 on_step = function(self, dtime, moveresult),
7027 -- Called every server step
7028 -- dtime: Elapsed time
7029 -- moveresult: Table with collision info (only available if physical=true)
7031 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
7033 on_rightclick = function(self, clicker),
7035 get_staticdata = function(self),
7036 -- Called sometimes; the string returned is passed to on_activate when
7037 -- the entity is re-activated from static state
7039 _custom_field = whatever,
7040 -- You can define arbitrary member variables here (see Item definition
7041 -- for more info) by using a '_' prefix
7044 Collision info passed to `on_step`:
7047 touching_ground = boolean,
7049 standing_on_object = boolean,
7052 type = string, -- "node" or "object",
7053 axis = string, -- "x", "y" or "z"
7054 node_pos = vector, -- if type is "node"
7055 object = ObjectRef, -- if type is "object"
7056 old_velocity = vector,
7057 new_velocity = vector,
7063 ABM (ActiveBlockModifier) definition
7064 ------------------------------------
7066 Used by `minetest.register_abm`.
7069 label = "Lava cooling",
7070 -- Descriptive label for profiling purposes (optional).
7071 -- Definitions with identical labels will be listed as one.
7073 nodenames = {"default:lava_source"},
7074 -- Apply `action` function to these nodes.
7075 -- `group:groupname` can also be used here.
7077 neighbors = {"default:water_source", "default:water_flowing"},
7078 -- Only apply `action` to nodes that have one of, or any
7079 -- combination of, these neighbors.
7080 -- If left out or empty, any neighbor will do.
7081 -- `group:groupname` can also be used here.
7084 -- Operation interval in seconds
7087 -- Chance of triggering `action` per-node per-interval is 1.0 / this
7091 -- If true, catch-up behaviour is enabled: The `chance` value is
7092 -- temporarily reduced when returning to an area to simulate time lost
7093 -- by the area being unattended. Note that the `chance` value can often
7096 action = function(pos, node, active_object_count, active_object_count_wider),
7097 -- Function triggered for each qualifying node.
7098 -- `active_object_count` is number of active objects in the node's
7100 -- `active_object_count_wider` is number of active objects in the node's
7101 -- mapblock plus all 26 neighboring mapblocks. If any neighboring
7102 -- mapblocks are unloaded an estmate is calculated for them based on
7103 -- loaded mapblocks.
7106 LBM (LoadingBlockModifier) definition
7107 -------------------------------------
7109 Used by `minetest.register_lbm`.
7111 A loading block modifier (LBM) is used to define a function that is called for
7112 specific nodes (defined by `nodenames`) when a mapblock which contains such nodes
7116 label = "Upgrade legacy doors",
7117 -- Descriptive label for profiling purposes (optional).
7118 -- Definitions with identical labels will be listed as one.
7120 name = "modname:replace_legacy_door",
7122 nodenames = {"default:lava_source"},
7123 -- List of node names to trigger the LBM on.
7124 -- Also non-registered nodes will work.
7125 -- Groups (as of group:groupname) will work as well.
7127 run_at_every_load = false,
7128 -- Whether to run the LBM's action every time a block gets loaded,
7129 -- and not only the first time the block gets loaded after the LBM
7132 action = function(pos, node),
7139 * `{name="image.png", animation={Tile Animation definition}}`
7140 * `{name="image.png", backface_culling=bool, align_style="node"/"world"/"user", scale=int}`
7141 * backface culling enabled by default for most nodes
7142 * align style determines whether the texture will be rotated with the node
7143 or kept aligned with its surroundings. "user" means that client
7144 setting will be used, similar to `glasslike_framed_optional`.
7145 Note: supported by solid nodes and nodeboxes only.
7146 * scale is used to make texture span several (exactly `scale`) nodes,
7147 instead of just one, in each direction. Works for world-aligned
7149 Note that as the effect is applied on per-mapblock basis, `16` should
7150 be equally divisible by `scale` or you may get wrong results.
7151 * `{name="image.png", color=ColorSpec}`
7152 * the texture's color will be multiplied with this color.
7153 * the tile's color overrides the owning node's color in all cases.
7154 * deprecated, yet still supported field names:
7157 Tile animation definition
7158 -------------------------
7161 type = "vertical_frames",
7164 -- Width of a frame in pixels
7167 -- Height of a frame in pixels
7177 -- Width in number of frames
7180 -- Height in number of frames
7183 -- Length of a single frame
7189 Used by `minetest.register_node`, `minetest.register_craftitem`, and
7190 `minetest.register_tool`.
7193 description = "Steel Axe",
7194 -- Can contain new lines. "\n" has to be used as new line character.
7195 -- See also: `get_description` in [`ItemStack`]
7197 short_description = "Steel Axe",
7198 -- Must not contain new lines.
7200 -- Use an [`ItemStack`] to get the short description, eg:
7201 -- ItemStack(itemname):get_short_description()
7204 -- key = name, value = rating; rating = 1..3.
7205 -- If rating not applicable, use 1.
7206 -- e.g. {wool = 1, fluffy = 3}
7207 -- {soil = 2, outerspace = 1, crumbly = 1}
7208 -- {bendy = 2, snappy = 1},
7209 -- {hard = 1, metal = 1, spikes = 1}
7211 inventory_image = "default_tool_steelaxe.png",
7213 inventory_overlay = "overlay.png",
7214 -- An overlay which does not get colorized
7221 -- An image file containing the palette of a node.
7222 -- You can set the currently used color as the "palette_index" field of
7223 -- the item stack metadata.
7224 -- The palette is always stretched to fit indices between 0 and 255, to
7225 -- ensure compatibility with "colorfacedir" and "colorwallmounted" nodes.
7227 color = "0xFFFFFFFF",
7228 -- The color of the item. The palette overrides this.
7230 wield_scale = {x = 1, y = 1, z = 1},
7232 -- The default value of 99 may be configured by
7233 -- users using the setting "default_stack_max"
7238 liquids_pointable = false,
7241 -- When used for nodes: Defines amount of light emitted by node.
7242 -- Otherwise: Defines texture glow when viewed as a dropped item
7243 -- To set the maximum (14), use the value 'minetest.LIGHT_MAX'.
7244 -- A value outside the range 0 to minetest.LIGHT_MAX causes undefined
7247 -- See "Tools" section for an example including explanation
7248 tool_capabilities = {
7249 full_punch_interval = 1.0,
7253 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00},
7254 uses = 20, maxlevel = 2},
7256 damage_groups = {groupname = damage},
7257 -- Damage values must be between -32768 and 32767 (2^15)
7259 punch_attack_uses = nil,
7260 -- Amount of uses this tool has for attacking players and entities
7261 -- by punching them (0 = infinite uses).
7262 -- For compatibility, this is automatically set from the first
7263 -- suitable groupcap using the forumla "uses * 3^(maxlevel - 1)".
7264 -- It is recommend to set this explicitly instead of relying on the
7265 -- fallback behavior.
7268 node_placement_prediction = nil,
7269 -- If nil and item is node, prediction is made automatically.
7270 -- If nil and item is not a node, no prediction is made.
7271 -- If "" and item is anything, no prediction is made.
7272 -- Otherwise should be name of node which the client immediately places
7273 -- on ground when the player places the item. Server will always update
7274 -- actual result to client in a short moment.
7276 node_dig_prediction = "air",
7277 -- if "", no prediction is made.
7278 -- if "air", node is removed.
7279 -- Otherwise should be name of node which the client immediately places
7280 -- upon digging. Server will always update actual result shortly.
7283 -- Definition of items sounds to be played at various events.
7284 -- All fields in this table are optional.
7286 breaks = <SimpleSoundSpec>,
7287 -- When tool breaks due to wear. Ignored for non-tools
7289 eat = <SimpleSoundSpec>,
7290 -- When item is eaten with `minetest.do_item_eat`
7293 on_place = function(itemstack, placer, pointed_thing),
7294 -- Shall place item and return the leftover itemstack.
7295 -- The placer may be any ObjectRef or nil.
7296 -- default: minetest.item_place
7298 on_secondary_use = function(itemstack, user, pointed_thing),
7299 -- Same as on_place but called when not pointing at a node.
7300 -- The user may be any ObjectRef or nil.
7303 on_drop = function(itemstack, dropper, pos),
7304 -- Shall drop item and return the leftover itemstack.
7305 -- The dropper may be any ObjectRef or nil.
7306 -- default: minetest.item_drop
7308 on_use = function(itemstack, user, pointed_thing),
7310 -- Function must return either nil if no item shall be removed from
7311 -- inventory, or an itemstack to replace the original itemstack.
7312 -- e.g. itemstack:take_item(); return itemstack
7313 -- Otherwise, the function is free to do what it wants.
7314 -- The user may be any ObjectRef or nil.
7315 -- The default functions handle regular use cases.
7317 after_use = function(itemstack, user, node, digparams),
7319 -- If defined, should return an itemstack and will be called instead of
7320 -- wearing out the tool. If returns nil, does nothing.
7321 -- If after_use doesn't exist, it is the same as:
7322 -- function(itemstack, user, node, digparams)
7323 -- itemstack:add_wear(digparams.wear)
7326 -- The user may be any ObjectRef or nil.
7328 _custom_field = whatever,
7329 -- Add your own custom fields. By convention, all custom field names
7330 -- should start with `_` to avoid naming collisions with future engine
7337 Used by `minetest.register_node`.
7340 -- <all fields allowed in item definitions>,
7342 drawtype = "normal", -- See "Node drawtypes"
7345 -- Supported for drawtypes "plantlike", "signlike", "torchlike",
7346 -- "firelike", "mesh", "nodebox", "allfaces".
7347 -- For plantlike and firelike, the image will start at the bottom of the
7348 -- node. For torchlike, the image will start at the surface to which the
7349 -- node "attaches". For the other drawtypes the image will be centered
7352 tiles = {tile definition 1, def2, def3, def4, def5, def6},
7353 -- Textures of node; +Y, -Y, +X, -X, +Z, -Z
7354 -- Old field name was 'tile_images'.
7355 -- List can be shortened to needed length.
7357 overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6},
7358 -- Same as `tiles`, but these textures are drawn on top of the base
7359 -- tiles. You can use this to colorize only specific parts of your
7360 -- texture. If the texture name is an empty string, that overlay is not
7361 -- drawn. Since such tiles are drawn twice, it is not recommended to use
7362 -- overlays on very common nodes.
7364 special_tiles = {tile definition 1, Tile definition 2},
7365 -- Special textures of node; used rarely.
7366 -- Old field name was 'special_materials'.
7367 -- List can be shortened to needed length.
7370 -- The node's original color will be multiplied with this color.
7371 -- If the node has a palette, then this setting only has an effect in
7372 -- the inventory and on the wield item.
7374 use_texture_alpha = ...,
7375 -- Specifies how the texture's alpha channel will be used for rendering.
7377 -- * "opaque": Node is rendered opaque regardless of alpha channel
7378 -- * "clip": A given pixel is either fully see-through or opaque
7379 -- depending on the alpha channel being below/above 50% in value
7380 -- * "blend": The alpha channel specifies how transparent a given pixel
7381 -- of the rendered node is
7382 -- The default is "opaque" for drawtypes normal, liquid and flowingliquid;
7383 -- "clip" otherwise.
7384 -- If set to a boolean value (deprecated): true either sets it to blend
7385 -- or clip, false sets it to clip or opaque mode depending on the drawtype.
7387 palette = "palette.png",
7388 -- The node's `param2` is used to select a pixel from the image.
7389 -- Pixels are arranged from left to right and from top to bottom.
7390 -- The node's color will be multiplied with the selected pixel's color.
7391 -- Tiles can override this behavior.
7392 -- Only when `paramtype2` supports palettes.
7394 post_effect_color = "green#0F",
7395 -- Screen tint if player is inside node, see "ColorSpec"
7397 paramtype = "none", -- See "Nodes"
7399 paramtype2 = "none", -- See "Nodes"
7401 place_param2 = nil, -- Force value for param2 when player places node
7403 is_ground_content = true,
7404 -- If false, the cave generator and dungeon generator will not carve
7405 -- through this node.
7406 -- Specifically, this stops mod-added nodes being removed by caves and
7407 -- dungeons when those generate in a neighbor mapchunk and extend out
7408 -- beyond the edge of that mapchunk.
7410 sunlight_propagates = false,
7411 -- If true, sunlight will go infinitely through this node
7413 walkable = true, -- If true, objects collide with node
7415 pointable = true, -- If true, can be pointed at
7417 diggable = true, -- If false, can never be dug
7419 climbable = false, -- If true, can be climbed on (ladder)
7421 buildable_to = false, -- If true, placed nodes can replace this node
7424 -- If true, liquids flow into and replace this node.
7425 -- Warning: making a liquid node 'floodable' will cause problems.
7427 liquidtype = "none", -- "none" / "source" / "flowing"
7429 liquid_alternative_flowing = "", -- Flowing version of source liquid
7431 liquid_alternative_source = "", -- Source version of flowing liquid
7433 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
7435 liquid_renewable = true,
7436 -- If true, a new liquid source can be created by placing two or more
7440 -- Only valid for "nodebox" drawtype with 'type = "leveled"'.
7441 -- Allows defining the nodebox height without using param2.
7442 -- The nodebox height is 'leveled' / 64 nodes.
7443 -- The maximum value of 'leveled' is `leveled_max`.
7446 -- Maximum value for `leveled` (0-127), enforced in
7447 -- `minetest.set_node_level` and `minetest.add_node_level`.
7448 -- Values above 124 might causes collision detection issues.
7450 liquid_range = 8, -- Number of flowing nodes around source (max. 8)
7453 -- Player will take this amount of damage if no bubbles are left
7455 damage_per_second = 0,
7456 -- If player is inside node, this damage is caused
7458 node_box = {type="regular"}, -- See "Node boxes"
7460 connects_to = nodenames,
7461 -- Used for nodebox nodes with the type == "connected".
7462 -- Specifies to what neighboring nodes connections will be drawn.
7463 -- e.g. `{"group:fence", "default:wood"}` or `"default:stone"`
7465 connect_sides = { "top", "bottom", "front", "left", "back", "right" },
7466 -- Tells connected nodebox nodes to connect only to these sides of this
7470 -- File name of mesh when using "mesh" drawtype
7475 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
7476 -- Node box format: see [Node boxes]
7479 -- Custom selection box definition. Multiple boxes can be defined.
7480 -- If "nodebox" drawtype is used and selection_box is nil, then node_box
7481 -- definition is used for the selection box.
7486 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
7487 -- Node box format: see [Node boxes]
7490 -- Custom collision box definition. Multiple boxes can be defined.
7491 -- If "nodebox" drawtype is used and collision_box is nil, then node_box
7492 -- definition is used for the collision box.
7494 -- Support maps made in and before January 2012
7495 legacy_facedir_simple = false,
7496 legacy_wallmounted = false,
7499 -- Valid for drawtypes:
7500 -- mesh, nodebox, plantlike, allfaces_optional, liquid, flowingliquid.
7501 -- 1 - wave node like plants (node top moves side-to-side, bottom is fixed)
7502 -- 2 - wave node like leaves (whole node moves side-to-side)
7503 -- 3 - wave node like liquids (whole node moves up and down)
7504 -- Not all models will properly wave.
7505 -- plantlike drawtype can only wave like plants.
7506 -- allfaces_optional drawtype can only wave like leaves.
7507 -- liquid, flowingliquid drawtypes can only wave like liquids.
7510 -- Definition of node sounds to be played at various events.
7511 -- All fields in this table are optional.
7513 footstep = <SimpleSoundSpec>,
7514 -- If walkable, played when object walks on it. If node is
7515 -- climbable or a liquid, played when object moves through it
7517 dig = <SimpleSoundSpec> or "__group",
7518 -- While digging node.
7519 -- If `"__group"`, then the sound will be
7520 -- `default_dig_<groupname>`, where `<groupname>` is the
7521 -- name of the tool's digging group with the fastest digging time.
7522 -- In case of a tie, one of the sounds will be played (but we
7523 -- cannot predict which one)
7524 -- Default value: `"__group"`
7526 dug = <SimpleSoundSpec>,
7529 place = <SimpleSoundSpec>,
7530 -- Node was placed. Also played after falling
7532 place_failed = <SimpleSoundSpec>,
7533 -- When node placement failed.
7534 -- Note: This happens if the _built-in_ node placement failed.
7535 -- This sound will still be played if the node is placed in the
7536 -- `on_place` callback manually.
7538 fall = <SimpleSoundSpec>,
7539 -- When node starts to fall or is detached
7543 -- Name of dropped item when dug.
7544 -- Default dropped item is the node itself.
7545 -- Using a table allows multiple items, drop chances and tool filtering.
7546 -- Tool filtering was undocumented until recently, tool filtering by string
7547 -- matching is deprecated.
7550 -- Maximum number of item lists to drop.
7551 -- The entries in 'items' are processed in order. For each:
7552 -- Tool filtering is applied, chance of drop is applied, if both are
7553 -- successful the entire item list is dropped.
7554 -- Entry processing continues until the number of dropped item lists
7555 -- equals 'max_items'.
7556 -- Therefore, entries should progress from low to high drop chance.
7560 -- 1 in 1000 chance of dropping a diamond.
7561 -- Default rarity is '1'.
7563 items = {"default:diamond"},
7566 -- Only drop if using a tool whose name is identical to one
7568 tools = {"default:shovel_mese", "default:shovel_diamond"},
7570 items = {"default:dirt"},
7571 -- Whether all items in the dropped item list inherit the
7572 -- hardware coloring palette color from the dug node.
7573 -- Default is 'false'.
7574 inherit_color = true,
7577 -- Only drop if using a tool whose name contains
7578 -- "default:shovel_" (this tool filtering by string matching
7580 tools = {"~default:shovel_"},
7582 -- The item list dropped.
7583 items = {"default:sand", "default:desert_sand"},
7588 on_construct = function(pos),
7589 -- Node constructor; called after adding node.
7590 -- Can set up metadata and stuff like that.
7591 -- Not called for bulk node placement (i.e. schematics and VoxelManip).
7594 on_destruct = function(pos),
7595 -- Node destructor; called before removing node.
7596 -- Not called for bulk node placement.
7599 after_destruct = function(pos, oldnode),
7600 -- Node destructor; called after removing node.
7601 -- Not called for bulk node placement.
7604 on_flood = function(pos, oldnode, newnode),
7605 -- Called when a liquid (newnode) is about to flood oldnode, if it has
7606 -- `floodable = true` in the nodedef. Not called for bulk node placement
7607 -- (i.e. schematics and VoxelManip) or air nodes. If return true the
7608 -- node is not flooded, but on_flood callback will most likely be called
7609 -- over and over again every liquid update interval.
7611 -- Warning: making a liquid node 'floodable' will cause problems.
7613 preserve_metadata = function(pos, oldnode, oldmeta, drops),
7614 -- Called when oldnode is about be converted to an item, but before the
7615 -- node is deleted from the world or the drops are added. This is
7616 -- generally the result of either the node being dug or an attached node
7617 -- becoming detached.
7618 -- oldmeta is the NodeMetaRef of the oldnode before deletion.
7619 -- drops is a table of ItemStacks, so any metadata to be preserved can
7620 -- be added directly to one or more of the dropped items. See
7621 -- "ItemStackMetaRef".
7624 after_place_node = function(pos, placer, itemstack, pointed_thing),
7625 -- Called after constructing node when node was placed using
7626 -- minetest.item_place_node / minetest.place_node.
7627 -- If return true no item is taken from itemstack.
7628 -- `placer` may be any valid ObjectRef or nil.
7631 after_dig_node = function(pos, oldnode, oldmetadata, digger),
7632 -- oldmetadata is in table format.
7633 -- Called after destructing node when node was dug using
7634 -- minetest.node_dig / minetest.dig_node.
7637 can_dig = function(pos, [player]),
7638 -- Returns true if node can be dug, or false if not.
7641 on_punch = function(pos, node, puncher, pointed_thing),
7642 -- default: minetest.node_punch
7643 -- Called when puncher (an ObjectRef) punches the node at pos.
7644 -- By default calls minetest.register_on_punchnode callbacks.
7646 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing),
7648 -- Called when clicker (an ObjectRef) "rightclicks"
7649 -- ("rightclick" here stands for the placement key) while pointing at
7650 -- the node at pos with 'node' being the node table.
7651 -- itemstack will hold clicker's wielded item.
7652 -- Shall return the leftover itemstack.
7653 -- Note: pointed_thing can be nil, if a mod calls this function.
7654 -- This function does not get triggered by clients <=0.4.16 if the
7655 -- "formspec" node metadata field is set.
7657 on_dig = function(pos, node, digger),
7658 -- default: minetest.node_dig
7659 -- By default checks privileges, wears out tool and removes node.
7660 -- return true if the node was dug successfully, false otherwise.
7661 -- Deprecated: returning nil is the same as returning true.
7663 on_timer = function(pos, elapsed),
7665 -- called by NodeTimers, see minetest.get_node_timer and NodeTimerRef.
7666 -- elapsed is the total time passed since the timer was started.
7667 -- return true to run the timer for another cycle with the same timeout
7670 on_receive_fields = function(pos, formname, fields, sender),
7671 -- fields = {name1 = value1, name2 = value2, ...}
7672 -- Called when an UI form (e.g. sign text input) returns data.
7673 -- See minetest.register_on_player_receive_fields for more info.
7676 allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7677 -- Called when a player wants to move items inside the inventory.
7678 -- Return value: number of items allowed to move.
7680 allow_metadata_inventory_put = function(pos, listname, index, stack, player),
7681 -- Called when a player wants to put something into the inventory.
7682 -- Return value: number of items allowed to put.
7683 -- Return value -1: Allow and don't modify item count in inventory.
7685 allow_metadata_inventory_take = function(pos, listname, index, stack, player),
7686 -- Called when a player wants to take something out of the inventory.
7687 -- Return value: number of items allowed to take.
7688 -- Return value -1: Allow and don't modify item count in inventory.
7690 on_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7691 on_metadata_inventory_put = function(pos, listname, index, stack, player),
7692 on_metadata_inventory_take = function(pos, listname, index, stack, player),
7693 -- Called after the actual action has happened, according to what was
7697 on_blast = function(pos, intensity),
7698 -- intensity: 1.0 = mid range of regular TNT.
7699 -- If defined, called when an explosion touches the node, instead of
7700 -- removing the node.
7702 mod_origin = "modname",
7703 -- stores which mod actually registered a node
7704 -- if it can not find a source, returns "??"
7705 -- useful for getting what mod truly registered something
7706 -- example: if a node is registered as ":othermodname:nodename",
7707 -- nodename will show "othermodname", but mod_orgin will say "modname"
7713 Used by `minetest.register_craft`.
7718 output = 'default:pick_stone',
7720 {'default:cobble', 'default:cobble', 'default:cobble'},
7721 {'', 'default:stick', ''},
7722 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
7724 replacements = <list of item pairs>,
7725 -- replacements: replace one input item with another item on crafting
7733 output = 'mushrooms:mushroom_stew',
7736 "mushrooms:mushroom_brown",
7737 "mushrooms:mushroom_red",
7739 replacements = <list of item pairs>,
7745 type = "toolrepair",
7746 additional_wear = -0.02,
7749 Note: Tools with group `disable_repair=1` will not repairable by this recipe.
7755 output = "default:glass",
7756 recipe = "default:sand",
7764 recipe = "bucket:bucket_lava",
7766 replacements = {{"bucket:bucket_lava", "bucket:bucket_empty"}},
7772 Used by `minetest.register_ore`.
7774 See [Ores] section above for essential information.
7777 ore_type = "scatter",
7779 ore = "default:stone_with_coal",
7782 -- Facedir rotation. Default is 0 (unchanged rotation)
7784 wherein = "default:stone",
7785 -- A list of nodenames is supported too
7787 clust_scarcity = 8 * 8 * 8,
7788 -- Ore has a 1 out of clust_scarcity chance of spawning in a node.
7789 -- If the desired average distance between ores is 'd', set this to
7793 -- Number of ores in a cluster
7796 -- Size of the bounding box of the cluster.
7797 -- In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27
7798 -- nodes are coal ore.
7802 -- Lower and upper limits for ore
7805 -- Attributes for the ore generation, see 'Ore attributes' section above
7807 noise_threshold = 0.5,
7808 -- If noise is above this threshold, ore is placed. Not needed for a
7809 -- uniform distribution.
7814 spread = {x = 100, y = 100, z = 100},
7819 -- NoiseParams structure describing one of the perlin noises used for
7820 -- ore distribution.
7821 -- Needed by "sheet", "puff", "blob" and "vein" ores.
7822 -- Omit from "scatter" ore for a uniform ore distribution.
7823 -- Omit from "stratum" ore for a simple horizontal strata from y_min to
7826 biomes = {"desert", "rainforest"},
7827 -- List of biomes in which this ore occurs.
7828 -- Occurs in all biomes if this is omitted, and ignored if the Mapgen
7829 -- being used does not support biomes.
7830 -- Can be a list of (or a single) biome names, IDs, or definitions.
7832 -- Type-specific parameters
7835 column_height_min = 1,
7836 column_height_max = 16,
7837 column_midpoint_factor = 0.5,
7843 spread = {x = 100, y = 100, z = 100},
7851 spread = {x = 100, y = 100, z = 100},
7858 random_factor = 1.0,
7861 np_stratum_thickness = {
7864 spread = {x = 100, y = 100, z = 100},
7869 stratum_thickness = 8,
7875 Used by `minetest.register_biome`.
7877 The maximum number of biomes that can be used is 65535. However, using an
7878 excessive number of biomes will slow down map generation. Depending on desired
7879 performance and computing power the practical limit is much lower.
7884 node_dust = "default:snow",
7885 -- Node dropped onto upper surface after all else is generated
7887 node_top = "default:dirt_with_snow",
7889 -- Node forming surface layer of biome and thickness of this layer
7891 node_filler = "default:permafrost",
7893 -- Node forming lower layer of biome and thickness of this layer
7895 node_stone = "default:bluestone",
7896 -- Node that replaces all stone nodes between roughly y_min and y_max.
7898 node_water_top = "default:ice",
7899 depth_water_top = 10,
7900 -- Node forming a surface layer in seawater with the defined thickness
7903 -- Node that replaces all seawater nodes not in the surface layer
7905 node_river_water = "default:ice",
7906 -- Node that replaces river water in mapgens that use
7907 -- default:river_water
7909 node_riverbed = "default:gravel",
7911 -- Node placed under river water and thickness of this layer
7913 node_cave_liquid = "default:lava_source",
7914 node_cave_liquid = {"default:water_source", "default:lava_source"},
7915 -- Nodes placed inside 50% of the medium size caves.
7916 -- Multiple nodes can be specified, each cave will use a randomly
7917 -- chosen node from the list.
7918 -- If this field is left out or 'nil', cave liquids fall back to
7919 -- classic behaviour of lava and water distributed using 3D noise.
7920 -- For no cave liquid, specify "air".
7922 node_dungeon = "default:cobble",
7923 -- Node used for primary dungeon structure.
7924 -- If absent, dungeon nodes fall back to the 'mapgen_cobble' mapgen
7925 -- alias, if that is also absent, dungeon nodes fall back to the biome
7927 -- If present, the following two nodes are also used.
7929 node_dungeon_alt = "default:mossycobble",
7930 -- Node used for randomly-distributed alternative structure nodes.
7931 -- If alternative structure nodes are not wanted leave this absent for
7932 -- performance reasons.
7934 node_dungeon_stair = "stairs:stair_cobble",
7935 -- Node used for dungeon stairs.
7936 -- If absent, stairs fall back to 'node_dungeon'.
7940 -- Upper and lower limits for biome.
7941 -- Alternatively you can use xyz limits as shown below.
7943 max_pos = {x = 31000, y = 128, z = 31000},
7944 min_pos = {x = -31000, y = 9, z = -31000},
7945 -- xyz limits for biome, an alternative to using 'y_min' and 'y_max'.
7946 -- Biome is limited to a cuboid defined by these positions.
7947 -- Any x, y or z field left undefined defaults to -31000 in 'min_pos' or
7948 -- 31000 in 'max_pos'.
7951 -- Vertical distance in nodes above 'y_max' over which the biome will
7952 -- blend with the biome above.
7953 -- Set to 0 for no vertical blend. Defaults to 0.
7956 humidity_point = 50,
7957 -- Characteristic temperature and humidity for the biome.
7958 -- These values create 'biome points' on a voronoi diagram with heat and
7959 -- humidity as axes. The resulting voronoi cells determine the
7960 -- distribution of the biomes.
7961 -- Heat and humidity have average values of 50, vary mostly between
7962 -- 0 and 100 but can exceed these values.
7965 Decoration definition
7966 ---------------------
7968 See [Decoration types]. Used by `minetest.register_decoration`.
7971 deco_type = "simple",
7973 place_on = "default:dirt_with_grass",
7974 -- Node (or list of nodes) that the decoration can be placed on
7977 -- Size of the square divisions of the mapchunk being generated.
7978 -- Determines the resolution of noise variation if used.
7979 -- If the chunk size is not evenly divisible by sidelen, sidelen is made
7980 -- equal to the chunk size.
7983 -- The value determines 'decorations per surface node'.
7984 -- Used only if noise_params is not specified.
7985 -- If >= 10.0 complete coverage is enabled and decoration placement uses
7986 -- a different and much faster method.
7991 spread = {x = 100, y = 100, z = 100},
7998 -- NoiseParams structure describing the perlin noise used for decoration
8000 -- A noise value is calculated for each square division and determines
8001 -- 'decorations per surface node' within each division.
8002 -- If the noise value >= 10.0 complete coverage is enabled and
8003 -- decoration placement uses a different and much faster method.
8005 biomes = {"Oceanside", "Hills", "Plains"},
8006 -- List of biomes in which this decoration occurs. Occurs in all biomes
8007 -- if this is omitted, and ignored if the Mapgen being used does not
8009 -- Can be a list of (or a single) biome names, IDs, or definitions.
8013 -- Lower and upper limits for decoration.
8014 -- These parameters refer to the Y co-ordinate of the 'place_on' node.
8016 spawn_by = "default:water",
8017 -- Node (or list of nodes) that the decoration only spawns next to.
8018 -- Checks two horizontal planes of 8 neighbouring nodes (including
8019 -- diagonal neighbours), one plane level with the 'place_on' node and a
8020 -- plane one node above that.
8023 -- Number of spawn_by nodes that must be surrounding the decoration
8024 -- position to occur.
8025 -- If absent or -1, decorations occur next to any nodes.
8027 flags = "liquid_surface, force_placement, all_floors, all_ceilings",
8028 -- Flags for all decoration types.
8029 -- "liquid_surface": Instead of placement on the highest solid surface
8030 -- in a mapchunk column, placement is on the highest liquid surface.
8031 -- Placement is disabled if solid nodes are found above the liquid
8033 -- "force_placement": Nodes other than "air" and "ignore" are replaced
8034 -- by the decoration.
8035 -- "all_floors", "all_ceilings": Instead of placement on the highest
8036 -- surface in a mapchunk the decoration is placed on all floor and/or
8037 -- ceiling surfaces, for example in caves and dungeons.
8038 -- Ceiling decorations act as an inversion of floor decorations so the
8039 -- effect of 'place_offset_y' is inverted.
8040 -- Y-slice probabilities do not function correctly for ceiling
8041 -- schematic decorations as the behaviour is unchanged.
8042 -- If a single decoration registration has both flags the floor and
8043 -- ceiling decorations will be aligned vertically.
8045 ----- Simple-type parameters
8047 decoration = "default:grass",
8048 -- The node name used as the decoration.
8049 -- If instead a list of strings, a randomly selected node from the list
8050 -- is placed as the decoration.
8053 -- Decoration height in nodes.
8054 -- If height_max is not 0, this is the lower limit of a randomly
8058 -- Upper limit of the randomly selected height.
8059 -- If absent, the parameter 'height' is used as a constant.
8062 -- Param2 value of decoration nodes.
8063 -- If param2_max is not 0, this is the lower limit of a randomly
8067 -- Upper limit of the randomly selected param2.
8068 -- If absent, the parameter 'param2' is used as a constant.
8071 -- Y offset of the decoration base node relative to the standard base
8073 -- Can be positive or negative. Default is 0.
8074 -- Effect is inverted for "all_ceilings" decorations.
8075 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
8076 -- to the 'place_on' node.
8078 ----- Schematic-type parameters
8080 schematic = "foobar.mts",
8081 -- If schematic is a string, it is the filepath relative to the current
8082 -- working directory of the specified Minetest schematic file.
8083 -- Could also be the ID of a previously registered schematic.
8086 size = {x = 4, y = 6, z = 4},
8088 {name = "default:cobble", param1 = 255, param2 = 0},
8089 {name = "default:dirt_with_grass", param1 = 255, param2 = 0},
8090 {name = "air", param1 = 255, param2 = 0},
8094 {ypos = 2, prob = 128},
8095 {ypos = 5, prob = 64},
8099 -- Alternative schematic specification by supplying a table. The fields
8100 -- size and data are mandatory whereas yslice_prob is optional.
8101 -- See 'Schematic specifier' for details.
8103 replacements = {["oldname"] = "convert_to", ...},
8105 flags = "place_center_x, place_center_y, place_center_z",
8106 -- Flags for schematic decorations. See 'Schematic attributes'.
8109 -- Rotation can be "0", "90", "180", "270", or "random"
8112 -- If the flag 'place_center_y' is set this parameter is ignored.
8113 -- Y offset of the schematic base node layer relative to the 'place_on'
8115 -- Can be positive or negative. Default is 0.
8116 -- Effect is inverted for "all_ceilings" decorations.
8117 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
8118 -- to the 'place_on' node.
8121 Chat command definition
8122 -----------------------
8124 Used by `minetest.register_chatcommand`.
8127 params = "<name> <privilege>", -- Short parameter description
8129 description = "Remove privilege from player", -- Full description
8131 privs = {privs=true}, -- Require the "privs" privilege to run
8133 func = function(name, param),
8134 -- Called when command is run. Returns boolean success and text output.
8135 -- Special case: The help message is shown to the player if `func`
8136 -- returns false without a text output.
8139 Note that in params, use of symbols is as follows:
8141 * `<>` signifies a placeholder to be replaced when the command is used. For
8142 example, when a player name is needed: `<name>`
8143 * `[]` signifies param is optional and not required when the command is used.
8144 For example, if you require param1 but param2 is optional:
8145 `<param1> [<param2>]`
8146 * `|` signifies exclusive or. The command requires one param from the options
8147 provided. For example: `<param1> | <param2>`
8148 * `()` signifies grouping. For example, when param1 and param2 are both
8149 required, or only param3 is required: `(<param1> <param2>) | <param3>`
8151 Privilege definition
8152 --------------------
8154 Used by `minetest.register_privilege`.
8158 -- Privilege description
8160 give_to_singleplayer = true,
8161 -- Whether to grant the privilege to singleplayer.
8163 give_to_admin = true,
8164 -- Whether to grant the privilege to the server admin.
8165 -- Uses value of 'give_to_singleplayer' by default.
8167 on_grant = function(name, granter_name),
8168 -- Called when given to player 'name' by 'granter_name'.
8169 -- 'granter_name' will be nil if the priv was granted by a mod.
8171 on_revoke = function(name, revoker_name),
8172 -- Called when taken from player 'name' by 'revoker_name'.
8173 -- 'revoker_name' will be nil if the priv was revoked by a mod.
8175 -- Note that the above two callbacks will be called twice if a player is
8176 -- responsible, once with the player name, and then with a nil player
8178 -- Return true in the above callbacks to stop register_on_priv_grant or
8179 -- revoke being called.
8182 Detached inventory callbacks
8183 ----------------------------
8185 Used by `minetest.create_detached_inventory`.
8188 allow_move = function(inv, from_list, from_index, to_list, to_index, count, player),
8189 -- Called when a player wants to move items inside the inventory.
8190 -- Return value: number of items allowed to move.
8192 allow_put = function(inv, listname, index, stack, player),
8193 -- Called when a player wants to put something into the inventory.
8194 -- Return value: number of items allowed to put.
8195 -- Return value -1: Allow and don't modify item count in inventory.
8197 allow_take = function(inv, listname, index, stack, player),
8198 -- Called when a player wants to take something out of the inventory.
8199 -- Return value: number of items allowed to take.
8200 -- Return value -1: Allow and don't modify item count in inventory.
8202 on_move = function(inv, from_list, from_index, to_list, to_index, count, player),
8203 on_put = function(inv, listname, index, stack, player),
8204 on_take = function(inv, listname, index, stack, player),
8205 -- Called after the actual action has happened, according to what was
8215 Used by `Player:hud_add`. Returned by `Player:hud_get`.
8218 hud_elem_type = "image", -- See HUD element types
8219 -- Type of element, can be "image", "text", "statbar", "inventory",
8220 -- "compass" or "minimap"
8222 position = {x=0.5, y=0.5},
8223 -- Left corner position of element
8227 scale = {x = 2, y = 2},
8236 -- Selected item in inventory. 0 for no item selected.
8239 -- Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
8241 alignment = {x=0, y=0},
8243 offset = {x=0, y=0},
8245 size = { x=100, y=100 },
8246 -- Size of element in pixels
8249 -- Z index : lower z-index HUDs are displayed behind higher z-index HUDs
8255 Used by `minetest.add_particle`.
8258 pos = {x=0, y=0, z=0},
8259 velocity = {x=0, y=0, z=0},
8260 acceleration = {x=0, y=0, z=0},
8261 -- Spawn particle at pos with velocity and acceleration
8264 -- Disappears after expirationtime seconds
8267 -- Scales the visual size of the particle texture.
8268 -- If `node` is set, size can be set to 0 to spawn a randomly-sized
8269 -- particle (just like actual node dig particles).
8271 collisiondetection = false,
8272 -- If true collides with `walkable` nodes and, depending on the
8273 -- `object_collision` field, objects too.
8275 collision_removal = false,
8276 -- If true particle is removed when it collides.
8277 -- Requires collisiondetection = true to have any effect.
8279 object_collision = false,
8280 -- If true particle collides with objects that are defined as
8281 -- `physical = true,` and `collide_with_objects = true,`.
8282 -- Requires collisiondetection = true to have any effect.
8285 -- If true faces player using y axis only
8287 texture = "image.png",
8288 -- The texture of the particle
8290 playername = "singleplayer",
8291 -- Optional, if specified spawns particle only on the player's client
8293 animation = {Tile Animation definition},
8294 -- Optional, specifies how to animate the particle texture
8297 -- Optional, specify particle self-luminescence in darkness.
8300 node = {name = "ignore", param2 = 0},
8301 -- Optional, if specified the particle will have the same appearance as
8302 -- node dig particles for the given node.
8303 -- `texture` and `animation` will be ignored if this is set.
8306 -- Optional, only valid in combination with `node`
8307 -- If set to a valid number 1-6, specifies the tile from which the
8308 -- particle texture is picked.
8309 -- Otherwise, the default behavior is used. (currently: any random tile)
8313 `ParticleSpawner` definition
8314 ----------------------------
8316 Used by `minetest.add_particlespawner`.
8320 -- Number of particles spawned over the time period `time`.
8323 -- Lifespan of spawner in seconds.
8324 -- If time is 0 spawner has infinite lifespan and spawns the `amount` on
8325 -- a per-second basis.
8327 minpos = {x=0, y=0, z=0},
8328 maxpos = {x=0, y=0, z=0},
8329 minvel = {x=0, y=0, z=0},
8330 maxvel = {x=0, y=0, z=0},
8331 minacc = {x=0, y=0, z=0},
8332 maxacc = {x=0, y=0, z=0},
8337 -- The particles' properties are random values between the min and max
8339 -- applies to: pos, velocity, acceleration, expirationtime, size
8340 -- If `node` is set, min and maxsize can be set to 0 to spawn
8341 -- randomly-sized particles (just like actual node dig particles).
8343 collisiondetection = false,
8344 -- If true collide with `walkable` nodes and, depending on the
8345 -- `object_collision` field, objects too.
8347 collision_removal = false,
8348 -- If true particles are removed when they collide.
8349 -- Requires collisiondetection = true to have any effect.
8351 object_collision = false,
8352 -- If true particles collide with objects that are defined as
8353 -- `physical = true,` and `collide_with_objects = true,`.
8354 -- Requires collisiondetection = true to have any effect.
8356 attached = ObjectRef,
8357 -- If defined, particle positions, velocities and accelerations are
8358 -- relative to this object's position and yaw
8361 -- If true face player using y axis only
8363 texture = "image.png",
8364 -- The texture of the particle
8366 playername = "singleplayer",
8367 -- Optional, if specified spawns particles only on the player's client
8369 animation = {Tile Animation definition},
8370 -- Optional, specifies how to animate the particles' texture
8373 -- Optional, specify particle self-luminescence in darkness.
8376 node = {name = "ignore", param2 = 0},
8377 -- Optional, if specified the particles will have the same appearance as
8378 -- node dig particles for the given node.
8379 -- `texture` and `animation` will be ignored if this is set.
8382 -- Optional, only valid in combination with `node`
8383 -- If set to a valid number 1-6, specifies the tile from which the
8384 -- particle texture is picked.
8385 -- Otherwise, the default behavior is used. (currently: any random tile)
8388 `HTTPRequest` definition
8389 ------------------------
8391 Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
8394 url = "http://example.org",
8397 -- Timeout for request to be completed in seconds. Default depends on engine settings.
8399 method = "GET", "POST", "PUT" or "DELETE"
8400 -- The http method to use. Defaults to "GET".
8402 data = "Raw request data string" OR {field1 = "data1", field2 = "data2"},
8403 -- Data for the POST, PUT or DELETE request.
8404 -- Accepts both a string and a table. If a table is specified, encodes
8405 -- table as x-www-form-urlencoded key-value pairs.
8407 user_agent = "ExampleUserAgent",
8408 -- Optional, if specified replaces the default minetest user agent with
8411 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
8412 -- Optional, if specified adds additional headers to the HTTP request.
8413 -- You must make sure that the header strings follow HTTP specification
8417 -- Optional, if true performs a multipart HTTP request.
8418 -- Default is false.
8419 -- Post only, data must be array
8421 post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
8422 -- Deprecated, use `data` instead. Forces `method = "POST"`.
8425 `HTTPRequestResult` definition
8426 ------------------------------
8428 Passed to `HTTPApiTable.fetch` callback. Returned by
8429 `HTTPApiTable.fetch_async_get`.
8433 -- If true, the request has finished (either succeeded, failed or timed
8437 -- If true, the request was successful
8440 -- If true, the request timed out
8448 Authentication handler definition
8449 ---------------------------------
8451 Used by `minetest.register_authentication_handler`.
8454 get_auth = function(name),
8455 -- Get authentication data for existing player `name` (`nil` if player
8457 -- Returns following structure:
8458 -- `{password=<string>, privileges=<table>, last_login=<number or nil>}`
8460 create_auth = function(name, password),
8461 -- Create new auth data for player `name`.
8462 -- Note that `password` is not plain-text but an arbitrary
8463 -- representation decided by the engine.
8465 delete_auth = function(name),
8466 -- Delete auth data of player `name`.
8467 -- Returns boolean indicating success (false if player is nonexistent).
8469 set_password = function(name, password),
8470 -- Set password of player `name` to `password`.
8471 -- Auth data should be created if not present.
8473 set_privileges = function(name, privileges),
8474 -- Set privileges of player `name`.
8475 -- `privileges` is in table form, auth data should be created if not
8478 reload = function(),
8479 -- Reload authentication data from the storage location.
8480 -- Returns boolean indicating success.
8482 record_login = function(name),
8483 -- Called when player joins, used for keeping track of last_login
8485 iterate = function(),
8486 -- Returns an iterator (use with `for` loops) for all player names
8487 -- currently in the auth database