1 Minetest Lua Modding API Reference
2 ==================================
4 * More information at <http://www.minetest.net/>
5 * Developer Wiki: <http://dev.minetest.net/>
6 * (Unofficial) Minetest Modding Book by rubenwardy: <https://rubenwardy.com/minetest_modding_book/>
11 Content and functionality can be added to Minetest using Lua scripting
12 in run-time loaded mods.
14 A mod is a self-contained bunch of scripts, textures and other related
15 things, which is loaded by and interfaces with Minetest.
17 Mods are contained and ran solely on the server side. Definitions and media
18 files are automatically transferred to the client.
20 If you see a deficiency in the API, feel free to attempt to add the
21 functionality in the engine and API, and to document it here.
26 If you have any difficulty in understanding this, please read
27 [Programming in Lua](http://www.lua.org/pil/).
32 Mods are loaded during server startup from the mod load paths by running
33 the `init.lua` scripts in a shared environment.
38 * `RUN_IN_PLACE=1` (Windows release, local build)
39 * `$path_user`: `<build directory>`
40 * `$path_share`: `<build directory>`
41 * `RUN_IN_PLACE=0`: (Linux release)
43 * Linux: `/usr/share/minetest`
44 * Windows: `<install directory>/minetest-0.4.x`
46 * Linux: `$HOME/.minetest`
47 * Windows: `C:/users/<user>/AppData/minetest` (maybe)
55 Games are looked up from:
57 * `$path_share/games/<gameid>/`
58 * `$path_user/games/<gameid>/`
60 Where `<gameid>` is unique to each game.
62 The game directory can contain the following files:
64 * `game.conf`, with the following keys:
65 * `name`: Required, a human readable title to address the game, e.g. `name = Minetest`.
66 * `description`: Short description to be shown in the content tab
67 * `allowed_mapgens = <comma-separated mapgens>`
68 e.g. `allowed_mapgens = v5,v6,flat`
69 Mapgens not in this list are removed from the list of mapgens for the
71 If not specified, all mapgens are allowed.
72 * `disallowed_mapgens = <comma-separated mapgens>`
73 e.g. `disallowed_mapgens = v5,v6,flat`
74 These mapgens are removed from the list of mapgens for the game.
75 When both `allowed_mapgens` and `disallowed_mapgens` are
76 specified, `allowed_mapgens` is applied before
78 * `disallowed_mapgen_settings= <comma-separated mapgen settings>`
79 e.g. `disallowed_mapgen_settings = mgv5_spflags`
80 These settings are hidden for this game in the world creation
81 dialog and game start menu.
82 * `author`: The author of the game. It only appears when downloaded from
84 * `release`: Ignore this: Should only ever be set by ContentDB, as it is
85 an internal ID used to track versions.
87 Used to set default settings when running this game.
89 In the same format as the one in builtin.
90 This settingtypes.txt will be parsed by the menu and the settings will be
91 displayed in the "Games" category in the advanced settings tab.
92 * If the game contains a folder called `textures` the server will load it as a
93 texturepack, overriding mod textures.
94 Any server texturepack will override mod textures and the game texturepack.
99 Games can provide custom main menu images. They are put inside a `menu`
100 directory inside the game directory.
102 The images are named `$identifier.png`, where `$identifier` is one of
103 `overlay`, `background`, `footer`, `header`.
104 If you want to specify multiple images for one identifier, add additional
105 images named like `$identifier.$n.png`, with an ascending number $n starting
106 with 1, and a random image will be chosen from the provided ones.
117 Paths are relative to the directories listed in the [Paths] section above.
119 * `games/<gameid>/mods/`
121 * `worlds/<worldname>/worldmods/`
126 It is possible to include a game in a world; in this case, no mods or
127 games are loaded or checked from anywhere else.
129 This is useful for e.g. adventure worlds and happens if the `<worldname>/game/`
132 Mods should then be placed in `<worldname>/game/mods/`.
137 Mods can be put in a subdirectory, if the parent directory, which otherwise
138 should be a mod, contains a file named `modpack.conf`.
139 The file is a key-value store of modpack details.
141 * `name`: The modpack name. Allows Minetest to determine the modpack name even
142 if the folder is wrongly named.
143 * `description`: Description of mod to be shown in the Mods tab of the main
145 * `author`: The author of the modpack. It only appears when downloaded from
147 * `release`: Ignore this: Should only ever be set by ContentDB, as it is an
148 internal ID used to track versions.
149 * `title`: A human-readable title to address the modpack.
151 Note: to support 0.4.x, please also create an empty modpack.txt file.
153 Mod directory structure
154 -----------------------
160 │ ├── settingtypes.txt
164 │ │ ├── modname_stuff.png
165 │ │ ├── modname_stuff_normal.png
166 │ │ ├── modname_something_else.png
167 │ │ ├── subfolder_foo
168 │ │ │ ├── modname_more_stuff.png
169 │ │ │ └── another_subfolder
170 │ │ └── bar_subfolder
179 The location of this directory can be fetched by using
180 `minetest.get_modpath(modname)`.
184 A `Settings` file that provides meta information about the mod.
186 * `name`: The mod name. Allows Minetest to determine the mod name even if the
187 folder is wrongly named.
188 * `description`: Description of mod to be shown in the Mods tab of the main
190 * `depends`: A comma separated list of dependencies. These are mods that must be
191 loaded before this mod.
192 * `optional_depends`: A comma separated list of optional dependencies.
193 Like a dependency, but no error if the mod doesn't exist.
194 * `author`: The author of the mod. It only appears when downloaded from
196 * `release`: Ignore this: Should only ever be set by ContentDB, as it is an
197 internal ID used to track versions.
198 * `title`: A human-readable title to address the mod.
200 Note: to support 0.4.x, please also provide depends.txt.
204 A screenshot shown in the mod manager within the main menu. It should
205 have an aspect ratio of 3:2 and a minimum size of 300×200 pixels.
209 **Deprecated:** you should use mod.conf instead.
211 This file is used if there are no dependencies in mod.conf.
213 List of mods that have to be loaded before loading this mod.
215 A single line contains a single modname.
217 Optional dependencies can be defined by appending a question mark
218 to a single modname. This means that if the specified mod
219 is missing, it does not prevent this mod from being loaded.
221 ### `description.txt`
223 **Deprecated:** you should use mod.conf instead.
225 This file is used if there is no description in mod.conf.
227 A file containing a description to be shown in the Mods tab of the main menu.
229 ### `settingtypes.txt`
231 The format is documented in `builtin/settingtypes.txt`.
232 It is parsed by the main menu settings dialogue to list mod-specific
233 settings in the "Mods" category.
237 The main Lua script. Running this script should register everything it
238 wants to register. Subsequent execution depends on minetest calling the
239 registered callbacks.
241 `minetest.settings` can be used to read custom or existing settings at load
242 time, if necessary. (See [`Settings`])
244 ### `textures`, `sounds`, `media`, `models`, `locale`
246 Media files (textures, sounds, whatever) that will be transferred to the
247 client and will be available for use by the mod and translation files for
248 the clients (see [Translations]).
250 It is suggested to use the folders for the purpous they are thought for,
251 eg. put textures into `textures`, translation files into `locale`,
252 models for entities or meshnodes into `models` et cetera.
254 These folders and subfolders can contain subfolders.
255 Subfolders with names starting with `_` or `.` are ignored.
256 If a subfolder contains a media file with the same name as a media file
257 in one of its parents, the parent's file is used.
262 Registered names should generally be in this format:
266 `<whatever>` can have these characters:
270 This is to prevent conflicting names from corrupting maps and is
271 enforced by the mod loader.
273 Registered names can be overridden by prefixing the name with `:`. This can
274 be used for overriding the registrations of some other mod.
276 The `:` prefix can also be used for maintaining backwards compatibility.
280 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
281 So the name should be `experimental:tnt`.
283 Any mod can redefine `experimental:tnt` by using the name
287 when registering it. That mod is required to have `experimental` as a
296 Aliases of itemnames can be added by using
297 `minetest.register_alias(alias, original_name)` or
298 `minetest.register_alias_force(alias, original_name)`.
300 This adds an alias `alias` for the item called `original_name`.
301 From now on, you can use `alias` to refer to the item `original_name`.
303 The only difference between `minetest.register_alias` and
304 `minetest.register_alias_force` is that if an item named `alias` already exists,
305 `minetest.register_alias` will do nothing while
306 `minetest.register_alias_force` will unregister it.
308 This can be used for maintaining backwards compatibility.
310 This can also set quick access names for things, e.g. if
311 you have an item called `epiclylongmodname:stuff`, you could do
313 minetest.register_alias("stuff", "epiclylongmodname:stuff")
315 and be able to use `/giveme stuff`.
320 In a game, a certain number of these must be set to tell core mapgens which
321 of the game's nodes are to be used for core mapgen generation. For example:
323 minetest.register_alias("mapgen_stone", "default:stone")
325 ### Aliases for non-V6 mapgens
327 #### Essential aliases
330 * mapgen_water_source
331 * mapgen_river_water_source
333 `mapgen_river_water_source` is required for mapgens with sloping rivers where
334 it is necessary to have a river liquid node with a short `liquid_range` and
335 `liquid_renewable = false` to avoid flooding.
337 #### Optional aliases
341 Fallback lava node used if cave liquids are not defined in biome definitions.
342 Deprecated for non-V6 mapgens, define cave liquids in biome definitions instead.
346 Fallback node used if dungeon nodes are not defined in biome definitions.
347 Deprecated for non-V6 mapgens, define dungeon nodes in biome definitions instead.
349 ### Aliases needed for Mapgen V6
352 * mapgen_water_source
355 * mapgen_dirt_with_grass
358 * mapgen_desert_stone
360 * mapgen_dirt_with_snow
369 * mapgen_jungleleaves
372 * mapgen_pine_needles
375 * mapgen_stair_cobble
377 * mapgen_stair_desert_stone
379 ### Setting the node used in Mapgen Singlenode
381 By default the world is filled with air nodes. To set a different node use, for
384 minetest.register_alias("mapgen_singlenode", "default:stone")
392 Mods should generally prefix their textures with `modname_`, e.g. given
393 the mod name `foomod`, a texture could be called:
397 Textures are referred to by their complete name, or alternatively by
398 stripping out the file extension:
400 * e.g. `foomod_foothing.png`
401 * e.g. `foomod_foothing`
407 If shaders and bumpmapping or parallax occlusion is enabled, Minetest tries
409 Those image files have to end with `_normal.png` and start with the same name
410 as their corresponding texture.
411 For example a normalmap for `foomod_foothing.png` has to be called
412 `foomod_foothing_normal.png`.
414 The sRGB R, G and B colour values of a normalmap pixel are each directly
415 mapped from `{0, ..., 255}` to `[-1, 1]` and, taken together,
416 define the normal vector.
417 The alpha channel defines the heightmap for parallax occlusion.
418 To be safe, the alpha values should always be bigger than zero
419 because the colour values, which define the normal vector,
420 may be undefined for image formats where colour is discarded in fully
423 Bumpmapping and parallax occlusion are currently experimental features:
425 * Bumpmapping in Minetest happens in an obscure way; there are no light sources
426 defined in the shaders except the sunlight direction.
427 * Parallax occlusion with relief-mapping mode does not yet work correctly
428 together with Minetest's Fastfaces.
429 * The normalmap files must end with `.png`, so other image files are not
436 There are various texture modifiers that can be used
437 to let the client generate textures on-the-fly.
438 The modifiers are applied directly in sRGB colorspace,
439 i.e. without gamma-correction.
441 ### Texture overlaying
443 Textures can be overlaid by putting a `^` between them.
447 default_dirt.png^default_grass_side.png
449 `default_grass_side.png` is overlaid over `default_dirt.png`.
450 The texture with the lower resolution will be automatically upscaled to
451 the higher resolution texture.
455 Textures can be grouped together by enclosing them in `(` and `)`.
457 Example: `cobble.png^(thing1.png^thing2.png)`
459 A texture for `thing1.png^thing2.png` is created and the resulting
460 texture is overlaid on top of `cobble.png`.
464 Modifiers that accept texture names (e.g. `[combine`) accept escaping to allow
465 passing complex texture names as arguments. Escaping is done with backslash and
466 is required for `^` and `:`.
468 Example: `cobble.png^[lowpart:50:color.png\^[mask\:trans.png`
470 The lower 50 percent of `color.png^[mask:trans.png` are overlaid
471 on top of `cobble.png`.
473 ### Advanced texture modifiers
479 * `[crack:<t>:<n>:<p>`
480 * `[cracko:<t>:<n>:<p>`
484 * `<t>`: tile count (in each direction)
485 * `<n>`: animation frame count
486 * `<p>`: current animation frame
488 Draw a step of the crack animation on the texture.
489 `crack` draws it normally, while `cracko` lays it over, keeping transparent
494 default_cobble.png^[crack:10:1
496 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
502 * `<file>`: texture to combine
504 Creates a texture of size `<w>` times `<h>` and blits the listed files to their
505 specified coordinates.
509 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
511 #### `[resize:<w>x<h>`
513 Resizes the texture to the given dimensions.
517 default_sandstone.png^[resize:16x16
521 Makes the base image transparent according to the given ratio.
523 `r` must be between 0 (transparent) and 255 (opaque).
527 default_sandstone.png^[opacity:127
529 #### `[invert:<mode>`
531 Inverts the given channels of the base image.
532 Mode may contain the characters "r", "g", "b", "a".
533 Only the channels that are mentioned in the mode string will be inverted.
537 default_apple.png^[invert:rgb
541 Brightens the texture.
545 tnt_tnt_side.png^[brighten
549 Makes the texture completely opaque.
553 default_leaves.png^[noalpha
555 #### `[makealpha:<r>,<g>,<b>`
557 Convert one color to transparency.
561 default_cobble.png^[makealpha:128,128,128
565 * `<t>`: transformation(s) to apply
567 Rotates and/or flips the image.
569 `<t>` can be a number (between 0 and 7) or a transform name.
570 Rotations are counter-clockwise.
573 1 R90 rotate by 90 degrees
574 2 R180 rotate by 180 degrees
575 3 R270 rotate by 270 degrees
577 5 FXR90 flip X then rotate by 90 degrees
579 7 FYR90 flip Y then rotate by 90 degrees
583 default_stone.png^[transformFXR90
585 #### `[inventorycube{<top>{<left>{<right>`
587 Escaping does not apply here and `^` is replaced by `&` in texture names
590 Create an inventory cube texture using the side textures.
594 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
596 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
597 `dirt.png^grass_side.png` textures
599 #### `[lowpart:<percent>:<file>`
601 Blit the lower `<percent>`% part of `<file>` on the texture.
605 base.png^[lowpart:25:overlay.png
607 #### `[verticalframe:<t>:<n>`
609 * `<t>`: animation frame count
610 * `<n>`: current animation frame
612 Crops the texture to a frame of a vertical animation.
616 default_torch_animated.png^[verticalframe:16:8
620 Apply a mask to the base image.
622 The mask is applied using binary AND.
624 #### `[sheet:<w>x<h>:<x>,<y>`
626 Retrieves a tile at position x,y from the base image
627 which it assumes to be a tilesheet with dimensions w,h.
629 #### `[colorize:<color>:<ratio>`
631 Colorize the textures with the given color.
632 `<color>` is specified as a `ColorString`.
633 `<ratio>` is an int ranging from 0 to 255 or the word "`alpha`". If
634 it is an int, then it specifies how far to interpolate between the
635 colors where 0 is only the texture color and 255 is only `<color>`. If
636 omitted, the alpha of `<color>` will be used as the ratio. If it is
637 the word "`alpha`", then each texture pixel will contain the RGB of
638 `<color>` and the alpha of `<color>` multiplied by the alpha of the
641 #### `[multiply:<color>`
643 Multiplies texture colors with the given color.
644 `<color>` is specified as a `ColorString`.
645 Result is more like what you'd expect if you put a color on top of another
646 color, meaning white surfaces get a lot of your new color while black parts
647 don't change very much.
652 The goal of hardware coloring is to simplify the creation of
653 colorful nodes. If your textures use the same pattern, and they only
654 differ in their color (like colored wool blocks), you can use hardware
655 coloring instead of creating and managing many texture files.
656 All of these methods use color multiplication (so a white-black texture
657 with red coloring will result in red-black color).
661 This method is useful if you wish to create nodes/items with
662 the same texture, in different colors, each in a new node/item definition.
666 When you register an item or node, set its `color` field (which accepts a
667 `ColorSpec`) to the desired color.
669 An `ItemStack`'s static color can be overwritten by the `color` metadata
670 field. If you set that field to a `ColorString`, that color will be used.
674 Each tile may have an individual static color, which overwrites every
675 other coloring method. To disable the coloring of a face,
676 set its color to white (because multiplying with white does nothing).
677 You can set the `color` property of the tiles in the node's definition
678 if the tile is in table format.
682 For nodes and items which can have many colors, a palette is more
683 suitable. A palette is a texture, which can contain up to 256 pixels.
684 Each pixel is one possible color for the node/item.
685 You can register one node/item, which can have up to 256 colors.
687 #### Palette indexing
689 When using palettes, you always provide a pixel index for the given
690 node or `ItemStack`. The palette is read from left to right and from
691 top to bottom. If the palette has less than 256 pixels, then it is
692 stretched to contain exactly 256 pixels (after arranging the pixels
693 to one line). The indexing starts from 0.
697 * 16x16 palette, index = 0: the top left corner
698 * 16x16 palette, index = 4: the fifth pixel in the first row
699 * 16x16 palette, index = 16: the pixel below the top left corner
700 * 16x16 palette, index = 255: the bottom right corner
701 * 2 (width) x 4 (height) palette, index = 31: the top left corner.
702 The palette has 8 pixels, so each pixel is stretched to 32 pixels,
703 to ensure the total 256 pixels.
704 * 2x4 palette, index = 32: the top right corner
705 * 2x4 palette, index = 63: the top right corner
706 * 2x4 palette, index = 64: the pixel below the top left corner
708 #### Using palettes with items
710 When registering an item, set the item definition's `palette` field to
711 a texture. You can also use texture modifiers.
713 The `ItemStack`'s color depends on the `palette_index` field of the
714 stack's metadata. `palette_index` is an integer, which specifies the
715 index of the pixel to use.
717 #### Linking palettes with nodes
719 When registering a node, set the item definition's `palette` field to
720 a texture. You can also use texture modifiers.
721 The node's color depends on its `param2`, so you also must set an
722 appropriate `paramtype2`:
724 * `paramtype2 = "color"` for nodes which use their full `param2` for
725 palette indexing. These nodes can have 256 different colors.
726 The palette should contain 256 pixels.
727 * `paramtype2 = "colorwallmounted"` for nodes which use the first
728 five bits (most significant) of `param2` for palette indexing.
729 The remaining three bits are describing rotation, as in `wallmounted`
730 paramtype2. Division by 8 yields the palette index (without stretching the
731 palette). These nodes can have 32 different colors, and the palette
732 should contain 32 pixels.
734 * `param2 = 17` is 2 * 8 + 1, so the rotation is 1 and the third (= 2 + 1)
735 pixel will be picked from the palette.
736 * `param2 = 35` is 4 * 8 + 3, so the rotation is 3 and the fifth (= 4 + 1)
737 pixel will be picked from the palette.
738 * `paramtype2 = "colorfacedir"` for nodes which use the first
739 three bits of `param2` for palette indexing. The remaining
740 five bits are describing rotation, as in `facedir` paramtype2.
741 Division by 32 yields the palette index (without stretching the
742 palette). These nodes can have 8 different colors, and the
743 palette should contain 8 pixels.
745 * `param2 = 17` is 0 * 32 + 17, so the rotation is 17 and the
746 first (= 0 + 1) pixel will be picked from the palette.
747 * `param2 = 35` is 1 * 32 + 3, so the rotation is 3 and the
748 second (= 1 + 1) pixel will be picked from the palette.
750 To colorize a node on the map, set its `param2` value (according
751 to the node's paramtype2).
753 ### Conversion between nodes in the inventory and on the map
755 Static coloring is the same for both cases, there is no need
758 If the `ItemStack`'s metadata contains the `color` field, it will be
759 lost on placement, because nodes on the map can only use palettes.
761 If the `ItemStack`'s metadata contains the `palette_index` field, it is
762 automatically transferred between node and item forms by the engine,
763 when a player digs or places a colored node.
764 You can disable this feature by setting the `drop` field of the node
765 to itself (without metadata).
766 To transfer the color to a special drop, you need a drop table.
770 minetest.register_node("mod:stone", {
771 description = "Stone",
772 tiles = {"default_stone.png"},
773 paramtype2 = "color",
774 palette = "palette.png",
777 -- assume that mod:cobblestone also has the same palette
778 {items = {"mod:cobblestone"}, inherit_color = true },
783 ### Colored items in craft recipes
785 Craft recipes only support item strings, but fortunately item strings
786 can also contain metadata. Example craft recipe registration:
788 minetest.register_craft({
789 output = minetest.itemstring_with_palette("wool:block", 3),
797 To set the `color` field, you can use `minetest.itemstring_with_color`.
799 Metadata field filtering in the `recipe` field are not supported yet,
800 so the craft output is independent of the color of the ingredients.
805 Sometimes hardware coloring is not enough, because it affects the
806 whole tile. Soft texture overlays were added to Minetest to allow
807 the dynamic coloring of only specific parts of the node's texture.
808 For example a grass block may have colored grass, while keeping the
811 These overlays are 'soft', because unlike texture modifiers, the layers
812 are not merged in the memory, but they are simply drawn on top of each
813 other. This allows different hardware coloring, but also means that
814 tiles with overlays are drawn slower. Using too much overlays might
817 For inventory and wield images you can specify overlays which
818 hardware coloring does not modify. You have to set `inventory_overlay`
819 and `wield_overlay` fields to an image name.
821 To define a node overlay, simply set the `overlay_tiles` field of the node
822 definition. These tiles are defined in the same way as plain tiles:
823 they can have a texture name, color etc.
824 To skip one face, set that overlay tile to an empty string.
826 Example (colored grass block):
828 minetest.register_node("default:dirt_with_grass", {
829 description = "Dirt with Grass",
830 -- Regular tiles, as usual
831 -- The dirt tile disables palette coloring
832 tiles = {{name = "default_grass.png"},
833 {name = "default_dirt.png", color = "white"}},
834 -- Overlay tiles: define them in the same style
835 -- The top and bottom tile does not have overlay
836 overlay_tiles = {"", "",
837 {name = "default_grass_side.png", tileable_vertical = false}},
838 -- Global color, used in inventory
840 -- Palette in the world
841 paramtype2 = "color",
842 palette = "default_foilage.png",
851 Only Ogg Vorbis files are supported.
853 For positional playing of sounds, only single-channel (mono) files are
854 supported. Otherwise OpenAL will play them non-positionally.
856 Mods should generally prefix their sounds with `modname_`, e.g. given
857 the mod name "`foomod`", a sound could be called:
861 Sounds are referred to by their name with a dot, a single digit and the
862 file extension stripped out. When a sound is played, the actual sound file
863 is chosen randomly from the matching sounds.
865 When playing the sound `foomod_foosound`, the sound is chosen randomly
866 from the available ones of the following files:
868 * `foomod_foosound.ogg`
869 * `foomod_foosound.0.ogg`
870 * `foomod_foosound.1.ogg`
872 * `foomod_foosound.9.ogg`
874 Examples of sound parameter tables:
876 -- Play locationless on all clients
878 gain = 1.0, -- default
879 fade = 0.0, -- default, change to a value > 0 to fade the sound in
880 pitch = 1.0, -- default
882 -- Play locationless to one player
885 gain = 1.0, -- default
886 fade = 0.0, -- default, change to a value > 0 to fade the sound in
887 pitch = 1.0, -- default
889 -- Play locationless to one player, looped
892 gain = 1.0, -- default
895 -- Play at a location
897 pos = {x = 1, y = 2, z = 3},
898 gain = 1.0, -- default
899 max_hear_distance = 32, -- default, uses an euclidean metric
901 -- Play connected to an object, looped
903 object = <an ObjectRef>,
904 gain = 1.0, -- default
905 max_hear_distance = 32, -- default, uses an euclidean metric
908 -- Play at a location, heard by anyone *but* the given player
910 pos = {x = 32, y = 0, z = 100},
911 max_hear_distance = 40,
912 exclude_player = name,
915 Looped sounds must either be connected to an object or played locationless to
916 one player using `to_player = name`.
918 A positional sound will only be heard by players that are within
919 `max_hear_distance` of the sound position, at the start of the sound.
921 `exclude_player = name` can be applied to locationless, positional and object-
922 bound sounds to exclude a single player from hearing them.
927 Specifies a sound name, gain (=volume) and pitch.
928 This is either a string or a table.
930 In string form, you just specify the sound name or
931 the empty string for no sound.
933 Table form has the following fields:
936 * `gain`: Volume (`1.0` = 100%)
937 * `pitch`: Pitch (`1.0` = 100%)
939 `gain` and `pitch` are optional and default to `1.0`.
945 * `"default_place_node"`: Play e.g. `default_place_node.ogg`
946 * `{name = "default_place_node"}`: Same as above
947 * `{name = "default_place_node", gain = 0.5}`: 50% volume
948 * `{name = "default_place_node", gain = 0.9, pitch = 1.1}`: 90% volume, 110% pitch
953 These sound files are played back by the engine if provided.
955 * `player_damage`: Played when the local player takes damage (gain = 0.5)
956 * `player_falling_damage`: Played when the local player takes
957 damage by falling (gain = 0.5)
958 * `player_jump`: Played when the local player jumps
959 * `default_dig_<groupname>`: Default node digging sound
960 (see node sound definition for details)
962 Registered definitions
963 ======================
965 Anything added using certain [Registration functions] gets added to one or more
966 of the global [Registered definition tables].
968 Note that in some cases you will stumble upon things that are not contained
969 in these tables (e.g. when a mod has been removed). Always check for
970 existence before trying to access the fields.
974 All nodes register with `minetest.register_node` get added to the table
975 `minetest.registered_nodes`.
977 If you want to check the drawtype of a node, you could do:
979 local function get_nodedef_field(nodename, fieldname)
980 if not minetest.registered_nodes[nodename] then
983 return minetest.registered_nodes[nodename][fieldname]
985 local drawtype = get_nodedef_field(nodename, "drawtype")
993 Nodes are the bulk data of the world: cubes and other things that take the
994 space of a cube. Huge amounts of them are handled efficiently, but they
997 The definition of a node is stored and can be accessed by using
999 minetest.registered_nodes[node.name]
1001 See [Registered definitions].
1003 Nodes are passed by value between Lua and the engine.
1004 They are represented by a table:
1006 {name="name", param1=num, param2=num}
1008 `param1` and `param2` are 8-bit integers ranging from 0 to 255. The engine uses
1009 them for certain automated functions. If you don't use these functions, you can
1010 use them to store arbitrary values.
1015 The functions of `param1` and `param2` are determined by certain fields in the
1018 The function of `param1` is determined by `paramtype` in node definition.
1019 `param1` is reserved for the engine when `paramtype != "none"`.
1021 * `paramtype = "light"`
1022 * The value stores light with and without sun in its upper and lower 4 bits
1024 * Required by a light source node to enable spreading its light.
1025 * Required by the following drawtypes as they determine their visual
1026 brightness from their internal light value:
1036 * `paramtype = "none"`
1037 * `param1` will not be used by the engine and can be used to store
1040 The function of `param2` is determined by `paramtype2` in node definition.
1041 `param2` is reserved for the engine when `paramtype2 != "none"`.
1043 * `paramtype2 = "flowingliquid"`
1044 * Used by `drawtype = "flowingliquid"` and `liquidtype = "flowing"`
1045 * The liquid level and a flag of the liquid are stored in `param2`
1046 * Bits 0-2: Liquid level (0-7). The higher, the more liquid is in this node
1047 * Bit 3: If set, liquid is flowing downwards (no graphical effect)
1048 * `paramtype2 = "wallmounted"`
1049 * Supported drawtypes: "torchlike", "signlike", "normal", "nodebox", "mesh"
1050 * The rotation of the node is stored in `param2`
1051 * You can make this value by using `minetest.dir_to_wallmounted()`
1052 * Values range 0 - 5
1053 * The value denotes at which direction the node is "mounted":
1054 0 = y+, 1 = y-, 2 = x+, 3 = x-, 4 = z+, 5 = z-
1055 * `paramtype2 = "facedir"`
1056 * Supported drawtypes: "normal", "nodebox", "mesh"
1057 * The rotation of the node is stored in `param2`. Furnaces and chests are
1058 rotated this way. Can be made by using `minetest.dir_to_facedir()`.
1059 * Values range 0 - 23
1060 * facedir / 4 = axis direction:
1061 0 = y+, 1 = z+, 2 = z-, 3 = x+, 4 = x-, 5 = y-
1062 * facedir modulo 4 = rotation around that axis
1063 * `paramtype2 = "leveled"`
1064 * Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
1066 * The level of the top face of the nodebox is stored in `param2`.
1067 * The other faces are defined by 'fixed = {}' like 'type = "fixed"'
1069 * The nodebox height is (`param2` / 64) nodes.
1070 * The maximum accepted value of `param2` is 127.
1072 * The height of the 'plantlike' section is stored in `param2`.
1073 * The height is (`param2` / 16) nodes.
1074 * `paramtype2 = "degrotate"`
1075 * Only valid for "plantlike" drawtype. The rotation of the node is stored in
1077 * Values range 0 - 179. The value stored in `param2` is multiplied by two to
1078 get the actual rotation in degrees of the node.
1079 * `paramtype2 = "meshoptions"`
1080 * Only valid for "plantlike" drawtype. `param2` encodes the shape and
1081 optional modifiers of the "plant". `param2` is a bitfield.
1082 * Bits 0 to 2 select the shape.
1083 Use only one of the values below:
1084 * 0 = a "x" shaped plant (ordinary plant)
1085 * 1 = a "+" shaped plant (just rotated 45 degrees)
1086 * 2 = a "*" shaped plant with 3 faces instead of 2
1087 * 3 = a "#" shaped plant with 4 faces instead of 2
1088 * 4 = a "#" shaped plant with 4 faces that lean outwards
1089 * 5-7 are unused and reserved for future meshes.
1090 * Bits 3 to 7 are used to enable any number of optional modifiers.
1091 Just add the corresponding value(s) below to `param2`:
1092 * 8 - Makes the plant slightly vary placement horizontally
1093 * 16 - Makes the plant mesh 1.4x larger
1094 * 32 - Moves each face randomly a small bit down (1/8 max)
1095 * values 64 and 128 (bits 6-7) are reserved for future use.
1096 * Example: `param2 = 0` selects a normal "x" shaped plant
1097 * Example: `param2 = 17` selects a "+" shaped plant, 1.4x larger (1+16)
1098 * `paramtype2 = "color"`
1099 * `param2` tells which color is picked from the palette.
1100 The palette should have 256 pixels.
1101 * `paramtype2 = "colorfacedir"`
1102 * Same as `facedir`, but with colors.
1103 * The first three bits of `param2` tells which color is picked from the
1104 palette. The palette should have 8 pixels.
1105 * `paramtype2 = "colorwallmounted"`
1106 * Same as `wallmounted`, but with colors.
1107 * The first five bits of `param2` tells which color is picked from the
1108 palette. The palette should have 32 pixels.
1109 * `paramtype2 = "glasslikeliquidlevel"`
1110 * Only valid for "glasslike_framed" or "glasslike_framed_optional"
1112 * `param2` values 0-63 define 64 levels of internal liquid, 0 being empty
1114 * Liquid texture is defined using `special_tiles = {"modname_tilename.png"}`
1115 * `paramtype2 = "none"`
1116 * `param2` will not be used by the engine and can be used to store
1119 Nodes can also contain extra data. See [Node Metadata].
1124 There are a bunch of different looking node types.
1126 Look for examples in `games/devtest` or `games/minetest_game`.
1129 * A node-sized cube.
1131 * Invisible, uses no texture.
1133 * The cubic source node for a liquid.
1135 * The flowing version of a liquid, appears with various heights and slopes.
1137 * Often used for partially-transparent nodes.
1138 * Only external sides of textures are visible.
1139 * `glasslike_framed`
1140 * All face-connected nodes are drawn as one volume within a surrounding
1142 * The frame appearance is generated from the edges of the first texture
1143 specified in `tiles`. The width of the edges used are 1/16th of texture
1144 size: 1 pixel for 16x16, 2 pixels for 32x32 etc.
1145 * The glass 'shine' (or other desired detail) on each node face is supplied
1146 by the second texture specified in `tiles`.
1147 * `glasslike_framed_optional`
1148 * This switches between the above 2 drawtypes according to the menu setting
1151 * Often used for partially-transparent nodes.
1152 * External and internal sides of textures are visible.
1153 * `allfaces_optional`
1154 * Often used for leaves nodes.
1155 * This switches between `normal`, `glasslike` and `allfaces` according to
1156 the menu setting: Opaque Leaves / Simple Leaves / Fancy Leaves.
1157 * With 'Simple Leaves' selected, the texture specified in `special_tiles`
1158 is used instead, if present. This allows a visually thicker texture to be
1159 used to compensate for how `glasslike` reduces visual thickness.
1161 * A single vertical texture.
1162 * If placed on top of a node, uses the first texture specified in `tiles`.
1163 * If placed against the underside of a node, uses the second texture
1164 specified in `tiles`.
1165 * If placed on the side of a node, uses the third texture specified in
1166 `tiles` and is perpendicular to that node.
1168 * A single texture parallel to, and mounted against, the top, underside or
1171 * Two vertical and diagonal textures at right-angles to each other.
1172 * See `paramtype2 = "meshoptions"` above for other options.
1174 * When above a flat surface, appears as 6 textures, the central 2 as
1175 `plantlike` plus 4 more surrounding those.
1176 * If not above a surface the central 2 do not appear, but the texture
1177 appears against the faces of surrounding nodes if they are present.
1179 * A 3D model suitable for a wooden fence.
1180 * One placed node appears as a single vertical post.
1181 * Adjacently-placed nodes cause horizontal bars to appear between them.
1183 * Often used for tracks for mining carts.
1184 * Requires 4 textures to be specified in `tiles`, in order: Straight,
1185 curved, t-junction, crossing.
1186 * Each placed node automatically switches to a suitable rotated texture
1187 determined by the adjacent `raillike` nodes, in order to create a
1188 continuous track network.
1189 * Becomes a sloping node if placed against stepped nodes.
1191 * Often used for stairs and slabs.
1192 * Allows defining nodes consisting of an arbitrary number of boxes.
1193 * See [Node boxes] below for more information.
1195 * Uses models for nodes.
1196 * Tiles should hold model materials textures.
1197 * Only static meshes are implemented.
1198 * For supported model formats see Irrlicht engine documentation.
1199 * `plantlike_rooted`
1200 * Enables underwater `plantlike` without air bubbles around the nodes.
1201 * Consists of a base cube at the co-ordinates of the node plus a
1202 `plantlike` extension above with a height of `param2 / 16` nodes.
1203 * The `plantlike` extension visually passes through any nodes above the
1204 base cube without affecting them.
1205 * The base cube texture tiles are defined as normal, the `plantlike`
1206 extension uses the defined special tile, for example:
1207 `special_tiles = {{name = "default_papyrus.png", tileable_vertical = true}},`
1209 `*_optional` drawtypes need less rendering time if deactivated
1210 (always client-side).
1215 Node selection boxes are defined using "node boxes".
1217 A nodebox is defined as any of:
1220 -- A normal cube; the default in most things
1224 -- A fixed box (or boxes) (facedir param2 is used, if applicable)
1226 fixed = box OR {box1, box2, ...}
1229 -- A variable height box (or boxes) with the top face position defined
1230 -- by the node parameter 'leveled = ', or if 'paramtype2 == "leveled"'
1232 -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
1234 fixed = box OR {box1, box2, ...}
1237 -- A box like the selection box for torches
1238 -- (wallmounted param2 is used, if applicable)
1239 type = "wallmounted",
1245 -- A node that has optional boxes depending on neighbouring nodes'
1246 -- presence and type. See also `connects_to`.
1248 fixed = box OR {box1, box2, ...}
1249 connect_top = box OR {box1, box2, ...}
1250 connect_bottom = box OR {box1, box2, ...}
1251 connect_front = box OR {box1, box2, ...}
1252 connect_left = box OR {box1, box2, ...}
1253 connect_back = box OR {box1, box2, ...}
1254 connect_right = box OR {box1, box2, ...}
1255 -- The following `disconnected_*` boxes are the opposites of the
1256 -- `connect_*` ones above, i.e. when a node has no suitable neighbour
1257 -- on the respective side, the corresponding disconnected box is drawn.
1258 disconnected_top = box OR {box1, box2, ...}
1259 disconnected_bottom = box OR {box1, box2, ...}
1260 disconnected_front = box OR {box1, box2, ...}
1261 disconnected_left = box OR {box1, box2, ...}
1262 disconnected_back = box OR {box1, box2, ...}
1263 disconnected_right = box OR {box1, box2, ...}
1264 disconnected = box OR {box1, box2, ...} -- when there is *no* neighbour
1265 disconnected_sides = box OR {box1, box2, ...} -- when there are *no*
1266 -- neighbours to the sides
1269 A `box` is defined as:
1271 {x1, y1, z1, x2, y2, z2}
1273 A box of a regular node would look like:
1275 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
1280 Map terminology and coordinates
1281 ===============================
1283 Nodes, mapblocks, mapchunks
1284 ---------------------------
1286 A 'node' is the fundamental cubic unit of a world and appears to a player as
1287 roughly 1x1x1 meters in size.
1289 A 'mapblock' (often abbreviated to 'block') is 16x16x16 nodes and is the
1290 fundamental region of a world that is stored in the world database, sent to
1291 clients and handled by many parts of the engine.
1292 'mapblock' is preferred terminology to 'block' to help avoid confusion with
1293 'node', however 'block' often appears in the API.
1295 A 'mapchunk' (sometimes abbreviated to 'chunk') is usually 5x5x5 mapblocks
1296 (80x80x80 nodes) and is the volume of world generated in one operation by
1298 The size in mapblocks has been chosen to optimise map generation.
1303 ### Orientation of axes
1305 For node and mapblock coordinates, +X is East, +Y is up, +Z is North.
1307 ### Node coordinates
1309 Almost all positions used in the API use node coordinates.
1311 ### Mapblock coordinates
1313 Occasionally the API uses 'blockpos' which refers to mapblock coordinates that
1314 specify a particular mapblock.
1315 For example blockpos (0,0,0) specifies the mapblock that extends from
1316 node position (0,0,0) to node position (15,15,15).
1318 #### Converting node position to the containing blockpos
1320 To calculate the blockpos of the mapblock that contains the node at 'nodepos',
1323 * blockpos = math.floor(nodepos / 16)
1325 #### Converting blockpos to min/max node positions
1327 To calculate the min/max node positions contained in the mapblock at 'blockpos',
1331 nodepos = blockpos * 16
1333 nodepos = blockpos * 16 + 15
1344 The position field is used for all element types.
1346 To account for differing resolutions, the position coordinates are the
1347 percentage of the screen, ranging in value from `0` to `1`.
1349 The name field is not yet used, but should contain a description of what the
1350 HUD element represents.
1352 The `direction` field is the direction in which something is drawn.
1353 `0` draws from left to right, `1` draws from right to left, `2` draws from
1354 top to bottom, and `3` draws from bottom to top.
1356 The `alignment` field specifies how the item will be aligned. It is a table
1357 where `x` and `y` range from `-1` to `1`, with `0` being central. `-1` is
1358 moved to the left/up, and `1` is to the right/down. Fractional values can be
1361 The `offset` field specifies a pixel offset from the position. Contrary to
1362 position, the offset is not scaled to screen size. This allows for some
1363 precisely positioned items in the HUD.
1365 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
1368 The `z_index` field specifies the order of HUD elements from back to front.
1369 Lower z-index elements are displayed behind higher z-index elements. Elements
1370 with same z-index are displayed in an arbitrary order. Default 0.
1371 Supports negative values. By convention, the following values are recommended:
1373 * -400: Graphical effects, such as vignette
1374 * -300: Name tags, waypoints
1376 * -100: Things that block the player's view, e.g. masks
1377 * 0: Default. For standard in-game HUD elements like crosshair, hotbar,
1378 minimap, builtin statbars, etc.
1379 * 100: Temporary text messages or notification icons
1380 * 1000: Full-screen effects such as full-black screen or credits.
1381 This includes effects that cover the entire screen
1382 * Other: If your HUD element doesn't fit into any category, pick a number
1383 between the suggested values
1387 Below are the specific uses for fields in each type; fields not listed for that
1392 Displays an image on the HUD.
1394 * `scale`: The scale of the image, with 1 being the original texture size.
1395 Only the X coordinate scale is used (positive values).
1396 Negative values represent that percentage of the screen it
1397 should take; e.g. `x=-100` means 100% (width).
1398 * `text`: The name of the texture that is displayed.
1399 * `alignment`: The alignment of the image.
1400 * `offset`: offset in pixels from position.
1404 Displays text on the HUD.
1406 * `scale`: Defines the bounding rectangle of the text.
1407 A value such as `{x=100, y=100}` should work.
1408 * `text`: The text to be displayed in the HUD element.
1409 * `number`: An integer containing the RGB value of the color used to draw the
1410 text. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1411 * `alignment`: The alignment of the text.
1412 * `offset`: offset in pixels from position.
1413 * `size`: size of the text.
1414 The player-set font size is multiplied by size.x (y value isn't used).
1418 Displays a horizontal bar made up of half-images with an optional background.
1420 * `text`: The name of the texture to use.
1421 * `text2`: Optional texture name to enable a background / "off state"
1422 texture (useful to visualize the maximal value). Both textures
1423 must have the same size.
1424 * `number`: The number of half-textures that are displayed.
1425 If odd, will end with a vertically center-split texture.
1426 * `item`: Same as `number` but for the "off state" texture
1427 * `direction`: To which direction the images will extend to
1428 * `offset`: offset in pixels from position.
1429 * `size`: If used, will force full-image size to this value (override texture
1434 * `text`: The name of the inventory list to be displayed.
1435 * `number`: Number of items in the inventory to be displayed.
1436 * `item`: Position of item that is selected.
1438 * `offset`: offset in pixels from position.
1442 Displays distance to selected world position.
1444 * `name`: The name of the waypoint.
1445 * `text`: Distance suffix. Can be blank.
1446 * `precision`: Waypoint precision, integer >= 0. Defaults to 10.
1447 If set to 0, distance is not shown. Shown value is `floor(distance*precision)/precision`.
1448 When the precision is an integer multiple of 10, there will be `log_10(precision)` digits after the decimal point.
1449 `precision = 1000`, for example, will show 3 decimal places (eg: `0.999`).
1450 `precision = 2` will show multiples of `0.5`; precision = 5 will show multiples of `0.2` and so on:
1451 `precision = n` will show multiples of `1/n`
1452 * `number:` An integer containing the RGB value of the color used to draw the
1454 * `world_pos`: World position of the waypoint.
1455 * `offset`: offset in pixels from position.
1456 * `alignment`: The alignment of the waypoint.
1458 ### `image_waypoint`
1460 Same as `image`, but does not accept a `position`; the position is instead determined by `world_pos`, the world position of the waypoint.
1462 * `scale`: The scale of the image, with 1 being the original texture size.
1463 Only the X coordinate scale is used (positive values).
1464 Negative values represent that percentage of the screen it
1465 should take; e.g. `x=-100` means 100% (width).
1466 * `text`: The name of the texture that is displayed.
1467 * `alignment`: The alignment of the image.
1468 * `world_pos`: World position of the waypoint.
1469 * `offset`: offset in pixels from position.
1473 Displays an image oriented or translated according to current heading direction.
1475 * `size`: The size of this element. Negative values represent percentage
1476 of the screen; e.g. `x=-100` means 100% (width).
1477 * `scale`: Scale of the translated image (used only for dir = 2 or dir = 3).
1478 * `text`: The name of the texture to use.
1479 * `alignment`: The alignment of the image.
1480 * `offset`: Offset in pixels from position.
1481 * `dir`: How the image is rotated/translated:
1482 * 0 - Rotate as heading direction
1483 * 1 - Rotate in reverse direction
1484 * 2 - Translate as landscape direction
1485 * 3 - Translate in reverse direction
1487 If translation is chosen, texture is repeated horizontally to fill the whole element.
1491 Displays a minimap on the HUD.
1493 * `size`: Size of the minimap to display. Minimap should be a square to avoid
1495 * `alignment`: The alignment of the minimap.
1496 * `offset`: offset in pixels from position.
1498 Representations of simple things
1499 ================================
1504 {x=num, y=num, z=num}
1506 For helper functions see [Spatial Vectors].
1511 * `{type="nothing"}`
1512 * `{type="node", under=pos, above=pos}`
1513 * Indicates a pointed node selection box.
1514 * `under` refers to the node position behind the pointed face.
1515 * `above` refers to the node position in front of the pointed face.
1516 * `{type="object", ref=ObjectRef}`
1518 Exact pointing location (currently only `Raycast` supports these fields):
1520 * `pointed_thing.intersection_point`: The absolute world coordinates of the
1521 point on the selection box which is pointed at. May be in the selection box
1522 if the pointer is in the box too.
1523 * `pointed_thing.box_id`: The ID of the pointed selection box (counting starts
1525 * `pointed_thing.intersection_normal`: Unit vector, points outwards of the
1526 selected selection box. This specifies which face is pointed at.
1527 Is a null vector `{x = 0, y = 0, z = 0}` when the pointer is inside the
1533 Flag Specifier Format
1534 =====================
1536 Flags using the standardized flag specifier format can be specified in either
1537 of two ways, by string or table.
1539 The string format is a comma-delimited set of flag names; whitespace and
1540 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1541 flag, and specifying a flag prefixed by the string `"no"` explicitly
1542 clears the flag from whatever the default may be.
1544 In addition to the standard string flag format, the schematic flags field can
1545 also be a table of flag names to boolean values representing whether or not the
1546 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1547 is present, mapped to a boolean of any value, the specified flag is unset.
1549 E.g. A flag field of value
1551 {place_center_x = true, place_center_y=false, place_center_z=true}
1555 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1557 which is equivalent to
1559 "place_center_x, noplace_center_y, place_center_z"
1563 "place_center_x, place_center_z"
1565 since, by default, no schematic attributes are set.
1576 There are three kinds of items: nodes, tools and craftitems.
1578 * Node: Can be placed in the world's voxel grid
1579 * Tool: Has a wear property but cannot be stacked. The default use action is to
1580 dig nodes or hit objects according to its tool capabilities.
1581 * Craftitem: Cannot dig nodes or be placed
1586 All item stacks have an amount between 0 and 65535. It is 1 by
1587 default. Tool item stacks can not have an amount greater than 1.
1589 Tools use a wear (damage) value ranging from 0 to 65535. The
1590 value 0 is the default and is used for unworn tools. The values
1591 1 to 65535 are used for worn tools, where a higher value stands for
1592 a higher wear. Non-tools always have a wear value of 0.
1597 Items and item stacks can exist in three formats: Serializes, table format
1600 When an item must be passed to a function, it can usually be in any of
1605 This is called "stackstring" or "itemstring". It is a simple string with
1606 1-3 components: the full item identifier, an optional amount and an optional
1609 <identifier> [<amount>[ <wear>]]
1613 * `'default:apple'`: 1 apple
1614 * `'default:dirt 5'`: 5 dirt
1615 * `'default:pick_stone'`: a new stone pickaxe
1616 * `'default:pick_wood 1 21323'`: a wooden pickaxe, ca. 1/3 worn out
1624 {name="default:dirt", count=5, wear=0, metadata=""}
1626 A wooden pick about 1/3 worn out:
1628 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1632 {name="default:apple", count=1, wear=0, metadata=""}
1636 A native C++ format with many helper methods. Useful for converting
1637 between formats. See the [Class reference] section for details.
1645 In a number of places, there is a group table. Groups define the
1646 properties of a thing (item, node, armor of entity, capabilities of
1647 tool) in such a way that the engine and other mods can can interact with
1648 the thing without actually knowing what the thing is.
1653 Groups are stored in a table, having the group names with keys and the
1654 group ratings as values. Group ratings are integer values within the
1655 range [-32767, 32767]. For example:
1658 groups = {crumbly=3, soil=1}
1660 -- A more special dirt-kind of thing
1661 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1663 Groups always have a rating associated with them. If there is no
1664 useful meaning for a rating for an enabled group, it shall be `1`.
1666 When not defined, the rating of a group defaults to `0`. Thus when you
1667 read groups, you must interpret `nil` and `0` as the same value, `0`.
1669 You can read the rating of a group for an item or a node by using
1671 minetest.get_item_group(itemname, groupname)
1676 Groups of items can define what kind of an item it is (e.g. wool).
1681 In addition to the general item things, groups are used to define whether
1682 a node is destroyable and how long it takes to destroy by a tool.
1687 For entities, groups are, as of now, used only for calculating damage.
1688 The rating is the percentage of damage caused by tools with this damage group.
1689 See [Entity damage mechanism].
1691 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1692 object.set_armor_groups({fleshy=30, cracky=80})
1697 Groups in tools define which groups of nodes and entities they are
1700 Groups in crafting recipes
1701 --------------------------
1703 An example: Make meat soup from any meat, any water and any bowl:
1706 output = 'food:meat_soup_raw',
1712 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1715 Another example: Make red wool from white wool and red dye:
1719 output = 'wool:red',
1720 recipe = {'wool:white', 'group:dye,basecolor_red'},
1726 The asterisk `(*)` after a group name describes that there is no engine
1727 functionality bound to it, and implementation is left up as a suggestion
1730 ### Node, item and tool groups
1732 * `not_in_creative_inventory`: (*) Special group for inventory mods to indicate
1733 that the item should be hidden in item lists.
1736 ### Node-only groups
1738 * `attached_node`: if the node under it is not a walkable block the node will be
1739 dropped as an item. If the node is wallmounted the wallmounted direction is
1741 * `bouncy`: value is bounce speed in percent
1742 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1743 connect to each other
1744 * `dig_immediate`: Player can always pick up node without reducing tool wear
1745 * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
1746 * `3`: the node always gets the digging time 0 seconds (torch)
1747 * `disable_jump`: Player (and possibly other things) cannot jump from node
1748 or if their feet are in the node. Note: not supported for `new_move = false`
1749 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1750 * `falling_node`: if there is no walkable block under the node it will fall
1751 * `float`: the node will not fall through liquids
1752 * `level`: Can be used to give an additional sense of progression in the game.
1753 * A larger level will cause e.g. a weapon of a lower level make much less
1754 damage, and get worn out much faster, or not be able to get drops
1755 from destroyed nodes.
1756 * `0` is something that is directly accessible at the start of gameplay
1757 * There is no upper limit
1758 * See also: `leveldiff` in [Tools]
1759 * `slippery`: Players and items will slide on the node.
1760 Slipperiness rises steadily with `slippery` value, starting at 1.
1763 ### Tool-only groups
1765 * `disable_repair`: If set to 1 for a tool, it cannot be repaired using the
1766 `"toolrepair"` crafting recipe
1769 ### `ObjectRef` groups
1771 * `immortal`: Skips all damage and breath handling for an object. This group
1772 will also hide the integrated HUD status bars for players, and is
1773 automatically set to all players when damage is disabled on the server.
1774 * `punch_operable`: For entities; disables the regular damage mechanism for
1775 players punching it by hand or a non-tool item, so that it can do something
1776 else than take damage.
1780 Known damage and digging time defining groups
1781 ---------------------------------------------
1783 * `crumbly`: dirt, sand
1784 * `cracky`: tough but crackable stuff like stone.
1785 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1786 plants, wire, sheets of metal
1787 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1788 * `fleshy`: Living things like animals and the player. This could imply
1789 some blood effects when hitting.
1790 * `explody`: Especially prone to explosions
1791 * `oddly_breakable_by_hand`:
1792 Can be added to nodes that shouldn't logically be breakable by the
1793 hand but are. Somewhat similar to `dig_immediate`, but times are more
1794 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1795 speed of a tool if the tool can dig at a faster speed than this
1796 suggests for the hand.
1798 Examples of custom groups
1799 -------------------------
1801 Item groups are often used for defining, well, _groups of items_.
1803 * `meat`: any meat-kind of a thing (rating might define the size or healing
1804 ability or be irrelevant -- it is not defined as of yet)
1805 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1807 * `flammable`: can be set on fire. Rating might define the intensity of the
1808 fire, affecting e.g. the speed of the spreading of an open fire.
1809 * `wool`: any wool (any origin, any color)
1810 * `metal`: any metal
1811 * `weapon`: any weapon
1812 * `heavy`: anything considerably heavy
1814 Digging time calculation specifics
1815 ----------------------------------
1817 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1818 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1819 faster digging time.
1821 The `level` group is used to limit the toughness of nodes a tool can dig
1822 and to scale the digging times / damage to a greater extent.
1824 **Please do understand this**, otherwise you cannot use the system to it's
1827 Tools define their properties by a list of parameters for groups. They
1828 cannot dig other groups; thus it is important to use a standard bunch of
1829 groups to enable interaction with tools.
1842 * Full punch interval
1843 * Maximum drop level
1844 * For an arbitrary list of groups:
1845 * Uses (until the tool breaks)
1846 * Maximum level (usually `0`, `1`, `2` or `3`)
1850 ### Full punch interval
1852 When used as a weapon, the tool will do full damage if this time is spent
1853 between punches. If e.g. half the time is spent, the tool will do half
1856 ### Maximum drop level
1858 Suggests the maximum level of node, when dug with the tool, that will drop
1859 it's useful item. (e.g. iron ore to drop a lump of iron).
1861 This is not automated; it is the responsibility of the node definition
1866 Determines how many uses the tool has when it is used for digging a node,
1867 of this group, of the maximum level. For lower leveled nodes, the use count
1868 is multiplied by `3^leveldiff`.
1869 `leveldiff` is the difference of the tool's `maxlevel` `groupcaps` and the
1870 node's `level` group. The node cannot be dug if `leveldiff` is less than zero.
1872 * `uses=10, leveldiff=0`: actual uses: 10
1873 * `uses=10, leveldiff=1`: actual uses: 30
1874 * `uses=10, leveldiff=2`: actual uses: 90
1878 Tells what is the maximum level of a node of this group that the tool will
1883 List of digging times for different ratings of the group, for nodes of the
1886 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1887 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1888 for this group, and unable to dig the rating `1`, which is the toughest.
1889 Unless there is a matching group that enables digging otherwise.
1891 If the result digging time is 0, a delay of 0.15 seconds is added between
1892 digging nodes; If the player releases LMB after digging, this delay is set to 0,
1893 i.e. players can more quickly click the nodes away instead of holding LMB.
1897 List of damage for groups of entities. See [Entity damage mechanism].
1899 Example definition of the capabilities of a tool
1900 ------------------------------------------------
1902 tool_capabilities = {
1903 full_punch_interval=1.5,
1906 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1908 damage_groups = {fleshy=2},
1911 This makes the tool be able to dig nodes that fulfil both of these:
1913 * Have the `crumbly` group
1914 * Have a `level` group less or equal to `2`
1916 Table of resulting digging times:
1918 crumbly 0 1 2 3 4 <- level
1920 1 0.80 1.60 1.60 - -
1921 2 0.60 1.20 1.20 - -
1922 3 0.40 0.80 0.80 - -
1924 level diff: 2 1 0 -1 -2
1926 Table of resulting tool uses:
1935 * At `crumbly==0`, the node is not diggable.
1936 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1937 easy nodes to be quickly breakable.
1938 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1943 Entity damage mechanism
1944 =======================
1949 foreach group in cap.damage_groups:
1950 damage += cap.damage_groups[group]
1951 * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
1952 * (object.armor_groups[group] / 100.0)
1953 -- Where object.armor_groups[group] is 0 for inexistent values
1956 Client predicts damage based on damage groups. Because of this, it is able to
1957 give an immediate response when an entity is damaged or dies; the response is
1958 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1960 Currently a smoke puff will appear when an entity dies.
1962 The group `immortal` completely disables normal damage.
1964 Entities can define a special armor group, which is `punch_operable`. This
1965 group disables the regular damage mechanism for players punching it by hand or
1966 a non-tool item, so that it can do something else than take damage.
1968 On the Lua side, every punch calls:
1970 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction,
1973 This should never be called directly, because damage is usually not handled by
1976 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1977 accessed unless absolutely required, to encourage interoperability.
1978 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1979 * `tool_capabilities` can be `nil`.
1980 * `direction` is a unit vector, pointing from the source of the punch to
1982 * `damage` damage that will be done to entity
1983 Return value of this function will determine if damage is done by this function
1984 (retval true) or shall be done by engine (retval false)
1986 To punch an entity/object in Lua, call:
1988 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1990 * Return value is tool wear.
1991 * Parameters are equal to the above callback.
1992 * If `direction` equals `nil` and `puncher` does not equal `nil`, `direction`
1993 will be automatically filled in based on the location of `puncher`.
2004 The instance of a node in the world normally only contains the three values
2005 mentioned in [Nodes]. However, it is possible to insert extra data into a node.
2006 It is called "node metadata"; See `NodeMetaRef`.
2008 Node metadata contains two things:
2013 Some of the values in the key-value store are handled specially:
2015 * `formspec`: Defines a right-click inventory menu. See [Formspec].
2016 * `infotext`: Text shown on the screen when the node is pointed at
2020 local meta = minetest.get_meta(pos)
2021 meta:set_string("formspec",
2023 "list[context;main;0,0;8,4;]"..
2024 "list[current_player;main;0,5;8,4;]")
2025 meta:set_string("infotext", "Chest");
2026 local inv = meta:get_inventory()
2027 inv:set_size("main", 8*4)
2028 print(dump(meta:to_table()))
2031 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
2032 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
2033 [10] = "", [11] = "", [12] = "", [13] = "",
2034 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
2035 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
2036 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
2037 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
2041 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
2049 Item stacks can store metadata too. See [`ItemStackMetaRef`].
2051 Item metadata only contains a key-value store.
2053 Some of the values in the key-value store are handled specially:
2055 * `description`: Set the item stack's description. Defaults to
2057 * `color`: A `ColorString`, which sets the stack's color.
2058 * `palette_index`: If the item has a palette, this is used to get the
2059 current color from the palette.
2063 local meta = stack:get_meta()
2064 meta:set_string("key", "value")
2065 print(dump(meta:to_table()))
2073 Formspec defines a menu. This supports inventories and some of the
2074 typical widgets like buttons, checkboxes, text input fields, etc.
2075 It is a string, with a somewhat strange format.
2077 A formspec is made out of formspec elements, which includes widgets
2078 like buttons but also can be used to set stuff like background color.
2080 Many formspec elements have a `name`, which is a unique identifier which
2081 is used when the server receives user input. You must not use the name
2082 "quit" for formspec elements.
2084 Spaces and newlines can be inserted between the blocks, as is used in the
2087 Position and size units are inventory slots unless the new coordinate system
2088 is enabled. `X` and `Y` position the formspec element relative to the top left
2089 of the menu or container. `W` and `H` are its width and height values.
2091 If the new system is enabled, all elements have unified coordinates for all
2092 elements with no padding or spacing in between. This is highly recommended
2093 for new forms. See `real_coordinates[<bool>]` and `Migrating to Real
2096 Inventories with a `player:<name>` inventory location are only sent to the
2097 player named `<name>`.
2099 When displaying text which can contain formspec code, e.g. text set by a player,
2100 use `minetest.formspec_escape`.
2101 For coloured text you can use `minetest.colorize`.
2103 Since formspec version 3, elements drawn in the order they are defined. All
2104 background elements are drawn before all other elements.
2106 **WARNING**: do _not_ use a element name starting with `key_`; those names are
2107 reserved to pass key press events to formspec!
2109 **WARNING**: Minetest allows you to add elements to every single formspec instance
2110 using `player:set_formspec_prepend()`, which may be the reason backgrounds are
2111 appearing when you don't expect them to, or why things are styled differently
2112 to normal. See [`no_prepend[]`] and [Styling Formspecs].
2120 list[context;main;0,0;8,4;]
2121 list[current_player;main;0,5;8,4;]
2126 list[context;fuel;2,3;1,1;]
2127 list[context;src;2,1;1,1;]
2128 list[context;dst;5,1;2,2;]
2129 list[current_player;main;0,5;8,4;]
2131 ### Minecraft-like player inventory
2134 image[1,0.6;1,2;player.png]
2135 list[current_player;main;0,3.5;8,4;]
2136 list[current_player;craft;3,0;3,3;]
2137 list[current_player;craftpreview;7,1;1,1;]
2142 ### `formspec_version[<version>]`
2144 * Set the formspec version to a certain number. If not specified,
2145 version 1 is assumed.
2146 * Must be specified before `size` element.
2147 * Clients older than this version can neither show newer elements nor display
2148 elements with new arguments correctly.
2149 * Available since feature `formspec_version_element`.
2151 ### `size[<W>,<H>,<fixed_size>]`
2153 * Define the size of the menu in inventory slots
2154 * `fixed_size`: `true`/`false` (optional)
2155 * deprecated: `invsize[<W>,<H>;]`
2157 ### `position[<X>,<Y>]`
2159 * Must be used after `size` element.
2160 * Defines the position on the game window of the formspec's `anchor` point.
2161 * For X and Y, 0.0 and 1.0 represent opposite edges of the game window,
2163 * [0.0, 0.0] sets the position to the top left corner of the game window.
2164 * [1.0, 1.0] sets the position to the bottom right of the game window.
2165 * Defaults to the center of the game window [0.5, 0.5].
2167 ### `anchor[<X>,<Y>]`
2169 * Must be used after both `size` and `position` (if present) elements.
2170 * Defines the location of the anchor point within the formspec.
2171 * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec,
2173 * [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
2174 * [1.0, 0.0] sets the anchor to the top right of the formspec.
2175 * Defaults to the center of the formspec [0.5, 0.5].
2177 * `position` and `anchor` elements need suitable values to avoid a formspec
2178 extending off the game window due to particular game window sizes.
2182 * Must be used after the `size`, `position`, and `anchor` elements (if present).
2183 * Disables player:set_formspec_prepend() from applying to this formspec.
2185 ### `real_coordinates[<bool>]`
2187 * INFORMATION: Enable it automatically using `formspec_version` version 2 or newer.
2188 * When set to true, all following formspec elements will use the new coordinate system.
2189 * If used immediately after `size`, `position`, `anchor`, and `no_prepend` elements
2190 (if present), the form size will use the new coordinate system.
2191 * **Note**: Formspec prepends are not affected by the coordinates in the main form.
2192 They must enable it explicitly.
2193 * For information on converting forms to the new coordinate system, see `Migrating
2194 to Real Coordinates`.
2196 ### `container[<X>,<Y>]`
2198 * Start of a container block, moves all physical elements in the container by
2200 * Must have matching `container_end`
2201 * Containers can be nested, in which case the offsets are added
2202 (child containers are relative to parent containers)
2204 ### `container_end[]`
2206 * End of a container, following elements are no longer relative to this
2209 ### `scroll_container[<X>,<Y>;<W>,<H>;<scrollbar name>;<orientation>;<scroll factor>]`
2211 * Start of a scroll_container block. All contained elements will ...
2212 * take the scroll_container coordinate as position origin,
2213 * be additionally moved by the current value of the scrollbar with the name
2214 `scrollbar name` times `scroll factor` along the orientation `orientation` and
2215 * be clipped to the rectangle defined by `X`, `Y`, `W` and `H`.
2216 * `orientation`: possible values are `vertical` and `horizontal`.
2217 * `scroll factor`: optional, defaults to `0.1`.
2218 * Nesting is possible.
2219 * Some elements might work a little different if they are in a scroll_container.
2220 * Note: If you want the scroll_container to actually work, you also need to add a
2221 scrollbar element with the specified name. Furthermore, it is highly recommended
2222 to use a scrollbaroptions element on this scrollbar.
2224 ### `scroll_container_end[]`
2226 * End of a scroll_container, following elements are no longer bound to this
2229 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
2231 * Show an inventory list if it has been sent to the client. Nothing will
2232 be shown if the inventory list is of size 0.
2233 * **Note**: With the new coordinate system, the spacing between inventory
2234 slots is one-fourth the size of an inventory slot.
2236 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
2238 * Show an inventory list if it has been sent to the client. Nothing will
2239 be shown if the inventory list is of size 0.
2240 * **Note**: With the new coordinate system, the spacing between inventory
2241 slots is one-fourth the size of an inventory slot.
2243 ### `listring[<inventory location>;<list name>]`
2245 * Allows to create a ring of inventory lists
2246 * Shift-clicking on items in one element of the ring
2247 will send them to the next inventory list inside the ring
2248 * The first occurrence of an element inside the ring will
2249 determine the inventory where items will be sent to
2253 * Shorthand for doing `listring[<inventory location>;<list name>]`
2254 for the last two inventory lists added by list[...]
2256 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
2258 * Sets background color of slots as `ColorString`
2259 * Sets background color of slots on mouse hovering
2261 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
2263 * Sets background color of slots as `ColorString`
2264 * Sets background color of slots on mouse hovering
2265 * Sets color of slots border
2267 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
2269 * Sets background color of slots as `ColorString`
2270 * Sets background color of slots on mouse hovering
2271 * Sets color of slots border
2272 * Sets default background color of tooltips
2273 * Sets default font color of tooltips
2275 ### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2277 * Adds tooltip for an element
2278 * `bgcolor` tooltip background color as `ColorString` (optional)
2279 * `fontcolor` tooltip font color as `ColorString` (optional)
2281 ### `tooltip[<X>,<Y>;<W>,<H>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2283 * Adds tooltip for an area. Other tooltips will take priority when present.
2284 * `bgcolor` tooltip background color as `ColorString` (optional)
2285 * `fontcolor` tooltip font color as `ColorString` (optional)
2287 ### `image[<X>,<Y>;<W>,<H>;<texture name>]`
2291 ### `animated_image[<X>,<Y>;<W>,<H>;<name>;<texture name>;<frame count>;<frame duration>;<frame start>]`
2293 * Show an animated image. The image is drawn like a "vertical_frames" tile
2294 animation (See [Tile animation definition]), but uses a frame count/duration
2296 * `name`: Element name to send when an event occurs. The event value is the index of the current frame.
2297 * `texture name`: The image to use.
2298 * `frame count`: The number of frames animating the image.
2299 * `frame duration`: Milliseconds between each frame. `0` means the frames don't advance.
2300 * `frame start` (Optional): The index of the frame to start on. Default `1`.
2302 ### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
2304 * Show an inventory image of registered item/node
2306 ### `bgcolor[<bgcolor>;<fullscreen>;<fbgcolor>]`
2308 * Sets background color of formspec.
2309 * `bgcolor` and `fbgcolor` (optional) are `ColorString`s, they define the color
2310 of the non-fullscreen and the fullscreen background.
2311 * `fullscreen` (optional) can be one of the following:
2312 * `false`: Only the non-fullscreen background color is drawn. (default)
2313 * `true`: Only the fullscreen background color is drawn.
2314 * `both`: The non-fullscreen and the fullscreen background color are drawn.
2315 * `neither`: No background color is drawn.
2316 * Note: Leave a parameter empty to not modify the value.
2317 * Note: `fbgcolor`, leaving parameters empty and values for `fullscreen` that
2318 are not bools are only available since formspec version 3.
2320 ### `background[<X>,<Y>;<W>,<H>;<texture name>]`
2322 * Example for formspec 8x4 in 16x resolution: image shall be sized
2323 8 times 16px times 4 times 16px.
2325 ### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
2327 * Example for formspec 8x4 in 16x resolution:
2328 image shall be sized 8 times 16px times 4 times 16px
2329 * If `auto_clip` is `true`, the background is clipped to the formspec size
2330 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2332 ### `background9[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>;<middle>]`
2334 * 9-sliced background. See https://en.wikipedia.org/wiki/9-slice_scaling
2335 * Middle is a rect which defines the middle of the 9-slice.
2336 * `x` - The middle will be x pixels from all sides.
2337 * `x,y` - The middle will be x pixels from the horizontal and y from the vertical.
2338 * `x,y,x2,y2` - The middle will start at x,y, and end at x2, y2. Negative x2 and y2 values
2339 will be added to the width and height of the texture, allowing it to be used as the
2340 distance from the far end.
2341 * All numbers in middle are integers.
2342 * Example for formspec 8x4 in 16x resolution:
2343 image shall be sized 8 times 16px times 4 times 16px
2344 * If `auto_clip` is `true`, the background is clipped to the formspec size
2345 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2346 * Available since formspec version 2
2348 ### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
2350 * Textual password style field; will be sent to server when a button is clicked
2351 * When enter is pressed in field, fields.key_enter_field will be sent with the
2353 * With the old coordinate system, fields are a set height, but will be vertically
2354 centred on `H`. With the new coordinate system, `H` will modify the height.
2355 * `name` is the name of the field as returned in fields to `on_receive_fields`
2356 * `label`, if not blank, will be text printed on the top left above the field
2357 * See `field_close_on_enter` to stop enter closing the formspec
2359 ### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2361 * Textual field; will be sent to server when a button is clicked
2362 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2363 the name of this field.
2364 * With the old coordinate system, fields are a set height, but will be vertically
2365 centred on `H`. With the new coordinate system, `H` will modify the height.
2366 * `name` is the name of the field as returned in fields to `on_receive_fields`
2367 * `label`, if not blank, will be text printed on the top left above the field
2368 * `default` is the default value of the field
2369 * `default` may contain variable references such as `${text}` which
2370 will fill the value from the metadata value `text`
2371 * **Note**: no extra text or more than a single variable is supported ATM.
2372 * See `field_close_on_enter` to stop enter closing the formspec
2374 ### `field[<name>;<label>;<default>]`
2376 * As above, but without position/size units
2377 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2378 the name of this field.
2379 * Special field for creating simple forms, such as sign text input
2380 * Must be used without a `size[]` element
2381 * A "Proceed" button will be added automatically
2382 * See `field_close_on_enter` to stop enter closing the formspec
2384 ### `field_close_on_enter[<name>;<close_on_enter>]`
2386 * <name> is the name of the field
2387 * if <close_on_enter> is false, pressing enter in the field will submit the
2388 form but not close it.
2389 * defaults to true when not specified (ie: no tag for a field)
2391 ### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2393 * Same as fields above, but with multi-line input
2394 * If the text overflows, a vertical scrollbar is added.
2395 * If the name is empty, the textarea is read-only and
2396 the background is not shown, which corresponds to a multi-line label.
2398 ### `label[<X>,<Y>;<label>]`
2400 * The label formspec element displays the text set in `label`
2401 at the specified position.
2402 * **Note**: If the new coordinate system is enabled, labels are
2403 positioned from the center of the text, not the top.
2404 * The text is displayed directly without automatic line breaking,
2405 so label should not be used for big text chunks. Newlines can be
2406 used to make labels multiline.
2407 * **Note**: With the new coordinate system, newlines are spaced with
2408 half a coordinate. With the old system, newlines are spaced 2/5 of
2411 ### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]`
2412 * Displays a static formatted text with hyperlinks.
2413 * **Note**: This element is currently unstable and subject to change.
2414 * `x`, `y`, `w` and `h` work as per field
2415 * `name` is the name of the field as returned in fields to `on_receive_fields` in case of action in text.
2416 * `text` is the formatted text using `Markup Language` described below.
2418 ### `vertlabel[<X>,<Y>;<label>]`
2419 * Textual label drawn vertically
2420 * `label` is the text on the label
2421 * **Note**: If the new coordinate system is enabled, vertlabels are
2422 positioned from the center of the text, not the left.
2424 ### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
2426 * Clickable button. When clicked, fields will be sent.
2427 * With the old coordinate system, buttons are a set height, but will be vertically
2428 centred on `H`. With the new coordinate system, `H` will modify the height.
2429 * `label` is the text on the button
2431 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2433 * `texture name` is the filename of an image
2434 * **Note**: Height is supported on both the old and new coordinate systems
2437 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
2439 * `texture name` is the filename of an image
2440 * `noclip=true` means the image button doesn't need to be within specified
2442 * `drawborder`: draw button border or not
2443 * `pressed texture name` is the filename of an image on pressed state
2445 ### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
2447 * `item name` is the registered name of an item/node
2448 * The item description will be used as the tooltip. This can be overridden with
2451 ### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
2453 * When clicked, fields will be sent and the form will quit.
2454 * Same as `button` in all other respects.
2456 ### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2458 * When clicked, fields will be sent and the form will quit.
2459 * Same as `image_button` in all other respects.
2461 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
2463 * Scrollable item list showing arbitrary text elements
2464 * `name` fieldname sent to server on doubleclick value is current selected
2466 * `listelements` can be prepended by #color in hexadecimal format RRGGBB
2468 * if you want a listelement to start with "#" write "##".
2470 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
2472 * Scrollable itemlist showing arbitrary text elements
2473 * `name` fieldname sent to server on doubleclick value is current selected
2475 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
2476 * if you want a listelement to start with "#" write "##"
2477 * Index to be selected within textlist
2478 * `true`/`false`: draw transparent background
2479 * See also `minetest.explode_textlist_event`
2480 (main menu: `core.explode_textlist_event`).
2482 ### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2484 * Show a tab**header** at specific position (ignores formsize)
2485 * `X` and `Y`: position of the tabheader
2486 * *Note*: Width and height are automatically chosen with this syntax
2487 * `name` fieldname data is transferred to Lua
2488 * `caption 1`...: name shown on top of tab
2489 * `current_tab`: index of selected tab 1...
2490 * `transparent` (optional): if true, tabs are semi-transparent
2491 * `draw_border` (optional): if true, draw a thin line at tab base
2493 ### `tabheader[<X>,<Y>;<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2495 * Show a tab**header** at specific position (ignores formsize)
2496 * **Important note**: This syntax for tabheaders can only be used with the
2497 new coordinate system.
2498 * `X` and `Y`: position of the tabheader
2499 * `H`: height of the tabheader. Width is automatically determined with this syntax.
2500 * `name` fieldname data is transferred to Lua
2501 * `caption 1`...: name shown on top of tab
2502 * `current_tab`: index of selected tab 1...
2503 * `transparent` (optional): show transparent
2504 * `draw_border` (optional): draw border
2506 ### `tabheader[<X>,<Y>;<W>,<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2508 * Show a tab**header** at specific position (ignores formsize)
2509 * **Important note**: This syntax for tabheaders can only be used with the
2510 new coordinate system.
2511 * `X` and `Y`: position of the tabheader
2512 * `W` and `H`: width and height of the tabheader
2513 * `name` fieldname data is transferred to Lua
2514 * `caption 1`...: name shown on top of tab
2515 * `current_tab`: index of selected tab 1...
2516 * `transparent` (optional): show transparent
2517 * `draw_border` (optional): draw border
2519 ### `box[<X>,<Y>;<W>,<H>;<color>]`
2521 * Simple colored box
2522 * `color` is color specified as a `ColorString`.
2523 If the alpha component is left blank, the box will be semitransparent.
2524 If the color is not specified, the box will use the options specified by
2525 its style. If the color is specified, all styling options will be ignored.
2527 ### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
2529 * Show a dropdown field
2530 * **Important note**: There are two different operation modes:
2531 1. handle directly on change (only changed dropdown is submitted)
2532 2. read the value on pressing a button (all dropdown values are available)
2533 * `X` and `Y`: position of the dropdown
2534 * `W`: width of the dropdown. Height is automatically chosen with this syntax.
2535 * Fieldname data is transferred to Lua
2536 * Items to be shown in dropdown
2537 * Index of currently selected dropdown item
2538 * `index event` (optional, allowed parameter since formspec version 4): Specifies the
2539 event field value for selected items.
2540 * `true`: Selected item index
2541 * `false` (default): Selected item value
2543 ### `dropdown[<X>,<Y>;<W>,<H>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
2545 * Show a dropdown field
2546 * **Important note**: This syntax for dropdowns can only be used with the
2547 new coordinate system.
2548 * **Important note**: There are two different operation modes:
2549 1. handle directly on change (only changed dropdown is submitted)
2550 2. read the value on pressing a button (all dropdown values are available)
2551 * `X` and `Y`: position of the dropdown
2552 * `W` and `H`: width and height of the dropdown
2553 * Fieldname data is transferred to Lua
2554 * Items to be shown in dropdown
2555 * Index of currently selected dropdown item
2556 * `index event` (optional, allowed parameter since formspec version 4): Specifies the
2557 event field value for selected items.
2558 * `true`: Selected item index
2559 * `false` (default): Selected item value
2561 ### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
2564 * `name` fieldname data is transferred to Lua
2565 * `label` to be shown left of checkbox
2566 * `selected` (optional): `true`/`false`
2567 * **Note**: If the new coordinate system is enabled, checkboxes are
2568 positioned from the center of the checkbox, not the top.
2570 ### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
2572 * Show a scrollbar using options defined by the previous `scrollbaroptions[]`
2573 * There are two ways to use it:
2574 1. handle the changed event (only changed scrollbar is available)
2575 2. read the value on pressing a button (all scrollbars are available)
2576 * `orientation`: `vertical`/`horizontal`. Default horizontal.
2577 * Fieldname data is transferred to Lua
2578 * Value of this trackbar is set to (`0`-`1000`) by default
2579 * See also `minetest.explode_scrollbar_event`
2580 (main menu: `core.explode_scrollbar_event`).
2582 ### `scrollbaroptions[opt1;opt2;...]`
2583 * Sets options for all following `scrollbar[]` elements
2585 * Sets scrollbar minimum value, defaults to `0`.
2587 * Sets scrollbar maximum value, defaults to `1000`.
2588 If the max is equal to the min, the scrollbar will be disabled.
2590 * Sets scrollbar step value when the arrows are clicked or the mouse wheel is
2592 * If this is set to a negative number, the value will be reset to `10`.
2594 * Sets scrollbar step value used by page up and page down.
2595 * If this is set to a negative number, the value will be reset to `100`.
2597 * Sets size of the thumb on the scrollbar. Size is calculated in the number of
2598 units the thumb spans out of the range of the scrollbar values.
2599 * Example: If a scrollbar has a `min` of 1 and a `max` of 100, a thumbsize of 10
2600 would span a tenth of the scrollbar space.
2601 * If this is set to zero or less, the value will be reset to `1`.
2602 * `arrows=<show/hide/default>`
2603 * Whether to show the arrow buttons on the scrollbar. `default` hides the arrows
2604 when the scrollbar gets too small, but shows them otherwise.
2606 ### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
2608 * Show scrollable table using options defined by the previous `tableoptions[]`
2609 * Displays cells as defined by the previous `tablecolumns[]`
2610 * `name`: fieldname sent to server on row select or doubleclick
2611 * `cell 1`...`cell n`: cell contents given in row-major order
2612 * `selected idx`: index of row to be selected within table (first row = `1`)
2613 * See also `minetest.explode_table_event`
2614 (main menu: `core.explode_table_event`).
2616 ### `tableoptions[<opt 1>;<opt 2>;...]`
2618 * Sets options for `table[]`
2620 * default text color (`ColorString`), defaults to `#FFFFFF`
2621 * `background=#RRGGBB`
2622 * table background color (`ColorString`), defaults to `#000000`
2623 * `border=<true/false>`
2624 * should the table be drawn with a border? (default: `true`)
2625 * `highlight=#RRGGBB`
2626 * highlight background color (`ColorString`), defaults to `#466432`
2627 * `highlight_text=#RRGGBB`
2628 * highlight text color (`ColorString`), defaults to `#FFFFFF`
2629 * `opendepth=<value>`
2630 * all subtrees up to `depth < value` are open (default value = `0`)
2631 * only useful when there is a column of type "tree"
2633 ### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
2635 * Sets columns for `table[]`
2636 * Types: `text`, `image`, `color`, `indent`, `tree`
2637 * `text`: show cell contents as text
2638 * `image`: cell contents are an image index, use column options to define
2640 * `color`: cell contents are a ColorString and define color of following
2642 * `indent`: cell contents are a number and define indentation of following
2644 * `tree`: same as indent, but user can open and close subtrees
2648 * for `text` and `image`: content alignment within cells.
2649 Available values: `left` (default), `center`, `right`, `inline`
2651 * for `text` and `image`: minimum width in em (default: `0`)
2652 * for `indent` and `tree`: indent width in em (default: `1.5`)
2653 * `padding=<value>`: padding left of the column, in em (default `0.5`).
2654 Exception: defaults to 0 for indent columns
2655 * `tooltip=<value>`: tooltip text (default: empty)
2656 * `image` column options:
2657 * `0=<value>` sets image for image index 0
2658 * `1=<value>` sets image for image index 1
2659 * `2=<value>` sets image for image index 2
2660 * and so on; defined indices need not be contiguous empty or
2661 non-numeric cells are treated as `0`.
2662 * `color` column options:
2663 * `span=<value>`: number of following columns to affect
2664 (default: infinite).
2666 ### `style[<selector 1>,<selector 2>;<prop1>;<prop2>;...]`
2668 * Set the style for the element(s) matching `selector` by name.
2669 * `selector` can be one of:
2670 * `<name>` - An element name. Includes `*`, which represents every element.
2671 * `<name>:<state>` - An element name, a colon, and one or more states.
2672 * `state` is a list of states separated by the `+` character.
2673 * If a state is provided, the style will only take effect when the element is in that state.
2674 * All provided states must be active for the style to apply.
2675 * Note: this **must** be before the element is defined.
2676 * See [Styling Formspecs].
2679 ### `style_type[<selector 1>,<selector 2>;<prop1>;<prop2>;...]`
2681 * Set the style for the element(s) matching `selector` by type.
2682 * `selector` can be one of:
2683 * `<type>` - An element type. Includes `*`, which represents every element.
2684 * `<type>:<state>` - An element type, a colon, and one or more states.
2685 * `state` is a list of states separated by the `+` character.
2686 * If a state is provided, the style will only take effect when the element is in that state.
2687 * All provided states must be active for the style to apply.
2688 * See [Styling Formspecs].
2690 ### `set_focus[<name>;<force>]`
2692 * Sets the focus to the element with the same `name` parameter.
2693 * **Note**: This element must be placed before the element it focuses.
2694 * `force` (optional, default `false`): By default, focus is not applied for
2695 re-sent formspecs with the same name so that player-set focus is kept.
2696 `true` sets the focus to the specified element for every sent formspec.
2697 * The following elements have the ability to be focused:
2712 Migrating to Real Coordinates
2713 -----------------------------
2715 In the old system, positions included padding and spacing. Padding is a gap between
2716 the formspec window edges and content, and spacing is the gaps between items. For
2717 example, two `1x1` elements at `0,0` and `1,1` would have a spacing of `5/4` between them,
2718 and a padding of `3/8` from the formspec edge. It may be easiest to recreate old layouts
2719 in the new coordinate system from scratch.
2721 To recreate an old layout with padding, you'll need to pass the positions and sizes
2722 through the following formula to re-introduce padding:
2725 pos = (oldpos + 1)*spacing + padding
2731 You'll need to change the `size[]` tag like this:
2734 size = (oldsize-1)*spacing + padding*2 + 1
2737 A few elements had random offsets in the old system. Here is a table which shows these
2738 offsets when migrating:
2740 | Element | Position | Size | Notes
2741 |---------|------------|---------|-------
2742 | box | +0.3, +0.1 | 0, -0.4 |
2743 | button | | | Buttons now support height, so set h = 2 * 15/13 * 0.35, and reposition if h ~= 15/13 * 0.35 before
2744 | list | | | Spacing is now 0.25 for both directions, meaning lists will be taller in height
2745 | label | 0, +0.3 | | The first line of text is now positioned centered exactly at the position specified
2750 Formspec elements can be themed using the style elements:
2752 style[<name 1>,<name 2>;<prop1>;<prop2>;...]
2753 style[<name 1>:<state>,<name 2>:<state>;<prop1>;<prop2>;...]
2754 style_type[<type 1>,<type 2>;<prop1>;<prop2>;...]
2755 style_type[<type 1>:<state>,<type 2>:<state>;<prop1>;<prop2>;...]
2759 property_name=property_value
2763 style_type[button;bgcolor=#006699]
2764 style[world_delete;bgcolor=red;textcolor=yellow]
2765 button[4,3.95;2.6,1;world_delete;Delete]
2767 A name/type can optionally be a comma separated list of names/types, like so:
2769 world_delete,world_create,world_configure
2772 A `*` type can be used to select every element in the formspec.
2774 Any name/type in the list can also be accompanied by a `+`-separated list of states, like so:
2776 world_delete:hovered+pressed
2779 States allow you to apply styles in response to changes in the element, instead of applying at all times.
2781 Setting a property to nothing will reset it to the default value. For example:
2783 style_type[button;bgimg=button.png;bgimg_pressed=button_pressed.png;border=false]
2784 style[btn_exit;bgimg=;bgimg_pressed=;border=;bgcolor=red]
2787 ### Supported Element Types
2789 Some types may inherit styles from parent types.
2791 * animated_image, inherits from image
2794 * button_exit, inherits from button
2802 * pwdfield, inherits from field
2808 * vertlabel, inherits from label
2811 ### Valid Properties
2814 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2816 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2817 * Defaults to false in formspec_version version 3 or higher
2818 * **Note**: `colors`, `bordercolors`, and `borderwidths` accept multiple input types:
2819 * Single value (e.g. `#FF0`): All corners/borders.
2820 * Two values (e.g. `red,#FFAAFF`): top-left and bottom-right,top-right and bottom-left/
2821 top and bottom,left and right.
2822 * Four values (e.g. `blue,#A0F,green,#FFFA`): top-left/top and rotates clockwise.
2823 * These work similarly to CSS borders.
2824 * colors - `ColorString`. Sets the color(s) of the box corners. Default `black`.
2825 * bordercolors - `ColorString`. Sets the color(s) of the borders. Default `black`.
2826 * borderwidths - Integer. Sets the width(s) of the borders in pixels. If the width is
2827 negative, the border will extend inside the box, whereas positive extends outside
2828 the box. A width of zero results in no border; this is default.
2829 * button, button_exit, image_button, item_image_button
2830 * alpha - boolean, whether to draw alpha in bgimg. Default true.
2831 * bgcolor - color, sets button tint.
2832 * bgcolor_hovered - color when hovered. Defaults to a lighter bgcolor when not provided.
2833 * This is deprecated, use states instead.
2834 * bgcolor_pressed - color when pressed. Defaults to a darker bgcolor when not provided.
2835 * This is deprecated, use states instead.
2836 * bgimg - standard background image. Defaults to none.
2837 * bgimg_hovered - background image when hovered. Defaults to bgimg when not provided.
2838 * This is deprecated, use states instead.
2839 * bgimg_middle - Makes the bgimg textures render in 9-sliced mode and defines the middle rect.
2840 See background9[] documentation for more details. This property also pads the
2841 button's content when set.
2842 * bgimg_pressed - background image when pressed. Defaults to bgimg when not provided.
2843 * This is deprecated, use states instead.
2844 * font - Sets font type. This is a comma separated list of options. Valid options:
2845 * Main font type options. These cannot be combined with each other:
2846 * `normal`: Default font
2847 * `mono`: Monospaced font
2848 * Font modification options. If used without a main font type, `normal` is used:
2849 * `bold`: Makes font bold.
2850 * `italic`: Makes font italic.
2852 * font_size - Sets font size. Default is user-set. Can have multiple values:
2853 * `<number>`: Sets absolute font size to `number`.
2854 * `+<number>`/`-<number>`: Offsets default font size by `number` points.
2855 * `*<number>`: Multiplies default font size by `number`, similar to CSS `em`.
2856 * border - boolean, draw border. Set to false to hide the bevelled button pane. Default true.
2857 * content_offset - 2d vector, shifts the position of the button's content without resizing it.
2858 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2859 * padding - rect, adds space between the edges of the button and the content. This value is
2860 relative to bgimg_middle.
2861 * textcolor - color, default white.
2863 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2865 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2866 * field, pwdfield, textarea
2867 * border - set to false to hide the textbox background and border. Default true.
2868 * font - Sets font type. See button `font` property for more information.
2869 * font_size - Sets font size. See button `font_size` property for more information.
2870 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2871 * textcolor - color. Default white.
2873 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2874 * Default to false in formspec_version version 3 or higher
2876 * noclip - boolean, set to true to allow the element to exceed formspec bounds. Default to false.
2878 * font - Sets font type. See button `font` property for more information.
2879 * font_size - Sets font size. See button `font_size` property for more information.
2880 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2881 * image_button (additional properties)
2882 * fgimg - standard image. Defaults to none.
2883 * fgimg_hovered - image when hovered. Defaults to fgimg when not provided.
2884 * This is deprecated, use states instead.
2885 * fgimg_pressed - image when pressed. Defaults to fgimg when not provided.
2886 * This is deprecated, use states instead.
2887 * NOTE: The parameters of any given image_button will take precedence over fgimg/fgimg_pressed
2889 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2891 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2892 * textcolor - color. Default white.
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.
2901 * default - Equivalent to providing no states
2902 * button, button_exit, image_button, item_image_button
2903 * hovered - Active when the mouse is hovering over the element
2904 * pressed - Active when the button is pressed
2909 Markup language used in `hypertext[]` elements uses tags that look like HTML tags.
2910 The markup language is currently unstable and subject to change. Use with caution.
2911 Some tags can enclose text, they open with `<tagname>` and close with `</tagname>`.
2912 Tags can have attributes, in that case, attributes are in the opening tag in
2913 form of a key/value separated with equal signs. Attribute values should not be quoted.
2915 These are the technically basic tags but see below for usual tags. Base tags are:
2917 `<style color=... font=... size=...>...</style>`
2919 Changes the style of the text.
2921 * `color`: Text color. Given color is a `colorspec`.
2922 * `size`: Text size.
2923 * `font`: Text font (`mono` or `normal`).
2925 `<global background=... margin=... valign=... color=... hovercolor=... size=... font=... halign=... >`
2930 * `background`: Text background, a `colorspec` or `none`.
2931 * `margin`: Page margins in pixel.
2932 * `valign`: Text vertical alignment (`top`, `middle`, `bottom`).
2934 Inheriting styles (affects child elements):
2935 * `color`: Default text color. Given color is a `colorspec`.
2936 * `hovercolor`: Color of <action> tags when mouse is over.
2937 * `size`: Default text size.
2938 * `font`: Default text font (`mono` or `normal`).
2939 * `halign`: Default text horizontal alignment (`left`, `right`, `center`, `justify`).
2941 This tag needs to be placed only once as it changes the global settings of the
2942 text. Anyway, if several tags are placed, each changed will be made in the order
2945 `<tag name=... color=... hovercolor=... font=... size=...>`
2947 Defines or redefines tag style. This can be used to define new tags.
2948 * `name`: Name of the tag to define or change.
2949 * `color`: Text color. Given color is a `colorspec`.
2950 * `hovercolor`: Text color when element hovered (only for `action` tags). Given color is a `colorspec`.
2951 * `size`: Text size.
2952 * `font`: Text font (`mono` or `normal`).
2954 Following tags are the usual tags for text layout. They are defined by default.
2955 Other tags can be added using `<tag ...>` tag.
2957 `<normal>...</normal>`: Normal size text
2959 `<big>...</big>`: Big text
2961 `<bigger>...</bigger>`: Bigger text
2963 `<center>...</center>`: Centered text
2965 `<left>...</left>`: Left-aligned text
2967 `<right>...</right>`: Right-aligned text
2969 `<justify>...</justify>`: Justified text
2971 `<mono>...</mono>`: Monospaced font
2973 `<b>...</b>`, `<i>...</i>`, `<u>...</u>`: Bold, italic, underline styles.
2975 `<action name=...>...</action>`
2977 Make that text a clickable text triggering an action.
2979 * `name`: Name of the action (mandatory).
2981 When clicked, the formspec is send to the server. The value of the text field
2982 sent to `on_player_receive_fields` will be "action:" concatenated to the action
2985 `<img name=... float=... width=... height=...>`
2987 Draws an image which is present in the client media cache.
2989 * `name`: Name of the texture (mandatory).
2990 * `float`: If present, makes the image floating (`left` or `right`).
2991 * `width`: Force image width instead of taking texture width.
2992 * `height`: Force image height instead of taking texture height.
2994 If only width or height given, texture aspect is kept.
2996 `<item name=... float=... width=... height=... rotate=...>`
2998 Draws an item image.
3000 * `name`: Item string of the item to draw (mandatory).
3001 * `float`: If present, makes the image floating (`left` or `right`).
3002 * `width`: Item image width.
3003 * `height`: Item image height.
3004 * `rotate`: Rotate item image if set to `yes` or `X,Y,Z`. X, Y and Z being
3005 rotation speeds in percent of standard speed (-1000 to 1000). Works only if
3006 `inventory_items_animations` is set to true.
3007 * `angle`: Angle in which the item image is shown. Value has `X,Y,Z` form.
3008 X, Y and Z being angles around each three axes. Works only if
3009 `inventory_items_animations` is set to true.
3017 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
3018 * `"current_player"`: Player to whom the menu is shown
3019 * `"player:<name>"`: Any player
3020 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
3021 * `"detached:<name>"`: A detached inventory
3023 Player Inventory lists
3024 ----------------------
3026 * `main`: list containing the default inventory
3027 * `craft`: list containing the craft input
3028 * `craftpreview`: list containing the craft prediction
3029 * `craftresult`: list containing the crafted output
3030 * `hand`: list containing an override for the empty hand
3031 * Is not created automatically, use `InvRef:set_size`
3032 * Is only used to enhance the empty hand's tool capabilities
3040 `#RGB` defines a color in hexadecimal format.
3042 `#RGBA` defines a color in hexadecimal format and alpha channel.
3044 `#RRGGBB` defines a color in hexadecimal format.
3046 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
3048 Named colors are also supported and are equivalent to
3049 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
3050 To specify the value of the alpha channel, append `#AA` to the end of the color
3051 name (e.g. `colorname#08`). For named colors the hexadecimal string
3052 representing the alpha value must (always) be two hexadecimal digits.
3057 A ColorSpec specifies a 32-bit color. It can be written in any of the following
3060 * table form: Each element ranging from 0..255 (a, if absent, defaults to 255):
3061 * `colorspec = {a=255, r=0, g=255, b=0}`
3062 * numerical form: The raw integer value of an ARGB8 quad:
3063 * `colorspec = 0xFF00FF00`
3064 * string form: A ColorString (defined above):
3065 * `colorspec = "green"`
3073 Most text can contain escape sequences, that can for example color the text.
3074 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
3075 The following functions provide escape sequences:
3077 * `minetest.get_color_escape_sequence(color)`:
3078 * `color` is a ColorString
3079 * The escape sequence sets the text color to `color`
3080 * `minetest.colorize(color, message)`:
3082 `minetest.get_color_escape_sequence(color) ..
3084 minetest.get_color_escape_sequence("#ffffff")`
3085 * `minetest.get_background_escape_sequence(color)`
3086 * `color` is a ColorString
3087 * The escape sequence sets the background of the whole text element to
3088 `color`. Only defined for item descriptions and tooltips.
3089 * `minetest.strip_foreground_colors(str)`
3090 * Removes foreground colors added by `get_color_escape_sequence`.
3091 * `minetest.strip_background_colors(str)`
3092 * Removes background colors added by `get_background_escape_sequence`.
3093 * `minetest.strip_colors(str)`
3094 * Removes all color escape sequences.
3101 A spatial vector is similar to a position, but instead using
3102 absolute world coordinates, it uses *relative* coordinates, relative to
3103 no particular point.
3105 Internally, it is implemented as a table with the 3 fields
3106 `x`, `y` and `z`. Example: `{x = 0, y = 1, z = 0}`.
3108 For the following functions, `v`, `v1`, `v2` are vectors,
3109 `p1`, `p2` are positions,
3110 `s` is a scalar (a number):
3112 * `vector.new(a[, b, c])`:
3114 * A copy of `a` if `a` is a vector.
3115 * `{x = a, y = b, z = c}`, if all of `a`, `b`, `c` are defined numbers.
3116 * `vector.direction(p1, p2)`:
3117 * Returns a vector of length 1 with direction `p1` to `p2`.
3118 * If `p1` and `p2` are identical, returns `{x = 0, y = 0, z = 0}`.
3119 * `vector.distance(p1, p2)`:
3120 * Returns zero or a positive number, the distance between `p1` and `p2`.
3121 * `vector.length(v)`:
3122 * Returns zero or a positive number, the length of vector `v`.
3123 * `vector.normalize(v)`:
3124 * Returns a vector of length 1 with direction of vector `v`.
3125 * If `v` has zero length, returns `{x = 0, y = 0, z = 0}`.
3126 * `vector.floor(v)`:
3127 * Returns a vector, each dimension rounded down.
3128 * `vector.round(v)`:
3129 * Returns a vector, each dimension rounded to nearest integer.
3130 * `vector.apply(v, func)`:
3131 * Returns a vector where the function `func` has been applied to each
3133 * `vector.equals(v1, v2)`:
3134 * Returns a boolean, `true` if the vectors are identical.
3135 * `vector.sort(v1, v2)`:
3136 * Returns in order minp, maxp vectors of the cuboid defined by `v1`, `v2`.
3137 * `vector.angle(v1, v2)`:
3138 * Returns the angle between `v1` and `v2` in radians.
3139 * `vector.dot(v1, v2)`:
3140 * Returns the dot product of `v1` and `v2`.
3141 * `vector.cross(v1, v2)`:
3142 * Returns the cross product of `v1` and `v2`.
3143 * `vector.offset(v, x, y, z)`:
3144 * Returns the sum of the vectors `v` and `{x = x, y = y, z = z}`.
3146 For the following functions `x` can be either a vector or a number:
3148 * `vector.add(v, x)`:
3150 * If `x` is a vector: Returns the sum of `v` and `x`.
3151 * If `x` is a number: Adds `x` to each component of `v`.
3152 * `vector.subtract(v, x)`:
3154 * If `x` is a vector: Returns the difference of `v` subtracted by `x`.
3155 * If `x` is a number: Subtracts `x` from each component of `v`.
3156 * `vector.multiply(v, s)`:
3157 * Returns a scaled vector.
3158 * Deprecated: If `s` is a vector: Returns the Schur product.
3159 * `vector.divide(v, s)`:
3160 * Returns a scaled vector.
3161 * Deprecated: If `s` is a vector: Returns the Schur quotient.
3163 For the following functions `a` is an angle in radians and `r` is a rotation
3164 vector ({x = <pitch>, y = <yaw>, z = <roll>}) where pitch, yaw and roll are
3167 * `vector.rotate(v, r)`:
3168 * Applies the rotation `r` to `v` and returns the result.
3169 * `vector.rotate({x = 0, y = 0, z = 1}, r)` and
3170 `vector.rotate({x = 0, y = 1, z = 0}, r)` return vectors pointing
3171 forward and up relative to an entity's rotation `r`.
3172 * `vector.rotate_around_axis(v1, v2, a)`:
3173 * Returns `v1` rotated around axis `v2` by `a` radians according to
3174 the right hand rule.
3175 * `vector.dir_to_rotation(direction[, up])`:
3176 * Returns a rotation vector for `direction` pointing forward using `up`
3178 * If `up` is omitted, the roll of the returned vector defaults to zero.
3179 * Otherwise `direction` and `up` need to be vectors in a 90 degree angle to each other.
3187 * `dump2(obj, name, dumped)`: returns a string which makes `obj`
3188 human-readable, handles reference loops.
3189 * `obj`: arbitrary variable
3190 * `name`: string, default: `"_"`
3191 * `dumped`: table, default: `{}`
3192 * `dump(obj, dumped)`: returns a string which makes `obj` human-readable
3193 * `obj`: arbitrary variable
3194 * `dumped`: table, default: `{}`
3195 * `math.hypot(x, y)`
3196 * Get the hypotenuse of a triangle with legs x and y.
3197 Useful for distance calculation.
3198 * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
3199 * Get the sign of a number.
3200 * tolerance: number, default: `0.0`
3201 * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
3203 * `math.factorial(x)`: returns the factorial of `x`
3204 * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
3205 * `separator`: string, default: `","`
3206 * `include_empty`: boolean, default: `false`
3207 * `max_splits`: number, if it's negative, splits aren't limited,
3209 * `sep_is_pattern`: boolean, it specifies whether separator is a plain
3210 string or a pattern (regex), default: `false`
3211 * e.g. `"a,b":split","` returns `{"a","b"}`
3212 * `string:trim()`: returns the string without whitespace pre- and suffixes
3213 * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
3214 * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
3215 * Adds newlines to the string to keep it within the specified character
3217 * Note that the returned lines may be longer than the limit since it only
3218 splits at word borders.
3219 * `limit`: number, maximal amount of characters in one line
3220 * `as_table`: boolean, if set to true, a table of lines instead of a string
3221 is returned, default: `false`
3222 * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
3223 * `pos`: table {x=X, y=Y, z=Z}
3224 * Converts the position `pos` to a human-readable, printable string
3225 * `decimal_places`: number, if specified, the x, y and z values of
3226 the position are rounded to the given decimal place.
3227 * `minetest.string_to_pos(string)`: returns a position or `nil`
3228 * Same but in reverse.
3229 * If the string can't be parsed to a position, nothing is returned.
3230 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
3231 * Converts a string representing an area box into two positions
3232 * `minetest.formspec_escape(string)`: returns a string
3233 * escapes the characters "[", "]", "\", "," and ";", which can not be used
3235 * `minetest.is_yes(arg)`
3236 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
3237 * `minetest.is_nan(arg)`
3238 * returns true when the passed number represents NaN.
3239 * `minetest.get_us_time()`
3240 * returns time with microsecond precision. May not return wall time.
3241 * `table.copy(table)`: returns a table
3242 * returns a deep copy of `table`
3243 * `table.indexof(list, val)`: returns the smallest numerical index containing
3244 the value `val` in the table `list`. Non-numerical indices are ignored.
3245 If `val` could not be found, `-1` is returned. `list` must not have
3247 * `table.insert_all(table, other_table)`:
3248 * Appends all values in `other_table` to `table` - uses `#table + 1` to
3250 * `table.key_value_swap(t)`: returns a table with keys and values swapped
3251 * If multiple keys in `t` map to the same value, the result is undefined.
3252 * `table.shuffle(table, [from], [to], [random_func])`:
3253 * Shuffles elements `from` to `to` in `table` in place
3254 * `from` defaults to `1`
3255 * `to` defaults to `#table`
3256 * `random_func` defaults to `math.random`. This function receives two
3257 integers as arguments and should return a random integer inclusively
3259 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
3261 * returns the exact position on the surface of a pointed node
3262 * `minetest.get_dig_params(groups, tool_capabilities)`: Simulates a tool
3264 Returns a table with the following fields:
3265 * `diggable`: `true` if node can be dug, `false` otherwise.
3266 * `time`: Time it would take to dig the node.
3267 * `wear`: How much wear would be added to the tool.
3268 `time` and `wear` are meaningless if node's not diggable
3270 * `groups`: Table of the node groups of the node that would be dug
3271 * `tool_capabilities`: Tool capabilities table of the tool
3272 * `minetest.get_hit_params(groups, tool_capabilities [, time_from_last_punch])`:
3273 Simulates an item that punches an object.
3274 Returns a table with the following fields:
3275 * `hp`: How much damage the punch would cause.
3276 * `wear`: How much wear would be added to the tool.
3278 * `groups`: Damage groups of the object
3279 * `tool_capabilities`: Tool capabilities table of the item
3280 * `time_from_last_punch`: time in seconds since last punch action
3288 Texts can be translated client-side with the help of `minetest.translate` and
3291 Translating a string
3292 --------------------
3294 Two functions are provided to translate strings: `minetest.translate` and
3295 `minetest.get_translator`.
3297 * `minetest.get_translator(textdomain)` is a simple wrapper around
3298 `minetest.translate`, and `minetest.get_translator(textdomain)(str, ...)` is
3299 equivalent to `minetest.translate(textdomain, str, ...)`.
3300 It is intended to be used in the following way, so that it avoids verbose
3301 repetitions of `minetest.translate`:
3303 local S = minetest.get_translator(textdomain)
3306 As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
3308 * `minetest.translate(textdomain, str, ...)` translates the string `str` with
3309 the given `textdomain` for disambiguation. The textdomain must match the
3310 textdomain specified in the translation file in order to get the string
3311 translated. This can be used so that a string is translated differently in
3313 It is advised to use the name of the mod as textdomain whenever possible, to
3314 avoid clashes with other mods.
3315 This function must be given a number of arguments equal to the number of
3316 arguments the translated string expects.
3317 Arguments are literal strings -- they will not be translated, so if you want
3318 them to be, they need to come as outputs of `minetest.translate` as well.
3320 For instance, suppose we want to translate "@1 Wool" with "@1" being replaced
3321 by the translation of "Red". We can do the following:
3323 local S = minetest.get_translator()
3324 S("@1 Wool", S("Red"))
3326 This will be displayed as "Red Wool" on old clients and on clients that do
3327 not have localization enabled. However, if we have for instance a translation
3328 file named `wool.fr.tr` containing the following:
3333 this will be displayed as "Laine Rouge" on clients with a French locale.
3335 Operations on translated strings
3336 --------------------------------
3338 The output of `minetest.translate` is a string, with escape sequences adding
3339 additional information to that string so that it can be translated on the
3340 different clients. In particular, you can't expect operations like string.length
3341 to work on them like you would expect them to, or string.gsub to work in the
3342 expected manner. However, string concatenation will still work as expected
3343 (note that you should only use this for things like formspecs; do not translate
3344 sentences by breaking them into parts; arguments should be used instead), and
3345 operations such as `minetest.colorize` which are also concatenation.
3347 Translation file format
3348 -----------------------
3350 A translation file has the suffix `.[lang].tr`, where `[lang]` is the language
3351 it corresponds to. It must be put into the `locale` subdirectory of the mod.
3352 The file should be a text file, with the following format:
3354 * Lines beginning with `# textdomain:` (the space is significant) can be used
3355 to specify the text domain of all following translations in the file.
3356 * All other empty lines or lines beginning with `#` are ignored.
3357 * Other lines should be in the format `original=translated`. Both `original`
3358 and `translated` can contain escape sequences beginning with `@` to insert
3359 arguments, literal `@`, `=` or newline (See [Escapes] below).
3360 There must be no extraneous whitespace around the `=` or at the beginning or
3361 the end of the line.
3366 Strings that need to be translated can contain several escapes, preceded by `@`.
3368 * `@@` acts as a literal `@`.
3369 * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated
3370 string that will be inlined when translated. Due to how translations are
3371 implemented, the original translation string **must** have its arguments in
3372 increasing order, without gaps or repetitions, starting from 1.
3373 * `@=` acts as a literal `=`. It is not required in strings given to
3374 `minetest.translate`, but is in translation files to avoid being confused
3375 with the `=` separating the original from the translation.
3376 * `@\n` (where the `\n` is a literal newline) acts as a literal newline.
3377 As with `@=`, this escape is not required in strings given to
3378 `minetest.translate`, but is in translation files.
3379 * `@n` acts as a literal newline as well.
3381 Server side translations
3382 ------------------------
3384 On some specific cases, server translation could be useful. For example, filter
3385 a list on labels and send results to client. A method is supplied to achieve
3388 `minetest.get_translated_string(lang_code, string)`: Translates `string` using
3389 translations for `lang_code` language. It gives the same result as if the string
3390 was translated by the client.
3392 The `lang_code` to use for a given player can be retrieved from
3393 the table returned by `minetest.get_player_information(name)`.
3395 IMPORTANT: This functionality should only be used for sorting, filtering or similar purposes.
3396 You do not need to use this to get translated strings to show up on the client.
3401 Perlin noise creates a continuously-varying value depending on the input values.
3402 Usually in Minetest the input values are either 2D or 3D co-ordinates in nodes.
3403 The result is used during map generation to create the terrain shape, vary heat
3404 and humidity to distribute biomes, vary the density of decorations or vary the
3407 Structure of perlin noise
3408 -------------------------
3410 An 'octave' is a simple noise generator that outputs a value between -1 and 1.
3411 The smooth wavy noise it generates has a single characteristic scale, almost
3412 like a 'wavelength', so on its own does not create fine detail.
3413 Due to this perlin noise combines several octaves to create variation on
3414 multiple scales. Each additional octave has a smaller 'wavelength' than the
3417 This combination results in noise varying very roughly between -2.0 and 2.0 and
3418 with an average value of 0.0, so `scale` and `offset` are then used to multiply
3419 and offset the noise variation.
3421 The final perlin noise variation is created as follows:
3423 noise = offset + scale * (octave1 +
3424 octave2 * persistence +
3425 octave3 * persistence ^ 2 +
3426 octave4 * persistence ^ 3 +
3432 Noise Parameters are commonly called `NoiseParams`.
3436 After the multiplication by `scale` this is added to the result and is the final
3437 step in creating the noise value.
3438 Can be positive or negative.
3442 Once all octaves have been combined, the result is multiplied by this.
3443 Can be positive or negative.
3447 For octave1, this is roughly the change of input value needed for a very large
3448 variation in the noise value generated by octave1. It is almost like a
3449 'wavelength' for the wavy noise variation.
3450 Each additional octave has a 'wavelength' that is smaller than the previous
3451 octave, to create finer detail. `spread` will therefore roughly be the typical
3452 size of the largest structures in the final noise variation.
3454 `spread` is a vector with values for x, y, z to allow the noise variation to be
3455 stretched or compressed in the desired axes.
3456 Values are positive numbers.
3460 This is a whole number that determines the entire pattern of the noise
3461 variation. Altering it enables different noise patterns to be created.
3462 With other parameters equal, different seeds produce different noise patterns
3463 and identical seeds produce identical noise patterns.
3465 For this parameter you can randomly choose any whole number. Usually it is
3466 preferable for this to be different from other seeds, but sometimes it is useful
3467 to be able to create identical noise patterns.
3469 In some noise APIs the world seed is added to the seed specified in noise
3470 parameters. This is done to make the resulting noise pattern vary in different
3471 worlds, and be 'world-specific'.
3475 The number of simple noise generators that are combined.
3476 A whole number, 1 or more.
3477 Each additional octave adds finer detail to the noise but also increases the
3478 noise calculation load.
3479 3 is a typical minimum for a high quality, complex and natural-looking noise
3480 variation. 1 octave has a slight 'gridlike' appearence.
3482 Choose the number of octaves according to the `spread` and `lacunarity`, and the
3483 size of the finest detail you require. For example:
3484 if `spread` is 512 nodes, `lacunarity` is 2.0 and finest detail required is 16
3485 nodes, octaves will be 6 because the 'wavelengths' of the octaves will be
3486 512, 256, 128, 64, 32, 16 nodes.
3487 Warning: If the 'wavelength' of any octave falls below 1 an error will occur.
3491 Each additional octave has an amplitude that is the amplitude of the previous
3492 octave multiplied by `persistence`, to reduce the amplitude of finer details,
3493 as is often helpful and natural to do so.
3494 Since this controls the balance of fine detail to large-scale detail
3495 `persistence` can be thought of as the 'roughness' of the noise.
3497 A positive or negative non-zero number, often between 0.3 and 1.0.
3498 A common medium value is 0.5, such that each octave has half the amplitude of
3499 the previous octave.
3500 This may need to be tuned when altering `lacunarity`; when doing so consider
3501 that a common medium value is 1 / lacunarity.
3505 Each additional octave has a 'wavelength' that is the 'wavelength' of the
3506 previous octave multiplied by 1 / lacunarity, to create finer detail.
3507 'lacunarity' is often 2.0 so 'wavelength' often halves per octave.
3509 A positive number no smaller than 1.0.
3510 Values below 2.0 create higher quality noise at the expense of requiring more
3511 octaves to cover a paticular range of 'wavelengths'.
3515 Leave this field unset for no special handling.
3516 Currently supported are `defaults`, `eased` and `absvalue`:
3520 Specify this if you would like to keep auto-selection of eased/not-eased while
3521 specifying some other flags.
3525 Maps noise gradient values onto a quintic S-curve before performing
3526 interpolation. This results in smooth, rolling noise.
3527 Disable this (`noeased`) for sharp-looking noise with a slightly gridded
3529 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is
3531 Easing a 3D noise significantly increases the noise calculation load, so use
3536 The absolute value of each octave's noise variation is used when combining the
3537 octaves. The final perlin noise variation is created as follows:
3539 noise = offset + scale * (abs(octave1) +
3540 abs(octave2) * persistence +
3541 abs(octave3) * persistence ^ 2 +
3542 abs(octave4) * persistence ^ 3 +
3547 For 2D or 3D perlin noise or perlin noise maps:
3552 spread = {x = 500, y = 500, z = 500},
3557 flags = "defaults, absvalue",
3560 For 2D noise the Z component of `spread` is still defined but is ignored.
3561 A single noise parameter table can be used for 2D or 3D noise.
3572 These tell in what manner the ore is generated.
3574 All default ores are of the uniformly-distributed scatter type.
3578 Randomly chooses a location and generates a cluster of ore.
3580 If `noise_params` is specified, the ore will be placed if the 3D perlin noise
3581 at that point is greater than the `noise_threshold`, giving the ability to
3582 create a non-equal distribution of ore.
3586 Creates a sheet of ore in a blob shape according to the 2D perlin noise
3587 described by `noise_params` and `noise_threshold`. This is essentially an
3588 improved version of the so-called "stratus" ore seen in some unofficial mods.
3590 This sheet consists of vertical columns of uniform randomly distributed height,
3591 varying between the inclusive range `column_height_min` and `column_height_max`.
3592 If `column_height_min` is not specified, this parameter defaults to 1.
3593 If `column_height_max` is not specified, this parameter defaults to `clust_size`
3594 for reverse compatibility. New code should prefer `column_height_max`.
3596 The `column_midpoint_factor` parameter controls the position of the column at
3597 which ore emanates from.
3598 If 1, columns grow upward. If 0, columns grow downward. If 0.5, columns grow
3599 equally starting from each direction.
3600 `column_midpoint_factor` is a decimal number ranging in value from 0 to 1. If
3601 this parameter is not specified, the default is 0.5.
3603 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this
3608 Creates a sheet of ore in a cloud-like puff shape.
3610 As with the `sheet` ore type, the size and shape of puffs are described by
3611 `noise_params` and `noise_threshold` and are placed at random vertical
3612 positions within the currently generated chunk.
3614 The vertical top and bottom displacement of each puff are determined by the
3615 noise parameters `np_puff_top` and `np_puff_bottom`, respectively.
3619 Creates a deformed sphere of ore according to 3d perlin noise described by
3620 `noise_params`. The maximum size of the blob is `clust_size`, and
3621 `clust_scarcity` has the same meaning as with the `scatter` type.
3625 Creates veins of ore varying in density by according to the intersection of two
3626 instances of 3d perlin noise with different seeds, both described by
3629 `random_factor` varies the influence random chance has on placement of an ore
3630 inside the vein, which is `1` by default. Note that modifying this parameter
3631 may require adjusting `noise_threshold`.
3633 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
3636 This ore type is difficult to control since it is sensitive to small changes.
3637 The following is a decent set of parameters to work from:
3642 spread = {x=200, y=200, z=200},
3649 noise_threshold = 1.6
3651 **WARNING**: Use this ore type *very* sparingly since it is ~200x more
3652 computationally expensive than any other ore.
3656 Creates a single undulating ore stratum that is continuous across mapchunk
3657 borders and horizontally spans the world.
3659 The 2D perlin noise described by `noise_params` defines the Y co-ordinate of
3660 the stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
3661 defines the stratum's vertical thickness (in units of nodes). Due to being
3662 continuous across mapchunk borders the stratum's vertical thickness is
3665 If the noise parameter `noise_params` is omitted the ore will occur from y_min
3666 to y_max in a simple horizontal stratum.
3668 A parameter `stratum_thickness` can be provided instead of the noise parameter
3669 `np_stratum_thickness`, to create a constant thickness.
3671 Leaving out one or both noise parameters makes the ore generation less
3672 intensive, useful when adding multiple strata.
3674 `y_min` and `y_max` define the limits of the ore generation and for performance
3675 reasons should be set as close together as possible but without clipping the
3676 stratum's Y variation.
3678 Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
3679 solid-ore stratum would require a `clust_scarcity` of 1.
3681 The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
3682 `random_factor` are ignored by this ore type.
3687 See section [Flag Specifier Format].
3689 Currently supported flags:
3690 `puff_cliffs`, `puff_additive_composition`.
3694 If set, puff ore generation will not taper down large differences in
3695 displacement when approaching the edge of a puff. This flag has no effect for
3696 ore types other than `puff`.
3698 ### `puff_additive_composition`
3700 By default, when noise described by `np_puff_top` or `np_puff_bottom` results
3701 in a negative displacement, the sub-column at that point is not generated. With
3702 this attribute set, puff ore generation will instead generate the absolute
3703 difference in noise displacement values. This flag has no effect for ore types
3712 The varying types of decorations that can be placed.
3717 Creates a 1 times `H` times 1 column of a specified node (or a random node from
3718 a list, if a decoration list is specified). Can specify a certain node it must
3719 spawn next to, such as water or lava, for example. Can also generate a
3720 decoration of random height between a specified lower and upper bound.
3721 This type of decoration is intended for placement of grass, flowers, cacti,
3722 papyri, waterlilies and so on.
3727 Copies a box of `MapNodes` from a specified schematic file (or raw description).
3728 Can specify a probability of a node randomly appearing when placed.
3729 This decoration type is intended to be used for multi-node sized discrete
3730 structures, such as trees, cave spikes, rocks, and so on.
3739 --------------------
3741 A schematic specifier identifies a schematic by either a filename to a
3742 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
3743 in the form of a table. This table specifies the following fields:
3745 * The `size` field is a 3D vector containing the dimensions of the provided
3746 schematic. (required field)
3747 * The `yslice_prob` field is a table of {ypos, prob} slice tables. A slice table
3748 sets the probability of a particular horizontal slice of the schematic being
3749 placed. (optional field)
3750 `ypos` = 0 for the lowest horizontal slice of a schematic.
3751 The default of `prob` is 255.
3752 * The `data` field is a flat table of MapNode tables making up the schematic,
3753 in the order of `[z [y [x]]]`. (required field)
3754 Each MapNode table contains:
3755 * `name`: the name of the map node to place (required)
3756 * `prob` (alias `param1`): the probability of this node being placed
3758 * `param2`: the raw param2 value of the node being placed onto the map
3760 * `force_place`: boolean representing if the node should forcibly overwrite
3761 any previous contents (default: false)
3763 About probability values:
3765 * A probability value of `0` or `1` means that node will never appear
3767 * A probability value of `254` or `255` means the node will always appear
3769 * If the probability value `p` is greater than `1`, then there is a
3770 `(p / 256 * 100)` percent chance that node will appear when the schematic is
3773 Schematic attributes
3774 --------------------
3776 See section [Flag Specifier Format].
3778 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
3781 * `place_center_x`: Placement of this decoration is centered along the X axis.
3782 * `place_center_y`: Placement of this decoration is centered along the Y axis.
3783 * `place_center_z`: Placement of this decoration is centered along the Z axis.
3784 * `force_placement`: Schematic nodes other than "ignore" will replace existing
3790 Lua Voxel Manipulator
3791 =====================
3796 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator'
3797 facility. The purpose of this object is for fast, low-level, bulk access to
3798 reading and writing Map content. As such, setting map nodes through VoxelManip
3799 will lack many of the higher level features and concepts you may be used to
3800 with other methods of setting nodes. For example, nodes will not have their
3801 construction and destruction callbacks run, and no rollback information is
3804 It is important to note that VoxelManip is designed for speed, and *not* ease
3805 of use or flexibility. If your mod requires a map manipulation facility that
3806 will handle 100% of all edge cases, or the use of high level node placement
3807 features, perhaps `minetest.set_node()` is better suited for the job.
3809 In addition, VoxelManip might not be faster, or could even be slower, for your
3810 specific use case. VoxelManip is most effective when setting large areas of map
3811 at once - for example, if only setting a 3x3x3 node area, a
3812 `minetest.set_node()` loop may be more optimal. Always profile code using both
3813 methods of map manipulation to determine which is most appropriate for your
3816 A recent simple test of setting cubic areas showed that `minetest.set_node()`
3817 is faster than a VoxelManip for a 3x3x3 node cube or smaller.
3822 A VoxelManip object can be created any time using either:
3823 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
3825 If the optional position parameters are present for either of these routines,
3826 the specified region will be pre-loaded into the VoxelManip object on creation.
3827 Otherwise, the area of map you wish to manipulate must first be loaded into the
3828 VoxelManip object using `VoxelManip:read_from_map()`.
3830 Note that `VoxelManip:read_from_map()` returns two position vectors. The region
3831 formed by these positions indicate the minimum and maximum (respectively)
3832 positions of the area actually loaded in the VoxelManip, which may be larger
3833 than the area requested. For convenience, the loaded area coordinates can also
3834 be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
3836 Now that the VoxelManip object is populated with map data, your mod can fetch a
3837 copy of this data using either of two methods. `VoxelManip:get_node_at()`,
3838 which retrieves an individual node in a MapNode formatted table at the position
3839 requested is the simplest method to use, but also the slowest.
3841 Nodes in a VoxelManip object may also be read in bulk to a flat array table
3844 * `VoxelManip:get_data()` for node content (in Content ID form, see section
3846 * `VoxelManip:get_light_data()` for node light levels, and
3847 * `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
3849 See section [Flat array format] for more details.
3851 It is very important to understand that the tables returned by any of the above
3852 three functions represent a snapshot of the VoxelManip's internal state at the
3853 time of the call. This copy of the data will not magically update itself if
3854 another function modifies the internal VoxelManip state.
3855 Any functions that modify a VoxelManip's contents work on the VoxelManip's
3856 internal state unless otherwise explicitly stated.
3858 Once the bulk data has been edited to your liking, the internal VoxelManip
3859 state can be set using:
3861 * `VoxelManip:set_data()` for node content (in Content ID form, see section
3863 * `VoxelManip:set_light_data()` for node light levels, and
3864 * `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
3866 The parameter to each of the above three functions can use any table at all in
3867 the same flat array format as produced by `get_data()` etc. and is not required
3868 to be a table retrieved from `get_data()`.
3870 Once the internal VoxelManip state has been modified to your liking, the
3871 changes can be committed back to the map by calling `VoxelManip:write_to_map()`
3873 ### Flat array format
3876 `Nx = p2.X - p1.X + 1`,
3877 `Ny = p2.Y - p1.Y + 1`, and
3878 `Nz = p2.Z - p1.Z + 1`.
3880 Then, for a loaded region of p1..p2, this array ranges from `1` up to and
3881 including the value of the expression `Nx * Ny * Nz`.
3883 Positions offset from p1 are present in the array with the format of:
3886 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
3887 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
3889 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
3890 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
3892 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
3894 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
3897 and the array index for a position p contained completely in p1..p2 is:
3899 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
3901 Note that this is the same "flat 3D array" format as
3902 `PerlinNoiseMap:get3dMap_flat()`.
3903 VoxelArea objects (see section [`VoxelArea`]) can be used to simplify calculation
3904 of the index for a single point in a flat VoxelManip array.
3908 A Content ID is a unique integer identifier for a specific node type.
3909 These IDs are used by VoxelManip in place of the node name string for
3910 `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
3911 `minetest.get_content_id()` to look up the Content ID for the specified node
3912 name, and `minetest.get_name_from_content_id()` to look up the node name string
3913 for a given Content ID.
3914 After registration of a node, its Content ID will remain the same throughout
3915 execution of the mod.
3916 Note that the node being queried needs to have already been been registered.
3918 The following builtin node types have their Content IDs defined as constants:
3920 * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
3921 * `minetest.CONTENT_AIR`: ID for "air" nodes
3922 * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
3924 ### Mapgen VoxelManip objects
3926 Inside of `on_generated()` callbacks, it is possible to retrieve the same
3927 VoxelManip object used by the core's Map Generator (commonly abbreviated
3928 Mapgen). Most of the rules previously described still apply but with a few
3931 * The Mapgen VoxelManip object is retrieved using:
3932 `minetest.get_mapgen_object("voxelmanip")`
3933 * This VoxelManip object already has the region of map just generated loaded
3934 into it; it's not necessary to call `VoxelManip:read_from_map()` before using
3935 a Mapgen VoxelManip.
3936 * The `on_generated()` callbacks of some mods may place individual nodes in the
3937 generated area using non-VoxelManip map modification methods. Because the
3938 same Mapgen VoxelManip object is passed through each `on_generated()`
3939 callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3940 consistency with the current map state. For this reason, calling any of the
3941 following functions:
3942 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3943 will also update the Mapgen VoxelManip object's internal state active on the
3945 * After modifying the Mapgen VoxelManip object's internal buffer, it may be
3946 necessary to update lighting information using either:
3947 `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3949 ### Other API functions operating on a VoxelManip
3951 If any VoxelManip contents were set to a liquid node,
3952 `VoxelManip:update_liquids()` must be called for these liquid nodes to begin
3953 flowing. It is recommended to call this function only after having written all
3954 buffered data back to the VoxelManip object, save for special situations where
3955 the modder desires to only have certain liquid nodes begin flowing.
3957 The functions `minetest.generate_ores()` and `minetest.generate_decorations()`
3958 will generate all registered decorations and ores throughout the full area
3959 inside of the specified VoxelManip object.
3961 `minetest.place_schematic_on_vmanip()` is otherwise identical to
3962 `minetest.place_schematic()`, except instead of placing the specified schematic
3963 directly on the map at the specified position, it will place the schematic
3964 inside the VoxelManip.
3968 * Attempting to read data from a VoxelManip object before map is read will
3969 result in a zero-length array table for `VoxelManip:get_data()`, and an
3970 "ignore" node at any position for `VoxelManip:get_node_at()`.
3971 * If either a region of map has not yet been generated or is out-of-bounds of
3972 the map, that region is filled with "ignore" nodes.
3973 * Other mods, or the core itself, could possibly modify the area of map
3974 currently loaded into a VoxelManip object. With the exception of Mapgen
3975 VoxelManips (see above section), the internal buffers are not updated. For
3976 this reason, it is strongly encouraged to complete the usage of a particular
3977 VoxelManip object in the same callback it had been created.
3978 * If a VoxelManip object will be used often, such as in an `on_generated()`
3979 callback, consider passing a file-scoped table as the optional parameter to
3980 `VoxelManip:get_data()`, which serves as a static buffer the function can use
3981 to write map data to instead of returning a new table each call. This greatly
3982 enhances performance by avoiding unnecessary memory allocations.
3987 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object
3988 containing the region formed by `p1` and `p2`.
3989 * returns actual emerged `pmin`, actual emerged `pmax`
3990 * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to
3992 * **important**: data must be set using `VoxelManip:set_data()` before
3994 * if `light` is true, then lighting is automatically recalculated.
3995 The default value is true.
3996 If `light` is false, no light calculations happen, and you should correct
3997 all modified blocks with `minetest.fix_light()` as soon as possible.
3998 Keep in mind that modifying the map where light is incorrect can cause
4000 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
4001 the `VoxelManip` at that position
4002 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
4004 * `get_data([buffer])`: Retrieves the node content data loaded into the
4005 `VoxelManip` object.
4006 * returns raw node data in the form of an array of node content IDs
4007 * if the param `buffer` is present, this table will be used to store the
4009 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
4010 * `update_map()`: Does nothing, kept for compatibility.
4011 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to
4013 * `light` is a table, `{day=<0...15>, night=<0...15>}`
4014 * To be used only by a `VoxelManip` object from
4015 `minetest.get_mapgen_object`.
4016 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4018 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
4019 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4021 * Each value is the bitwise combination of day and night light values
4023 * `light = day + (night * 16)`
4024 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
4025 in the `VoxelManip`.
4026 * expects lighting data in the same format that `get_light_data()` returns
4027 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the
4028 `VoxelManip` object.
4029 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4031 * If the param `buffer` is present, this table will be used to store the
4033 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in
4035 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the
4037 * To be used only by a `VoxelManip` object from
4038 `minetest.get_mapgen_object`.
4039 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4040 area if left out or nil. For almost all uses these should be left out
4041 or nil to use the default.
4042 * `propagate_shadow` is an optional boolean deciding whether shadows in a
4043 generated mapchunk above are propagated down into the mapchunk, defaults
4044 to `true` if left out.
4045 * `update_liquids()`: Update liquid flow
4046 * `was_modified()`: Returns `true` or `false` if the data in the voxel
4047 manipulator had been modified since the last read from map, due to a call to
4048 `minetest.set_data()` on the loaded area elsewhere.
4049 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
4054 A helper class for voxel areas.
4055 It can be created via `VoxelArea:new{MinEdge = pmin, MaxEdge = pmax}`.
4056 The coordinates are *inclusive*, like most other things in Minetest.
4060 * `getExtent()`: returns a 3D vector containing the size of the area formed by
4061 `MinEdge` and `MaxEdge`.
4062 * `getVolume()`: returns the volume of the area formed by `MinEdge` and
4064 * `index(x, y, z)`: returns the index of an absolute position in a flat array
4066 * `x`, `y` and `z` must be integers to avoid an incorrect index result.
4067 * The position (x, y, z) is not checked for being inside the area volume,
4068 being outside can cause an incorrect index result.
4069 * Useful for things like `VoxelManip`, raw Schematic specifiers,
4070 `PerlinNoiseMap:get2d`/`3dMap`, and so on.
4071 * `indexp(p)`: same functionality as `index(x, y, z)` but takes a vector.
4072 * As with `index(x, y, z)`, the components of `p` must be integers, and `p`
4073 is not checked for being inside the area volume.
4074 * `position(i)`: returns the absolute position vector corresponding to index
4076 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by
4077 `MinEdge` and `MaxEdge`.
4078 * `containsp(p)`: same as above, except takes a vector
4079 * `containsi(i)`: same as above, except takes an index `i`
4080 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns
4082 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of
4084 * `iterp(minp, maxp)`: same as above, except takes a vector
4086 ### Y stride and z stride of a flat array
4088 For a particular position in a voxel area, whose flat array index is known,
4089 it is often useful to know the index of a neighboring or nearby position.
4090 The table below shows the changes of index required for 1 node movements along
4091 the axes in a voxel area:
4093 Movement Change of index
4103 local area = VoxelArea:new{MinEdge = emin, MaxEdge = emax}
4105 The values of `ystride` and `zstride` can be obtained using `area.ystride` and
4114 A mapgen object is a construct used in map generation. Mapgen objects can be
4115 used by an `on_generate` callback to speed up operations by avoiding
4116 unnecessary recalculations, these can be retrieved using the
4117 `minetest.get_mapgen_object()` function. If the requested Mapgen object is
4118 unavailable, or `get_mapgen_object()` was called outside of an `on_generate()`
4119 callback, `nil` is returned.
4121 The following Mapgen objects are currently available:
4125 This returns three values; the `VoxelManip` object to be used, minimum and
4126 maximum emerged position, in that order. All mapgens support this object.
4130 Returns an array containing the y coordinates of the ground levels of nodes in
4131 the most recently generated chunk by the current mapgen.
4135 Returns an array containing the biome IDs of nodes in the most recently
4136 generated chunk by the current mapgen.
4140 Returns an array containing the temperature values of nodes in the most
4141 recently generated chunk by the current mapgen.
4145 Returns an array containing the humidity values of nodes in the most recently
4146 generated chunk by the current mapgen.
4150 Returns a table mapping requested generation notification types to arrays of
4151 positions at which the corresponding generated structures are located within
4152 the current chunk. To set the capture of positions of interest to be recorded
4153 on generate, use `minetest.set_gen_notify()`.
4154 For decorations, the returned positions are the ground surface 'place_on'
4155 nodes, not the decorations themselves. A 'simple' type decoration is often 1
4156 node above the returned position and possibly displaced by 'place_offset_y'.
4158 Possible fields of the table returned are:
4164 * `large_cave_begin`
4168 Decorations have a key in the format of `"decoration#id"`, where `id` is the
4169 numeric unique decoration ID as returned by `minetest.get_decoration_id`.
4177 Functions receive a "luaentity" as `self`:
4179 * It has the member `.name`, which is the registered name `("mod:thing")`
4180 * It has the member `.object`, which is an `ObjectRef` pointing to the object
4181 * The original prototype stuff is visible directly via a metatable
4185 * `on_activate(self, staticdata, dtime_s)`
4186 * Called when the object is instantiated.
4187 * `dtime_s` is the time passed since the object was unloaded, which can be
4188 used for updating the entity state.
4189 * `on_step(self, dtime)`
4190 * Called on every server tick, after movement and collision processing.
4191 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
4193 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)`
4194 * Called when somebody punches the object.
4195 * Note that you probably want to handle most punches using the automatic
4197 * `puncher`: an `ObjectRef` (can be `nil`)
4198 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4200 * `tool_capabilities`: capability table of used tool (can be `nil`)
4201 * `dir`: unit vector of direction of punch. Always defined. Points from the
4202 puncher to the punched.
4203 * `damage`: damage that will be done to entity.
4204 * Can return `true` to prevent the default damage mechanism.
4205 * `on_death(self, killer)`
4206 * Called when the object dies.
4207 * `killer`: an `ObjectRef` (can be `nil`)
4208 * `on_rightclick(self, clicker)`
4209 * `on_attach_child(self, child)`
4210 * `child`: an `ObjectRef` of the child that attaches
4211 * `on_detach_child(self, child)`
4212 * `child`: an `ObjectRef` of the child that detaches
4213 * `on_detach(self, parent)`
4214 * `parent`: an `ObjectRef` (can be `nil`) from where it got detached
4215 * This happens before the parent object is removed from the world
4216 * `get_staticdata(self)`
4217 * Should return a string that will be passed to `on_activate` when the
4218 object is instantiated the next time.
4230 axiom, --string initial tree axiom
4231 rules_a, --string rules set A
4232 rules_b, --string rules set B
4233 rules_c, --string rules set C
4234 rules_d, --string rules set D
4235 trunk, --string trunk node name
4236 leaves, --string leaves node name
4237 leaves2, --string secondary leaves node name
4238 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
4239 angle, --num angle in deg
4240 iterations, --num max # of iterations, usually 2 -5
4241 random_level, --num factor to lower nr of iterations, usually 0 - 3
4242 trunk_type, --string single/double/crossed) type of trunk: 1 node,
4243 -- 2x2 nodes or 3x3 in cross shape
4244 thin_branches, --boolean true -> use thin (1 node) branches
4245 fruit, --string fruit node name
4246 fruit_chance, --num chance (0-100) to replace leaves with fruit node
4247 seed, --num random seed, if no seed is provided, the engine
4251 Key for special L-System symbols used in axioms
4252 -----------------------------------------------
4254 * `G`: move forward one unit with the pen up
4255 * `F`: move forward one unit with the pen down drawing trunks and branches
4256 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
4257 * `T`: move forward one unit with the pen down drawing trunks only
4258 * `R`: move forward one unit with the pen down placing fruit
4259 * `A`: replace with rules set A
4260 * `B`: replace with rules set B
4261 * `C`: replace with rules set C
4262 * `D`: replace with rules set D
4263 * `a`: replace with rules set A, chance 90%
4264 * `b`: replace with rules set B, chance 80%
4265 * `c`: replace with rules set C, chance 70%
4266 * `d`: replace with rules set D, chance 60%
4267 * `+`: yaw the turtle right by `angle` parameter
4268 * `-`: yaw the turtle left by `angle` parameter
4269 * `&`: pitch the turtle down by `angle` parameter
4270 * `^`: pitch the turtle up by `angle` parameter
4271 * `/`: roll the turtle to the right by `angle` parameter
4272 * `*`: roll the turtle to the left by `angle` parameter
4273 * `[`: save in stack current state info
4274 * `]`: recover from stack state info
4279 Spawn a small apple tree:
4281 pos = {x=230,y=20,z=4}
4284 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
4285 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
4286 trunk="default:tree",
4287 leaves="default:leaves",
4291 trunk_type="single",
4294 fruit="default:apple"
4296 minetest.spawn_tree(pos,apple_tree)
4301 'minetest' namespace reference
4302 ==============================
4307 * `minetest.get_current_modname()`: returns the currently loading mod's name,
4309 * `minetest.get_modpath(modname)`: returns e.g.
4310 `"/home/user/.minetest/usermods/modname"`.
4311 * Useful for loading additional `.lua` modules or static data from mod
4312 * `minetest.get_modnames()`: returns a list of installed mods
4313 * Return a list of installed mods, sorted alphabetically
4314 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
4315 * Useful for storing custom data
4316 * `minetest.is_singleplayer()`
4317 * `minetest.features`: Table containing API feature flags
4320 glasslike_framed = true, -- 0.4.7
4321 nodebox_as_selectionbox = true, -- 0.4.7
4322 get_all_craft_recipes_works = true, -- 0.4.7
4323 -- The transparency channel of textures can optionally be used on
4325 use_texture_alpha = true,
4326 -- Tree and grass ABMs are no longer done from C++ (0.4.8)
4327 no_legacy_abms = true,
4328 -- Texture grouping is possible using parentheses (0.4.11)
4329 texture_names_parens = true,
4330 -- Unique Area ID for AreaStore:insert_area (0.4.14)
4331 area_store_custom_ids = true,
4332 -- add_entity supports passing initial staticdata to on_activate
4334 add_entity_with_staticdata = true,
4335 -- Chat messages are no longer predicted (0.4.16)
4336 no_chat_message_prediction = true,
4337 -- The transparency channel of textures can optionally be used on
4338 -- objects (ie: players and lua entities) (5.0.0)
4339 object_use_texture_alpha = true,
4340 -- Object selectionbox is settable independently from collisionbox
4342 object_independent_selectionbox = true,
4343 -- Specifies whether binary data can be uploaded or downloaded using
4344 -- the HTTP API (5.1.0)
4345 httpfetch_binary_data = true,
4346 -- Whether formspec_version[<version>] may be used (5.1.0)
4347 formspec_version_element = true,
4348 -- Whether AreaStore's IDs are kept on save/load (5.1.0)
4349 area_store_persistent_ids = true,
4350 -- Whether minetest.find_path is functional (5.2.0)
4351 pathfinder_works = true,
4352 -- Whether Collision info is available to an objects' on_step (5.3.0)
4353 object_step_has_moveresult = true,
4354 -- Whether get_velocity() and add_velocity() can be used on players (5.4.0)
4355 direct_velocity_on_players = true,
4358 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
4359 * `arg`: string or table in format `{foo=true, bar=true}`
4360 * `missing_features`: `{foo=true, bar=true}`
4361 * `minetest.get_player_information(player_name)`: Table containing information
4362 about a player. Example return value:
4365 address = "127.0.0.1", -- IP address of client
4366 ip_version = 4, -- IPv4 / IPv6
4367 connection_uptime = 200, -- seconds since client connected
4368 protocol_version = 32, -- protocol version used by client
4369 formspec_version = 2, -- supported formspec version
4370 lang_code = "fr" -- Language code used for translation
4371 -- the following keys can be missing if no stats have been collected yet
4372 min_rtt = 0.01, -- minimum round trip time
4373 max_rtt = 0.2, -- maximum round trip time
4374 avg_rtt = 0.02, -- average round trip time
4375 min_jitter = 0.01, -- minimum packet time jitter
4376 max_jitter = 0.5, -- maximum packet time jitter
4377 avg_jitter = 0.03, -- average packet time jitter
4378 -- the following information is available in a debug build only!!!
4379 -- DO NOT USE IN MODS
4380 --ser_vers = 26, -- serialization version used by client
4381 --major = 0, -- major version number
4382 --minor = 4, -- minor version number
4383 --patch = 10, -- patch version number
4384 --vers_string = "0.4.9-git", -- full version string
4385 --state = "Active" -- current client state
4388 * `minetest.mkdir(path)`: returns success.
4389 * Creates a directory specified by `path`, creating parent directories
4390 if they don't exist.
4391 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
4393 * nil: return all entries,
4394 * true: return only subdirectory names, or
4395 * false: return only file names.
4396 * `minetest.safe_file_write(path, content)`: returns boolean indicating success
4397 * Replaces contents of file at path with new contents in a safe (atomic)
4398 way. Use this instead of below code when writing e.g. database files:
4399 `local f = io.open(path, "wb"); f:write(content); f:close()`
4400 * `minetest.get_version()`: returns a table containing components of the
4401 engine version. Components:
4402 * `project`: Name of the project, eg, "Minetest"
4403 * `string`: Simple version, eg, "1.2.3-dev"
4404 * `hash`: Full git version (only set if available),
4405 eg, "1.2.3-dev-01234567-dirty".
4406 Use this for informational purposes only. The information in the returned
4407 table does not represent the capabilities of the engine, nor is it
4408 reliable or verifiable. Compatible forks will have a different name and
4409 version entirely. To check for the presence of engine features, test
4410 whether the functions exported by the wanted features exist. For example:
4411 `if minetest.check_for_falling then ... end`.
4412 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
4413 * `data`: string of data to hash
4414 * `raw`: return raw bytes instead of hex digits, default: false
4419 * `minetest.debug(...)`
4420 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
4421 * `minetest.log([level,] text)`
4422 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
4423 `"info"`, or `"verbose"`. Default is `"none"`.
4425 Registration functions
4426 ----------------------
4428 Call these functions only at load time!
4432 * `minetest.register_node(name, node definition)`
4433 * `minetest.register_craftitem(name, item definition)`
4434 * `minetest.register_tool(name, item definition)`
4435 * `minetest.override_item(name, redefinition)`
4436 * Overrides fields of an item registered with register_node/tool/craftitem.
4437 * Note: Item must already be defined, (opt)depend on the mod defining it.
4438 * Example: `minetest.override_item("default:mese",
4439 {light_source=minetest.LIGHT_MAX})`
4440 * `minetest.unregister_item(name)`
4441 * Unregisters the item from the engine, and deletes the entry with key
4442 `name` from `minetest.registered_items` and from the associated item table
4443 according to its nature: `minetest.registered_nodes`, etc.
4444 * `minetest.register_entity(name, entity definition)`
4445 * `minetest.register_abm(abm definition)`
4446 * `minetest.register_lbm(lbm definition)`
4447 * `minetest.register_alias(alias, original_name)`
4448 * Also use this to set the 'mapgen aliases' needed in a game for the core
4449 mapgens. See [Mapgen aliases] section above.
4450 * `minetest.register_alias_force(alias, original_name)`
4451 * `minetest.register_ore(ore definition)`
4452 * Returns an integer object handle uniquely identifying the registered
4454 * The order of ore registrations determines the order of ore generation.
4455 * `minetest.register_biome(biome definition)`
4456 * Returns an integer object handle uniquely identifying the registered
4457 biome on success. To get the biome ID, use `minetest.get_biome_id`.
4458 * `minetest.unregister_biome(name)`
4459 * Unregisters the biome from the engine, and deletes the entry with key
4460 `name` from `minetest.registered_biomes`.
4461 * Warning: This alters the biome to biome ID correspondences, so any
4462 decorations or ores using the 'biomes' field must afterwards be cleared
4464 * `minetest.register_decoration(decoration definition)`
4465 * Returns an integer object handle uniquely identifying the registered
4466 decoration on success. To get the decoration ID, use
4467 `minetest.get_decoration_id`.
4468 * The order of decoration registrations determines the order of decoration
4470 * `minetest.register_schematic(schematic definition)`
4471 * Returns an integer object handle uniquely identifying the registered
4472 schematic on success.
4473 * If the schematic is loaded from a file, the `name` field is set to the
4475 * If the function is called when loading the mod, and `name` is a relative
4476 path, then the current mod path will be prepended to the schematic
4478 * `minetest.clear_registered_biomes()`
4479 * Clears all biomes currently registered.
4480 * Warning: Clearing and re-registering biomes alters the biome to biome ID
4481 correspondences, so any decorations or ores using the 'biomes' field must
4482 afterwards be cleared and re-registered.
4483 * `minetest.clear_registered_decorations()`
4484 * Clears all decorations currently registered.
4485 * `minetest.clear_registered_ores()`
4486 * Clears all ores currently registered.
4487 * `minetest.clear_registered_schematics()`
4488 * Clears all schematics currently registered.
4492 * `minetest.register_craft(recipe)`
4493 * Check recipe table syntax for different types below.
4494 * `minetest.clear_craft(recipe)`
4495 * Will erase existing craft based either on output item or on input recipe.
4496 * Specify either output or input only. If you specify both, input will be
4497 ignored. For input use the same recipe table syntax as for
4498 `minetest.register_craft(recipe)`. For output specify only the item,
4500 * Returns false if no erase candidate could be found, otherwise returns true.
4501 * **Warning**! The type field ("shaped", "cooking" or any other) will be
4502 ignored if the recipe contains output. Erasing is then done independently
4503 from the crafting method.
4504 * `minetest.register_chatcommand(cmd, chatcommand definition)`
4505 * `minetest.override_chatcommand(name, redefinition)`
4506 * Overrides fields of a chatcommand registered with `register_chatcommand`.
4507 * `minetest.unregister_chatcommand(name)`
4508 * Unregisters a chatcommands registered with `register_chatcommand`.
4509 * `minetest.register_privilege(name, definition)`
4510 * `definition` can be a description or a definition table (see [Privilege
4512 * If it is a description, the priv will be granted to singleplayer and admin
4514 * To allow players with `basic_privs` to grant, see the `basic_privs`
4515 minetest.conf setting.
4516 * `minetest.register_authentication_handler(authentication handler definition)`
4517 * Registers an auth handler that overrides the builtin one.
4518 * This function can be called by a single mod once only.
4520 Global callback registration functions
4521 --------------------------------------
4523 Call these functions only at load time!
4525 * `minetest.register_globalstep(function(dtime))`
4526 * Called every server step, usually interval of 0.1s
4527 * `minetest.register_on_mods_loaded(function())`
4528 * Called after mods have finished loading and before the media is cached or the
4530 * `minetest.register_on_shutdown(function())`
4531 * Called before server shutdown
4532 * **Warning**: If the server terminates abnormally (i.e. crashes), the
4533 registered callbacks **will likely not be run**. Data should be saved at
4534 semi-frequent intervals as well as on server shutdown.
4535 * `minetest.register_on_placenode(function(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
4536 * Called when a node has been placed
4537 * If return `true` no item is taken from `itemstack`
4538 * `placer` may be any valid ObjectRef or nil.
4539 * **Not recommended**; use `on_construct` or `after_place_node` in node
4540 definition whenever possible.
4541 * `minetest.register_on_dignode(function(pos, oldnode, digger))`
4542 * Called when a node has been dug.
4543 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node
4544 definition whenever possible.
4545 * `minetest.register_on_punchnode(function(pos, node, puncher, pointed_thing))`
4546 * Called when a node is punched
4547 * `minetest.register_on_generated(function(minp, maxp, blockseed))`
4548 * Called after generating a piece of world. Modifying nodes inside the area
4549 is a bit faster than usually.
4550 * `minetest.register_on_newplayer(function(ObjectRef))`
4551 * Called when a new player enters the world for the first time
4552 * `minetest.register_on_punchplayer(function(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
4553 * Called when a player is punched
4554 * Note: This callback is invoked even if the punched player is dead.
4555 * `player`: ObjectRef - Player that was punched
4556 * `hitter`: ObjectRef - Player that hit
4557 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4559 * `tool_capabilities`: Capability table of used tool (can be nil)
4560 * `dir`: Unit vector of direction of punch. Always defined. Points from
4561 the puncher to the punched.
4562 * `damage`: Number that represents the damage calculated by the engine
4563 * should return `true` to prevent the default damage mechanism
4564 * `minetest.register_on_player_hpchange(function(player, hp_change, reason), modifier)`
4565 * Called when the player gets damaged or healed
4566 * `player`: ObjectRef of the player
4567 * `hp_change`: the amount of change. Negative when it is damage.
4568 * `reason`: a PlayerHPChangeReason table.
4569 * The `type` field will have one of the following values:
4570 * `set_hp`: A mod or the engine called `set_hp` without
4571 giving a type - use this for custom damage types.
4572 * `punch`: Was punched. `reason.object` will hold the puncher, or nil if none.
4574 * `node_damage`: `damage_per_second` from a neighbouring node.
4575 `reason.node` will hold the node name or nil.
4578 * Any of the above types may have additional fields from mods.
4579 * `reason.from` will be `mod` or `engine`.
4580 * `modifier`: when true, the function should return the actual `hp_change`.
4581 Note: modifiers only get a temporary `hp_change` that can be modified by later modifiers.
4582 Modifiers can return true as a second argument to stop the execution of further functions.
4583 Non-modifiers receive the final HP change calculated by the modifiers.
4584 * `minetest.register_on_dieplayer(function(ObjectRef, reason))`
4585 * Called when a player dies
4586 * `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
4587 * `minetest.register_on_respawnplayer(function(ObjectRef))`
4588 * Called when player is to be respawned
4589 * Called _before_ repositioning of player occurs
4590 * return true in func to disable regular player placement
4591 * `minetest.register_on_prejoinplayer(function(name, ip))`
4592 * Called when a client connects to the server, prior to authentication
4593 * If it returns a string, the client is disconnected with that string as
4595 * `minetest.register_on_joinplayer(function(ObjectRef, last_login))`
4596 * Called when a player joins the game
4597 * `last_login`: The timestamp of the previous login, or nil if player is new
4598 * `minetest.register_on_leaveplayer(function(ObjectRef, timed_out))`
4599 * Called when a player leaves the game
4600 * `timed_out`: True for timeout, false for other reasons.
4601 * `minetest.register_on_authplayer(function(name, ip, is_success))`
4602 * Called when a client attempts to log into an account.
4603 * `name`: The name of the account being authenticated.
4604 * `ip`: The IP address of the client
4605 * `is_success`: Whether the client was successfully authenticated
4606 * For newly registered accounts, `is_success` will always be true
4607 * `minetest.register_on_auth_fail(function(name, ip))`
4608 * Deprecated: use `minetest.register_on_authplayer(name, ip, is_success)` instead.
4609 * `minetest.register_on_cheat(function(ObjectRef, cheat))`
4610 * Called when a player cheats
4611 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
4613 * `interacted_too_far`
4614 * `interacted_while_dead`
4615 * `finished_unknown_dig`
4618 * `minetest.register_on_chat_message(function(name, message))`
4619 * Called always when a player says something
4620 * Return `true` to mark the message as handled, which means that it will
4621 not be sent to other players.
4622 * `minetest.register_on_chatcommand(function(name, command, params))`
4623 * Called always when a chatcommand is triggered, before `minetest.registered_chatcommands`
4624 is checked to see if the command exists, but after the input is parsed.
4625 * Return `true` to mark the command as handled, which means that the default
4626 handlers will be prevented.
4627 * `minetest.register_on_player_receive_fields(function(player, formname, fields))`
4628 * Called when the server received input from `player` in a formspec with
4629 the given `formname`. Specifically, this is called on any of the
4631 * a button was pressed,
4632 * Enter was pressed while the focus was on a text field
4633 * a checkbox was toggled,
4634 * something was selected in a dropdown list,
4635 * a different tab was selected,
4636 * selection was changed in a textlist or table,
4637 * an entry was double-clicked in a textlist or table,
4638 * a scrollbar was moved, or
4639 * the form was actively closed by the player.
4640 * Fields are sent for formspec elements which define a field. `fields`
4641 is a table containing each formspecs element value (as string), with
4642 the `name` parameter as index for each. The value depends on the
4643 formspec element type:
4644 * `animated_image`: Returns the index of the current frame.
4645 * `button` and variants: If pressed, contains the user-facing button
4646 text as value. If not pressed, is `nil`
4647 * `field`, `textarea` and variants: Text in the field
4648 * `dropdown`: Either the index or value, depending on the `index event`
4650 * `tabheader`: Tab index, starting with `"1"` (only if tab changed)
4651 * `checkbox`: `"true"` if checked, `"false"` if unchecked
4652 * `textlist`: See `minetest.explode_textlist_event`
4653 * `table`: See `minetest.explode_table_event`
4654 * `scrollbar`: See `minetest.explode_scrollbar_event`
4655 * Special case: `["quit"]="true"` is sent when the user actively
4656 closed the form by mouse click, keypress or through a button_exit[]
4658 * Special case: `["key_enter"]="true"` is sent when the user pressed
4659 the Enter key and the focus was either nowhere (causing the formspec
4660 to be closed) or on a button. If the focus was on a text field,
4661 additionally, the index `key_enter_field` contains the name of the
4662 text field. See also: `field_close_on_enter`.
4663 * Newest functions are called first
4664 * If function returns `true`, remaining functions are not called
4665 * `minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv))`
4666 * Called when `player` crafts something
4667 * `itemstack` is the output
4668 * `old_craft_grid` contains the recipe (Note: the one in the inventory is
4670 * `craft_inv` is the inventory with the crafting grid
4671 * Return either an `ItemStack`, to replace the output, or `nil`, to not
4673 * `minetest.register_craft_predict(function(itemstack, player, old_craft_grid, craft_inv))`
4674 * The same as before, except that it is called before the player crafts, to
4675 make craft prediction, and it should not change anything.
4676 * `minetest.register_allow_player_inventory_action(function(player, action, inventory, inventory_info))`
4677 * Determines how much of a stack may be taken, put or moved to a
4679 * `player` (type `ObjectRef`) is the player who modified the inventory
4680 `inventory` (type `InvRef`).
4681 * List of possible `action` (string) values and their
4682 `inventory_info` (table) contents:
4683 * `move`: `{from_list=string, to_list=string, from_index=number, to_index=number, count=number}`
4684 * `put`: `{listname=string, index=number, stack=ItemStack}`
4685 * `take`: Same as `put`
4686 * Return a numeric value to limit the amount of items to be taken, put or
4687 moved. A value of `-1` for `take` will make the source stack infinite.
4688 * `minetest.register_on_player_inventory_action(function(player, action, inventory, inventory_info))`
4689 * Called after a take, put or move event from/to/in a player inventory
4690 * Function arguments: see `minetest.register_allow_player_inventory_action`
4691 * Does not accept or handle any return value.
4692 * `minetest.register_on_protection_violation(function(pos, name))`
4693 * Called by `builtin` and mods when a player violates protection at a
4694 position (eg, digs a node or punches a protected entity).
4695 * The registered functions can be called using
4696 `minetest.record_protection_violation`.
4697 * The provided function should check that the position is protected by the
4698 mod calling this function before it prints a message, if it does, to
4699 allow for multiple protection mods.
4700 * `minetest.register_on_item_eat(function(hp_change, replace_with_item, itemstack, user, pointed_thing))`
4701 * Called when an item is eaten, by `minetest.item_eat`
4702 * Return `itemstack` to cancel the default item eat response (i.e.: hp increase).
4703 * `minetest.register_on_priv_grant(function(name, granter, priv))`
4704 * Called when `granter` grants the priv `priv` to `name`.
4705 * Note that the callback will be called twice if it's done by a player,
4706 once with granter being the player name, and again with granter being nil.
4707 * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
4708 * Called when `revoker` revokes the priv `priv` from `name`.
4709 * Note that the callback will be called twice if it's done by a player,
4710 once with revoker being the player name, and again with revoker being nil.
4711 * `minetest.register_can_bypass_userlimit(function(name, ip))`
4712 * Called when `name` user connects with `ip`.
4713 * Return `true` to by pass the player limit
4714 * `minetest.register_on_modchannel_message(function(channel_name, sender, message))`
4715 * Called when an incoming mod channel message is received
4716 * You should have joined some channels to receive events.
4717 * If message comes from a server mod, `sender` field is an empty string.
4722 * `minetest.settings`: Settings object containing all of the settings from the
4723 main config file (`minetest.conf`).
4724 * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
4725 parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
4730 * `minetest.string_to_privs(str[, delim])`:
4731 * Converts string representation of privs into table form
4732 * `delim`: String separating the privs. Defaults to `","`.
4733 * Returns `{ priv1 = true, ... }`
4734 * `minetest.privs_to_string(privs[, delim])`:
4735 * Returns the string representation of `privs`
4736 * `delim`: String to delimit privs. Defaults to `","`.
4737 * `minetest.get_player_privs(name) -> {priv1=true,...}`
4738 * `minetest.check_player_privs(player_or_name, ...)`:
4739 returns `bool, missing_privs`
4740 * A quickhand for checking privileges.
4741 * `player_or_name`: Either a Player object or the name of a player.
4742 * `...` is either a list of strings, e.g. `"priva", "privb"` or
4743 a table, e.g. `{ priva = true, privb = true }`.
4745 * `minetest.check_password_entry(name, entry, password)`
4746 * Returns true if the "password entry" for a player with name matches given
4747 password, false otherwise.
4748 * The "password entry" is the password representation generated by the
4749 engine as returned as part of a `get_auth()` call on the auth handler.
4750 * Only use this function for making it possible to log in via password from
4751 external protocols such as IRC, other uses are frowned upon.
4752 * `minetest.get_password_hash(name, raw_password)`
4753 * Convert a name-password pair to a password hash that Minetest can use.
4754 * The returned value alone is not a good basis for password checks based
4755 on comparing the password hash in the database with the password hash
4756 from the function, with an externally provided password, as the hash
4757 in the db might use the new SRP verifier format.
4758 * For this purpose, use `minetest.check_password_entry` instead.
4759 * `minetest.get_player_ip(name)`: returns an IP address string for the player
4761 * The player needs to be online for this to be successful.
4763 * `minetest.get_auth_handler()`: Return the currently active auth handler
4764 * See the [Authentication handler definition]
4765 * Use this to e.g. get the authentication data for a player:
4766 `local auth_data = minetest.get_auth_handler().get_auth(playername)`
4767 * `minetest.notify_authentication_modified(name)`
4768 * Must be called by the authentication handler for privilege changes.
4769 * `name`: string; if omitted, all auth data should be considered modified
4770 * `minetest.set_player_password(name, password_hash)`: Set password hash of
4772 * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player
4774 * `minetest.auth_reload()`
4775 * See `reload()` in authentication handler definition
4777 `minetest.set_player_password`, `minetest.set_player_privs`,
4778 `minetest.get_player_privs` and `minetest.auth_reload` call the authentication
4784 * `minetest.chat_send_all(text)`
4785 * `minetest.chat_send_player(name, text)`
4786 * `minetest.format_chat_message(name, message)`
4787 * Used by the server to format a chat message, based on the setting `chat_message_format`.
4788 Refer to the documentation of the setting for a list of valid placeholders.
4789 * Takes player name and message, and returns the formatted string to be sent to players.
4790 * Can be redefined by mods if required, for things like colored names or messages.
4791 * **Only** the first occurrence of each placeholder will be replaced.
4796 * `minetest.set_node(pos, node)`
4797 * `minetest.add_node(pos, node)`: alias to `minetest.set_node`
4798 * Set node at position `pos`
4799 * `node`: table `{name=string, param1=number, param2=number}`
4800 * If param1 or param2 is omitted, it's set to `0`.
4801 * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
4802 * `minetest.bulk_set_node({pos1, pos2, pos3, ...}, node)`
4803 * Set node on all positions set in the first argument.
4804 * e.g. `minetest.bulk_set_node({{x=0, y=1, z=1}, {x=1, y=2, z=2}}, {name="default:stone"})`
4805 * For node specification or position syntax see `minetest.set_node` call
4806 * Faster than set_node due to single call, but still considerably slower
4807 than Lua Voxel Manipulators (LVM) for large numbers of nodes.
4808 Unlike LVMs, this will call node callbacks. It also allows setting nodes
4809 in spread out positions which would cause LVMs to waste memory.
4810 For setting a cube, this is 1.3x faster than set_node whereas LVM is 20
4812 * `minetest.swap_node(pos, node)`
4813 * Set node at position, but don't remove metadata
4814 * `minetest.remove_node(pos)`
4815 * By default it does the same as `minetest.set_node(pos, {name="air"})`
4816 * `minetest.get_node(pos)`
4817 * Returns the node at the given position as table in the format
4818 `{name="node_name", param1=0, param2=0}`,
4819 returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
4820 * `minetest.get_node_or_nil(pos)`
4821 * Same as `get_node` but returns `nil` for unloaded areas.
4822 * `minetest.get_node_light(pos, timeofday)`
4823 * Gets the light value at the given position. Note that the light value
4824 "inside" the node at the given position is returned, so you usually want
4825 to get the light value of a neighbor.
4826 * `pos`: The position where to measure the light.
4827 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
4828 * Returns a number between `0` and `15` or `nil`
4829 * `nil` is returned e.g. when the map isn't loaded at `pos`
4830 * `minetest.get_natural_light(pos[, timeofday])`
4831 * Figures out the sunlight (or moonlight) value at pos at the given time of
4833 * `pos`: The position of the node
4834 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
4835 * Returns a number between `0` and `15` or `nil`
4836 * This function tests 203 nodes in the worst case, which happens very
4838 * `minetest.get_artificial_light(param1)`
4839 * Calculates the artificial light (light from e.g. torches) value from the
4841 * `param1`: The param1 value of a `paramtype = "light"` node.
4842 * Returns a number between `0` and `15`
4843 * Currently it's the same as `math.floor(param1 / 16)`, except that it
4844 ensures compatibility.
4845 * `minetest.place_node(pos, node)`
4846 * Place node with the same effects that a player would cause
4847 * `minetest.dig_node(pos)`
4848 * Dig node with the same effects that a player would cause
4849 * Returns `true` if successful, `false` on failure (e.g. protected location)
4850 * `minetest.punch_node(pos)`
4851 * Punch node with the same effects that a player would cause
4852 * `minetest.spawn_falling_node(pos)`
4853 * Change node into falling node
4854 * Returns `true` if successful, `false` on failure
4856 * `minetest.find_nodes_with_meta(pos1, pos2)`
4857 * Get a table of positions of nodes that have metadata within a region
4859 * `minetest.get_meta(pos)`
4860 * Get a `NodeMetaRef` at that position
4861 * `minetest.get_node_timer(pos)`
4862 * Get `NodeTimerRef`
4864 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at
4866 * Returns `ObjectRef`, or `nil` if failed
4867 * `minetest.add_item(pos, item)`: Spawn item
4868 * Returns `ObjectRef`, or `nil` if failed
4869 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
4870 * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of
4872 * `radius`: using an euclidean metric
4873 * `minetest.set_timeofday(val)`
4874 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
4875 * `minetest.get_timeofday()`
4876 * `minetest.get_gametime()`: returns the time, in seconds, since the world was
4878 * `minetest.get_day_count()`: returns number days elapsed since world was
4880 * accounts for time changes.
4881 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns
4883 * `radius`: using a maximum metric
4884 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4885 * `search_center` is an optional boolean (default: `false`)
4886 If true `pos` is also checked for the nodes
4887 * `minetest.find_nodes_in_area(pos1, pos2, nodenames, [grouped])`
4888 * `pos1` and `pos2` are the min and max positions of the area to search.
4889 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4890 * If `grouped` is true the return value is a table indexed by node name
4891 which contains lists of positions.
4892 * If `grouped` is false or absent the return values are as follows:
4893 first value: Table with all node positions
4894 second value: Table with the count of each node with the node name
4896 * Area volume is limited to 4,096,000 nodes
4897 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
4899 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4900 * Return value: Table with all node positions with a node air above
4901 * Area volume is limited to 4,096,000 nodes
4902 * `minetest.get_perlin(noiseparams)`
4903 * Return world-specific perlin noise.
4904 * The actual seed used is the noiseparams seed plus the world seed.
4905 * `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
4906 * Deprecated: use `minetest.get_perlin(noiseparams)` instead.
4907 * Return world-specific perlin noise.
4908 * `minetest.get_voxel_manip([pos1, pos2])`
4909 * Return voxel manipulator object.
4910 * Loads the manipulator from the map if positions are passed.
4911 * `minetest.set_gen_notify(flags, {deco_ids})`
4912 * Set the types of on-generate notifications that should be collected.
4913 * `flags` is a flag field with the available flags:
4921 * The second parameter is a list of IDs of decorations which notification
4923 * `minetest.get_gen_notify()`
4924 * Returns a flagstring and a table with the `deco_id`s.
4925 * `minetest.get_decoration_id(decoration_name)`
4926 * Returns the decoration ID number for the provided decoration name string,
4927 or `nil` on failure.
4928 * `minetest.get_mapgen_object(objectname)`
4929 * Return requested mapgen object if available (see [Mapgen objects])
4930 * `minetest.get_heat(pos)`
4931 * Returns the heat at the position, or `nil` on failure.
4932 * `minetest.get_humidity(pos)`
4933 * Returns the humidity at the position, or `nil` on failure.
4934 * `minetest.get_biome_data(pos)`
4935 * Returns a table containing:
4936 * `biome` the biome id of the biome at that position
4937 * `heat` the heat at the position
4938 * `humidity` the humidity at the position
4939 * Or returns `nil` on failure.
4940 * `minetest.get_biome_id(biome_name)`
4941 * Returns the biome id, as used in the biomemap Mapgen object and returned
4942 by `minetest.get_biome_data(pos)`, for a given biome_name string.
4943 * `minetest.get_biome_name(biome_id)`
4944 * Returns the biome name string for the provided biome id, or `nil` on
4946 * If no biomes have been registered, such as in mgv6, returns `default`.
4947 * `minetest.get_mapgen_params()`
4948 * Deprecated: use `minetest.get_mapgen_setting(name)` instead.
4949 * Returns a table containing:
4955 * `minetest.set_mapgen_params(MapgenParams)`
4956 * Deprecated: use `minetest.set_mapgen_setting(name, value, override)`
4958 * Set map generation parameters.
4959 * Function cannot be called after the registration period; only
4960 initialization and `on_mapgen_init`.
4961 * Takes a table as an argument with the fields:
4967 * Leave field unset to leave that parameter unchanged.
4968 * `flags` contains a comma-delimited string of flags to set, or if the
4969 prefix `"no"` is attached, clears instead.
4970 * `flags` is in the same format and has the same options as `mg_flags` in
4972 * `minetest.get_mapgen_setting(name)`
4973 * Gets the *active* mapgen setting (or nil if none exists) in string
4974 format with the following order of precedence:
4975 1) Settings loaded from map_meta.txt or overrides set during mod
4977 2) Settings set by mods without a metafile override
4978 3) Settings explicitly set in the user config file, minetest.conf
4979 4) Settings set as the user config default
4980 * `minetest.get_mapgen_setting_noiseparams(name)`
4981 * Same as above, but returns the value as a NoiseParams table if the
4982 setting `name` exists and is a valid NoiseParams.
4983 * `minetest.set_mapgen_setting(name, value, [override_meta])`
4984 * Sets a mapgen param to `value`, and will take effect if the corresponding
4985 mapgen setting is not already present in map_meta.txt.
4986 * `override_meta` is an optional boolean (default: `false`). If this is set
4987 to true, the setting will become the active setting regardless of the map
4989 * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`.
4990 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
4991 * Same as above, except value is a NoiseParams table.
4992 * `minetest.set_noiseparams(name, noiseparams, set_default)`
4993 * Sets the noiseparams setting of `name` to the noiseparams table specified
4995 * `set_default` is an optional boolean (default: `true`) that specifies
4996 whether the setting should be applied to the default config or current
4998 * `minetest.get_noiseparams(name)`
4999 * Returns a table of the noiseparams for name.
5000 * `minetest.generate_ores(vm, pos1, pos2)`
5001 * Generate all registered ores within the VoxelManip `vm` and in the area
5002 from `pos1` to `pos2`.
5003 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
5004 * `minetest.generate_decorations(vm, pos1, pos2)`
5005 * Generate all registered decorations within the VoxelManip `vm` and in the
5006 area from `pos1` to `pos2`.
5007 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
5008 * `minetest.clear_objects([options])`
5009 * Clear all objects in the environment
5010 * Takes an optional table as an argument with the field `mode`.
5011 * mode = `"full"` : Load and go through every mapblock, clearing
5013 * mode = `"quick"`: Clear objects immediately in loaded mapblocks,
5014 clear objects in unloaded mapblocks only when the
5015 mapblocks are next activated.
5016 * `minetest.load_area(pos1[, pos2])`
5017 * Load the mapblocks containing the area from `pos1` to `pos2`.
5018 `pos2` defaults to `pos1` if not specified.
5019 * This function does not trigger map generation.
5020 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
5021 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be
5022 asynchronously fetched from memory, loaded from disk, or if inexistent,
5024 * If `callback` is a valid Lua function, this will be called for each block
5026 * The function signature of callback is:
5027 `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
5028 * `blockpos` is the *block* coordinates of the block that had been
5030 * `action` could be one of the following constant values:
5031 * `minetest.EMERGE_CANCELLED`
5032 * `minetest.EMERGE_ERRORED`
5033 * `minetest.EMERGE_FROM_MEMORY`
5034 * `minetest.EMERGE_FROM_DISK`
5035 * `minetest.EMERGE_GENERATED`
5036 * `calls_remaining` is the number of callbacks to be expected after
5038 * `param` is the user-defined parameter passed to emerge_area (or
5039 nil if the parameter was absent).
5040 * `minetest.delete_area(pos1, pos2)`
5041 * delete all mapblocks in the area from pos1 to pos2, inclusive
5042 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
5043 * Checks if there is anything other than air between pos1 and pos2.
5044 * Returns false if something is blocking the sight.
5045 * Returns the position of the blocking node when `false`
5046 * `pos1`: First position
5047 * `pos2`: Second position
5048 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
5049 * Creates a `Raycast` object.
5050 * `pos1`: start of the ray
5051 * `pos2`: end of the ray
5052 * `objects`: if false, only nodes will be returned. Default is `true`.
5053 * `liquids`: if false, liquid nodes won't be returned. Default is `false`.
5054 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
5055 * returns table containing path that can be walked on
5056 * returns a table of 3D points representing a path from `pos1` to `pos2` or
5058 * Reasons for failure:
5059 * No path exists at all
5060 * No path exists within `searchdistance` (see below)
5061 * Start or end pos is buried in land
5062 * `pos1`: start position
5063 * `pos2`: end position
5064 * `searchdistance`: maximum distance from the search positions to search in.
5065 In detail: Path must be completely inside a cuboid. The minimum
5066 `searchdistance` of 1 will confine search between `pos1` and `pos2`.
5067 Larger values will increase the size of this cuboid in all directions
5068 * `max_jump`: maximum height difference to consider walkable
5069 * `max_drop`: maximum height difference to consider droppable
5070 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`.
5071 Difference between `"A*"` and `"A*_noprefetch"` is that
5072 `"A*"` will pre-calculate the cost-data, the other will calculate it
5074 * `minetest.spawn_tree (pos, {treedef})`
5075 * spawns L-system tree at given `pos` with definition in `treedef` table
5076 * `minetest.transforming_liquid_add(pos)`
5077 * add node to liquid update queue
5078 * `minetest.get_node_max_level(pos)`
5079 * get max available level for leveled node
5080 * `minetest.get_node_level(pos)`
5081 * get level of leveled node (water, snow)
5082 * `minetest.set_node_level(pos, level)`
5083 * set level of leveled node, default `level` equals `1`
5084 * if `totallevel > maxlevel`, returns rest (`total-max`).
5085 * `minetest.add_node_level(pos, level)`
5086 * increase level of leveled node by level, default `level` equals `1`
5087 * if `totallevel > maxlevel`, returns rest (`total-max`)
5088 * `level` must be between -127 and 127
5089 * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
5090 * resets the light in a cuboid-shaped part of
5091 the map and removes lighting bugs.
5092 * Loads the area if it is not loaded.
5093 * `pos1` is the corner of the cuboid with the least coordinates
5094 (in node coordinates), inclusive.
5095 * `pos2` is the opposite corner of the cuboid, inclusive.
5096 * The actual updated cuboid might be larger than the specified one,
5097 because only whole map blocks can be updated.
5098 The actual updated area consists of those map blocks that intersect
5099 with the given cuboid.
5100 * However, the neighborhood of the updated area might change
5101 as well, as light can spread out of the cuboid, also light
5103 * returns `false` if the area is not fully generated,
5105 * `minetest.check_single_for_falling(pos)`
5106 * causes an unsupported `group:falling_node` node to fall and causes an
5107 unattached `group:attached_node` node to fall.
5108 * does not spread these updates to neighbours.
5109 * `minetest.check_for_falling(pos)`
5110 * causes an unsupported `group:falling_node` node to fall and causes an
5111 unattached `group:attached_node` node to fall.
5112 * spread these updates to neighbours and can cause a cascade
5114 * `minetest.get_spawn_level(x, z)`
5115 * Returns a player spawn y co-ordinate for the provided (x, z)
5116 co-ordinates, or `nil` for an unsuitable spawn point.
5117 * For most mapgens a 'suitable spawn point' is one with y between
5118 `water_level` and `water_level + 16`, and in mgv7 well away from rivers,
5119 so `nil` will be returned for many (x, z) co-ordinates.
5120 * The spawn level returned is for a player spawn in unmodified terrain.
5121 * The spawn level is intentionally above terrain level to cope with
5122 full-node biome 'dust' nodes.
5127 You can find mod channels communication scheme in `doc/mod_channels.png`.
5129 * `minetest.mod_channel_join(channel_name)`
5130 * Server joins channel `channel_name`, and creates it if necessary. You
5131 should listen for incoming messages with
5132 `minetest.register_on_modchannel_message`
5137 `minetest.get_inventory(location)`: returns an `InvRef`
5140 * `{type="player", name="celeron55"}`
5141 * `{type="node", pos={x=, y=, z=}}`
5142 * `{type="detached", name="creative"}`
5143 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns
5145 * `callbacks`: See [Detached inventory callbacks]
5146 * `player_name`: Make detached inventory available to one player
5147 exclusively, by default they will be sent to every player (even if not
5149 Note that this parameter is mostly just a workaround and will be removed
5151 * Creates a detached inventory. If it already exists, it is cleared.
5152 * `minetest.remove_detached_inventory(name)`
5153 * Returns a `boolean` indicating whether the removal succeeded.
5154 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
5155 returns left over ItemStack.
5156 * See `minetest.item_eat` and `minetest.register_on_item_eat`
5161 * `minetest.show_formspec(playername, formname, formspec)`
5162 * `playername`: name of player to show formspec
5163 * `formname`: name passed to `on_player_receive_fields` callbacks.
5164 It should follow the `"modname:<whatever>"` naming convention
5165 * `formspec`: formspec to display
5166 * `minetest.close_formspec(playername, formname)`
5167 * `playername`: name of player to close formspec
5168 * `formname`: has to exactly match the one given in `show_formspec`, or the
5169 formspec will not close.
5170 * calling `show_formspec(playername, formname, "")` is equal to this
5172 * to close a formspec regardless of the formname, call
5173 `minetest.close_formspec(playername, "")`.
5174 **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
5175 * `minetest.formspec_escape(string)`: returns a string
5176 * escapes the characters "[", "]", "\", "," and ";", which can not be used
5178 * `minetest.explode_table_event(string)`: returns a table
5179 * returns e.g. `{type="CHG", row=1, column=2}`
5181 * `"INV"`: no row selected
5183 * `"DCL"`: double-click
5184 * `minetest.explode_textlist_event(string)`: returns a table
5185 * returns e.g. `{type="CHG", index=1}`
5187 * `"INV"`: no row selected
5189 * `"DCL"`: double-click
5190 * `minetest.explode_scrollbar_event(string)`: returns a table
5191 * returns e.g. `{type="CHG", value=500}`
5193 * `"INV"`: something failed
5194 * `"CHG"`: has been changed
5195 * `"VAL"`: not changed
5200 * `minetest.inventorycube(img1, img2, img3)`
5201 * Returns a string for making an image of a cube (useful as an item image)
5202 * `minetest.get_pointed_thing_position(pointed_thing, above)`
5203 * Returns the position of a `pointed_thing` or `nil` if the `pointed_thing`
5204 does not refer to a node or entity.
5205 * If the optional `above` parameter is true and the `pointed_thing` refers
5206 to a node, then it will return the `above` position of the `pointed_thing`.
5207 * `minetest.dir_to_facedir(dir, is6d)`
5208 * Convert a vector to a facedir value, used in `param2` for
5209 `paramtype2="facedir"`.
5210 * passing something non-`nil`/`false` for the optional second parameter
5211 causes it to take the y component into account.
5212 * `minetest.facedir_to_dir(facedir)`
5213 * Convert a facedir back into a vector aimed directly out the "back" of a
5215 * `minetest.dir_to_wallmounted(dir)`
5216 * Convert a vector to a wallmounted value, used for
5217 `paramtype2="wallmounted"`.
5218 * `minetest.wallmounted_to_dir(wallmounted)`
5219 * Convert a wallmounted value back into a vector aimed directly out the
5221 * `minetest.dir_to_yaw(dir)`
5222 * Convert a vector into a yaw (angle)
5223 * `minetest.yaw_to_dir(yaw)`
5224 * Convert yaw (angle) to a vector
5225 * `minetest.is_colored_paramtype(ptype)`
5226 * Returns a boolean. Returns `true` if the given `paramtype2` contains
5227 color information (`color`, `colorwallmounted` or `colorfacedir`).
5228 * `minetest.strip_param2_color(param2, paramtype2)`
5229 * Removes everything but the color information from the
5230 given `param2` value.
5231 * Returns `nil` if the given `paramtype2` does not contain color
5233 * `minetest.get_node_drops(node, toolname)`
5234 * Returns list of itemstrings that are dropped by `node` when dug
5236 * `node`: node as table or node name
5237 * `toolname`: name of the tool item (can be `nil`)
5238 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
5239 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
5240 * `input.width` = for example `3`
5241 * `input.items` = for example
5242 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
5243 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
5244 * `output.time` = a number, if unsuccessful: `0`
5245 * `output.replacements` = List of replacement `ItemStack`s that couldn't be
5246 placed in `decremented_input.items`. Replacements can be placed in
5247 `decremented_input` if the stack of the replaced item has a count of 1.
5248 * `decremented_input` = like `input`
5249 * `minetest.get_craft_recipe(output)`: returns input
5250 * returns last registered recipe for output item (node)
5251 * `output` is a node or item type such as `"default:torch"`
5252 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
5253 * `input.width` = for example `3`
5254 * `input.items` = for example
5255 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
5256 * `input.items` = `nil` if no recipe found
5257 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
5258 * returns indexed table with all registered recipes for query item (node)
5259 or `nil` if no recipe was found.
5260 * recipe entry table:
5261 * `method`: 'normal' or 'cooking' or 'fuel'
5262 * `width`: 0-3, 0 means shapeless recipe
5263 * `items`: indexed [1-9] table with recipe items
5264 * `output`: string with item name and quantity
5265 * Example query for `"default:gold_ingot"` will return table:
5268 [1]={method = "cooking", width = 3, output = "default:gold_ingot",
5269 items = {1 = "default:gold_lump"}},
5270 [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
5271 items = {1 = "default:goldblock"}}
5273 * `minetest.handle_node_drops(pos, drops, digger)`
5274 * `drops`: list of itemstrings
5275 * Handles drops from nodes after digging: Default action is to put them
5276 into digger's inventory.
5277 * Can be overridden to get different functionality (e.g. dropping items on
5279 * `minetest.itemstring_with_palette(item, palette_index)`: returns an item
5281 * Creates an item string which contains palette index information
5282 for hardware colorization. You can use the returned string
5283 as an output in a craft recipe.
5284 * `item`: the item stack which becomes colored. Can be in string,
5285 table and native form.
5286 * `palette_index`: this index is added to the item stack
5287 * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
5288 * Creates an item string which contains static color information
5289 for hardware colorization. Use this method if you wish to colorize
5290 an item that does not own a palette. You can use the returned string
5291 as an output in a craft recipe.
5292 * `item`: the item stack which becomes colored. Can be in string,
5293 table and native form.
5294 * `colorstring`: the new color of the item stack
5299 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
5300 returns `{{actor, pos, time, oldnode, newnode}, ...}`
5301 * Find who has done something to a node, or near a node
5302 * `actor`: `"player:<name>"`, also `"liquid"`.
5303 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns
5304 `boolean, log_messages`.
5305 * Revert latest actions of someone
5306 * `actor`: `"player:<name>"`, also `"liquid"`.
5308 Defaults for the `on_place` and `on_drop` item definition functions
5309 -------------------------------------------------------------------
5311 * `minetest.item_place_node(itemstack, placer, pointed_thing[, param2, prevent_after_place])`
5312 * Place item as a node
5313 * `param2` overrides `facedir` and wallmounted `param2`
5314 * `prevent_after_place`: if set to `true`, `after_place_node` is not called
5315 for the newly placed node to prevent a callback and placement loop
5316 * returns `itemstack, position`
5317 * `position`: the location the node was placed to. `nil` if nothing was placed.
5318 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
5320 * returns the leftover itemstack
5321 * **Note**: This function is deprecated and will never be called.
5322 * `minetest.item_place(itemstack, placer, pointed_thing[, param2])`
5323 * Wrapper that calls `minetest.item_place_node` if appropriate
5324 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
5325 * **Note**: is not called when wielded item overrides `on_place`
5326 * `param2` overrides facedir and wallmounted `param2`
5327 * returns `itemstack, position`
5328 * `position`: the location the node was placed to. `nil` if nothing was placed.
5329 * `minetest.item_drop(itemstack, dropper, pos)`
5331 * returns the leftover itemstack
5332 * `minetest.item_eat(hp_change[, replace_with_item])`
5333 * Returns `function(itemstack, user, pointed_thing)` as a
5334 function wrapper for `minetest.do_item_eat`.
5335 * `replace_with_item` is the itemstring which is added to the inventory.
5336 If the player is eating a stack, then replace_with_item goes to a
5339 Defaults for the `on_punch` and `on_dig` node definition callbacks
5340 ------------------------------------------------------------------
5342 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
5343 * Calls functions registered by `minetest.register_on_punchnode()`
5344 * `minetest.node_dig(pos, node, digger)`
5345 * Checks if node can be dug, puts item into inventory, removes node
5346 * Calls functions registered by `minetest.registered_on_dignodes()`
5351 * `minetest.sound_play(spec, parameters, [ephemeral])`: returns a handle
5352 * `spec` is a `SimpleSoundSpec`
5353 * `parameters` is a sound parameter table
5354 * `ephemeral` is a boolean (default: false)
5355 Ephemeral sounds will not return a handle and can't be stopped or faded.
5356 It is recommend to use this for short sounds that happen in response to
5357 player actions (e.g. door closing).
5358 * `minetest.sound_stop(handle)`
5359 * `handle` is a handle returned by `minetest.sound_play`
5360 * `minetest.sound_fade(handle, step, gain)`
5361 * `handle` is a handle returned by `minetest.sound_play`
5362 * `step` determines how fast a sound will fade.
5363 The gain will change by this much per second,
5364 until it reaches the target gain.
5365 Note: Older versions used a signed step. This is deprecated, but old
5366 code will still work. (the client uses abs(step) to correct it)
5367 * `gain` the target gain for the fade.
5368 Fading to zero will delete the sound.
5373 * `minetest.after(time, func, ...)` : returns job table to use as below.
5374 * Call the function `func` after `time` seconds, may be fractional
5375 * Optional: Variable number of arguments that are passed to `func`
5378 * Cancels the job function from being called
5383 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for
5384 server shutdown. Will display `message` to clients.
5385 * `reconnect` == true displays a reconnect button
5386 * `delay` adds an optional delay (in seconds) before shutdown.
5387 Negative delay cancels the current active shutdown.
5388 Zero delay triggers an immediate shutdown.
5389 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
5390 * `minetest.get_server_status(name, joined)`
5391 * Returns the server status string when a player joins or when the command
5392 `/status` is called. Returns `nil` or an empty string when the message is
5394 * `joined`: Boolean value, indicates whether the function was called when
5396 * This function may be overwritten by mods to customize the status message.
5397 * `minetest.get_server_uptime()`: returns the server uptime in seconds
5398 * `minetest.remove_player(name)`: remove player from database (if they are not
5400 * As auth data is not removed, minetest.player_exists will continue to
5401 return true. Call the below method as well if you want to remove auth
5403 * Returns a code (0: successful, 1: no such player, 2: player is connected)
5404 * `minetest.remove_player_auth(name)`: remove player authentication data
5405 * Returns boolean indicating success (false if player nonexistant)
5406 * `minetest.dynamic_add_media(filepath)`
5407 * Adds the file at the given path to the media sent to clients by the server
5408 on startup and also pushes this file to already connected clients.
5409 The file must be a supported image, sound or model format. It must not be
5410 modified, deleted, moved or renamed after calling this function.
5411 The list of dynamically added media is not persisted.
5412 * Returns boolean indicating success (duplicate files count as error)
5413 * The media will be ready to use (in e.g. entity textures, sound_play)
5414 immediately after calling this function.
5415 Old clients that lack support for this feature will not see the media
5416 unless they reconnect to the server.
5417 * Since media transferred this way does not use client caching or HTTP
5418 transfers, dynamic media should not be used with big files or performance
5424 * `minetest.get_ban_list()`: returns a list of all bans formatted as string
5425 * `minetest.get_ban_description(ip_or_name)`: returns list of bans matching
5426 IP address or name formatted as string
5427 * `minetest.ban_player(name)`: ban the IP of a currently connected player
5428 * Returns boolean indicating success
5429 * `minetest.unban_player_or_ip(ip_or_name)`: remove ban record matching
5431 * `minetest.kick_player(name, [reason])`: disconnect a player with an optional
5433 * Returns boolean indicating success (false if player nonexistant)
5438 * `minetest.add_particle(particle definition)`
5439 * Deprecated: `minetest.add_particle(pos, velocity, acceleration,
5440 expirationtime, size, collisiondetection, texture, playername)`
5442 * `minetest.add_particlespawner(particlespawner definition)`
5443 * Add a `ParticleSpawner`, an object that spawns an amount of particles
5444 over `time` seconds.
5445 * Returns an `id`, and -1 if adding didn't succeed
5446 * Deprecated: `minetest.add_particlespawner(amount, time,
5450 minexptime, maxexptime,
5452 collisiondetection, texture, playername)`
5454 * `minetest.delete_particlespawner(id, player)`
5455 * Delete `ParticleSpawner` with `id` (return value from
5456 `minetest.add_particlespawner`).
5457 * If playername is specified, only deletes on the player's client,
5458 otherwise on all clients.
5463 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
5464 * Create a schematic from the volume of map specified by the box formed by
5466 * Apply the specified probability and per-node force-place to the specified
5467 nodes according to the `probability_list`.
5468 * `probability_list` is an array of tables containing two fields, `pos`
5470 * `pos` is the 3D vector specifying the absolute coordinates of the
5471 node being modified,
5472 * `prob` is an integer value from `0` to `255` that encodes
5473 probability and per-node force-place. Probability has levels
5474 0-127, then 128 may be added to encode per-node force-place.
5475 For probability stated as 0-255, divide by 2 and round down to
5476 get values 0-127, then add 128 to apply per-node force-place.
5477 * If there are two or more entries with the same pos value, the
5479 * If `pos` is not inside the box formed by `p1` and `p2`, it is
5481 * If `probability_list` equals `nil`, no probabilities are applied.
5482 * Apply the specified probability to the specified horizontal slices
5483 according to the `slice_prob_list`.
5484 * `slice_prob_list` is an array of tables containing two fields, `ypos`
5486 * `ypos` indicates the y position of the slice with a probability
5487 applied, the lowest slice being `ypos = 0`.
5488 * If slice probability list equals `nil`, no slice probabilities
5490 * Saves schematic in the Minetest Schematic format to filename.
5492 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement, flags)`
5493 * Place the schematic specified by schematic (see [Schematic specifier]) at
5495 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
5496 * If the `rotation` parameter is omitted, the schematic is not rotated.
5497 * `replacements` = `{["old_name"] = "convert_to", ...}`
5498 * `force_placement` is a boolean indicating whether nodes other than `air`
5499 and `ignore` are replaced by the schematic.
5500 * Returns nil if the schematic could not be loaded.
5501 * **Warning**: Once you have loaded a schematic from a file, it will be
5502 cached. Future calls will always use the cached version and the
5503 replacement list defined for it, regardless of whether the file or the
5504 replacement list parameter have changed. The only way to load the file
5505 anew is to restart the server.
5506 * `flags` is a flag field with the available flags:
5511 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement, flags)`:
5512 * This function is analogous to minetest.place_schematic, but places a
5513 schematic onto the specified VoxelManip object `vmanip` instead of the
5515 * Returns false if any part of the schematic was cut-off due to the
5516 VoxelManip not containing the full area required, and true if the whole
5517 schematic was able to fit.
5518 * Returns nil if the schematic could not be loaded.
5519 * After execution, any external copies of the VoxelManip contents are
5521 * `flags` is a flag field with the available flags:
5526 * `minetest.serialize_schematic(schematic, format, options)`
5527 * Return the serialized schematic specified by schematic
5528 (see [Schematic specifier])
5529 * in the `format` of either "mts" or "lua".
5530 * "mts" - a string containing the binary MTS data used in the MTS file
5532 * "lua" - a string containing Lua code representing the schematic in table
5534 * `options` is a table containing the following optional parameters:
5535 * If `lua_use_comments` is true and `format` is "lua", the Lua code
5536 generated will have (X, Z) position comments for every X row
5537 generated in the schematic data for easier reading.
5538 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua",
5539 the Lua code generated will use that number of spaces as indentation
5540 instead of a tab character.
5542 * `minetest.read_schematic(schematic, options)`
5543 * Returns a Lua table representing the schematic (see: [Schematic specifier])
5544 * `schematic` is the schematic to read (see: [Schematic specifier])
5545 * `options` is a table containing the following optional parameters:
5546 * `write_yslice_prob`: string value:
5547 * `none`: no `write_yslice_prob` table is inserted,
5548 * `low`: only probabilities that are not 254 or 255 are written in
5549 the `write_ylisce_prob` table,
5550 * `all`: write all probabilities to the `write_yslice_prob` table.
5551 * The default for this option is `all`.
5552 * Any invalid value will be interpreted as `all`.
5557 * `minetest.request_http_api()`:
5558 * returns `HTTPApiTable` containing http functions if the calling mod has
5559 been granted access by being listed in the `secure.http_mods` or
5560 `secure.trusted_mods` setting, otherwise returns `nil`.
5561 * The returned table contains the functions `fetch`, `fetch_async` and
5562 `fetch_async_get` described below.
5563 * Only works at init time and must be called from the mod's main scope
5564 (not from a function).
5565 * Function only exists if minetest server was built with cURL support.
5566 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
5568 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
5569 * Performs given request asynchronously and calls callback upon completion
5570 * callback: `function(HTTPRequestResult res)`
5571 * Use this HTTP function if you are unsure, the others are for advanced use
5572 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
5573 * Performs given request asynchronously and returns handle for
5574 `HTTPApiTable.fetch_async_get`
5575 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
5576 * Return response data for given asynchronous HTTP request
5581 * `minetest.get_mod_storage()`:
5582 * returns reference to mod private `StorageRef`
5583 * must be called during mod load time
5588 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
5589 * `minetest.is_player(obj)`: boolean, whether `obj` is a player
5590 * `minetest.player_exists(name)`: boolean, whether player exists
5591 (regardless of online status)
5592 * `minetest.hud_replace_builtin(name, hud_definition)`
5593 * Replaces definition of a builtin hud element
5594 * `name`: `"breath"` or `"health"`
5595 * `hud_definition`: definition to replace builtin definition
5596 * `minetest.send_join_message(player_name)`
5597 * This function can be overridden by mods to change the join message.
5598 * `minetest.send_leave_message(player_name, timed_out)`
5599 * This function can be overridden by mods to change the leave message.
5600 * `minetest.hash_node_position(pos)`: returns an 48-bit integer
5601 * `pos`: table {x=number, y=number, z=number},
5602 * Gives a unique hash number for a node position (16+16+16=48bit)
5603 * `minetest.get_position_from_hash(hash)`: returns a position
5604 * Inverse transform of `minetest.hash_node_position`
5605 * `minetest.get_item_group(name, group)`: returns a rating
5606 * Get rating of a group of an item. (`0` means: not in group)
5607 * `minetest.get_node_group(name, group)`: returns a rating
5608 * Deprecated: An alias for the former.
5609 * `minetest.raillike_group(name)`: returns a rating
5610 * Returns rating of the connect_to_raillike group corresponding to name
5611 * If name is not yet the name of a connect_to_raillike group, a new group
5612 id is created, with that name.
5613 * `minetest.get_content_id(name)`: returns an integer
5614 * Gets the internal content ID of `name`
5615 * `minetest.get_name_from_content_id(content_id)`: returns a string
5616 * Gets the name of the content with that content ID
5617 * `minetest.parse_json(string[, nullvalue])`: returns something
5618 * Convert a string containing JSON data into the Lua equivalent
5619 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
5620 * On success returns a table, a string, a number, a boolean or `nullvalue`
5621 * On failure outputs an error message and returns `nil`
5622 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
5623 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error
5625 * Convert a Lua table into a JSON string
5626 * styled: Outputs in a human-readable format if this is set, defaults to
5628 * Unserializable things like functions and userdata will cause an error.
5629 * **Warning**: JSON is more strict than the Lua table format.
5630 1. You can only use strings and positive integers of at least one as
5632 2. You can not mix string and integer keys.
5633 This is due to the fact that JSON has two distinct array and object
5635 * Example: `write_json({10, {a = false}})`,
5636 returns `"[10, {\"a\": false}]"`
5637 * `minetest.serialize(table)`: returns a string
5638 * Convert a table containing tables, strings, numbers, booleans and `nil`s
5639 into string form readable by `minetest.deserialize`
5640 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
5641 * `minetest.deserialize(string[, safe])`: returns a table
5642 * Convert a string returned by `minetest.serialize` into a table
5643 * `string` is loaded in an empty sandbox environment.
5644 * Will load functions if safe is false or omitted. Although these functions
5645 cannot directly access the global environment, they could bypass this
5646 restriction with maliciously crafted Lua bytecode if mod security is
5648 * This function should not be used on untrusted data, regardless of the
5649 value of `safe`. It is fine to serialize then deserialize user-provided
5650 data, but directly providing user input to deserialize is always unsafe.
5651 * Example: `deserialize('return { ["foo"] = "bar" }')`,
5652 returns `{foo='bar'}`
5653 * Example: `deserialize('print("foo")')`, returns `nil`
5654 (function call fails), returns
5655 `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
5656 * `minetest.compress(data, method, ...)`: returns `compressed_data`
5657 * Compress a string of data.
5658 * `method` is a string identifying the compression method to be used.
5659 * Supported compression methods:
5660 * Deflate (zlib): `"deflate"`
5661 * `...` indicates method-specific arguments. Currently defined arguments
5663 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
5664 * `minetest.decompress(compressed_data, method, ...)`: returns data
5665 * Decompress a string of data (using ZLib).
5666 * See documentation on `minetest.compress()` for supported compression
5668 * `...` indicates method-specific arguments. Currently, no methods use this
5669 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
5670 * Each argument is a 8 Bit unsigned integer
5671 * Returns the ColorString from rgb or rgba values
5672 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
5673 * `minetest.encode_base64(string)`: returns string encoded in base64
5674 * Encodes a string in base64.
5675 * `minetest.decode_base64(string)`: returns string or nil for invalid base64
5676 * Decodes a string encoded in base64.
5677 * `minetest.is_protected(pos, name)`: returns boolean
5678 * Returning `true` restricts the player `name` from modifying (i.e. digging,
5679 placing) the node at position `pos`.
5680 * `name` will be `""` for non-players or unknown players.
5681 * This function should be overridden by protection mods. It is highly
5682 recommended to grant access to players with the `protection_bypass` privilege.
5683 * Cache and call the old version of this function if the position is
5684 not protected by the mod. This will allow using multiple protection mods.
5687 local old_is_protected = minetest.is_protected
5688 function minetest.is_protected(pos, name)
5689 if mymod:position_protected_from(pos, name) then
5692 return old_is_protected(pos, name)
5694 * `minetest.record_protection_violation(pos, name)`
5695 * This function calls functions registered with
5696 `minetest.register_on_protection_violation`.
5697 * `minetest.is_creative_enabled(name)`: returns boolean
5698 * Returning `true` means that Creative Mode is enabled for player `name`.
5699 * `name` will be `""` for non-players or if the player is unknown.
5700 * This function should be overridden by Creative Mode-related mods to
5701 implement a per-player Creative Mode.
5702 * By default, this function returns `true` if the setting
5703 `creative_mode` is `true` and `false` otherwise.
5704 * `minetest.is_area_protected(pos1, pos2, player_name, interval)`
5705 * Returns the position of the first node that `player_name` may not modify
5706 in the specified cuboid between `pos1` and `pos2`.
5707 * Returns `false` if no protections were found.
5708 * Applies `is_protected()` to a 3D lattice of points in the defined volume.
5709 The points are spaced evenly throughout the volume and have a spacing
5710 similar to, but no larger than, `interval`.
5711 * All corners and edges of the defined volume are checked.
5712 * `interval` defaults to 4.
5713 * `interval` should be carefully chosen and maximised to avoid an excessive
5714 number of points being checked.
5715 * Like `minetest.is_protected`, this function may be extended or
5716 overwritten by mods to provide a faster implementation to check the
5717 cuboid for intersections.
5718 * `minetest.rotate_and_place(itemstack, placer, pointed_thing[, infinitestacks,
5719 orient_flags, prevent_after_place])`
5720 * Attempt to predict the desired orientation of the facedir-capable node
5721 defined by `itemstack`, and place it accordingly (on-wall, on the floor,
5722 or hanging from the ceiling).
5723 * `infinitestacks`: if `true`, the itemstack is not changed. Otherwise the
5724 stacks are handled normally.
5725 * `orient_flags`: Optional table containing extra tweaks to the placement code:
5726 * `invert_wall`: if `true`, place wall-orientation on the ground and
5727 ground-orientation on the wall.
5728 * `force_wall` : if `true`, always place the node in wall orientation.
5729 * `force_ceiling`: if `true`, always place on the ceiling.
5730 * `force_floor`: if `true`, always place the node on the floor.
5731 * `force_facedir`: if `true`, forcefully reset the facedir to north
5732 when placing on the floor or ceiling.
5733 * The first four options are mutually-exclusive; the last in the list
5734 takes precedence over the first.
5735 * `prevent_after_place` is directly passed to `minetest.item_place_node`
5736 * Returns the new itemstack after placement
5737 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
5738 * calls `rotate_and_place()` with `infinitestacks` set according to the state
5739 of the creative mode setting, checks for "sneak" to set the `invert_wall`
5740 parameter and `prevent_after_place` set to `true`.
5742 * `minetest.calculate_knockback(player, hitter, time_from_last_punch,
5743 tool_capabilities, dir, distance, damage)`
5744 * Returns the amount of knockback applied on the punched player.
5745 * Arguments are equivalent to `register_on_punchplayer`, except the following:
5746 * `distance`: distance between puncher and punched player
5747 * This function can be overriden by mods that wish to modify this behaviour.
5748 * You may want to cache and call the old function to allow multiple mods to
5749 change knockback behaviour.
5751 * `minetest.forceload_block(pos[, transient])`
5752 * forceloads the position `pos`.
5753 * returns `true` if area could be forceloaded
5754 * If `transient` is `false` or absent, the forceload will be persistent
5755 (saved between server runs). If `true`, the forceload will be transient
5756 (not saved between server runs).
5758 * `minetest.forceload_free_block(pos[, transient])`
5759 * stops forceloading the position `pos`
5760 * If `transient` is `false` or absent, frees a persistent forceload.
5761 If `true`, frees a transient forceload.
5763 * `minetest.request_insecure_environment()`: returns an environment containing
5764 insecure functions if the calling mod has been listed as trusted in the
5765 `secure.trusted_mods` setting or security is disabled, otherwise returns
5767 * Only works at init time and must be called from the mod's main scope
5768 (ie: the init.lua of the mod, not from another Lua file or within a function).
5769 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE
5770 IT IN A LOCAL VARIABLE!**
5772 * `minetest.global_exists(name)`
5773 * Checks if a global variable has been set, without triggering a warning.
5778 * `minetest.env`: `EnvRef` of the server environment and world.
5779 * Any function in the minetest namespace can be called using the syntax
5780 `minetest.env:somefunction(somearguments)`
5781 instead of `minetest.somefunction(somearguments)`
5782 * Deprecated, but support is not to be dropped soon
5787 ### Registered definition tables
5789 * `minetest.registered_items`
5790 * Map of registered items, indexed by name
5791 * `minetest.registered_nodes`
5792 * Map of registered node definitions, indexed by name
5793 * `minetest.registered_craftitems`
5794 * Map of registered craft item definitions, indexed by name
5795 * `minetest.registered_tools`
5796 * Map of registered tool definitions, indexed by name
5797 * `minetest.registered_entities`
5798 * Map of registered entity prototypes, indexed by name
5799 * Values in this table may be modified directly.
5800 Note: changes to initial properties will only affect entities spawned afterwards,
5801 as they are only read when spawning.
5802 * `minetest.object_refs`
5803 * Map of object references, indexed by active object id
5804 * `minetest.luaentities`
5805 * Map of Lua entities, indexed by active object id
5806 * `minetest.registered_abms`
5807 * List of ABM definitions
5808 * `minetest.registered_lbms`
5809 * List of LBM definitions
5810 * `minetest.registered_aliases`
5811 * Map of registered aliases, indexed by name
5812 * `minetest.registered_ores`
5813 * Map of registered ore definitions, indexed by the `name` field.
5814 * If `name` is nil, the key is the object handle returned by
5815 `minetest.register_ore`.
5816 * `minetest.registered_biomes`
5817 * Map of registered biome definitions, indexed by the `name` field.
5818 * If `name` is nil, the key is the object handle returned by
5819 `minetest.register_biome`.
5820 * `minetest.registered_decorations`
5821 * Map of registered decoration definitions, indexed by the `name` field.
5822 * If `name` is nil, the key is the object handle returned by
5823 `minetest.register_decoration`.
5824 * `minetest.registered_schematics`
5825 * Map of registered schematic definitions, indexed by the `name` field.
5826 * If `name` is nil, the key is the object handle returned by
5827 `minetest.register_schematic`.
5828 * `minetest.registered_chatcommands`
5829 * Map of registered chat command definitions, indexed by name
5830 * `minetest.registered_privileges`
5831 * Map of registered privilege definitions, indexed by name
5832 * Registered privileges can be modified directly in this table.
5834 ### Registered callback tables
5836 All callbacks registered with [Global callback registration functions] are added
5837 to corresponding `minetest.registered_*` tables.
5845 Sorted alphabetically.
5850 A fast access data structure to store areas, and find areas near a given
5852 Every area has a `data` string attribute to store additional information.
5853 You can create an empty `AreaStore` by calling `AreaStore()`, or
5854 `AreaStore(type_name)`. The mod decides where to save and load AreaStore.
5855 If you chose the parameter-less constructor, a fast implementation will be
5856 automatically chosen for you.
5860 * `get_area(id, include_borders, include_data)`
5861 * Returns the area information about the specified ID.
5862 * Returned values are either of these:
5864 nil -- Area not found
5865 true -- Without `include_borders` and `include_data`
5867 min = pos, max = pos -- `include_borders == true`
5868 data = string -- `include_data == true`
5871 * `get_areas_for_pos(pos, include_borders, include_data)`
5872 * Returns all areas as table, indexed by the area ID.
5873 * Table values: see `get_area`.
5874 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`
5875 * Returns all areas that contain all nodes inside the area specified by `edge1`
5876 and `edge2` (inclusive).
5877 * `accept_overlap`: if `true`, areas are returned that have nodes in
5878 common (intersect) with the specified area.
5879 * Returns the same values as `get_areas_for_pos`.
5880 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store.
5881 * Returns the new area's ID, or nil if the insertion failed.
5882 * The (inclusive) positions `edge1` and `edge2` describe the area.
5883 * `data` is a string stored with the area.
5884 * `id` (optional): will be used as the internal area ID if it is an unique
5885 number between 0 and 2^32-2.
5886 * `reserve(count)`: reserves resources for at most `count` many contained
5888 Only needed for efficiency, and only some implementations profit.
5889 * `remove_area(id)`: removes the area with the given id from the store, returns
5891 * `set_cache_params(params)`: sets params for the included prefiltering cache.
5892 Calling invalidates the cache, so that its elements have to be newly
5894 * `params` is a table with the following fields:
5896 enabled = boolean, -- Whether to enable, default true
5897 block_radius = int, -- The radius (in nodes) of the areas the cache
5898 -- generates prefiltered lists for, minimum 16,
5900 limit = int, -- The cache size, minimum 20, default 1000
5901 * `to_string()`: Experimental. Returns area store serialized as a (binary)
5903 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to
5905 * `from_string(str)`: Experimental. Deserializes string and loads it into the
5907 Returns success and, optionally, an error message.
5908 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data
5914 An `InvRef` is a reference to an inventory.
5918 * `is_empty(listname)`: return `true` if list is empty
5919 * `get_size(listname)`: get size of a list
5920 * `set_size(listname, size)`: set size of a list
5921 * returns `false` on error (e.g. invalid `listname` or `size`)
5922 * `get_width(listname)`: get width of a list
5923 * `set_width(listname, width)`: set width of list; currently used for crafting
5924 * `get_stack(listname, i)`: get a copy of stack index `i` in list
5925 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
5926 * `get_list(listname)`: return full list
5927 * `set_list(listname, list)`: set full list (size will not change)
5928 * `get_lists()`: returns list of inventory lists
5929 * `set_lists(lists)`: sets inventory lists (size will not change)
5930 * `add_item(listname, stack)`: add item somewhere in list, returns leftover
5932 * `room_for_item(listname, stack):` returns `true` if the stack of items
5933 can be fully added to the list
5934 * `contains_item(listname, stack, [match_meta])`: returns `true` if
5935 the stack of items can be fully taken from the list.
5936 If `match_meta` is false, only the items' names are compared
5938 * `remove_item(listname, stack)`: take as many items as specified from the
5939 list, returns the items that were actually removed (as an `ItemStack`)
5940 -- note that any item metadata is ignored, so attempting to remove a specific
5941 unique item this way will likely remove the wrong one -- to do that use
5942 `set_stack` with an empty `ItemStack`.
5943 * `get_location()`: returns a location compatible to
5944 `minetest.get_inventory(location)`.
5945 * returns `{type="undefined"}` in case location is not known
5949 Detached & nodemeta inventories provide the following callbacks for move actions:
5953 The `allow_*` callbacks return how many items can be moved.
5955 * `allow_move`/`allow_metadata_inventory_move`: Moving items in the inventory
5956 * `allow_take`/`allow_metadata_inventory_take`: Taking items from the inventory
5957 * `allow_put`/`allow_metadata_inventory_put`: Putting items to the inventory
5961 The `on_*` callbacks are called after the items have been placed in the inventories.
5963 * `on_move`/`on_metadata_inventory_move`: Moving items in the inventory
5964 * `on_take`/`on_metadata_inventory_take`: Taking items from the inventory
5965 * `on_put`/`on_metadata_inventory_put`: Putting items to the inventory
5969 When a player tries to put an item to a place where another item is, the items are *swapped*.
5970 This means that all callbacks will be called twice (once for each action).
5975 An `ItemStack` is a stack of items.
5977 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
5978 an itemstring, a table or `nil`.
5982 * `is_empty()`: returns `true` if stack is empty.
5983 * `get_name()`: returns item name (e.g. `"default:stone"`).
5984 * `set_name(item_name)`: returns a boolean indicating whether the item was
5986 * `get_count()`: Returns number of items on the stack.
5987 * `set_count(count)`: returns a boolean indicating whether the item was cleared
5988 * `count`: number, unsigned 16 bit integer
5989 * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
5990 * `set_wear(wear)`: returns boolean indicating whether item was cleared
5991 * `wear`: number, unsigned 16 bit integer
5992 * `get_meta()`: returns ItemStackMetaRef. See section for more details
5993 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
5995 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
5996 * `get_description()`: returns the description shown in inventory list tooltips.
5997 * `clear()`: removes all items from the stack, making it empty.
5998 * `replace(item)`: replace the contents of this stack.
5999 * `item` can also be an itemstring or table.
6000 * `to_string()`: returns the stack in itemstring form.
6001 * `to_table()`: returns the stack in Lua table form.
6002 * `get_stack_max()`: returns the maximum size of the stack (depends on the
6004 * `get_free_space()`: returns `get_stack_max() - get_count()`.
6005 * `is_known()`: returns `true` if the item name refers to a defined item type.
6006 * `get_definition()`: returns the item definition table.
6007 * `get_tool_capabilities()`: returns the digging properties of the item,
6008 or those of the hand if none are defined for this item type
6009 * `add_wear(amount)`
6010 * Increases wear by `amount` if the item is a tool
6011 * `amount`: number, integer
6012 * `add_item(item)`: returns leftover `ItemStack`
6013 * Put some item or stack onto this stack
6014 * `item_fits(item)`: returns `true` if item or stack can be fully added to
6016 * `take_item(n)`: returns taken `ItemStack`
6017 * Take (and remove) up to `n` items from this stack
6018 * `n`: number, default: `1`
6019 * `peek_item(n)`: returns taken `ItemStack`
6020 * Copy (don't remove) up to `n` items from this stack
6021 * `n`: number, default: `1`
6026 ItemStack metadata: reference extra data and functionality stored in a stack.
6027 Can be obtained via `item:get_meta()`.
6031 * All methods in MetaDataRef
6032 * `set_tool_capabilities([tool_capabilities])`
6033 * Overrides the item's tool capabilities
6034 * A nil value will clear the override data and restore the original
6040 Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],
6041 and [`PlayerMetaRef`].
6045 * `contains(key)`: Returns true if key present, otherwise false.
6046 * Returns `nil` when the MetaData is inexistent.
6047 * `get(key)`: Returns `nil` if key not present, else the stored string.
6048 * `set_string(key, value)`: Value of `""` will delete the key.
6049 * `get_string(key)`: Returns `""` if key not present.
6050 * `set_int(key, value)`
6051 * `get_int(key)`: Returns `0` if key not present.
6052 * `set_float(key, value)`
6053 * `get_float(key)`: Returns `0` if key not present.
6054 * `to_table()`: returns `nil` or a table with keys:
6055 * `fields`: key-value storage
6056 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
6057 * `from_table(nil or {})`
6058 * Any non-table value will clear the metadata
6059 * See [Node Metadata] for an example
6060 * returns `true` on success
6062 * returns `true` if this metadata has the same key-value pairs as `other`
6067 An interface to use mod channels on client and server
6071 * `leave()`: leave the mod channel.
6072 * Server leaves channel `channel_name`.
6073 * No more incoming or outgoing messages can be sent to this channel from
6075 * This invalidate all future object usage.
6076 * Ensure you set mod_channel to nil after that to free Lua resources.
6077 * `is_writeable()`: returns true if channel is writeable and mod can send over
6079 * `send_all(message)`: Send `message` though the mod channel.
6080 * If mod channel is not writeable or invalid, message will be dropped.
6081 * Message size is limited to 65535 characters by protocol.
6086 Node metadata: reference extra data and functionality stored in a node.
6087 Can be obtained via `minetest.get_meta(pos)`.
6091 * All methods in MetaDataRef
6092 * `get_inventory()`: returns `InvRef`
6093 * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
6094 This will prevent them from being sent to the client. Note that the "private"
6095 status will only be remembered if an associated key-value pair exists,
6096 meaning it's best to call this when initializing all other meta (e.g.
6102 Node Timers: a high resolution persistent per-node timer.
6103 Can be gotten via `minetest.get_node_timer(pos)`.
6107 * `set(timeout,elapsed)`
6108 * set a timer's state
6109 * `timeout` is in seconds, and supports fractional values (0.1 etc)
6110 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
6111 * will trigger the node's `on_timer` function after `(timeout - elapsed)`
6115 * equivalent to `set(timeout,0)`
6118 * `get_timeout()`: returns current timeout in seconds
6119 * if `timeout` equals `0`, timer is inactive
6120 * `get_elapsed()`: returns current elapsed time in seconds
6121 * the node's `on_timer` function will be called after `(timeout - elapsed)`
6123 * `is_started()`: returns boolean state of timer
6124 * returns `true` if timer is started, otherwise `false`
6129 Moving things in the game are generally these.
6130 This is basically a reference to a C++ `ServerActiveObject`.
6132 ### Advice on handling `ObjectRefs`
6134 When you receive an `ObjectRef` as a callback argument or from another API
6135 function, it is possible to store the reference somewhere and keep it around.
6136 It will keep functioning until the object is unloaded or removed.
6138 However, doing this is **NOT** recommended as there is (intentionally) no method
6139 to test if a previously acquired `ObjectRef` is still valid.
6140 Instead, `ObjectRefs` should be "let go" of as soon as control is returned from
6141 Lua back to the engine.
6142 Doing so is much less error-prone and you will never need to wonder if the
6143 object you are working with still exists.
6148 * `get_pos()`: returns `{x=num, y=num, z=num}`
6149 * `set_pos(pos)`: `pos`=`{x=num, y=num, z=num}`
6150 * `get_velocity()`: returns the velocity, a vector.
6151 * `add_velocity(vel)`
6152 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
6153 * In comparison to using get_velocity, adding the velocity and then using
6154 set_velocity, add_velocity is supposed to avoid synchronization problems.
6155 Additionally, players also do not support set_velocity.
6157 * Does not apply during free_move.
6158 * Note that since the player speed is normalized at each move step,
6159 increasing e.g. Y velocity beyond what would usually be achieved
6160 (see: physics overrides) will cause existing X/Z velocity to be reduced.
6161 * Example: `add_velocity({x=0, y=6.5, z=0})` is equivalent to
6162 pressing the jump key (assuming default settings)
6163 * `move_to(pos, continuous=false)`
6164 * Does an interpolated move for Lua entities for visually smooth transitions.
6165 * If `continuous` is true, the Lua entity will not be moved to the current
6166 position before starting the interpolated move.
6167 * For players this does the same as `set_pos`,`continuous` is ignored.
6168 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
6169 * `puncher` = another `ObjectRef`,
6170 * `time_from_last_punch` = time since last punch action of the puncher
6171 * `direction`: can be `nil`
6172 * `right_click(clicker)`; `clicker` is another `ObjectRef`
6173 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
6174 * `set_hp(hp, reason)`: set number of hitpoints (2 * number of hearts).
6175 * See reason in register_on_player_hpchange
6176 * Is limited to the range of 0 ... 65535 (2^16 - 1)
6177 * For players: HP are also limited by `hp_max` specified in the player's
6179 * `get_inventory()`: returns an `InvRef` for players, otherwise returns `nil`
6180 * `get_wield_list()`: returns the name of the inventory list the wielded item
6182 * `get_wield_index()`: returns the index of the wielded item
6183 * `get_wielded_item()`: returns an `ItemStack`
6184 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if
6186 * `set_armor_groups({group1=rating, group2=rating, ...})`
6187 * `get_armor_groups()`: returns a table with the armor group ratings
6188 * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
6189 * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
6190 * `frame_speed`: number, default: `15.0`
6191 * `frame_blend`: number, default: `0.0`
6192 * `frame_loop`: boolean, default: `true`
6193 * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and
6195 * `set_animation_frame_speed(frame_speed)`
6196 * `frame_speed`: number, default: `15.0`
6197 * `set_attach(parent, bone, position, rotation, forced_visible)`
6199 * `position`: `{x=num, y=num, z=num}` (relative)
6200 * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees
6201 * `forced_visible`: Boolean to control whether the attached entity
6202 should appear in first person.
6203 * `get_attach()`: returns parent, bone, position, rotation, forced_visible,
6204 or nil if it isn't attached.
6206 * `set_bone_position(bone, position, rotation)`
6208 * `position`: `{x=num, y=num, z=num}` (relative)
6209 * `rotation`: `{x=num, y=num, z=num}`
6210 * `get_bone_position(bone)`: returns position and rotation of the bone
6211 * `set_properties(object property table)`
6212 * `get_properties()`: returns object property table
6213 * `is_player()`: returns true for players, false otherwise
6214 * `get_nametag_attributes()`
6215 * returns a table with the attributes of the nametag of an object
6217 color = {a=0..255, r=0..255, g=0..255, b=0..255},
6220 * `set_nametag_attributes(attributes)`
6221 * sets the attributes of the nametag of an object
6225 text = "My Nametag",
6228 #### Lua entity only (no-op for other objects)
6230 * `remove()`: remove object
6231 * The object is removed after returning from Lua. However the `ObjectRef`
6232 itself instantly becomes unusable with all further method calls having
6233 no effect and returning `nil`.
6234 * `set_velocity(vel)`
6235 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
6236 * `set_acceleration(acc)`
6238 * `get_acceleration()`: returns the acceleration, a vector
6239 * `set_rotation(rot)`
6240 * `rot` is a vector (radians). X is pitch (elevation), Y is yaw (heading)
6241 and Z is roll (bank).
6242 * `get_rotation()`: returns the rotation, a vector (radians)
6243 * `set_yaw(radians)`: sets the yaw (heading).
6244 * `get_yaw()`: returns number in radians
6245 * `set_texture_mod(mod)`
6246 * Set a texture modifier to the base texture, for sprites and meshes.
6247 * When calling `set_texture_mod` again, the previous one is discarded.
6248 * `mod` the texture modifier. See [Texture modifiers].
6249 * `get_texture_mod()` returns current texture modifier
6250 * `set_sprite(p, num_frames, framelength, select_x_by_camera)`
6251 * Specifies and starts a sprite animation
6252 * Animations iterate along the frame `y` position.
6253 * `p`: {x=column number, y=row number}, the coordinate of the first frame
6254 default: `{x=0, y=0}`
6255 * `num_frames`: Total frames in the texture, default: `1`
6256 * `framelength`: Time per animated frame in seconds, default: `0.2`
6257 * `select_x_by_camera`: Only for visual = `sprite`. Changes the frame `x`
6258 position according to the view direction. default: `false`.
6259 * First column: subject facing the camera
6260 * Second column: subject looking to the left
6261 * Third column: subject backing the camera
6262 * Fourth column: subject looking to the right
6263 * Fifth column: subject viewed from above
6264 * Sixth column: subject viewed from below
6265 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
6268 #### Player only (no-op for other objects)
6270 * `get_player_name()`: returns `""` if is not a player
6271 * `get_player_velocity()`: **DEPRECATED**, use get_velocity() instead.
6272 table {x, y, z} representing the player's instantaneous velocity in nodes/s
6273 * `add_player_velocity(vel)`: **DEPRECATED**, use add_velocity(vel) instead.
6274 * `get_look_dir()`: get camera direction as a unit vector
6275 * `get_look_vertical()`: pitch in radians
6276 * Angle ranges between -pi/2 and pi/2, which are straight up and down
6278 * `get_look_horizontal()`: yaw in radians
6279 * Angle is counter-clockwise from the +z direction.
6280 * `set_look_vertical(radians)`: sets look pitch
6281 * radians: Angle from looking forward, where positive is downwards.
6282 * `set_look_horizontal(radians)`: sets look yaw
6283 * radians: Angle from the +z direction, where positive is counter-clockwise.
6284 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use
6285 `get_look_vertical`.
6286 * Angle ranges between -pi/2 and pi/2, which are straight down and up
6288 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use
6289 `get_look_horizontal`.
6290 * Angle is counter-clockwise from the +x direction.
6291 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use
6292 `set_look_vertical`.
6293 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use
6294 `set_look_horizontal`.
6295 * `get_breath()`: returns player's breath
6296 * `set_breath(value)`: sets player's breath
6298 * `0`: player is drowning
6299 * max: bubbles bar is not shown
6300 * See [Object properties] for more information
6301 * Is limited to range 0 ... 65535 (2^16 - 1)
6302 * `set_fov(fov, is_multiplier, transition_time)`: Sets player's FOV
6304 * `is_multiplier`: Set to `true` if the FOV value is a multiplier.
6305 Defaults to `false`.
6306 * `transition_time`: If defined, enables smooth FOV transition.
6307 Interpreted as the time (in seconds) to reach target FOV.
6308 If set to 0, FOV change is instantaneous. Defaults to 0.
6309 * Set `fov` to 0 to clear FOV override.
6310 * `get_fov()`: Returns the following:
6311 * Server-sent FOV value. Returns 0 if an FOV override doesn't exist.
6312 * Boolean indicating whether the FOV value is a multiplier.
6313 * Time (in seconds) taken for the FOV transition. Set by `set_fov`.
6314 * `set_attribute(attribute, value)`: DEPRECATED, use get_meta() instead
6315 * Sets an extra attribute with value on player.
6316 * `value` must be a string, or a number which will be converted to a
6318 * If `value` is `nil`, remove attribute from player.
6319 * `get_attribute(attribute)`: DEPRECATED, use get_meta() instead
6320 * Returns value (a string) for extra attribute.
6321 * Returns `nil` if no attribute found.
6322 * `get_meta()`: Returns a PlayerMetaRef.
6323 * `set_inventory_formspec(formspec)`
6324 * Redefine player's inventory form
6325 * Should usually be called in `on_joinplayer`
6326 * `get_inventory_formspec()`: returns a formspec string
6327 * `set_formspec_prepend(formspec)`:
6328 * the formspec string will be added to every formspec shown to the user,
6329 except for those with a no_prepend[] tag.
6330 * This should be used to set style elements such as background[] and
6331 bgcolor[], any non-style elements (eg: label) may result in weird behaviour.
6332 * Only affects formspecs shown after this is called.
6333 * `get_formspec_prepend(formspec)`: returns a formspec string.
6334 * `get_player_control()`: returns table with player pressed keys
6335 * The table consists of fields with the following boolean values
6336 representing the pressed keys: `up`, `down`, `left`, `right`, `jump`,
6337 `aux1`, `sneak`, `dig`, `place`, `LMB`, `RMB`, and `zoom`.
6338 * The fields `LMB` and `RMB` are equal to `dig` and `place` respectively,
6339 and exist only to preserve backwards compatibility.
6340 * `get_player_control_bits()`: returns integer with bit packed player pressed
6352 * `set_physics_override(override_table)`
6353 * `override_table` is a table with the following fields:
6354 * `speed`: multiplier to default walking speed value (default: `1`)
6355 * `jump`: multiplier to default jump value (default: `1`)
6356 * `gravity`: multiplier to default gravity value (default: `1`)
6357 * `sneak`: whether player can sneak (default: `true`)
6358 * `sneak_glitch`: whether player can use the new move code replications
6359 of the old sneak side-effects: sneak ladders and 2 node sneak jump
6361 * `new_move`: use new move/sneak code. When `false` the exact old code
6362 is used for the specific old sneak behaviour (default: `true`)
6363 * `get_physics_override()`: returns the table given to `set_physics_override`
6364 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
6366 * `hud_remove(id)`: remove the HUD element of the specified id
6367 * `hud_change(id, stat, value)`: change a value of a previously added HUD
6369 * element `stat` values:
6370 `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
6371 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
6372 * `hud_set_flags(flags)`: sets specified HUD flags of player.
6373 * `flags`: A table with the following fields set to boolean values
6381 * If a flag equals `nil`, the flag is not modified
6382 * `minimap`: Modifies the client's permission to view the minimap.
6383 The client may locally elect to not view the minimap.
6384 * `minimap_radar` is only usable when `minimap` is true
6385 * `hud_get_flags()`: returns a table of player HUD flags with boolean values.
6386 * See `hud_set_flags` for a list of flags that can be toggled.
6387 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
6388 * `count`: number of items, must be between `1` and `32`
6389 * `hud_get_hotbar_itemcount`: returns number of visible items
6390 * `hud_set_hotbar_image(texturename)`
6391 * sets background image for hotbar
6392 * `hud_get_hotbar_image`: returns texturename
6393 * `hud_set_hotbar_selected_image(texturename)`
6394 * sets image for selected item of hotbar
6395 * `hud_get_hotbar_selected_image`: returns texturename
6396 * `set_minimap_modes({mode, mode, ...}, selected_mode)`
6397 * Overrides the available minimap modes (and toggle order), and changes the
6399 * `mode` is a table consisting of up to four fields:
6400 * `type`: Available type:
6401 * `off`: Minimap off
6402 * `surface`: Minimap in surface mode
6403 * `radar`: Minimap in radar mode
6404 * `texture`: Texture to be displayed instead of terrain map
6405 (texture is centered around 0,0 and can be scaled).
6406 Texture size is limited to 512 x 512 pixel.
6407 * `label`: Optional label to display on minimap mode toggle
6408 The translation must be handled within the mod.
6409 * `size`: Sidelength or diameter, in number of nodes, of the terrain
6410 displayed in minimap
6411 * `texture`: Only for texture type, name of the texture to display
6412 * `scale`: Only for texture type, scale of the texture map in nodes per
6413 pixel (for example a `scale` of 2 means each pixel represents a 2x2
6415 * `selected_mode` is the mode index to be selected after modes have been changed
6416 (0 is the first mode).
6417 * `set_sky(parameters)`
6418 * `parameters` is a table with the following optional fields:
6419 * `base_color`: ColorSpec, changes fog in "skybox" and "plain".
6420 * `type`: Available types:
6421 * `"regular"`: Uses 0 textures, `base_color` ignored
6422 * `"skybox"`: Uses 6 textures, `base_color` used as fog.
6423 * `"plain"`: Uses 0 textures, `base_color` used as both fog and sky.
6424 * `textures`: A table containing up to six textures in the following
6425 order: Y+ (top), Y- (bottom), X- (west), X+ (east), Z+ (north), Z- (south).
6426 * `clouds`: Boolean for whether clouds appear. (default: `true`)
6427 * `sky_color`: A table containing the following values, alpha is ignored:
6428 * `day_sky`: ColorSpec, for the top half of the `"regular"`
6429 sky during the day. (default: `#8cbafa`)
6430 * `day_horizon`: ColorSpec, for the bottom half of the
6431 `"regular"` sky during the day. (default: `#9bc1f0`)
6432 * `dawn_sky`: ColorSpec, for the top half of the `"regular"`
6433 sky during dawn/sunset. (default: `#b4bafa`)
6434 The resulting sky color will be a darkened version of the ColorSpec.
6435 Warning: The darkening of the ColorSpec is subject to change.
6436 * `dawn_horizon`: ColorSpec, for the bottom half of the `"regular"`
6437 sky during dawn/sunset. (default: `#bac1f0`)
6438 The resulting sky color will be a darkened version of the ColorSpec.
6439 Warning: The darkening of the ColorSpec is subject to change.
6440 * `night_sky`: ColorSpec, for the top half of the `"regular"`
6441 sky during the night. (default: `#006aff`)
6442 The resulting sky color will be a dark version of the ColorSpec.
6443 Warning: The darkening of the ColorSpec is subject to change.
6444 * `night_horizon`: ColorSpec, for the bottom half of the `"regular"`
6445 sky during the night. (default: `#4090ff`)
6446 The resulting sky color will be a dark version of the ColorSpec.
6447 Warning: The darkening of the ColorSpec is subject to change.
6448 * `indoors`: ColorSpec, for when you're either indoors or
6449 underground. Only applies to the `"regular"` sky.
6450 (default: `#646464`)
6451 * `fog_sun_tint`: ColorSpec, changes the fog tinting for the sun
6452 at sunrise and sunset.
6453 * `fog_moon_tint`: ColorSpec, changes the fog tinting for the moon
6454 at sunrise and sunset.
6455 * `fog_tint_type`: string, changes which mode the directional fog
6456 abides by, `"custom"` uses `sun_tint` and `moon_tint`, while
6457 `"default"` uses the classic Minetest sun and moon tinting.
6458 Will use tonemaps, if set to `"default"`. (default: `"default"`)
6459 * `get_sky()`: returns base_color, type, table of textures, clouds.
6460 * `get_sky_color()`: returns a table with the `sky_color` parameters as in
6462 * `set_sun(parameters)`:
6463 * `parameters` is a table with the following optional fields:
6464 * `visible`: Boolean for whether the sun is visible.
6466 * `texture`: A regular texture for the sun. Setting to `""`
6467 will re-enable the mesh sun. (default: `"sun.png"`)
6468 * `tonemap`: A 512x1 texture containing the tonemap for the sun
6469 (default: `"sun_tonemap.png"`)
6470 * `sunrise`: A regular texture for the sunrise texture.
6471 (default: `"sunrisebg.png"`)
6472 * `sunrise_visible`: Boolean for whether the sunrise texture is visible.
6474 * `scale`: Float controlling the overall size of the sun. (default: `1`)
6475 * `get_sun()`: returns a table with the current sun parameters as in
6477 * `set_moon(parameters)`:
6478 * `parameters` is a table with the following optional fields:
6479 * `visible`: Boolean for whether the moon is visible.
6481 * `texture`: A regular texture for the moon. Setting to `""`
6482 will re-enable the mesh moon. (default: `"moon.png"`)
6483 * `tonemap`: A 512x1 texture containing the tonemap for the moon
6484 (default: `"moon_tonemap.png"`)
6485 * `scale`: Float controlling the overall size of the moon (default: `1`)
6486 * `get_moon()`: returns a table with the current moon parameters as in
6488 * `set_stars(parameters)`:
6489 * `parameters` is a table with the following optional fields:
6490 * `visible`: Boolean for whether the stars are visible.
6492 * `count`: Integer number to set the number of stars in
6493 the skybox. Only applies to `"skybox"` and `"regular"` sky types.
6495 * `star_color`: ColorSpec, sets the colors of the stars,
6496 alpha channel is used to set overall star brightness.
6497 (default: `#ebebff69`)
6498 * `scale`: Float controlling the overall size of the stars (default: `1`)
6499 * `get_stars()`: returns a table with the current stars parameters as in
6501 * `set_clouds(parameters)`: set cloud parameters
6502 * `parameters` is a table with the following optional fields:
6503 * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
6504 * `color`: basic cloud color with alpha channel, ColorSpec
6505 (default `#fff0f0e5`).
6506 * `ambient`: cloud color lower bound, use for a "glow at night" effect.
6507 ColorSpec (alpha ignored, default `#000000`)
6508 * `height`: cloud height, i.e. y of cloud base (default per conf,
6510 * `thickness`: cloud thickness in nodes (default `16`)
6511 * `speed`: 2D cloud speed + direction in nodes per second
6512 (default `{x=0, z=-2}`).
6513 * `get_clouds()`: returns a table with the current cloud parameters as in
6515 * `override_day_night_ratio(ratio or nil)`
6516 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific
6518 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
6519 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
6520 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`:
6521 set animation for player model in third person view
6523 set_local_animation({x=0, y=79}, -- stand/idle animation key frames
6524 {x=168, y=187}, -- walk animation key frames
6525 {x=189, y=198}, -- dig animation key frames
6526 {x=200, y=219}, -- walk+dig animation key frames
6527 frame_speed=30) -- animation frame speed
6528 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and
6530 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for
6532 * in first person view
6533 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
6534 * `get_eye_offset()`: returns `offset_first` and `offset_third`
6535 * `send_mapblock(blockpos)`:
6536 * Sends a server-side loaded mapblock to the player.
6537 * Returns `false` if failed.
6538 * Resource intensive - use sparsely
6539 * To get blockpos, integer divide pos by 16
6544 A 32-bit pseudorandom number generator.
6545 Uses PCG32, an algorithm of the permuted congruential generator family,
6546 offering very strong randomness.
6548 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
6552 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
6553 * `next(min, max)`: return next integer random number [`min`...`max`]
6554 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed
6555 random number [`min`...`max`].
6556 * This is only a rough approximation of a normal distribution with:
6557 * `mean = (max - min) / 2`, and
6558 * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
6559 * Increasing `num_trials` improves accuracy of the approximation
6564 A perlin noise generator.
6565 It can be created via `PerlinNoise()` or `minetest.get_perlin()`.
6566 For `minetest.get_perlin()`, the actual seed used is the noiseparams seed
6567 plus the world seed, to create world-specific noise.
6569 `PerlinNoise(noiseparams)`
6570 `PerlinNoise(seed, octaves, persistence, spread)` (Deprecated).
6572 `minetest.get_perlin(noiseparams)`
6573 `minetest.get_perlin(seeddiff, octaves, persistence, spread)` (Deprecated).
6577 * `get_2d(pos)`: returns 2D noise value at `pos={x=,y=}`
6578 * `get_3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
6583 A fast, bulk perlin noise generator.
6585 It can be created via `PerlinNoiseMap(noiseparams, size)` or
6586 `minetest.get_perlin_map(noiseparams, size)`.
6587 For `minetest.get_perlin_map()`, the actual seed used is the noiseparams seed
6588 plus the world seed, to create world-specific noise.
6590 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
6591 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
6594 For each of the functions with an optional `buffer` parameter: If `buffer` is
6595 not nil, this table will be used to store the result instead of creating a new
6600 * `get_2d_map(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
6601 with values starting at `pos={x=,y=}`
6602 * `get_3d_map(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>`
6603 3D array of 3D noise with values starting at `pos={x=,y=,z=}`.
6604 * `get_2d_map_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element
6605 array of 2D noise with values starting at `pos={x=,y=}`
6606 * `get_3d_map_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
6607 * `calc_2d_map(pos)`: Calculates the 2d noise map starting at `pos`. The result
6608 is stored internally.
6609 * `calc_3d_map(pos)`: Calculates the 3d noise map starting at `pos`. The result
6610 is stored internally.
6611 * `get_map_slice(slice_offset, slice_size, buffer)`: In the form of an array,
6612 returns a slice of the most recently computed noise results. The result slice
6613 begins at coordinates `slice_offset` and takes a chunk of `slice_size`.
6614 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer
6616 `noisevals = noise:get_map_slice({y=20}, {y=2})`
6617 It is important to note that `slice_offset` offset coordinates begin at 1,
6618 and are relative to the starting position of the most recently calculated
6620 To grab a single vertical column of noise starting at map coordinates
6621 x = 1023, y=1000, z = 1000:
6622 `noise:calc_3d_map({x=1000, y=1000, z=1000})`
6623 `noisevals = noise:get_map_slice({x=24, z=1}, {x=1, z=1})`
6629 Uses the same method of storage as the deprecated player attribute API, so
6630 data there will also be in player meta.
6631 Can be obtained using `player:get_meta()`.
6635 * All methods in MetaDataRef
6640 A 16-bit pseudorandom number generator.
6641 Uses a well-known LCG algorithm introduced by K&R.
6643 It can be created via `PseudoRandom(seed)`.
6647 * `next()`: return next integer random number [`0`...`32767`]
6648 * `next(min, max)`: return next integer random number [`min`...`max`]
6649 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
6650 due to the simple implementation making bad distribution otherwise.
6655 A raycast on the map. It works with selection boxes.
6656 Can be used as an iterator in a for loop as:
6658 local ray = Raycast(...)
6659 for pointed_thing in ray do
6663 The map is loaded as the ray advances. If the map is modified after the
6664 `Raycast` is created, the changes may or may not have an effect on the object.
6666 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
6667 `minetest.raycast(pos1, pos2, objects, liquids)` where:
6669 * `pos1`: start of the ray
6670 * `pos2`: end of the ray
6671 * `objects`: if false, only nodes will be returned. Default is true.
6672 * `liquids`: if false, liquid nodes won't be returned. Default is false.
6676 * `next()`: returns a `pointed_thing` with exact pointing location
6677 * Returns the next thing pointed by the ray or nil.
6682 Interface for the operating system's crypto-secure PRNG.
6684 It can be created via `SecureRandom()`. The constructor returns nil if a
6685 secure random device cannot be found on the system.
6689 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many
6690 random bytes, as a string.
6695 An interface to read config files in the format of `minetest.conf`.
6697 It can be created via `Settings(filename)`.
6701 * `get(key)`: returns a value
6702 * `get_bool(key, [default])`: returns a boolean
6703 * `default` is the value returned if `key` is not found.
6704 * Returns `nil` if `key` is not found and `default` not specified.
6705 * `get_np_group(key)`: returns a NoiseParams table
6707 * Returns `{flag = true/false, ...}` according to the set flags.
6708 * Is currently limited to mapgen flags `mg_flags` and mapgen-specific
6709 flags like `mgv5_spflags`.
6711 * Setting names can't contain whitespace or any of `="{}#`.
6712 * Setting values can't contain the sequence `\n"""`.
6713 * Setting names starting with "secure." can't be set on the main settings
6714 object (`minetest.settings`).
6715 * `set_bool(key, value)`
6716 * See documentation for set() above.
6717 * `set_np_group(key, value)`
6718 * `value` is a NoiseParams table.
6719 * Also, see documentation for set() above.
6720 * `remove(key)`: returns a boolean (`true` for success)
6721 * `get_names()`: returns `{key1,...}`
6722 * `write()`: returns a boolean (`true` for success)
6723 * Writes changes to file.
6724 * `to_table()`: returns `{[key1]=value1,...}`
6728 The settings have the format `key = value`. Example:
6740 Mod metadata: per mod metadata, saved automatically.
6741 Can be obtained via `minetest.get_mod_storage()` during load time.
6743 WARNING: This storage backend is incaptable to save raw binary data due
6744 to restrictions of JSON.
6748 * All methods in MetaDataRef
6759 Used by `ObjectRef` methods. Part of an Entity definition.
6760 These properties are not persistent, but are applied automatically to the
6761 corresponding Lua entity using the given registration fields.
6762 Player properties need to be saved manually.
6766 -- For players only. Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`.
6769 -- For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`.
6772 -- For players only. Zoom FOV in degrees.
6773 -- Note that zoom loads and/or generates world beyond the server's
6774 -- maximum send and generate distances, so acts like a telescope.
6775 -- Smaller zoom_fov values increase the distance loaded/generated.
6776 -- Defaults to 15 in creative mode, 0 in survival mode.
6777 -- zoom_fov = 0 disables zooming for the player.
6780 -- For players only. Camera height above feet position in nodes.
6781 -- Defaults to 1.625.
6784 -- Collide with `walkable` nodes.
6786 collide_with_objects = true,
6787 -- Collide with other objects if physical = true
6789 collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5}, -- Default
6790 selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
6791 -- Selection box uses collision box dimensions when not set.
6792 -- For both boxes: {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from
6796 -- Overrides selection box when false
6798 visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem" / "item",
6799 -- "cube" is a node-sized cube.
6800 -- "sprite" is a flat texture always facing the player.
6801 -- "upright_sprite" is a vertical flat texture.
6802 -- "mesh" uses the defined mesh model.
6803 -- "wielditem" is used for dropped items.
6804 -- (see builtin/game/item_entity.lua).
6805 -- For this use 'wield_item = itemname' (Deprecated: 'textures = {itemname}').
6806 -- If the item has a 'wield_image' the object will be an extrusion of
6808 -- If 'itemname' is a cubic node or nodebox the object will appear
6809 -- identical to 'itemname'.
6810 -- If 'itemname' is a plantlike node the object will be an extrusion
6812 -- Otherwise for non-node items, the object will be an extrusion of
6813 -- 'inventory_image'.
6814 -- If 'itemname' contains a ColorString or palette index (e.g. from
6815 -- `minetest.itemstring_with_palette()`), the entity will inherit the color.
6816 -- "item" is similar to "wielditem" but ignores the 'wield_image' parameter.
6818 visual_size = {x = 1, y = 1, z = 1},
6819 -- Multipliers for the visual size. If `z` is not specified, `x` will be used
6820 -- to scale the entity along both horizontal axes.
6823 -- File name of mesh when using "mesh" visual
6826 -- Number of required textures depends on visual.
6827 -- "cube" uses 6 textures just like a node, but all 6 must be defined.
6828 -- "sprite" uses 1 texture.
6829 -- "upright_sprite" uses 2 textures: {front, back}.
6830 -- "wielditem" expects 'textures = {itemname}' (see 'visual' above).
6833 -- Number of required colors depends on visual
6835 use_texture_alpha = false,
6836 -- Use texture's alpha channel.
6837 -- Excludes "upright_sprite" and "wielditem".
6838 -- Note: currently causes visual issues when viewed through other
6839 -- semi-transparent materials such as water.
6841 spritediv = {x = 1, y = 1},
6842 -- Used with spritesheet textures for animation and/or frame selection
6843 -- according to position relative to player.
6844 -- Defines the number of columns and rows in the spritesheet:
6847 initial_sprite_basepos = {x = 0, y = 0},
6848 -- Used with spritesheet textures.
6849 -- Defines the {column, row} position of the initially used frame in the
6853 -- If false, object is invisible and can't be pointed.
6855 makes_footstep_sound = false,
6856 -- If true, is able to make footstep sounds of nodes
6857 -- (see node sound definition for details).
6859 automatic_rotate = 0,
6860 -- Set constant rotation in radians per second, positive or negative.
6861 -- Object rotates along the local Y-axis, and works with set_rotation.
6862 -- Set to 0 to disable constant rotation.
6865 -- If positive number, object will climb upwards when it moves
6866 -- horizontally against a `walkable` node, if the height difference
6867 -- is within `stepheight`.
6869 automatic_face_movement_dir = 0.0,
6870 -- Automatically set yaw to movement direction, offset in degrees.
6871 -- 'false' to disable.
6873 automatic_face_movement_max_rotation_per_sec = -1,
6874 -- Limit automatic rotation to this value in degrees per second.
6875 -- No limit if value <= 0.
6877 backface_culling = true,
6878 -- Set to false to disable backface_culling for model
6881 -- Add this much extra lighting when calculating texture color.
6882 -- Value < 0 disables light's effect on texture color.
6883 -- For faking self-lighting, UI style entities, or programmatic coloring
6887 -- By default empty, for players their name is shown if empty
6889 nametag_color = <ColorSpec>,
6890 -- Sets color of nametag
6893 -- By default empty, text to be shown when pointed at object
6896 -- If false, never save this object statically. It will simply be
6897 -- deleted when the block gets unloaded.
6898 -- The get_staticdata() callback is never called then.
6899 -- Defaults to 'true'.
6901 damage_texture_modifier = "^[brighten",
6902 -- Texture modifier to be applied for a short duration when object is hit
6905 -- Setting this to 'false' disables diffuse lighting of entity
6911 Used by `minetest.register_entity`.
6914 initial_properties = {
6916 mesh = "boats_boat.obj",
6919 -- A table of object properties, see the `Object properties` section.
6920 -- Object properties being read directly from the entity definition
6921 -- table is deprecated. Define object properties in this
6922 -- `initial_properties` table instead.
6924 on_activate = function(self, staticdata, dtime_s),
6926 on_step = function(self, dtime, moveresult),
6927 -- Called every server step
6928 -- dtime: Elapsed time
6929 -- moveresult: Table with collision info (only available if physical=true)
6931 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
6933 on_rightclick = function(self, clicker),
6935 get_staticdata = function(self),
6936 -- Called sometimes; the string returned is passed to on_activate when
6937 -- the entity is re-activated from static state
6939 _custom_field = whatever,
6940 -- You can define arbitrary member variables here (see Item definition
6941 -- for more info) by using a '_' prefix
6944 Collision info passed to `on_step`:
6947 touching_ground = boolean,
6949 standing_on_object = boolean,
6952 type = string, -- "node" or "object",
6953 axis = string, -- "x", "y" or "z"
6954 node_pos = vector, -- if type is "node"
6955 object = ObjectRef, -- if type is "object"
6956 old_velocity = vector,
6957 new_velocity = vector,
6963 ABM (ActiveBlockModifier) definition
6964 ------------------------------------
6966 Used by `minetest.register_abm`.
6969 label = "Lava cooling",
6970 -- Descriptive label for profiling purposes (optional).
6971 -- Definitions with identical labels will be listed as one.
6973 nodenames = {"default:lava_source"},
6974 -- Apply `action` function to these nodes.
6975 -- `group:groupname` can also be used here.
6977 neighbors = {"default:water_source", "default:water_flowing"},
6978 -- Only apply `action` to nodes that have one of, or any
6979 -- combination of, these neighbors.
6980 -- If left out or empty, any neighbor will do.
6981 -- `group:groupname` can also be used here.
6984 -- Operation interval in seconds
6987 -- Chance of triggering `action` per-node per-interval is 1.0 / this
6991 -- If true, catch-up behaviour is enabled: The `chance` value is
6992 -- temporarily reduced when returning to an area to simulate time lost
6993 -- by the area being unattended. Note that the `chance` value can often
6996 action = function(pos, node, active_object_count, active_object_count_wider),
6997 -- Function triggered for each qualifying node.
6998 -- `active_object_count` is number of active objects in the node's
7000 -- `active_object_count_wider` is number of active objects in the node's
7001 -- mapblock plus all 26 neighboring mapblocks. If any neighboring
7002 -- mapblocks are unloaded an estmate is calculated for them based on
7003 -- loaded mapblocks.
7006 LBM (LoadingBlockModifier) definition
7007 -------------------------------------
7009 Used by `minetest.register_lbm`.
7011 A loading block modifier (LBM) is used to define a function that is called for
7012 specific nodes (defined by `nodenames`) when a mapblock which contains such nodes
7016 label = "Upgrade legacy doors",
7017 -- Descriptive label for profiling purposes (optional).
7018 -- Definitions with identical labels will be listed as one.
7020 name = "modname:replace_legacy_door",
7022 nodenames = {"default:lava_source"},
7023 -- List of node names to trigger the LBM on.
7024 -- Also non-registered nodes will work.
7025 -- Groups (as of group:groupname) will work as well.
7027 run_at_every_load = false,
7028 -- Whether to run the LBM's action every time a block gets loaded,
7029 -- and not only the first time the block gets loaded after the LBM
7032 action = function(pos, node),
7039 * `{name="image.png", animation={Tile Animation definition}}`
7040 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
7041 tileable_horizontal=bool, align_style="node"/"world"/"user", scale=int}`
7042 * backface culling enabled by default for most nodes
7043 * tileable flags are info for shaders, how they should treat texture
7044 when displacement mapping is used.
7045 Directions are from the point of view of the tile texture,
7046 not the node it's on.
7047 * align style determines whether the texture will be rotated with the node
7048 or kept aligned with its surroundings. "user" means that client
7049 setting will be used, similar to `glasslike_framed_optional`.
7050 Note: supported by solid nodes and nodeboxes only.
7051 * scale is used to make texture span several (exactly `scale`) nodes,
7052 instead of just one, in each direction. Works for world-aligned
7054 Note that as the effect is applied on per-mapblock basis, `16` should
7055 be equally divisible by `scale` or you may get wrong results.
7056 * `{name="image.png", color=ColorSpec}`
7057 * the texture's color will be multiplied with this color.
7058 * the tile's color overrides the owning node's color in all cases.
7059 * deprecated, yet still supported field names:
7062 Tile animation definition
7063 -------------------------
7066 type = "vertical_frames",
7069 -- Width of a frame in pixels
7072 -- Height of a frame in pixels
7082 -- Width in number of frames
7085 -- Height in number of frames
7088 -- Length of a single frame
7094 Used by `minetest.register_node`, `minetest.register_craftitem`, and
7095 `minetest.register_tool`.
7098 description = "Steel Axe",
7101 -- key = name, value = rating; rating = 1..3.
7102 -- If rating not applicable, use 1.
7103 -- e.g. {wool = 1, fluffy = 3}
7104 -- {soil = 2, outerspace = 1, crumbly = 1}
7105 -- {bendy = 2, snappy = 1},
7106 -- {hard = 1, metal = 1, spikes = 1}
7108 inventory_image = "default_tool_steelaxe.png",
7110 inventory_overlay = "overlay.png",
7111 -- An overlay which does not get colorized
7118 -- An image file containing the palette of a node.
7119 -- You can set the currently used color as the "palette_index" field of
7120 -- the item stack metadata.
7121 -- The palette is always stretched to fit indices between 0 and 255, to
7122 -- ensure compatibility with "colorfacedir" and "colorwallmounted" nodes.
7124 color = "0xFFFFFFFF",
7125 -- The color of the item. The palette overrides this.
7127 wield_scale = {x = 1, y = 1, z = 1},
7129 -- The default value of 99 may be configured by
7130 -- users using the setting "default_stack_max"
7135 liquids_pointable = false,
7138 -- When used for nodes: Defines amount of light emitted by node.
7139 -- Otherwise: Defines texture glow when viewed as a dropped item
7140 -- To set the maximum (14), use the value 'minetest.LIGHT_MAX'.
7141 -- A value outside the range 0 to minetest.LIGHT_MAX causes undefined
7144 -- See "Tools" section for an example including explanation
7145 tool_capabilities = {
7146 full_punch_interval = 1.0,
7150 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00},
7151 uses = 20, maxlevel = 2},
7153 damage_groups = {groupname = damage},
7154 -- Damage values must be between -32768 and 32767 (2^15)
7156 punch_attack_uses = nil,
7157 -- Amount of uses this tool has for attacking players and entities
7158 -- by punching them (0 = infinite uses).
7159 -- For compatibility, this is automatically set from the first
7160 -- suitable groupcap using the forumla "uses * 3^(maxlevel - 1)".
7161 -- It is recommend to set this explicitly instead of relying on the
7162 -- fallback behavior.
7165 node_placement_prediction = nil,
7166 -- If nil and item is node, prediction is made automatically.
7167 -- If nil and item is not a node, no prediction is made.
7168 -- If "" and item is anything, no prediction is made.
7169 -- Otherwise should be name of node which the client immediately places
7170 -- on ground when the player places the item. Server will always update
7171 -- actual result to client in a short moment.
7173 node_dig_prediction = "air",
7174 -- if "", no prediction is made.
7175 -- if "air", node is removed.
7176 -- Otherwise should be name of node which the client immediately places
7177 -- upon digging. Server will always update actual result shortly.
7180 -- Definition of items sounds to be played at various events.
7181 -- All fields in this table are optional.
7183 breaks = <SimpleSoundSpec>,
7184 -- When tool breaks due to wear. Ignored for non-tools
7186 eat = <SimpleSoundSpec>,
7187 -- When item is eaten with `minetest.do_item_eat`
7190 on_place = function(itemstack, placer, pointed_thing),
7191 -- Shall place item and return the leftover itemstack.
7192 -- The placer may be any ObjectRef or nil.
7193 -- default: minetest.item_place
7195 on_secondary_use = function(itemstack, user, pointed_thing),
7196 -- Same as on_place but called when not pointing at a node.
7197 -- The user may be any ObjectRef or nil.
7200 on_drop = function(itemstack, dropper, pos),
7201 -- Shall drop item and return the leftover itemstack.
7202 -- The dropper may be any ObjectRef or nil.
7203 -- default: minetest.item_drop
7205 on_use = function(itemstack, user, pointed_thing),
7207 -- Function must return either nil if no item shall be removed from
7208 -- inventory, or an itemstack to replace the original itemstack.
7209 -- e.g. itemstack:take_item(); return itemstack
7210 -- Otherwise, the function is free to do what it wants.
7211 -- The user may be any ObjectRef or nil.
7212 -- The default functions handle regular use cases.
7214 after_use = function(itemstack, user, node, digparams),
7216 -- If defined, should return an itemstack and will be called instead of
7217 -- wearing out the tool. If returns nil, does nothing.
7218 -- If after_use doesn't exist, it is the same as:
7219 -- function(itemstack, user, node, digparams)
7220 -- itemstack:add_wear(digparams.wear)
7223 -- The user may be any ObjectRef or nil.
7225 _custom_field = whatever,
7226 -- Add your own custom fields. By convention, all custom field names
7227 -- should start with `_` to avoid naming collisions with future engine
7234 Used by `minetest.register_node`.
7237 -- <all fields allowed in item definitions>,
7239 drawtype = "normal", -- See "Node drawtypes"
7242 -- Supported for drawtypes "plantlike", "signlike", "torchlike",
7243 -- "firelike", "mesh", "nodebox", "allfaces".
7244 -- For plantlike and firelike, the image will start at the bottom of the
7245 -- node. For torchlike, the image will start at the surface to which the
7246 -- node "attaches". For the other drawtypes the image will be centered
7249 tiles = {tile definition 1, def2, def3, def4, def5, def6},
7250 -- Textures of node; +Y, -Y, +X, -X, +Z, -Z
7251 -- Old field name was 'tile_images'.
7252 -- List can be shortened to needed length.
7254 overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6},
7255 -- Same as `tiles`, but these textures are drawn on top of the base
7256 -- tiles. You can use this to colorize only specific parts of your
7257 -- texture. If the texture name is an empty string, that overlay is not
7258 -- drawn. Since such tiles are drawn twice, it is not recommended to use
7259 -- overlays on very common nodes.
7261 special_tiles = {tile definition 1, Tile definition 2},
7262 -- Special textures of node; used rarely.
7263 -- Old field name was 'special_materials'.
7264 -- List can be shortened to needed length.
7267 -- The node's original color will be multiplied with this color.
7268 -- If the node has a palette, then this setting only has an effect in
7269 -- the inventory and on the wield item.
7271 use_texture_alpha = false,
7272 -- Use texture's alpha channel
7273 -- If this is set to false, the node will be rendered fully opaque
7274 -- regardless of any texture transparency.
7276 palette = "palette.png",
7277 -- The node's `param2` is used to select a pixel from the image.
7278 -- Pixels are arranged from left to right and from top to bottom.
7279 -- The node's color will be multiplied with the selected pixel's color.
7280 -- Tiles can override this behavior.
7281 -- Only when `paramtype2` supports palettes.
7283 post_effect_color = "green#0F",
7284 -- Screen tint if player is inside node, see "ColorSpec"
7286 paramtype = "none", -- See "Nodes"
7288 paramtype2 = "none", -- See "Nodes"
7290 place_param2 = nil, -- Force value for param2 when player places node
7292 is_ground_content = true,
7293 -- If false, the cave generator and dungeon generator will not carve
7294 -- through this node.
7295 -- Specifically, this stops mod-added nodes being removed by caves and
7296 -- dungeons when those generate in a neighbor mapchunk and extend out
7297 -- beyond the edge of that mapchunk.
7299 sunlight_propagates = false,
7300 -- If true, sunlight will go infinitely through this node
7302 walkable = true, -- If true, objects collide with node
7304 pointable = true, -- If true, can be pointed at
7306 diggable = true, -- If false, can never be dug
7308 climbable = false, -- If true, can be climbed on (ladder)
7310 buildable_to = false, -- If true, placed nodes can replace this node
7313 -- If true, liquids flow into and replace this node.
7314 -- Warning: making a liquid node 'floodable' will cause problems.
7316 liquidtype = "none", -- "none" / "source" / "flowing"
7318 liquid_alternative_flowing = "", -- Flowing version of source liquid
7320 liquid_alternative_source = "", -- Source version of flowing liquid
7322 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
7324 liquid_renewable = true,
7325 -- If true, a new liquid source can be created by placing two or more
7329 -- Only valid for "nodebox" drawtype with 'type = "leveled"'.
7330 -- Allows defining the nodebox height without using param2.
7331 -- The nodebox height is 'leveled' / 64 nodes.
7332 -- The maximum value of 'leveled' is `leveled_max`.
7335 -- Maximum value for `leveled` (0-127), enforced in
7336 -- `minetest.set_node_level` and `minetest.add_node_level`.
7338 liquid_range = 8, -- Number of flowing nodes around source (max. 8)
7341 -- Player will take this amount of damage if no bubbles are left
7343 damage_per_second = 0,
7344 -- If player is inside node, this damage is caused
7346 node_box = {type="regular"}, -- See "Node boxes"
7348 connects_to = nodenames,
7349 -- Used for nodebox nodes with the type == "connected".
7350 -- Specifies to what neighboring nodes connections will be drawn.
7351 -- e.g. `{"group:fence", "default:wood"}` or `"default:stone"`
7353 connect_sides = { "top", "bottom", "front", "left", "back", "right" },
7354 -- Tells connected nodebox nodes to connect only to these sides of this
7358 -- File name of mesh when using "mesh" drawtype
7363 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
7366 -- Custom selection box definition. Multiple boxes can be defined.
7367 -- If "nodebox" drawtype is used and selection_box is nil, then node_box
7368 -- definition is used for the selection box.
7373 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
7376 -- Custom collision box definition. Multiple boxes can be defined.
7377 -- If "nodebox" drawtype is used and collision_box is nil, then node_box
7378 -- definition is used for the collision box.
7379 -- Both of the boxes above are defined as:
7380 -- {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from node center.
7382 -- Support maps made in and before January 2012
7383 legacy_facedir_simple = false,
7384 legacy_wallmounted = false,
7387 -- Valid for drawtypes:
7388 -- mesh, nodebox, plantlike, allfaces_optional, liquid, flowingliquid.
7389 -- 1 - wave node like plants (node top moves side-to-side, bottom is fixed)
7390 -- 2 - wave node like leaves (whole node moves side-to-side)
7391 -- 3 - wave node like liquids (whole node moves up and down)
7392 -- Not all models will properly wave.
7393 -- plantlike drawtype can only wave like plants.
7394 -- allfaces_optional drawtype can only wave like leaves.
7395 -- liquid, flowingliquid drawtypes can only wave like liquids.
7398 -- Definition of node sounds to be played at various events.
7399 -- All fields in this table are optional.
7401 footstep = <SimpleSoundSpec>,
7402 -- If walkable, played when object walks on it. If node is
7403 -- climbable or a liquid, played when object moves through it
7405 dig = <SimpleSoundSpec> or "__group",
7406 -- While digging node.
7407 -- If `"__group"`, then the sound will be
7408 -- `default_dig_<groupname>`, where `<groupname>` is the
7409 -- name of the tool's digging group with the fastest digging time.
7410 -- In case of a tie, one of the sounds will be played (but we
7411 -- cannot predict which one)
7412 -- Default value: `"__group"`
7414 dug = <SimpleSoundSpec>,
7417 place = <SimpleSoundSpec>,
7418 -- Node was placed. Also played after falling
7420 place_failed = <SimpleSoundSpec>,
7421 -- When node placement failed.
7422 -- Note: This happens if the _built-in_ node placement failed.
7423 -- This sound will still be played if the node is placed in the
7424 -- `on_place` callback manually.
7426 fall = <SimpleSoundSpec>,
7427 -- When node starts to fall or is detached
7431 -- Name of dropped item when dug.
7432 -- Default dropped item is the node itself.
7433 -- Using a table allows multiple items, drop chances and tool filtering.
7434 -- Tool filtering was undocumented until recently, tool filtering by string
7435 -- matching is deprecated.
7438 -- Maximum number of item lists to drop.
7439 -- The entries in 'items' are processed in order. For each:
7440 -- Tool filtering is applied, chance of drop is applied, if both are
7441 -- successful the entire item list is dropped.
7442 -- Entry processing continues until the number of dropped item lists
7443 -- equals 'max_items'.
7444 -- Therefore, entries should progress from low to high drop chance.
7448 -- 1 in 1000 chance of dropping a diamond.
7449 -- Default rarity is '1'.
7451 items = {"default:diamond"},
7454 -- Only drop if using a tool whose name is identical to one
7456 tools = {"default:shovel_mese", "default:shovel_diamond"},
7458 items = {"default:dirt"},
7459 -- Whether all items in the dropped item list inherit the
7460 -- hardware coloring palette color from the dug node.
7461 -- Default is 'false'.
7462 inherit_color = true,
7465 -- Only drop if using a tool whose name contains
7466 -- "default:shovel_" (this tool filtering by string matching
7468 tools = {"~default:shovel_"},
7470 -- The item list dropped.
7471 items = {"default:sand", "default:desert_sand"},
7476 on_construct = function(pos),
7477 -- Node constructor; called after adding node.
7478 -- Can set up metadata and stuff like that.
7479 -- Not called for bulk node placement (i.e. schematics and VoxelManip).
7482 on_destruct = function(pos),
7483 -- Node destructor; called before removing node.
7484 -- Not called for bulk node placement.
7487 after_destruct = function(pos, oldnode),
7488 -- Node destructor; called after removing node.
7489 -- Not called for bulk node placement.
7492 on_flood = function(pos, oldnode, newnode),
7493 -- Called when a liquid (newnode) is about to flood oldnode, if it has
7494 -- `floodable = true` in the nodedef. Not called for bulk node placement
7495 -- (i.e. schematics and VoxelManip) or air nodes. If return true the
7496 -- node is not flooded, but on_flood callback will most likely be called
7497 -- over and over again every liquid update interval.
7499 -- Warning: making a liquid node 'floodable' will cause problems.
7501 preserve_metadata = function(pos, oldnode, oldmeta, drops),
7502 -- Called when oldnode is about be converted to an item, but before the
7503 -- node is deleted from the world or the drops are added. This is
7504 -- generally the result of either the node being dug or an attached node
7505 -- becoming detached.
7506 -- oldmeta is the NodeMetaRef of the oldnode before deletion.
7507 -- drops is a table of ItemStacks, so any metadata to be preserved can
7508 -- be added directly to one or more of the dropped items. See
7509 -- "ItemStackMetaRef".
7512 after_place_node = function(pos, placer, itemstack, pointed_thing),
7513 -- Called after constructing node when node was placed using
7514 -- minetest.item_place_node / minetest.place_node.
7515 -- If return true no item is taken from itemstack.
7516 -- `placer` may be any valid ObjectRef or nil.
7519 after_dig_node = function(pos, oldnode, oldmetadata, digger),
7520 -- oldmetadata is in table format.
7521 -- Called after destructing node when node was dug using
7522 -- minetest.node_dig / minetest.dig_node.
7525 can_dig = function(pos, [player]),
7526 -- Returns true if node can be dug, or false if not.
7529 on_punch = function(pos, node, puncher, pointed_thing),
7530 -- default: minetest.node_punch
7531 -- Called when puncher (an ObjectRef) punches the node at pos.
7532 -- By default calls minetest.register_on_punchnode callbacks.
7534 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing),
7536 -- Called when clicker (an ObjectRef) "rightclicks"
7537 -- ("rightclick" here stands for the placement key) while pointing at
7538 -- the node at pos with 'node' being the node table.
7539 -- itemstack will hold clicker's wielded item.
7540 -- Shall return the leftover itemstack.
7541 -- Note: pointed_thing can be nil, if a mod calls this function.
7542 -- This function does not get triggered by clients <=0.4.16 if the
7543 -- "formspec" node metadata field is set.
7545 on_dig = function(pos, node, digger),
7546 -- default: minetest.node_dig
7547 -- By default checks privileges, wears out tool and removes node.
7549 on_timer = function(pos, elapsed),
7551 -- called by NodeTimers, see minetest.get_node_timer and NodeTimerRef.
7552 -- elapsed is the total time passed since the timer was started.
7553 -- return true to run the timer for another cycle with the same timeout
7556 on_receive_fields = function(pos, formname, fields, sender),
7557 -- fields = {name1 = value1, name2 = value2, ...}
7558 -- Called when an UI form (e.g. sign text input) returns data.
7559 -- See minetest.register_on_player_receive_fields for more info.
7562 allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7563 -- Called when a player wants to move items inside the inventory.
7564 -- Return value: number of items allowed to move.
7566 allow_metadata_inventory_put = function(pos, listname, index, stack, player),
7567 -- Called when a player wants to put something into the inventory.
7568 -- Return value: number of items allowed to put.
7569 -- Return value -1: Allow and don't modify item count in inventory.
7571 allow_metadata_inventory_take = function(pos, listname, index, stack, player),
7572 -- Called when a player wants to take something out of the inventory.
7573 -- Return value: number of items allowed to take.
7574 -- Return value -1: Allow and don't modify item count in inventory.
7576 on_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7577 on_metadata_inventory_put = function(pos, listname, index, stack, player),
7578 on_metadata_inventory_take = function(pos, listname, index, stack, player),
7579 -- Called after the actual action has happened, according to what was
7583 on_blast = function(pos, intensity),
7584 -- intensity: 1.0 = mid range of regular TNT.
7585 -- If defined, called when an explosion touches the node, instead of
7586 -- removing the node.
7592 Used by `minetest.register_craft`.
7597 output = 'default:pick_stone',
7599 {'default:cobble', 'default:cobble', 'default:cobble'},
7600 {'', 'default:stick', ''},
7601 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
7603 replacements = <list of item pairs>,
7604 -- replacements: replace one input item with another item on crafting
7612 output = 'mushrooms:mushroom_stew',
7615 "mushrooms:mushroom_brown",
7616 "mushrooms:mushroom_red",
7618 replacements = <list of item pairs>,
7624 type = "toolrepair",
7625 additional_wear = -0.02,
7628 Note: Tools with group `disable_repair=1` will not repairable by this recipe.
7634 output = "default:glass",
7635 recipe = "default:sand",
7643 recipe = "bucket:bucket_lava",
7645 replacements = {{"bucket:bucket_lava", "bucket:bucket_empty"}},
7651 Used by `minetest.register_ore`.
7653 See [Ores] section above for essential information.
7656 ore_type = "scatter",
7658 ore = "default:stone_with_coal",
7661 -- Facedir rotation. Default is 0 (unchanged rotation)
7663 wherein = "default:stone",
7664 -- A list of nodenames is supported too
7666 clust_scarcity = 8 * 8 * 8,
7667 -- Ore has a 1 out of clust_scarcity chance of spawning in a node.
7668 -- If the desired average distance between ores is 'd', set this to
7672 -- Number of ores in a cluster
7675 -- Size of the bounding box of the cluster.
7676 -- In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27
7677 -- nodes are coal ore.
7681 -- Lower and upper limits for ore
7684 -- Attributes for the ore generation, see 'Ore attributes' section above
7686 noise_threshold = 0.5,
7687 -- If noise is above this threshold, ore is placed. Not needed for a
7688 -- uniform distribution.
7693 spread = {x = 100, y = 100, z = 100},
7698 -- NoiseParams structure describing one of the perlin noises used for
7699 -- ore distribution.
7700 -- Needed by "sheet", "puff", "blob" and "vein" ores.
7701 -- Omit from "scatter" ore for a uniform ore distribution.
7702 -- Omit from "stratum" ore for a simple horizontal strata from y_min to
7705 biomes = {"desert", "rainforest"},
7706 -- List of biomes in which this ore occurs.
7707 -- Occurs in all biomes if this is omitted, and ignored if the Mapgen
7708 -- being used does not support biomes.
7709 -- Can be a list of (or a single) biome names, IDs, or definitions.
7711 -- Type-specific parameters
7714 column_height_min = 1,
7715 column_height_max = 16,
7716 column_midpoint_factor = 0.5,
7722 spread = {x = 100, y = 100, z = 100},
7730 spread = {x = 100, y = 100, z = 100},
7737 random_factor = 1.0,
7740 np_stratum_thickness = {
7743 spread = {x = 100, y = 100, z = 100},
7748 stratum_thickness = 8,
7754 Used by `minetest.register_biome`.
7756 The maximum number of biomes that can be used is 65535. However, using an
7757 excessive number of biomes will slow down map generation. Depending on desired
7758 performance and computing power the practical limit is much lower.
7763 node_dust = "default:snow",
7764 -- Node dropped onto upper surface after all else is generated
7766 node_top = "default:dirt_with_snow",
7768 -- Node forming surface layer of biome and thickness of this layer
7770 node_filler = "default:permafrost",
7772 -- Node forming lower layer of biome and thickness of this layer
7774 node_stone = "default:bluestone",
7775 -- Node that replaces all stone nodes between roughly y_min and y_max.
7777 node_water_top = "default:ice",
7778 depth_water_top = 10,
7779 -- Node forming a surface layer in seawater with the defined thickness
7782 -- Node that replaces all seawater nodes not in the surface layer
7784 node_river_water = "default:ice",
7785 -- Node that replaces river water in mapgens that use
7786 -- default:river_water
7788 node_riverbed = "default:gravel",
7790 -- Node placed under river water and thickness of this layer
7792 node_cave_liquid = "default:lava_source",
7793 node_cave_liquid = {"default:water_source", "default:lava_source"},
7794 -- Nodes placed inside 50% of the medium size caves.
7795 -- Multiple nodes can be specified, each cave will use a randomly
7796 -- chosen node from the list.
7797 -- If this field is left out or 'nil', cave liquids fall back to
7798 -- classic behaviour of lava and water distributed using 3D noise.
7799 -- For no cave liquid, specify "air".
7801 node_dungeon = "default:cobble",
7802 -- Node used for primary dungeon structure.
7803 -- If absent, dungeon nodes fall back to the 'mapgen_cobble' mapgen
7804 -- alias, if that is also absent, dungeon nodes fall back to the biome
7806 -- If present, the following two nodes are also used.
7808 node_dungeon_alt = "default:mossycobble",
7809 -- Node used for randomly-distributed alternative structure nodes.
7810 -- If alternative structure nodes are not wanted leave this absent for
7811 -- performance reasons.
7813 node_dungeon_stair = "stairs:stair_cobble",
7814 -- Node used for dungeon stairs.
7815 -- If absent, stairs fall back to 'node_dungeon'.
7819 -- Upper and lower limits for biome.
7820 -- Alternatively you can use xyz limits as shown below.
7822 max_pos = {x = 31000, y = 128, z = 31000},
7823 min_pos = {x = -31000, y = 9, z = -31000},
7824 -- xyz limits for biome, an alternative to using 'y_min' and 'y_max'.
7825 -- Biome is limited to a cuboid defined by these positions.
7826 -- Any x, y or z field left undefined defaults to -31000 in 'min_pos' or
7827 -- 31000 in 'max_pos'.
7830 -- Vertical distance in nodes above 'y_max' over which the biome will
7831 -- blend with the biome above.
7832 -- Set to 0 for no vertical blend. Defaults to 0.
7835 humidity_point = 50,
7836 -- Characteristic temperature and humidity for the biome.
7837 -- These values create 'biome points' on a voronoi diagram with heat and
7838 -- humidity as axes. The resulting voronoi cells determine the
7839 -- distribution of the biomes.
7840 -- Heat and humidity have average values of 50, vary mostly between
7841 -- 0 and 100 but can exceed these values.
7844 Decoration definition
7845 ---------------------
7847 See [Decoration types]. Used by `minetest.register_decoration`.
7850 deco_type = "simple",
7852 place_on = "default:dirt_with_grass",
7853 -- Node (or list of nodes) that the decoration can be placed on
7856 -- Size of the square divisions of the mapchunk being generated.
7857 -- Determines the resolution of noise variation if used.
7858 -- If the chunk size is not evenly divisible by sidelen, sidelen is made
7859 -- equal to the chunk size.
7862 -- The value determines 'decorations per surface node'.
7863 -- Used only if noise_params is not specified.
7864 -- If >= 10.0 complete coverage is enabled and decoration placement uses
7865 -- a different and much faster method.
7870 spread = {x = 100, y = 100, z = 100},
7877 -- NoiseParams structure describing the perlin noise used for decoration
7879 -- A noise value is calculated for each square division and determines
7880 -- 'decorations per surface node' within each division.
7881 -- If the noise value >= 10.0 complete coverage is enabled and
7882 -- decoration placement uses a different and much faster method.
7884 biomes = {"Oceanside", "Hills", "Plains"},
7885 -- List of biomes in which this decoration occurs. Occurs in all biomes
7886 -- if this is omitted, and ignored if the Mapgen being used does not
7888 -- Can be a list of (or a single) biome names, IDs, or definitions.
7892 -- Lower and upper limits for decoration.
7893 -- These parameters refer to the Y co-ordinate of the 'place_on' node.
7895 spawn_by = "default:water",
7896 -- Node (or list of nodes) that the decoration only spawns next to.
7897 -- Checks two horizontal planes of 8 neighbouring nodes (including
7898 -- diagonal neighbours), one plane level with the 'place_on' node and a
7899 -- plane one node above that.
7902 -- Number of spawn_by nodes that must be surrounding the decoration
7903 -- position to occur.
7904 -- If absent or -1, decorations occur next to any nodes.
7906 flags = "liquid_surface, force_placement, all_floors, all_ceilings",
7907 -- Flags for all decoration types.
7908 -- "liquid_surface": Instead of placement on the highest solid surface
7909 -- in a mapchunk column, placement is on the highest liquid surface.
7910 -- Placement is disabled if solid nodes are found above the liquid
7912 -- "force_placement": Nodes other than "air" and "ignore" are replaced
7913 -- by the decoration.
7914 -- "all_floors", "all_ceilings": Instead of placement on the highest
7915 -- surface in a mapchunk the decoration is placed on all floor and/or
7916 -- ceiling surfaces, for example in caves and dungeons.
7917 -- Ceiling decorations act as an inversion of floor decorations so the
7918 -- effect of 'place_offset_y' is inverted.
7919 -- Y-slice probabilities do not function correctly for ceiling
7920 -- schematic decorations as the behaviour is unchanged.
7921 -- If a single decoration registration has both flags the floor and
7922 -- ceiling decorations will be aligned vertically.
7924 ----- Simple-type parameters
7926 decoration = "default:grass",
7927 -- The node name used as the decoration.
7928 -- If instead a list of strings, a randomly selected node from the list
7929 -- is placed as the decoration.
7932 -- Decoration height in nodes.
7933 -- If height_max is not 0, this is the lower limit of a randomly
7937 -- Upper limit of the randomly selected height.
7938 -- If absent, the parameter 'height' is used as a constant.
7941 -- Param2 value of decoration nodes.
7942 -- If param2_max is not 0, this is the lower limit of a randomly
7946 -- Upper limit of the randomly selected param2.
7947 -- If absent, the parameter 'param2' is used as a constant.
7950 -- Y offset of the decoration base node relative to the standard base
7952 -- Can be positive or negative. Default is 0.
7953 -- Effect is inverted for "all_ceilings" decorations.
7954 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
7955 -- to the 'place_on' node.
7957 ----- Schematic-type parameters
7959 schematic = "foobar.mts",
7960 -- If schematic is a string, it is the filepath relative to the current
7961 -- working directory of the specified Minetest schematic file.
7962 -- Could also be the ID of a previously registered schematic.
7965 size = {x = 4, y = 6, z = 4},
7967 {name = "default:cobble", param1 = 255, param2 = 0},
7968 {name = "default:dirt_with_grass", param1 = 255, param2 = 0},
7969 {name = "air", param1 = 255, param2 = 0},
7973 {ypos = 2, prob = 128},
7974 {ypos = 5, prob = 64},
7978 -- Alternative schematic specification by supplying a table. The fields
7979 -- size and data are mandatory whereas yslice_prob is optional.
7980 -- See 'Schematic specifier' for details.
7982 replacements = {["oldname"] = "convert_to", ...},
7984 flags = "place_center_x, place_center_y, place_center_z",
7985 -- Flags for schematic decorations. See 'Schematic attributes'.
7988 -- Rotation can be "0", "90", "180", "270", or "random"
7991 -- If the flag 'place_center_y' is set this parameter is ignored.
7992 -- Y offset of the schematic base node layer relative to the 'place_on'
7994 -- Can be positive or negative. Default is 0.
7995 -- Effect is inverted for "all_ceilings" decorations.
7996 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
7997 -- to the 'place_on' node.
8000 Chat command definition
8001 -----------------------
8003 Used by `minetest.register_chatcommand`.
8006 params = "<name> <privilege>", -- Short parameter description
8008 description = "Remove privilege from player", -- Full description
8010 privs = {privs=true}, -- Require the "privs" privilege to run
8012 func = function(name, param),
8013 -- Called when command is run. Returns boolean success and text output.
8014 -- Special case: The help message is shown to the player if `func`
8015 -- returns false without a text output.
8018 Note that in params, use of symbols is as follows:
8020 * `<>` signifies a placeholder to be replaced when the command is used. For
8021 example, when a player name is needed: `<name>`
8022 * `[]` signifies param is optional and not required when the command is used.
8023 For example, if you require param1 but param2 is optional:
8024 `<param1> [<param2>]`
8025 * `|` signifies exclusive or. The command requires one param from the options
8026 provided. For example: `<param1> | <param2>`
8027 * `()` signifies grouping. For example, when param1 and param2 are both
8028 required, or only param3 is required: `(<param1> <param2>) | <param3>`
8030 Privilege definition
8031 --------------------
8033 Used by `minetest.register_privilege`.
8037 -- Privilege description
8039 give_to_singleplayer = true,
8040 -- Whether to grant the privilege to singleplayer.
8042 give_to_admin = true,
8043 -- Whether to grant the privilege to the server admin.
8044 -- Uses value of 'give_to_singleplayer' by default.
8046 on_grant = function(name, granter_name),
8047 -- Called when given to player 'name' by 'granter_name'.
8048 -- 'granter_name' will be nil if the priv was granted by a mod.
8050 on_revoke = function(name, revoker_name),
8051 -- Called when taken from player 'name' by 'revoker_name'.
8052 -- 'revoker_name' will be nil if the priv was revoked by a mod.
8054 -- Note that the above two callbacks will be called twice if a player is
8055 -- responsible, once with the player name, and then with a nil player
8057 -- Return true in the above callbacks to stop register_on_priv_grant or
8058 -- revoke being called.
8061 Detached inventory callbacks
8062 ----------------------------
8064 Used by `minetest.create_detached_inventory`.
8067 allow_move = function(inv, from_list, from_index, to_list, to_index, count, player),
8068 -- Called when a player wants to move items inside the inventory.
8069 -- Return value: number of items allowed to move.
8071 allow_put = function(inv, listname, index, stack, player),
8072 -- Called when a player wants to put something into the inventory.
8073 -- Return value: number of items allowed to put.
8074 -- Return value -1: Allow and don't modify item count in inventory.
8076 allow_take = function(inv, listname, index, stack, player),
8077 -- Called when a player wants to take something out of the inventory.
8078 -- Return value: number of items allowed to take.
8079 -- Return value -1: Allow and don't modify item count in inventory.
8081 on_move = function(inv, from_list, from_index, to_list, to_index, count, player),
8082 on_put = function(inv, listname, index, stack, player),
8083 on_take = function(inv, listname, index, stack, player),
8084 -- Called after the actual action has happened, according to what was
8094 Used by `Player:hud_add`. Returned by `Player:hud_get`.
8097 hud_elem_type = "image", -- See HUD element types
8098 -- Type of element, can be "image", "text", "statbar", "inventory",
8099 -- "compass" or "minimap"
8101 position = {x=0.5, y=0.5},
8102 -- Left corner position of element
8106 scale = {x = 2, y = 2},
8115 -- Selected item in inventory. 0 for no item selected.
8118 -- Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
8120 alignment = {x=0, y=0},
8122 offset = {x=0, y=0},
8124 size = { x=100, y=100 },
8125 -- Size of element in pixels
8128 -- Z index : lower z-index HUDs are displayed behind higher z-index HUDs
8134 Used by `minetest.add_particle`.
8137 pos = {x=0, y=0, z=0},
8138 velocity = {x=0, y=0, z=0},
8139 acceleration = {x=0, y=0, z=0},
8140 -- Spawn particle at pos with velocity and acceleration
8143 -- Disappears after expirationtime seconds
8146 -- Scales the visual size of the particle texture.
8147 -- If `node` is set, size can be set to 0 to spawn a randomly-sized
8148 -- particle (just like actual node dig particles).
8150 collisiondetection = false,
8151 -- If true collides with `walkable` nodes and, depending on the
8152 -- `object_collision` field, objects too.
8154 collision_removal = false,
8155 -- If true particle is removed when it collides.
8156 -- Requires collisiondetection = true to have any effect.
8158 object_collision = false,
8159 -- If true particle collides with objects that are defined as
8160 -- `physical = true,` and `collide_with_objects = true,`.
8161 -- Requires collisiondetection = true to have any effect.
8164 -- If true faces player using y axis only
8166 texture = "image.png",
8167 -- The texture of the particle
8169 playername = "singleplayer",
8170 -- Optional, if specified spawns particle only on the player's client
8172 animation = {Tile Animation definition},
8173 -- Optional, specifies how to animate the particle texture
8176 -- Optional, specify particle self-luminescence in darkness.
8179 node = {name = "ignore", param2 = 0},
8180 -- Optional, if specified the particle will have the same appearance as
8181 -- node dig particles for the given node.
8182 -- `texture` and `animation` will be ignored if this is set.
8185 -- Optional, only valid in combination with `node`
8186 -- If set to a valid number 1-6, specifies the tile from which the
8187 -- particle texture is picked.
8188 -- Otherwise, the default behavior is used. (currently: any random tile)
8192 `ParticleSpawner` definition
8193 ----------------------------
8195 Used by `minetest.add_particlespawner`.
8199 -- Number of particles spawned over the time period `time`.
8202 -- Lifespan of spawner in seconds.
8203 -- If time is 0 spawner has infinite lifespan and spawns the `amount` on
8204 -- a per-second basis.
8206 minpos = {x=0, y=0, z=0},
8207 maxpos = {x=0, y=0, z=0},
8208 minvel = {x=0, y=0, z=0},
8209 maxvel = {x=0, y=0, z=0},
8210 minacc = {x=0, y=0, z=0},
8211 maxacc = {x=0, y=0, z=0},
8216 -- The particles' properties are random values between the min and max
8218 -- applies to: pos, velocity, acceleration, expirationtime, size
8219 -- If `node` is set, min and maxsize can be set to 0 to spawn
8220 -- randomly-sized particles (just like actual node dig particles).
8222 collisiondetection = false,
8223 -- If true collide with `walkable` nodes and, depending on the
8224 -- `object_collision` field, objects too.
8226 collision_removal = false,
8227 -- If true particles are removed when they collide.
8228 -- Requires collisiondetection = true to have any effect.
8230 object_collision = false,
8231 -- If true particles collide with objects that are defined as
8232 -- `physical = true,` and `collide_with_objects = true,`.
8233 -- Requires collisiondetection = true to have any effect.
8235 attached = ObjectRef,
8236 -- If defined, particle positions, velocities and accelerations are
8237 -- relative to this object's position and yaw
8240 -- If true face player using y axis only
8242 texture = "image.png",
8243 -- The texture of the particle
8245 playername = "singleplayer",
8246 -- Optional, if specified spawns particles only on the player's client
8248 animation = {Tile Animation definition},
8249 -- Optional, specifies how to animate the particles' texture
8252 -- Optional, specify particle self-luminescence in darkness.
8255 node = {name = "ignore", param2 = 0},
8256 -- Optional, if specified the particles will have the same appearance as
8257 -- node dig particles for the given node.
8258 -- `texture` and `animation` will be ignored if this is set.
8261 -- Optional, only valid in combination with `node`
8262 -- If set to a valid number 1-6, specifies the tile from which the
8263 -- particle texture is picked.
8264 -- Otherwise, the default behavior is used. (currently: any random tile)
8267 `HTTPRequest` definition
8268 ------------------------
8270 Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
8273 url = "http://example.org",
8276 -- Timeout for connection in seconds. Default is 3 seconds.
8278 method = "GET", "POST", "PUT" or "DELETE"
8279 -- The http method to use. Defaults to "GET".
8281 data = "Raw request data string" OR {field1 = "data1", field2 = "data2"},
8282 -- Data for the POST, PUT or DELETE request.
8283 -- Accepts both a string and a table. If a table is specified, encodes
8284 -- table as x-www-form-urlencoded key-value pairs.
8286 user_agent = "ExampleUserAgent",
8287 -- Optional, if specified replaces the default minetest user agent with
8290 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
8291 -- Optional, if specified adds additional headers to the HTTP request.
8292 -- You must make sure that the header strings follow HTTP specification
8296 -- Optional, if true performs a multipart HTTP request.
8297 -- Default is false.
8298 -- Post only, data must be array
8300 post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
8301 -- Deprecated, use `data` instead. Forces `method = "POST"`.
8304 `HTTPRequestResult` definition
8305 ------------------------------
8307 Passed to `HTTPApiTable.fetch` callback. Returned by
8308 `HTTPApiTable.fetch_async_get`.
8312 -- If true, the request has finished (either succeeded, failed or timed
8316 -- If true, the request was successful
8319 -- If true, the request timed out
8327 Authentication handler definition
8328 ---------------------------------
8330 Used by `minetest.register_authentication_handler`.
8333 get_auth = function(name),
8334 -- Get authentication data for existing player `name` (`nil` if player
8336 -- Returns following structure:
8337 -- `{password=<string>, privileges=<table>, last_login=<number or nil>}`
8339 create_auth = function(name, password),
8340 -- Create new auth data for player `name`.
8341 -- Note that `password` is not plain-text but an arbitrary
8342 -- representation decided by the engine.
8344 delete_auth = function(name),
8345 -- Delete auth data of player `name`.
8346 -- Returns boolean indicating success (false if player is nonexistent).
8348 set_password = function(name, password),
8349 -- Set password of player `name` to `password`.
8350 -- Auth data should be created if not present.
8352 set_privileges = function(name, privileges),
8353 -- Set privileges of player `name`.
8354 -- `privileges` is in table form, auth data should be created if not
8357 reload = function(),
8358 -- Reload authentication data from the storage location.
8359 -- Returns boolean indicating success.
8361 record_login = function(name),
8362 -- Called when player joins, used for keeping track of last_login
8364 iterate = function(),
8365 -- Returns an iterator (use with `for` loops) for all player names
8366 -- currently in the auth database