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, human readable name 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
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
79 Used to set default settings when running this game.
81 In the same format as the one in builtin.
82 This settingtypes.txt will be parsed by the menu and the settings will be
83 displayed in the "Games" category in the advanced settings tab.
84 * If the game contains a folder called `textures` the server will load it as a
85 texturepack, overriding mod textures.
86 Any server texturepack will override mod textures and the game texturepack.
91 Games can provide custom main menu images. They are put inside a `menu`
92 directory inside the game directory.
94 The images are named `$identifier.png`, where `$identifier` is one of
95 `overlay`, `background`, `footer`, `header`.
96 If you want to specify multiple images for one identifier, add additional
97 images named like `$identifier.$n.png`, with an ascending number $n starting
98 with 1, and a random image will be chosen from the provided ones.
109 Paths are relative to the directories listed in the [Paths] section above.
111 * `games/<gameid>/mods/`
113 * `worlds/<worldname>/worldmods/`
118 It is possible to include a game in a world; in this case, no mods or
119 games are loaded or checked from anywhere else.
121 This is useful for e.g. adventure worlds and happens if the `<worldname>/game/`
124 Mods should then be placed in `<worldname>/game/mods/`.
129 Mods can be put in a subdirectory, if the parent directory, which otherwise
130 should be a mod, contains a file named `modpack.conf`.
131 The file is a key-value store of modpack details.
133 * `name`: The modpack name.
134 * `description`: Description of mod to be shown in the Mods tab of the main
137 Note: to support 0.4.x, please also create an empty modpack.txt file.
139 Mod directory structure
140 -----------------------
146 │ ├── settingtypes.txt
150 │ │ ├── modname_stuff.png
151 │ │ └── modname_something_else.png
160 The location of this directory can be fetched by using
161 `minetest.get_modpath(modname)`.
165 A `Settings` file that provides meta information about the mod.
167 * `name`: The mod name. Allows Minetest to determine the mod name even if the
168 folder is wrongly named.
169 * `description`: Description of mod to be shown in the Mods tab of the main
171 * `depends`: A comma separated list of dependencies. These are mods that must be
172 loaded before this mod.
173 * `optional_depends`: A comma separated list of optional dependencies.
174 Like a dependency, but no error if the mod doesn't exist.
176 Note: to support 0.4.x, please also provide depends.txt.
180 A screenshot shown in the mod manager within the main menu. It should
181 have an aspect ratio of 3:2 and a minimum size of 300×200 pixels.
185 **Deprecated:** you should use mod.conf instead.
187 This file is used if there are no dependencies in mod.conf.
189 List of mods that have to be loaded before loading this mod.
191 A single line contains a single modname.
193 Optional dependencies can be defined by appending a question mark
194 to a single modname. This means that if the specified mod
195 is missing, it does not prevent this mod from being loaded.
197 ### `description.txt`
199 **Deprecated:** you should use mod.conf instead.
201 This file is used if there is no description in mod.conf.
203 A file containing a description to be shown in the Mods tab of the main menu.
205 ### `settingtypes.txt`
207 The format is documented in `builtin/settingtypes.txt`.
208 It is parsed by the main menu settings dialogue to list mod-specific
209 settings in the "Mods" category.
213 The main Lua script. Running this script should register everything it
214 wants to register. Subsequent execution depends on minetest calling the
215 registered callbacks.
217 `minetest.settings` can be used to read custom or existing settings at load
218 time, if necessary. (See [`Settings`])
222 Models for entities or meshnodes.
224 ### `textures`, `sounds`, `media`
226 Media files (textures, sounds, whatever) that will be transferred to the
227 client and will be available for use by the mod.
231 Translation files for the clients. (See [Translations])
236 Registered names should generally be in this format:
240 `<whatever>` can have these characters:
244 This is to prevent conflicting names from corrupting maps and is
245 enforced by the mod loader.
247 Registered names can be overridden by prefixing the name with `:`. This can
248 be used for overriding the registrations of some other mod.
250 The `:` prefix can also be used for maintaining backwards compatibility.
254 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
255 So the name should be `experimental:tnt`.
257 Any mod can redefine `experimental:tnt` by using the name
261 when registering it. That mod is required to have `experimental` as a
270 Aliases of itemnames can be added by using
271 `minetest.register_alias(alias, original_name)` or
272 `minetest.register_alias_force(alias, original_name)`.
274 This adds an alias `alias` for the item called `original_name`.
275 From now on, you can use `alias` to refer to the item `original_name`.
277 The only difference between `minetest.register_alias` and
278 `minetest.register_alias_force` is that if an item named `alias` already exists,
279 `minetest.register_alias` will do nothing while
280 `minetest.register_alias_force` will unregister it.
282 This can be used for maintaining backwards compatibility.
284 This can also set quick access names for things, e.g. if
285 you have an item called `epiclylongmodname:stuff`, you could do
287 minetest.register_alias("stuff", "epiclylongmodname:stuff")
289 and be able to use `/giveme stuff`.
294 In a game, a certain number of these must be set to tell core mapgens which
295 of the game's nodes are to be used for core mapgen generation. For example:
297 minetest.register_alias("mapgen_stone", "default:stone")
299 ### Aliases for non-V6 mapgens
301 #### Essential aliases
304 * mapgen_water_source
305 * mapgen_river_water_source
307 `mapgen_river_water_source` is required for mapgens with sloping rivers where
308 it is necessary to have a river liquid node with a short `liquid_range` and
309 `liquid_renewable = false` to avoid flooding.
311 #### Optional aliases
315 Fallback lava node used if cave liquids are not defined in biome definitions.
316 Deprecated for non-V6 mapgens, define cave liquids in biome definitions instead.
320 Fallback node used if dungeon nodes are not defined in biome definitions.
321 Deprecated for non-V6 mapgens, define dungeon nodes in biome definitions instead.
323 ### Aliases needed for Mapgen V6
326 * mapgen_water_source
329 * mapgen_dirt_with_grass
332 * mapgen_desert_stone
334 * mapgen_dirt_with_snow
343 * mapgen_jungleleaves
346 * mapgen_pine_needles
349 * mapgen_stair_cobble
351 * mapgen_stair_desert_stone
353 ### Setting the node used in Mapgen Singlenode
355 By default the world is filled with air nodes. To set a different node use, for
358 minetest.register_alias("mapgen_singlenode", "default:stone")
366 Mods should generally prefix their textures with `modname_`, e.g. given
367 the mod name `foomod`, a texture could be called:
371 Textures are referred to by their complete name, or alternatively by
372 stripping out the file extension:
374 * e.g. `foomod_foothing.png`
375 * e.g. `foomod_foothing`
380 There are various texture modifiers that can be used
381 to generate textures on-the-fly.
383 ### Texture overlaying
385 Textures can be overlaid by putting a `^` between them.
389 default_dirt.png^default_grass_side.png
391 `default_grass_side.png` is overlaid over `default_dirt.png`.
392 The texture with the lower resolution will be automatically upscaled to
393 the higher resolution texture.
397 Textures can be grouped together by enclosing them in `(` and `)`.
399 Example: `cobble.png^(thing1.png^thing2.png)`
401 A texture for `thing1.png^thing2.png` is created and the resulting
402 texture is overlaid on top of `cobble.png`.
406 Modifiers that accept texture names (e.g. `[combine`) accept escaping to allow
407 passing complex texture names as arguments. Escaping is done with backslash and
408 is required for `^` and `:`.
410 Example: `cobble.png^[lowpart:50:color.png\^[mask\:trans.png`
412 The lower 50 percent of `color.png^[mask:trans.png` are overlaid
413 on top of `cobble.png`.
415 ### Advanced texture modifiers
421 * `[crack:<t>:<n>:<p>`
422 * `[cracko:<t>:<n>:<p>`
426 * `<t>`: tile count (in each direction)
427 * `<n>`: animation frame count
428 * `<p>`: current animation frame
430 Draw a step of the crack animation on the texture.
431 `crack` draws it normally, while `cracko` lays it over, keeping transparent
436 default_cobble.png^[crack:10:1
438 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
444 * `<file>`: texture to combine
446 Creates a texture of size `<w>` times `<h>` and blits the listed files to their
447 specified coordinates.
451 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
453 #### `[resize:<w>x<h>`
455 Resizes the texture to the given dimensions.
459 default_sandstone.png^[resize:16x16
463 Makes the base image transparent according to the given ratio.
465 `r` must be between 0 (transparent) and 255 (opaque).
469 default_sandstone.png^[opacity:127
471 #### `[invert:<mode>`
473 Inverts the given channels of the base image.
474 Mode may contain the characters "r", "g", "b", "a".
475 Only the channels that are mentioned in the mode string will be inverted.
479 default_apple.png^[invert:rgb
483 Brightens the texture.
487 tnt_tnt_side.png^[brighten
491 Makes the texture completely opaque.
495 default_leaves.png^[noalpha
497 #### `[makealpha:<r>,<g>,<b>`
499 Convert one color to transparency.
503 default_cobble.png^[makealpha:128,128,128
507 * `<t>`: transformation(s) to apply
509 Rotates and/or flips the image.
511 `<t>` can be a number (between 0 and 7) or a transform name.
512 Rotations are counter-clockwise.
515 1 R90 rotate by 90 degrees
516 2 R180 rotate by 180 degrees
517 3 R270 rotate by 270 degrees
519 5 FXR90 flip X then rotate by 90 degrees
521 7 FYR90 flip Y then rotate by 90 degrees
525 default_stone.png^[transformFXR90
527 #### `[inventorycube{<top>{<left>{<right>`
529 Escaping does not apply here and `^` is replaced by `&` in texture names
532 Create an inventory cube texture using the side textures.
536 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
538 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
539 `dirt.png^grass_side.png` textures
541 #### `[lowpart:<percent>:<file>`
543 Blit the lower `<percent>`% part of `<file>` on the texture.
547 base.png^[lowpart:25:overlay.png
549 #### `[verticalframe:<t>:<n>`
551 * `<t>`: animation frame count
552 * `<n>`: current animation frame
554 Crops the texture to a frame of a vertical animation.
558 default_torch_animated.png^[verticalframe:16:8
562 Apply a mask to the base image.
564 The mask is applied using binary AND.
566 #### `[sheet:<w>x<h>:<x>,<y>`
568 Retrieves a tile at position x,y from the base image
569 which it assumes to be a tilesheet with dimensions w,h.
571 #### `[colorize:<color>:<ratio>`
573 Colorize the textures with the given color.
574 `<color>` is specified as a `ColorString`.
575 `<ratio>` is an int ranging from 0 to 255 or the word "`alpha`". If
576 it is an int, then it specifies how far to interpolate between the
577 colors where 0 is only the texture color and 255 is only `<color>`. If
578 omitted, the alpha of `<color>` will be used as the ratio. If it is
579 the word "`alpha`", then each texture pixel will contain the RGB of
580 `<color>` and the alpha of `<color>` multiplied by the alpha of the
583 #### `[multiply:<color>`
585 Multiplies texture colors with the given color.
586 `<color>` is specified as a `ColorString`.
587 Result is more like what you'd expect if you put a color on top of another
588 color, meaning white surfaces get a lot of your new color while black parts
589 don't change very much.
594 The goal of hardware coloring is to simplify the creation of
595 colorful nodes. If your textures use the same pattern, and they only
596 differ in their color (like colored wool blocks), you can use hardware
597 coloring instead of creating and managing many texture files.
598 All of these methods use color multiplication (so a white-black texture
599 with red coloring will result in red-black color).
603 This method is useful if you wish to create nodes/items with
604 the same texture, in different colors, each in a new node/item definition.
608 When you register an item or node, set its `color` field (which accepts a
609 `ColorSpec`) to the desired color.
611 An `ItemStack`'s static color can be overwritten by the `color` metadata
612 field. If you set that field to a `ColorString`, that color will be used.
616 Each tile may have an individual static color, which overwrites every
617 other coloring method. To disable the coloring of a face,
618 set its color to white (because multiplying with white does nothing).
619 You can set the `color` property of the tiles in the node's definition
620 if the tile is in table format.
624 For nodes and items which can have many colors, a palette is more
625 suitable. A palette is a texture, which can contain up to 256 pixels.
626 Each pixel is one possible color for the node/item.
627 You can register one node/item, which can have up to 256 colors.
629 #### Palette indexing
631 When using palettes, you always provide a pixel index for the given
632 node or `ItemStack`. The palette is read from left to right and from
633 top to bottom. If the palette has less than 256 pixels, then it is
634 stretched to contain exactly 256 pixels (after arranging the pixels
635 to one line). The indexing starts from 0.
639 * 16x16 palette, index = 0: the top left corner
640 * 16x16 palette, index = 4: the fifth pixel in the first row
641 * 16x16 palette, index = 16: the pixel below the top left corner
642 * 16x16 palette, index = 255: the bottom right corner
643 * 2 (width) x 4 (height) palette, index = 31: the top left corner.
644 The palette has 8 pixels, so each pixel is stretched to 32 pixels,
645 to ensure the total 256 pixels.
646 * 2x4 palette, index = 32: the top right corner
647 * 2x4 palette, index = 63: the top right corner
648 * 2x4 palette, index = 64: the pixel below the top left corner
650 #### Using palettes with items
652 When registering an item, set the item definition's `palette` field to
653 a texture. You can also use texture modifiers.
655 The `ItemStack`'s color depends on the `palette_index` field of the
656 stack's metadata. `palette_index` is an integer, which specifies the
657 index of the pixel to use.
659 #### Linking palettes with nodes
661 When registering a node, set the item definition's `palette` field to
662 a texture. You can also use texture modifiers.
663 The node's color depends on its `param2`, so you also must set an
664 appropriate `paramtype2`:
666 * `paramtype2 = "color"` for nodes which use their full `param2` for
667 palette indexing. These nodes can have 256 different colors.
668 The palette should contain 256 pixels.
669 * `paramtype2 = "colorwallmounted"` for nodes which use the first
670 five bits (most significant) of `param2` for palette indexing.
671 The remaining three bits are describing rotation, as in `wallmounted`
672 paramtype2. Division by 8 yields the palette index (without stretching the
673 palette). These nodes can have 32 different colors, and the palette
674 should contain 32 pixels.
676 * `param2 = 17` is 2 * 8 + 1, so the rotation is 1 and the third (= 2 + 1)
677 pixel will be picked from the palette.
678 * `param2 = 35` is 4 * 8 + 3, so the rotation is 3 and the fifth (= 4 + 1)
679 pixel will be picked from the palette.
680 * `paramtype2 = "colorfacedir"` for nodes which use the first
681 three bits of `param2` for palette indexing. The remaining
682 five bits are describing rotation, as in `facedir` paramtype2.
683 Division by 32 yields the palette index (without stretching the
684 palette). These nodes can have 8 different colors, and the
685 palette should contain 8 pixels.
687 * `param2 = 17` is 0 * 32 + 17, so the rotation is 17 and the
688 first (= 0 + 1) pixel will be picked from the palette.
689 * `param2 = 35` is 1 * 32 + 3, so the rotation is 3 and the
690 second (= 1 + 1) pixel will be picked from the palette.
692 To colorize a node on the map, set its `param2` value (according
693 to the node's paramtype2).
695 ### Conversion between nodes in the inventory and on the map
697 Static coloring is the same for both cases, there is no need
700 If the `ItemStack`'s metadata contains the `color` field, it will be
701 lost on placement, because nodes on the map can only use palettes.
703 If the `ItemStack`'s metadata contains the `palette_index` field, it is
704 automatically transferred between node and item forms by the engine,
705 when a player digs or places a colored node.
706 You can disable this feature by setting the `drop` field of the node
707 to itself (without metadata).
708 To transfer the color to a special drop, you need a drop table.
712 minetest.register_node("mod:stone", {
713 description = "Stone",
714 tiles = {"default_stone.png"},
715 paramtype2 = "color",
716 palette = "palette.png",
719 -- assume that mod:cobblestone also has the same palette
720 {items = {"mod:cobblestone"}, inherit_color = true },
725 ### Colored items in craft recipes
727 Craft recipes only support item strings, but fortunately item strings
728 can also contain metadata. Example craft recipe registration:
730 minetest.register_craft({
731 output = minetest.itemstring_with_palette("wool:block", 3),
739 To set the `color` field, you can use `minetest.itemstring_with_color`.
741 Metadata field filtering in the `recipe` field are not supported yet,
742 so the craft output is independent of the color of the ingredients.
747 Sometimes hardware coloring is not enough, because it affects the
748 whole tile. Soft texture overlays were added to Minetest to allow
749 the dynamic coloring of only specific parts of the node's texture.
750 For example a grass block may have colored grass, while keeping the
753 These overlays are 'soft', because unlike texture modifiers, the layers
754 are not merged in the memory, but they are simply drawn on top of each
755 other. This allows different hardware coloring, but also means that
756 tiles with overlays are drawn slower. Using too much overlays might
759 For inventory and wield images you can specify overlays which
760 hardware coloring does not modify. You have to set `inventory_overlay`
761 and `wield_overlay` fields to an image name.
763 To define a node overlay, simply set the `overlay_tiles` field of the node
764 definition. These tiles are defined in the same way as plain tiles:
765 they can have a texture name, color etc.
766 To skip one face, set that overlay tile to an empty string.
768 Example (colored grass block):
770 minetest.register_node("default:dirt_with_grass", {
771 description = "Dirt with Grass",
772 -- Regular tiles, as usual
773 -- The dirt tile disables palette coloring
774 tiles = {{name = "default_grass.png"},
775 {name = "default_dirt.png", color = "white"}},
776 -- Overlay tiles: define them in the same style
777 -- The top and bottom tile does not have overlay
778 overlay_tiles = {"", "",
779 {name = "default_grass_side.png", tileable_vertical = false}},
780 -- Global color, used in inventory
782 -- Palette in the world
783 paramtype2 = "color",
784 palette = "default_foilage.png",
793 Only Ogg Vorbis files are supported.
795 For positional playing of sounds, only single-channel (mono) files are
796 supported. Otherwise OpenAL will play them non-positionally.
798 Mods should generally prefix their sounds with `modname_`, e.g. given
799 the mod name "`foomod`", a sound could be called:
803 Sounds are referred to by their name with a dot, a single digit and the
804 file extension stripped out. When a sound is played, the actual sound file
805 is chosen randomly from the matching sounds.
807 When playing the sound `foomod_foosound`, the sound is chosen randomly
808 from the available ones of the following files:
810 * `foomod_foosound.ogg`
811 * `foomod_foosound.0.ogg`
812 * `foomod_foosound.1.ogg`
814 * `foomod_foosound.9.ogg`
816 Examples of sound parameter tables:
818 -- Play locationless on all clients
820 gain = 1.0, -- default
821 fade = 0.0, -- default, change to a value > 0 to fade the sound in
822 pitch = 1.0, -- default
824 -- Play locationless to one player
827 gain = 1.0, -- default
828 fade = 0.0, -- default, change to a value > 0 to fade the sound in
829 pitch = 1.0, -- default
831 -- Play locationless to one player, looped
834 gain = 1.0, -- default
837 -- Play at a location
839 pos = {x = 1, y = 2, z = 3},
840 gain = 1.0, -- default
841 max_hear_distance = 32, -- default, uses an euclidean metric
843 -- Play connected to an object, looped
845 object = <an ObjectRef>,
846 gain = 1.0, -- default
847 max_hear_distance = 32, -- default, uses an euclidean metric
850 -- Play at a location, heard by anyone *but* the given player
852 pos = {x = 32, y = 0, z = 100},
853 max_hear_distance = 40,
854 exclude_player = name,
857 Looped sounds must either be connected to an object or played locationless to
858 one player using `to_player = name`.
860 A positional sound will only be heard by players that are within
861 `max_hear_distance` of the sound position, at the start of the sound.
863 `exclude_player = name` can be applied to locationless, positional and object-
864 bound sounds to exclude a single player from hearing them.
869 Specifies a sound name, gain (=volume) and pitch.
870 This is either a string or a table.
872 In string form, you just specify the sound name or
873 the empty string for no sound.
875 Table form has the following fields:
878 * `gain`: Volume (`1.0` = 100%)
879 * `pitch`: Pitch (`1.0` = 100%)
881 `gain` and `pitch` are optional and default to `1.0`.
887 * `"default_place_node"`: Play e.g. `default_place_node.ogg`
888 * `{name = "default_place_node"}`: Same as above
889 * `{name = "default_place_node", gain = 0.5}`: 50% volume
890 * `{name = "default_place_node", gain = 0.9, pitch = 1.1}`: 90% volume, 110% pitch
895 These sound files are played back by the engine if provided.
897 * `player_damage`: Played when the local player takes damage (gain = 0.5)
898 * `player_falling_damage`: Played when the local player takes
899 damage by falling (gain = 0.5)
900 * `default_dig_<groupname>`: Default node digging sound
901 (see node sound definition for details)
903 Registered definitions
904 ======================
906 Anything added using certain [Registration functions] gets added to one or more
907 of the global [Registered definition tables].
909 Note that in some cases you will stumble upon things that are not contained
910 in these tables (e.g. when a mod has been removed). Always check for
911 existence before trying to access the fields.
915 All nodes register with `minetest.register_node` get added to the table
916 `minetest.registered_nodes`.
918 If you want to check the drawtype of a node, you could do:
920 local function get_nodedef_field(nodename, fieldname)
921 if not minetest.registered_nodes[nodename] then
924 return minetest.registered_nodes[nodename][fieldname]
926 local drawtype = get_nodedef_field(nodename, "drawtype")
934 Nodes are the bulk data of the world: cubes and other things that take the
935 space of a cube. Huge amounts of them are handled efficiently, but they
938 The definition of a node is stored and can be accessed by using
940 minetest.registered_nodes[node.name]
942 See [Registered definitions].
944 Nodes are passed by value between Lua and the engine.
945 They are represented by a table:
947 {name="name", param1=num, param2=num}
949 `param1` and `param2` are 8-bit integers ranging from 0 to 255. The engine uses
950 them for certain automated functions. If you don't use these functions, you can
951 use them to store arbitrary values.
956 The functions of `param1` and `param2` are determined by certain fields in the
959 The function of `param1` is determined by `paramtype` in node definition.
960 `param1` is reserved for the engine when `paramtype != "none"`.
962 * `paramtype = "light"`
963 * The value stores light with and without sun in its upper and lower 4 bits
965 * Required by a light source node to enable spreading its light.
966 * Required by the following drawtypes as they determine their visual
967 brightness from their internal light value:
977 * `paramtype = "none"`
978 * `param1` will not be used by the engine and can be used to store
981 The function of `param2` is determined by `paramtype2` in node definition.
982 `param2` is reserved for the engine when `paramtype2 != "none"`.
984 * `paramtype2 = "flowingliquid"`
985 * Used by `drawtype = "flowingliquid"` and `liquidtype = "flowing"`
986 * The liquid level and a flag of the liquid are stored in `param2`
987 * Bits 0-2: Liquid level (0-7). The higher, the more liquid is in this node
988 * Bit 3: If set, liquid is flowing downwards (no graphical effect)
989 * `paramtype2 = "wallmounted"`
990 * Supported drawtypes: "torchlike", "signlike", "normal", "nodebox", "mesh"
991 * The rotation of the node is stored in `param2`
992 * You can make this value by using `minetest.dir_to_wallmounted()`
994 * The value denotes at which direction the node is "mounted":
995 0 = y+, 1 = y-, 2 = x+, 3 = x-, 4 = z+, 5 = z-
996 * `paramtype2 = "facedir"`
997 * Supported drawtypes: "normal", "nodebox", "mesh"
998 * The rotation of the node is stored in `param2`. Furnaces and chests are
999 rotated this way. Can be made by using `minetest.dir_to_facedir()`.
1000 * Values range 0 - 23
1001 * facedir / 4 = axis direction:
1002 0 = y+, 1 = z+, 2 = z-, 3 = x+, 4 = x-, 5 = y-
1003 * facedir modulo 4 = rotation around that axis
1004 * `paramtype2 = "leveled"`
1005 * Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
1007 * The level of the top face of the nodebox is stored in `param2`.
1008 * The other faces are defined by 'fixed = {}' like 'type = "fixed"'
1010 * The nodebox height is (`param2` / 64) nodes.
1011 * The maximum accepted value of `param2` is 127.
1013 * The height of the 'plantlike' section is stored in `param2`.
1014 * The height is (`param2` / 16) nodes.
1015 * `paramtype2 = "degrotate"`
1016 * Only valid for "plantlike" drawtype. The rotation of the node is stored in
1018 * Values range 0 - 179. The value stored in `param2` is multiplied by two to
1019 get the actual rotation in degrees of the node.
1020 * `paramtype2 = "meshoptions"`
1021 * Only valid for "plantlike" drawtype. `param2` encodes the shape and
1022 optional modifiers of the "plant". `param2` is a bitfield.
1023 * Bits 0 to 2 select the shape.
1024 Use only one of the values below:
1025 * 0 = a "x" shaped plant (ordinary plant)
1026 * 1 = a "+" shaped plant (just rotated 45 degrees)
1027 * 2 = a "*" shaped plant with 3 faces instead of 2
1028 * 3 = a "#" shaped plant with 4 faces instead of 2
1029 * 4 = a "#" shaped plant with 4 faces that lean outwards
1030 * 5-7 are unused and reserved for future meshes.
1031 * Bits 3 to 7 are used to enable any number of optional modifiers.
1032 Just add the corresponding value(s) below to `param2`:
1033 * 8 - Makes the plant slightly vary placement horizontally
1034 * 16 - Makes the plant mesh 1.4x larger
1035 * 32 - Moves each face randomly a small bit down (1/8 max)
1036 * values 64 and 128 (bits 6-7) are reserved for future use.
1037 * Example: `param2 = 0` selects a normal "x" shaped plant
1038 * Example: `param2 = 17` selects a "+" shaped plant, 1.4x larger (1+16)
1039 * `paramtype2 = "color"`
1040 * `param2` tells which color is picked from the palette.
1041 The palette should have 256 pixels.
1042 * `paramtype2 = "colorfacedir"`
1043 * Same as `facedir`, but with colors.
1044 * The first three bits of `param2` tells which color is picked from the
1045 palette. The palette should have 8 pixels.
1046 * `paramtype2 = "colorwallmounted"`
1047 * Same as `wallmounted`, but with colors.
1048 * The first five bits of `param2` tells which color is picked from the
1049 palette. The palette should have 32 pixels.
1050 * `paramtype2 = "glasslikeliquidlevel"`
1051 * Only valid for "glasslike_framed" or "glasslike_framed_optional"
1053 * `param2` values 0-63 define 64 levels of internal liquid, 0 being empty
1055 * Liquid texture is defined using `special_tiles = {"modname_tilename.png"}`
1056 * `paramtype2 = "none"`
1057 * `param2` will not be used by the engine and can be used to store
1060 Nodes can also contain extra data. See [Node Metadata].
1065 There are a bunch of different looking node types.
1067 Look for examples in `games/minimal` or `games/minetest_game`.
1070 * A node-sized cube.
1072 * Invisible, uses no texture.
1074 * The cubic source node for a liquid.
1076 * The flowing version of a liquid, appears with various heights and slopes.
1078 * Often used for partially-transparent nodes.
1079 * Only external sides of textures are visible.
1080 * `glasslike_framed`
1081 * All face-connected nodes are drawn as one volume within a surrounding
1083 * The frame appearance is generated from the edges of the first texture
1084 specified in `tiles`. The width of the edges used are 1/16th of texture
1085 size: 1 pixel for 16x16, 2 pixels for 32x32 etc.
1086 * The glass 'shine' (or other desired detail) on each node face is supplied
1087 by the second texture specified in `tiles`.
1088 * `glasslike_framed_optional`
1089 * This switches between the above 2 drawtypes according to the menu setting
1092 * Often used for partially-transparent nodes.
1093 * External and internal sides of textures are visible.
1094 * `allfaces_optional`
1095 * Often used for leaves nodes.
1096 * This switches between `normal`, `glasslike` and `allfaces` according to
1097 the menu setting: Opaque Leaves / Simple Leaves / Fancy Leaves.
1098 * With 'Simple Leaves' selected, the texture specified in `special_tiles`
1099 is used instead, if present. This allows a visually thicker texture to be
1100 used to compensate for how `glasslike` reduces visual thickness.
1102 * A single vertical texture.
1103 * If placed on top of a node, uses the first texture specified in `tiles`.
1104 * If placed against the underside of a node, uses the second texture
1105 specified in `tiles`.
1106 * If placed on the side of a node, uses the third texture specified in
1107 `tiles` and is perpendicular to that node.
1109 * A single texture parallel to, and mounted against, the top, underside or
1112 * Two vertical and diagonal textures at right-angles to each other.
1113 * See `paramtype2 = "meshoptions"` above for other options.
1115 * When above a flat surface, appears as 6 textures, the central 2 as
1116 `plantlike` plus 4 more surrounding those.
1117 * If not above a surface the central 2 do not appear, but the texture
1118 appears against the faces of surrounding nodes if they are present.
1120 * A 3D model suitable for a wooden fence.
1121 * One placed node appears as a single vertical post.
1122 * Adjacently-placed nodes cause horizontal bars to appear between them.
1124 * Often used for tracks for mining carts.
1125 * Requires 4 textures to be specified in `tiles`, in order: Straight,
1126 curved, t-junction, crossing.
1127 * Each placed node automatically switches to a suitable rotated texture
1128 determined by the adjacent `raillike` nodes, in order to create a
1129 continuous track network.
1130 * Becomes a sloping node if placed against stepped nodes.
1132 * Often used for stairs and slabs.
1133 * Allows defining nodes consisting of an arbitrary number of boxes.
1134 * See [Node boxes] below for more information.
1136 * Uses models for nodes.
1137 * Tiles should hold model materials textures.
1138 * Only static meshes are implemented.
1139 * For supported model formats see Irrlicht engine documentation.
1140 * `plantlike_rooted`
1141 * Enables underwater `plantlike` without air bubbles around the nodes.
1142 * Consists of a base cube at the co-ordinates of the node plus a
1143 `plantlike` extension above with a height of `param2 / 16` nodes.
1144 * The `plantlike` extension visually passes through any nodes above the
1145 base cube without affecting them.
1146 * The base cube texture tiles are defined as normal, the `plantlike`
1147 extension uses the defined special tile, for example:
1148 `special_tiles = {{name = "default_papyrus.png", tileable_vertical = true}},`
1150 `*_optional` drawtypes need less rendering time if deactivated
1151 (always client-side).
1156 Node selection boxes are defined using "node boxes".
1158 A nodebox is defined as any of:
1161 -- A normal cube; the default in most things
1165 -- A fixed box (or boxes) (facedir param2 is used, if applicable)
1167 fixed = box OR {box1, box2, ...}
1170 -- A variable height box (or boxes) with the top face position defined
1171 -- by the node parameter 'leveled = ', or if 'paramtype2 == "leveled"'
1173 -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
1175 fixed = box OR {box1, box2, ...}
1178 -- A box like the selection box for torches
1179 -- (wallmounted param2 is used, if applicable)
1180 type = "wallmounted",
1186 -- A node that has optional boxes depending on neighbouring nodes'
1187 -- presence and type. See also `connects_to`.
1189 fixed = box OR {box1, box2, ...}
1190 connect_top = box OR {box1, box2, ...}
1191 connect_bottom = box OR {box1, box2, ...}
1192 connect_front = box OR {box1, box2, ...}
1193 connect_left = box OR {box1, box2, ...}
1194 connect_back = box OR {box1, box2, ...}
1195 connect_right = box OR {box1, box2, ...}
1196 -- The following `disconnected_*` boxes are the opposites of the
1197 -- `connect_*` ones above, i.e. when a node has no suitable neighbour
1198 -- on the respective side, the corresponding disconnected box is drawn.
1199 disconnected_top = box OR {box1, box2, ...}
1200 disconnected_bottom = box OR {box1, box2, ...}
1201 disconnected_front = box OR {box1, box2, ...}
1202 disconnected_left = box OR {box1, box2, ...}
1203 disconnected_back = box OR {box1, box2, ...}
1204 disconnected_right = box OR {box1, box2, ...}
1205 disconnected = box OR {box1, box2, ...} -- when there is *no* neighbour
1206 disconnected_sides = box OR {box1, box2, ...} -- when there are *no*
1207 -- neighbours to the sides
1210 A `box` is defined as:
1212 {x1, y1, z1, x2, y2, z2}
1214 A box of a regular node would look like:
1216 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
1221 Map terminology and coordinates
1222 ===============================
1224 Nodes, mapblocks, mapchunks
1225 ---------------------------
1227 A 'node' is the fundamental cubic unit of a world and appears to a player as
1228 roughly 1x1x1 meters in size.
1230 A 'mapblock' (often abbreviated to 'block') is 16x16x16 nodes and is the
1231 fundamental region of a world that is stored in the world database, sent to
1232 clients and handled by many parts of the engine.
1233 'mapblock' is preferred terminology to 'block' to help avoid confusion with
1234 'node', however 'block' often appears in the API.
1236 A 'mapchunk' (sometimes abbreviated to 'chunk') is usually 5x5x5 mapblocks
1237 (80x80x80 nodes) and is the volume of world generated in one operation by
1239 The size in mapblocks has been chosen to optimise map generation.
1244 ### Orientation of axes
1246 For node and mapblock coordinates, +X is East, +Y is up, +Z is North.
1248 ### Node coordinates
1250 Almost all positions used in the API use node coordinates.
1252 ### Mapblock coordinates
1254 Occasionally the API uses 'blockpos' which refers to mapblock coordinates that
1255 specify a particular mapblock.
1256 For example blockpos (0,0,0) specifies the mapblock that extends from
1257 node position (0,0,0) to node position (15,15,15).
1259 #### Converting node position to the containing blockpos
1261 To calculate the blockpos of the mapblock that contains the node at 'nodepos',
1264 * blockpos = math.floor(nodepos / 16)
1266 #### Converting blockpos to min/max node positions
1268 To calculate the min/max node positions contained in the mapblock at 'blockpos',
1272 nodepos = blockpos * 16
1274 nodepos = blockpos * 16 + 15
1285 The position field is used for all element types.
1287 To account for differing resolutions, the position coordinates are the
1288 percentage of the screen, ranging in value from `0` to `1`.
1290 The name field is not yet used, but should contain a description of what the
1291 HUD element represents. The direction field is the direction in which something
1294 `0` draws from left to right, `1` draws from right to left, `2` draws from
1295 top to bottom, and `3` draws from bottom to top.
1297 The `alignment` field specifies how the item will be aligned. It is a table
1298 where `x` and `y` range from `-1` to `1`, with `0` being central. `-1` is
1299 moved to the left/up, and `1` is to the right/down. Fractional values can be
1302 The `offset` field specifies a pixel offset from the position. Contrary to
1303 position, the offset is not scaled to screen size. This allows for some
1304 precisely positioned items in the HUD.
1306 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
1309 The `z_index` field specifies the order of HUD elements from back to front.
1310 Lower z-index elements are displayed behind higher z-index elements. Elements
1311 with same z-index are displayed in an arbitrary order. Default 0.
1312 Supports negative values.
1314 Below are the specific uses for fields in each type; fields not listed for that
1319 Displays an image on the HUD.
1321 * `scale`: The scale of the image, with 1 being the original texture size.
1322 Only the X coordinate scale is used (positive values).
1323 Negative values represent that percentage of the screen it
1324 should take; e.g. `x=-100` means 100% (width).
1325 * `text`: The name of the texture that is displayed.
1326 * `alignment`: The alignment of the image.
1327 * `offset`: offset in pixels from position.
1331 Displays text on the HUD.
1333 * `scale`: Defines the bounding rectangle of the text.
1334 A value such as `{x=100, y=100}` should work.
1335 * `text`: The text to be displayed in the HUD element.
1336 * `number`: An integer containing the RGB value of the color used to draw the
1337 text. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1338 * `alignment`: The alignment of the text.
1339 * `offset`: offset in pixels from position.
1343 Displays a horizontal bar made up of half-images.
1345 * `text`: The name of the texture that is used.
1346 * `number`: The number of half-textures that are displayed.
1347 If odd, will end with a vertically center-split texture.
1349 * `offset`: offset in pixels from position.
1350 * `size`: If used, will force full-image size to this value (override texture
1355 * `text`: The name of the inventory list to be displayed.
1356 * `number`: Number of items in the inventory to be displayed.
1357 * `item`: Position of item that is selected.
1359 * `offset`: offset in pixels from position.
1363 Displays distance to selected world position.
1365 * `name`: The name of the waypoint.
1366 * `text`: Distance suffix. Can be blank.
1367 * `precision`: Waypoint precision, integer >= 0. Defaults to 10.
1368 If set to 0, distance is not shown. Shown value is `floor(distance*precision)/precision`.
1369 When the precision is an integer multiple of 10, there will be `log_10(precision)` digits after the decimal point.
1370 `precision = 1000`, for example, will show 3 decimal places (eg: `0.999`).
1371 `precision = 2` will show multiples of `0.5`; precision = 5 will show multiples of `0.2` and so on:
1372 `precision = n` will show multiples of `1/n`
1373 * `number:` An integer containing the RGB value of the color used to draw the
1375 * `world_pos`: World position of the waypoint.
1376 * `offset`: offset in pixels from position.
1377 * `alignment`: The alignment of the waypoint.
1379 ### `image_waypoint`
1381 Same as `image`, but does not accept a `position`; the position is instead determined by `world_pos`, the world position of the waypoint.
1383 * `scale`: The scale of the image, with 1 being the original texture size.
1384 Only the X coordinate scale is used (positive values).
1385 Negative values represent that percentage of the screen it
1386 should take; e.g. `x=-100` means 100% (width).
1387 * `text`: The name of the texture that is displayed.
1388 * `alignment`: The alignment of the image.
1389 * `world_pos`: World position of the waypoint.
1390 * `offset`: offset in pixels from position.
1394 Representations of simple things
1395 ================================
1400 {x=num, y=num, z=num}
1402 For helper functions see [Spatial Vectors].
1407 * `{type="nothing"}`
1408 * `{type="node", under=pos, above=pos}`
1409 * Indicates a pointed node selection box.
1410 * `under` refers to the node position behind the pointed face.
1411 * `above` refers to the node position in front of the pointed face.
1412 * `{type="object", ref=ObjectRef}`
1414 Exact pointing location (currently only `Raycast` supports these fields):
1416 * `pointed_thing.intersection_point`: The absolute world coordinates of the
1417 point on the selection box which is pointed at. May be in the selection box
1418 if the pointer is in the box too.
1419 * `pointed_thing.box_id`: The ID of the pointed selection box (counting starts
1421 * `pointed_thing.intersection_normal`: Unit vector, points outwards of the
1422 selected selection box. This specifies which face is pointed at.
1423 Is a null vector `{x = 0, y = 0, z = 0}` when the pointer is inside the
1429 Flag Specifier Format
1430 =====================
1432 Flags using the standardized flag specifier format can be specified in either
1433 of two ways, by string or table.
1435 The string format is a comma-delimited set of flag names; whitespace and
1436 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1437 flag, and specifying a flag prefixed by the string `"no"` explicitly
1438 clears the flag from whatever the default may be.
1440 In addition to the standard string flag format, the schematic flags field can
1441 also be a table of flag names to boolean values representing whether or not the
1442 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1443 is present, mapped to a boolean of any value, the specified flag is unset.
1445 E.g. A flag field of value
1447 {place_center_x = true, place_center_y=false, place_center_z=true}
1451 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1453 which is equivalent to
1455 "place_center_x, noplace_center_y, place_center_z"
1459 "place_center_x, place_center_z"
1461 since, by default, no schematic attributes are set.
1472 There are three kinds of items: nodes, tools and craftitems.
1474 * Node: Can be placed in the world's voxel grid
1475 * Tool: Has a wear property but cannot be stacked. The default use action is to
1476 dig nodes or hit objects according to its tool capabilities.
1477 * Craftitem: Cannot dig nodes or be placed
1482 All item stacks have an amount between 0 and 65535. It is 1 by
1483 default. Tool item stacks can not have an amount greater than 1.
1485 Tools use a wear (damage) value ranging from 0 to 65535. The
1486 value 0 is the default and is used for unworn tools. The values
1487 1 to 65535 are used for worn tools, where a higher value stands for
1488 a higher wear. Non-tools always have a wear value of 0.
1493 Items and item stacks can exist in three formats: Serializes, table format
1496 When an item must be passed to a function, it can usually be in any of
1501 This is called "stackstring" or "itemstring". It is a simple string with
1502 1-3 components: the full item identifier, an optional amount and an optional
1505 <identifier> [<amount>[ <wear>]]
1509 * `'default:apple'`: 1 apple
1510 * `'default:dirt 5'`: 5 dirt
1511 * `'default:pick_stone'`: a new stone pickaxe
1512 * `'default:pick_wood 1 21323'`: a wooden pickaxe, ca. 1/3 worn out
1520 {name="default:dirt", count=5, wear=0, metadata=""}
1522 A wooden pick about 1/3 worn out:
1524 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1528 {name="default:apple", count=1, wear=0, metadata=""}
1532 A native C++ format with many helper methods. Useful for converting
1533 between formats. See the [Class reference] section for details.
1541 In a number of places, there is a group table. Groups define the
1542 properties of a thing (item, node, armor of entity, capabilities of
1543 tool) in such a way that the engine and other mods can can interact with
1544 the thing without actually knowing what the thing is.
1549 Groups are stored in a table, having the group names with keys and the
1550 group ratings as values. Group ratings are integer values within the
1551 range [-32767, 32767]. For example:
1554 groups = {crumbly=3, soil=1}
1556 -- A more special dirt-kind of thing
1557 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1559 Groups always have a rating associated with them. If there is no
1560 useful meaning for a rating for an enabled group, it shall be `1`.
1562 When not defined, the rating of a group defaults to `0`. Thus when you
1563 read groups, you must interpret `nil` and `0` as the same value, `0`.
1565 You can read the rating of a group for an item or a node by using
1567 minetest.get_item_group(itemname, groupname)
1572 Groups of items can define what kind of an item it is (e.g. wool).
1577 In addition to the general item things, groups are used to define whether
1578 a node is destroyable and how long it takes to destroy by a tool.
1583 For entities, groups are, as of now, used only for calculating damage.
1584 The rating is the percentage of damage caused by tools with this damage group.
1585 See [Entity damage mechanism].
1587 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1588 object.set_armor_groups({fleshy=30, cracky=80})
1593 Groups in tools define which groups of nodes and entities they are
1596 Groups in crafting recipes
1597 --------------------------
1599 An example: Make meat soup from any meat, any water and any bowl:
1602 output = 'food:meat_soup_raw',
1608 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1611 Another example: Make red wool from white wool and red dye:
1615 output = 'wool:red',
1616 recipe = {'wool:white', 'group:dye,basecolor_red'},
1622 The asterisk `(*)` after a group name describes that there is no engine
1623 functionality bound to it, and implementation is left up as a suggestion
1626 ### Node, item and tool groups
1628 * `not_in_creative_inventory`: (*) Special group for inventory mods to indicate
1629 that the item should be hidden in item lists.
1632 ### Node-only groups
1634 * `attached_node`: if the node under it is not a walkable block the node will be
1635 dropped as an item. If the node is wallmounted the wallmounted direction is
1637 * `bouncy`: value is bounce speed in percent
1638 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1639 connect to each other
1640 * `dig_immediate`: Player can always pick up node without reducing tool wear
1641 * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
1642 * `3`: the node always gets the digging time 0 seconds (torch)
1643 * `disable_jump`: Player (and possibly other things) cannot jump from node
1644 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1645 * `falling_node`: if there is no walkable block under the node it will fall
1646 * `float`: the node will not fall through liquids
1647 * `level`: Can be used to give an additional sense of progression in the game.
1648 * A larger level will cause e.g. a weapon of a lower level make much less
1649 damage, and get worn out much faster, or not be able to get drops
1650 from destroyed nodes.
1651 * `0` is something that is directly accessible at the start of gameplay
1652 * There is no upper limit
1653 * See also: `leveldiff` in [Tools]
1654 * `slippery`: Players and items will slide on the node.
1655 Slipperiness rises steadily with `slippery` value, starting at 1.
1658 ### Tool-only groups
1660 * `disable_repair`: If set to 1 for a tool, it cannot be repaired using the
1661 `"toolrepair"` crafting recipe
1664 ### `ObjectRef` groups
1666 * `immortal`: Skips all damage and breath handling for an object. This group
1667 will also hide the integrated HUD status bars for players, and is
1668 automatically set to all players when damage is disabled on the server.
1669 * `punch_operable`: For entities; disables the regular damage mechanism for
1670 players punching it by hand or a non-tool item, so that it can do something
1671 else than take damage.
1675 Known damage and digging time defining groups
1676 ---------------------------------------------
1678 * `crumbly`: dirt, sand
1679 * `cracky`: tough but crackable stuff like stone.
1680 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1681 plants, wire, sheets of metal
1682 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1683 * `fleshy`: Living things like animals and the player. This could imply
1684 some blood effects when hitting.
1685 * `explody`: Especially prone to explosions
1686 * `oddly_breakable_by_hand`:
1687 Can be added to nodes that shouldn't logically be breakable by the
1688 hand but are. Somewhat similar to `dig_immediate`, but times are more
1689 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1690 speed of a tool if the tool can dig at a faster speed than this
1691 suggests for the hand.
1693 Examples of custom groups
1694 -------------------------
1696 Item groups are often used for defining, well, _groups of items_.
1698 * `meat`: any meat-kind of a thing (rating might define the size or healing
1699 ability or be irrelevant -- it is not defined as of yet)
1700 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1702 * `flammable`: can be set on fire. Rating might define the intensity of the
1703 fire, affecting e.g. the speed of the spreading of an open fire.
1704 * `wool`: any wool (any origin, any color)
1705 * `metal`: any metal
1706 * `weapon`: any weapon
1707 * `heavy`: anything considerably heavy
1709 Digging time calculation specifics
1710 ----------------------------------
1712 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1713 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1714 faster digging time.
1716 The `level` group is used to limit the toughness of nodes a tool can dig
1717 and to scale the digging times / damage to a greater extent.
1719 **Please do understand this**, otherwise you cannot use the system to it's
1722 Tools define their properties by a list of parameters for groups. They
1723 cannot dig other groups; thus it is important to use a standard bunch of
1724 groups to enable interaction with tools.
1737 * Full punch interval
1738 * Maximum drop level
1739 * For an arbitrary list of groups:
1740 * Uses (until the tool breaks)
1741 * Maximum level (usually `0`, `1`, `2` or `3`)
1745 ### Full punch interval
1747 When used as a weapon, the tool will do full damage if this time is spent
1748 between punches. If e.g. half the time is spent, the tool will do half
1751 ### Maximum drop level
1753 Suggests the maximum level of node, when dug with the tool, that will drop
1754 it's useful item. (e.g. iron ore to drop a lump of iron).
1756 This is not automated; it is the responsibility of the node definition
1761 Determines how many uses the tool has when it is used for digging a node,
1762 of this group, of the maximum level. For lower leveled nodes, the use count
1763 is multiplied by `3^leveldiff`.
1764 `leveldiff` is the difference of the tool's `maxlevel` `groupcaps` and the
1765 node's `level` group. The node cannot be dug if `leveldiff` is less than zero.
1767 * `uses=10, leveldiff=0`: actual uses: 10
1768 * `uses=10, leveldiff=1`: actual uses: 30
1769 * `uses=10, leveldiff=2`: actual uses: 90
1773 Tells what is the maximum level of a node of this group that the tool will
1778 List of digging times for different ratings of the group, for nodes of the
1781 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1782 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1783 for this group, and unable to dig the rating `1`, which is the toughest.
1784 Unless there is a matching group that enables digging otherwise.
1786 If the result digging time is 0, a delay of 0.15 seconds is added between
1787 digging nodes; If the player releases LMB after digging, this delay is set to 0,
1788 i.e. players can more quickly click the nodes away instead of holding LMB.
1792 List of damage for groups of entities. See [Entity damage mechanism].
1794 Example definition of the capabilities of a tool
1795 ------------------------------------------------
1797 tool_capabilities = {
1798 full_punch_interval=1.5,
1801 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1803 damage_groups = {fleshy=2},
1806 This makes the tool be able to dig nodes that fulfil both of these:
1808 * Have the `crumbly` group
1809 * Have a `level` group less or equal to `2`
1811 Table of resulting digging times:
1813 crumbly 0 1 2 3 4 <- level
1815 1 0.80 1.60 1.60 - -
1816 2 0.60 1.20 1.20 - -
1817 3 0.40 0.80 0.80 - -
1819 level diff: 2 1 0 -1 -2
1821 Table of resulting tool uses:
1830 * At `crumbly==0`, the node is not diggable.
1831 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1832 easy nodes to be quickly breakable.
1833 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1838 Entity damage mechanism
1839 =======================
1844 foreach group in cap.damage_groups:
1845 damage += cap.damage_groups[group]
1846 * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
1847 * (object.armor_groups[group] / 100.0)
1848 -- Where object.armor_groups[group] is 0 for inexistent values
1851 Client predicts damage based on damage groups. Because of this, it is able to
1852 give an immediate response when an entity is damaged or dies; the response is
1853 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1855 Currently a smoke puff will appear when an entity dies.
1857 The group `immortal` completely disables normal damage.
1859 Entities can define a special armor group, which is `punch_operable`. This
1860 group disables the regular damage mechanism for players punching it by hand or
1861 a non-tool item, so that it can do something else than take damage.
1863 On the Lua side, every punch calls:
1865 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction,
1868 This should never be called directly, because damage is usually not handled by
1871 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1872 accessed unless absolutely required, to encourage interoperability.
1873 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1874 * `tool_capabilities` can be `nil`.
1875 * `direction` is a unit vector, pointing from the source of the punch to
1877 * `damage` damage that will be done to entity
1878 Return value of this function will determine if damage is done by this function
1879 (retval true) or shall be done by engine (retval false)
1881 To punch an entity/object in Lua, call:
1883 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1885 * Return value is tool wear.
1886 * Parameters are equal to the above callback.
1887 * If `direction` equals `nil` and `puncher` does not equal `nil`, `direction`
1888 will be automatically filled in based on the location of `puncher`.
1899 The instance of a node in the world normally only contains the three values
1900 mentioned in [Nodes]. However, it is possible to insert extra data into a node.
1901 It is called "node metadata"; See `NodeMetaRef`.
1903 Node metadata contains two things:
1908 Some of the values in the key-value store are handled specially:
1910 * `formspec`: Defines a right-click inventory menu. See [Formspec].
1911 * `infotext`: Text shown on the screen when the node is pointed at
1915 local meta = minetest.get_meta(pos)
1916 meta:set_string("formspec",
1918 "list[context;main;0,0;8,4;]"..
1919 "list[current_player;main;0,5;8,4;]")
1920 meta:set_string("infotext", "Chest");
1921 local inv = meta:get_inventory()
1922 inv:set_size("main", 8*4)
1923 print(dump(meta:to_table()))
1926 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1927 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1928 [10] = "", [11] = "", [12] = "", [13] = "",
1929 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1930 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1931 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1932 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1936 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1944 Item stacks can store metadata too. See [`ItemStackMetaRef`].
1946 Item metadata only contains a key-value store.
1948 Some of the values in the key-value store are handled specially:
1950 * `description`: Set the item stack's description. Defaults to
1952 * `color`: A `ColorString`, which sets the stack's color.
1953 * `palette_index`: If the item has a palette, this is used to get the
1954 current color from the palette.
1958 local meta = stack:get_meta()
1959 meta:set_string("key", "value")
1960 print(dump(meta:to_table()))
1968 Formspec defines a menu. This supports inventories and some of the
1969 typical widgets like buttons, checkboxes, text input fields, etc.
1970 It is a string, with a somewhat strange format.
1972 A formspec is made out of formspec elements, which includes widgets
1973 like buttons but also can be used to set stuff like background color.
1975 Many formspec elements have a `name`, which is a unique identifier which
1976 is used when the server receives user input. You must not use the name
1977 "quit" for formspec elements.
1979 Spaces and newlines can be inserted between the blocks, as is used in the
1982 Position and size units are inventory slots unless the new coordinate system
1983 is enabled. `X` and `Y` position the formspec element relative to the top left
1984 of the menu or container. `W` and `H` are its width and height values.
1986 If the new system is enabled, all elements have unified coordinates for all
1987 elements with no padding or spacing in between. This is highly recommended
1988 for new forms. See `real_coordinates[<bool>]` and `Migrating to Real
1991 Inventories with a `player:<name>` inventory location are only sent to the
1992 player named `<name>`.
1994 When displaying text which can contain formspec code, e.g. text set by a player,
1995 use `minetest.formspec_escape`.
1996 For coloured text you can use `minetest.colorize`.
1998 Since formspec version 3, elements drawn in the order they are defined. All
1999 background elements are drawn before all other elements.
2001 **WARNING**: do _not_ use a element name starting with `key_`; those names are
2002 reserved to pass key press events to formspec!
2004 **WARNING**: Minetest allows you to add elements to every single formspec instance
2005 using `player:set_formspec_prepend()`, which may be the reason backgrounds are
2006 appearing when you don't expect them to, or why things are styled differently
2007 to normal. See [`no_prepend[]`] and [Styling Formspecs].
2015 list[context;main;0,0;8,4;]
2016 list[current_player;main;0,5;8,4;]
2021 list[context;fuel;2,3;1,1;]
2022 list[context;src;2,1;1,1;]
2023 list[context;dst;5,1;2,2;]
2024 list[current_player;main;0,5;8,4;]
2026 ### Minecraft-like player inventory
2029 image[1,0.6;1,2;player.png]
2030 list[current_player;main;0,3.5;8,4;]
2031 list[current_player;craft;3,0;3,3;]
2032 list[current_player;craftpreview;7,1;1,1;]
2037 ### `formspec_version[<version>]`
2039 * Set the formspec version to a certain number. If not specified,
2040 version 1 is assumed.
2041 * Must be specified before `size` element.
2042 * Clients older than this version can neither show newer elements nor display
2043 elements with new arguments correctly.
2044 * Available since feature `formspec_version_element`.
2046 ### `size[<W>,<H>,<fixed_size>]`
2048 * Define the size of the menu in inventory slots
2049 * `fixed_size`: `true`/`false` (optional)
2050 * deprecated: `invsize[<W>,<H>;]`
2052 ### `position[<X>,<Y>]`
2054 * Must be used after `size` element.
2055 * Defines the position on the game window of the formspec's `anchor` point.
2056 * For X and Y, 0.0 and 1.0 represent opposite edges of the game window,
2058 * [0.0, 0.0] sets the position to the top left corner of the game window.
2059 * [1.0, 1.0] sets the position to the bottom right of the game window.
2060 * Defaults to the center of the game window [0.5, 0.5].
2062 ### `anchor[<X>,<Y>]`
2064 * Must be used after both `size` and `position` (if present) elements.
2065 * Defines the location of the anchor point within the formspec.
2066 * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec,
2068 * [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
2069 * [1.0, 0.0] sets the anchor to the top right of the formspec.
2070 * Defaults to the center of the formspec [0.5, 0.5].
2072 * `position` and `anchor` elements need suitable values to avoid a formspec
2073 extending off the game window due to particular game window sizes.
2077 * Must be used after the `size`, `position`, and `anchor` elements (if present).
2078 * Disables player:set_formspec_prepend() from applying to this formspec.
2080 ### `real_coordinates[<bool>]`
2082 * INFORMATION: Enable it automatically using `formspec_version` version 2 or newer.
2083 * When set to true, all following formspec elements will use the new coordinate system.
2084 * If used immediately after `size`, `position`, `anchor`, and `no_prepend` elements
2085 (if present), the form size will use the new coordinate system.
2086 * **Note**: Formspec prepends are not affected by the coordinates in the main form.
2087 They must enable it explicitly.
2088 * For information on converting forms to the new coordinate system, see `Migrating
2089 to Real Coordinates`.
2091 ### `container[<X>,<Y>]`
2093 * Start of a container block, moves all physical elements in the container by
2095 * Must have matching `container_end`
2096 * Containers can be nested, in which case the offsets are added
2097 (child containers are relative to parent containers)
2099 ### `container_end[]`
2101 * End of a container, following elements are no longer relative to this
2104 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
2106 * Show an inventory list if it has been sent to the client. Nothing will
2107 be shown if the inventory list is of size 0.
2108 * **Note**: With the new coordinate system, the spacing between inventory
2109 slots is one-fourth the size of an inventory slot.
2111 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
2113 * Show an inventory list if it has been sent to the client. Nothing will
2114 be shown if the inventory list is of size 0.
2115 * **Note**: With the new coordinate system, the spacing between inventory
2116 slots is one-fourth the size of an inventory slot.
2118 ### `listring[<inventory location>;<list name>]`
2120 * Allows to create a ring of inventory lists
2121 * Shift-clicking on items in one element of the ring
2122 will send them to the next inventory list inside the ring
2123 * The first occurrence of an element inside the ring will
2124 determine the inventory where items will be sent to
2128 * Shorthand for doing `listring[<inventory location>;<list name>]`
2129 for the last two inventory lists added by list[...]
2131 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
2133 * Sets background color of slots as `ColorString`
2134 * Sets background color of slots on mouse hovering
2136 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
2138 * Sets background color of slots as `ColorString`
2139 * Sets background color of slots on mouse hovering
2140 * Sets color of slots border
2142 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
2144 * Sets background color of slots as `ColorString`
2145 * Sets background color of slots on mouse hovering
2146 * Sets color of slots border
2147 * Sets default background color of tooltips
2148 * Sets default font color of tooltips
2150 ### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2152 * Adds tooltip for an element
2153 * `bgcolor` tooltip background color as `ColorString` (optional)
2154 * `fontcolor` tooltip font color as `ColorString` (optional)
2156 ### `tooltip[<X>,<Y>;<W>,<H>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2158 * Adds tooltip for an area. Other tooltips will take priority when present.
2159 * `bgcolor` tooltip background color as `ColorString` (optional)
2160 * `fontcolor` tooltip font color as `ColorString` (optional)
2162 ### `image[<X>,<Y>;<W>,<H>;<texture name>]`
2166 ### `animated_image[<X>,<Y>;<W>,<H>;<name>;<texture name>;<frame count>;<frame duration>;<frame start>]`
2168 * Show an animated image. The image is drawn like a "vertical_frames" tile
2169 animation (See [Tile animation definition]), but uses a frame count/duration
2171 * `name`: Element name to send when an event occurs. The event value is the index of the current frame.
2172 * `texture name`: The image to use.
2173 * `frame count`: The number of frames animating the image.
2174 * `frame duration`: Milliseconds between each frame. `0` means the frames don't advance.
2175 * `frame start` (Optional): The index of the frame to start on. Default `1`.
2177 ### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
2179 * Show an inventory image of registered item/node
2181 ### `bgcolor[<bgcolor>;<fullscreen>;<fbgcolor>]`
2183 * Sets background color of formspec.
2184 * `bgcolor` and `fbgcolor` (optional) are `ColorString`s, they define the color
2185 of the non-fullscreen and the fullscreen background.
2186 * `fullscreen` (optional) can be one of the following:
2187 * `false`: Only the non-fullscreen background color is drawn. (default)
2188 * `true`: Only the fullscreen background color is drawn.
2189 * `both`: The non-fullscreen and the fullscreen background color are drawn.
2190 * `neither`: No background color is drawn.
2191 * Note: Leave a parameter empty to not modify the value.
2192 * Note: `fbgcolor`, leaving parameters empty and values for `fullscreen` that
2193 are not bools are only available since formspec version 3.
2195 ### `background[<X>,<Y>;<W>,<H>;<texture name>]`
2197 * Example for formspec 8x4 in 16x resolution: image shall be sized
2198 8 times 16px times 4 times 16px.
2200 ### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
2202 * Example for formspec 8x4 in 16x resolution:
2203 image shall be sized 8 times 16px times 4 times 16px
2204 * If `auto_clip` is `true`, the background is clipped to the formspec size
2205 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2207 ### `background9[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>;<middle>]`
2209 * 9-sliced background. See https://en.wikipedia.org/wiki/9-slice_scaling
2210 * Middle is a rect which defines the middle of the 9-slice.
2211 * `x` - The middle will be x pixels from all sides.
2212 * `x,y` - The middle will be x pixels from the horizontal and y from the vertical.
2213 * `x,y,x2,y2` - The middle will start at x,y, and end at x2, y2. Negative x2 and y2 values
2214 will be added to the width and height of the texture, allowing it to be used as the
2215 distance from the far end.
2216 * All numbers in middle are integers.
2217 * Example for formspec 8x4 in 16x resolution:
2218 image shall be sized 8 times 16px times 4 times 16px
2219 * If `auto_clip` is `true`, the background is clipped to the formspec size
2220 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2221 * Available since formspec version 2
2223 ### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
2225 * Textual password style field; will be sent to server when a button is clicked
2226 * When enter is pressed in field, fields.key_enter_field will be sent with the
2228 * With the old coordinate system, fields are a set height, but will be vertically
2229 centred on `H`. With the new coordinate system, `H` will modify the height.
2230 * `name` is the name of the field as returned in fields to `on_receive_fields`
2231 * `label`, if not blank, will be text printed on the top left above the field
2232 * See `field_close_on_enter` to stop enter closing the formspec
2234 ### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2236 * Textual field; will be sent to server when a button is clicked
2237 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2238 the name of this field.
2239 * With the old coordinate system, fields are a set height, but will be vertically
2240 centred on `H`. With the new coordinate system, `H` will modify the height.
2241 * `name` is the name of the field as returned in fields to `on_receive_fields`
2242 * `label`, if not blank, will be text printed on the top left above the field
2243 * `default` is the default value of the field
2244 * `default` may contain variable references such as `${text}` which
2245 will fill the value from the metadata value `text`
2246 * **Note**: no extra text or more than a single variable is supported ATM.
2247 * See `field_close_on_enter` to stop enter closing the formspec
2249 ### `field[<name>;<label>;<default>]`
2251 * As above, but without position/size units
2252 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2253 the name of this field.
2254 * Special field for creating simple forms, such as sign text input
2255 * Must be used without a `size[]` element
2256 * A "Proceed" button will be added automatically
2257 * See `field_close_on_enter` to stop enter closing the formspec
2259 ### `field_close_on_enter[<name>;<close_on_enter>]`
2261 * <name> is the name of the field
2262 * if <close_on_enter> is false, pressing enter in the field will submit the
2263 form but not close it.
2264 * defaults to true when not specified (ie: no tag for a field)
2266 ### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2268 * Same as fields above, but with multi-line input
2269 * If the text overflows, a vertical scrollbar is added.
2270 * If the name is empty, the textarea is read-only and
2271 the background is not shown, which corresponds to a multi-line label.
2273 ### `label[<X>,<Y>;<label>]`
2275 * The label formspec element displays the text set in `label`
2276 at the specified position.
2277 * **Note**: If the new coordinate system is enabled, labels are
2278 positioned from the center of the text, not the top.
2279 * The text is displayed directly without automatic line breaking,
2280 so label should not be used for big text chunks. Newlines can be
2281 used to make labels multiline.
2282 * **Note**: With the new coordinate system, newlines are spaced with
2283 half a coordinate. With the old system, newlines are spaced 2/5 of
2286 ### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]`
2287 * Displays a static formatted text with hyperlinks.
2288 * **Note**: This element is currently unstable and subject to change.
2289 * `x`, `y`, `w` and `h` work as per field
2290 * `name` is the name of the field as returned in fields to `on_receive_fields` in case of action in text.
2291 * `text` is the formatted text using `Markup Language` described below.
2293 ### `vertlabel[<X>,<Y>;<label>]`
2294 * Textual label drawn vertically
2295 * `label` is the text on the label
2296 * **Note**: If the new coordinate system is enabled, vertlabels are
2297 positioned from the center of the text, not the left.
2299 ### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
2301 * Clickable button. When clicked, fields will be sent.
2302 * With the old coordinate system, buttons are a set height, but will be vertically
2303 centred on `H`. With the new coordinate system, `H` will modify the height.
2304 * `label` is the text on the button
2306 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2308 * `texture name` is the filename of an image
2309 * **Note**: Height is supported on both the old and new coordinate systems
2312 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
2314 * `texture name` is the filename of an image
2315 * `noclip=true` means the image button doesn't need to be within specified
2317 * `drawborder`: draw button border or not
2318 * `pressed texture name` is the filename of an image on pressed state
2320 ### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
2322 * `item name` is the registered name of an item/node
2323 * The item description will be used as the tooltip. This can be overridden with
2326 ### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
2328 * When clicked, fields will be sent and the form will quit.
2329 * Same as `button` in all other respects.
2331 ### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2333 * When clicked, fields will be sent and the form will quit.
2334 * Same as `image_button` in all other respects.
2336 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
2338 * Scrollable item list showing arbitrary text elements
2339 * `name` fieldname sent to server on doubleclick value is current selected
2341 * `listelements` can be prepended by #color in hexadecimal format RRGGBB
2343 * if you want a listelement to start with "#" write "##".
2345 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
2347 * Scrollable itemlist showing arbitrary text elements
2348 * `name` fieldname sent to server on doubleclick value is current selected
2350 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
2351 * if you want a listelement to start with "#" write "##"
2352 * Index to be selected within textlist
2353 * `true`/`false`: draw transparent background
2354 * See also `minetest.explode_textlist_event`
2355 (main menu: `core.explode_textlist_event`).
2357 ### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2359 * Show a tab**header** at specific position (ignores formsize)
2360 * `X` and `Y`: position of the tabheader
2361 * *Note*: Width and height are automatically chosen with this syntax
2362 * `name` fieldname data is transferred to Lua
2363 * `caption 1`...: name shown on top of tab
2364 * `current_tab`: index of selected tab 1...
2365 * `transparent` (optional): if true, tabs are semi-transparent
2366 * `draw_border` (optional): if true, draw a thin line at tab base
2368 ### `tabheader[<X>,<Y>;<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2370 * Show a tab**header** at specific position (ignores formsize)
2371 * **Important note**: This syntax for tabheaders can only be used with the
2372 new coordinate system.
2373 * `X` and `Y`: position of the tabheader
2374 * `H`: height of the tabheader. Width is automatically determined with this syntax.
2375 * `name` fieldname data is transferred to Lua
2376 * `caption 1`...: name shown on top of tab
2377 * `current_tab`: index of selected tab 1...
2378 * `transparent` (optional): show transparent
2379 * `draw_border` (optional): draw border
2381 ### `tabheader[<X>,<Y>;<W>,<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2383 * Show a tab**header** at specific position (ignores formsize)
2384 * **Important note**: This syntax for tabheaders can only be used with the
2385 new coordinate system.
2386 * `X` and `Y`: position of the tabheader
2387 * `W` and `H`: width and height of the tabheader
2388 * `name` fieldname data is transferred to Lua
2389 * `caption 1`...: name shown on top of tab
2390 * `current_tab`: index of selected tab 1...
2391 * `transparent` (optional): show transparent
2392 * `draw_border` (optional): draw border
2394 ### `box[<X>,<Y>;<W>,<H>;<color>]`
2396 * Simple colored box
2397 * `color` is color specified as a `ColorString`.
2398 If the alpha component is left blank, the box will be semitransparent.
2400 ### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
2402 * Show a dropdown field
2403 * **Important note**: There are two different operation modes:
2404 1. handle directly on change (only changed dropdown is submitted)
2405 2. read the value on pressing a button (all dropdown values are available)
2406 * `X` and `Y`: position of the dropdown
2407 * `W`: width of the dropdown. Height is automatically chosen with this syntax.
2408 * Fieldname data is transferred to Lua
2409 * Items to be shown in dropdown
2410 * Index of currently selected dropdown item
2412 ### `dropdown[<X>,<Y>;<W>,<H>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
2414 * Show a dropdown field
2415 * **Important note**: This syntax for dropdowns can only be used with the
2416 new coordinate system.
2417 * **Important note**: There are two different operation modes:
2418 1. handle directly on change (only changed dropdown is submitted)
2419 2. read the value on pressing a button (all dropdown values are available)
2420 * `X` and `Y`: position of the dropdown
2421 * `W` and `H`: width and height of the dropdown
2422 * Fieldname data is transferred to Lua
2423 * Items to be shown in dropdown
2424 * Index of currently selected dropdown item
2426 ### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
2429 * `name` fieldname data is transferred to Lua
2430 * `label` to be shown left of checkbox
2431 * `selected` (optional): `true`/`false`
2432 * **Note**: If the new coordinate system is enabled, checkboxes are
2433 positioned from the center of the checkbox, not the top.
2435 ### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
2437 * Show a scrollbar using options defined by the previous `scrollbaroptions[]`
2438 * There are two ways to use it:
2439 1. handle the changed event (only changed scrollbar is available)
2440 2. read the value on pressing a button (all scrollbars are available)
2441 * `orientation`: `vertical`/`horizontal`
2442 * Fieldname data is transferred to Lua
2443 * Value of this trackbar is set to (`0`-`1000`) by default
2444 * See also `minetest.explode_scrollbar_event`
2445 (main menu: `core.explode_scrollbar_event`).
2447 ### `scrollbaroptions[opt1;opt2;...]`
2448 * Sets options for all following `scrollbar[]` elements
2450 * Sets scrollbar minimum value, defaults to `0`.
2452 * Sets scrollbar maximum value, defaults to `1000`.
2453 If the max is equal to the min, the scrollbar will be disabled.
2455 * Sets scrollbar step value when the arrows are clicked or the mouse wheel is
2457 * If this is set to a negative number, the value will be reset to `10`.
2459 * Sets scrollbar step value used by page up and page down.
2460 * If this is set to a negative number, the value will be reset to `100`.
2462 * Sets size of the thumb on the scrollbar. Size is calculated in the number of
2463 units the thumb spans out of the range of the scrollbar values.
2464 * Example: If a scrollbar has a `min` of 1 and a `max` of 100, a thumbsize of 10
2465 would span a tenth of the scrollbar space.
2466 * If this is set to zero or less, the value will be reset to `1`.
2467 * `arrows=<show/hide/default>`
2468 * Whether to show the arrow buttons on the scrollbar. `default` hides the arrows
2469 when the scrollbar gets too small, but shows them otherwise.
2471 ### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
2473 * Show scrollable table using options defined by the previous `tableoptions[]`
2474 * Displays cells as defined by the previous `tablecolumns[]`
2475 * `name`: fieldname sent to server on row select or doubleclick
2476 * `cell 1`...`cell n`: cell contents given in row-major order
2477 * `selected idx`: index of row to be selected within table (first row = `1`)
2478 * See also `minetest.explode_table_event`
2479 (main menu: `core.explode_table_event`).
2481 ### `tableoptions[<opt 1>;<opt 2>;...]`
2483 * Sets options for `table[]`
2485 * default text color (`ColorString`), defaults to `#FFFFFF`
2486 * `background=#RRGGBB`
2487 * table background color (`ColorString`), defaults to `#000000`
2488 * `border=<true/false>`
2489 * should the table be drawn with a border? (default: `true`)
2490 * `highlight=#RRGGBB`
2491 * highlight background color (`ColorString`), defaults to `#466432`
2492 * `highlight_text=#RRGGBB`
2493 * highlight text color (`ColorString`), defaults to `#FFFFFF`
2494 * `opendepth=<value>`
2495 * all subtrees up to `depth < value` are open (default value = `0`)
2496 * only useful when there is a column of type "tree"
2498 ### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
2500 * Sets columns for `table[]`
2501 * Types: `text`, `image`, `color`, `indent`, `tree`
2502 * `text`: show cell contents as text
2503 * `image`: cell contents are an image index, use column options to define
2505 * `color`: cell contents are a ColorString and define color of following
2507 * `indent`: cell contents are a number and define indentation of following
2509 * `tree`: same as indent, but user can open and close subtrees
2513 * for `text` and `image`: content alignment within cells.
2514 Available values: `left` (default), `center`, `right`, `inline`
2516 * for `text` and `image`: minimum width in em (default: `0`)
2517 * for `indent` and `tree`: indent width in em (default: `1.5`)
2518 * `padding=<value>`: padding left of the column, in em (default `0.5`).
2519 Exception: defaults to 0 for indent columns
2520 * `tooltip=<value>`: tooltip text (default: empty)
2521 * `image` column options:
2522 * `0=<value>` sets image for image index 0
2523 * `1=<value>` sets image for image index 1
2524 * `2=<value>` sets image for image index 2
2525 * and so on; defined indices need not be contiguous empty or
2526 non-numeric cells are treated as `0`.
2527 * `color` column options:
2528 * `span=<value>`: number of following columns to affect
2529 (default: infinite).
2531 ### `style[<selector 1>,<selector 2>;<prop1>;<prop2>;...]`
2533 * Set the style for the element(s) matching `selector` by name.
2534 * `selector` can be one of:
2535 * `<name>` - An element name.
2536 * `<name>:<state>` - An element name, a colon, and one or more states.
2537 * `state` is a list of states separated by the `+` character.
2538 * If a state is provided, the style will only take effect when the element is in that state.
2539 * All provided states must be active for the style to apply.
2540 * Note: this **must** be before the element is defined.
2541 * See [Styling Formspecs].
2544 ### `style_type[<selector 1>,<selector 2>;<prop1>;<prop2>;...]`
2546 * Set the style for the element(s) matching `selector` by type.
2547 * `selector` can be one of:
2548 * `<type>` - An element type.
2549 * `<type>:<state>` - An element type, a colon, and one or more states.
2550 * `state` is a list of states separated by the `+` character.
2551 * If a state is provided, the style will only take effect when the element is in that state.
2552 * All provided states must be active for the style to apply.
2553 * See [Styling Formspecs].
2555 Migrating to Real Coordinates
2556 -----------------------------
2558 In the old system, positions included padding and spacing. Padding is a gap between
2559 the formspec window edges and content, and spacing is the gaps between items. For
2560 example, two `1x1` elements at `0,0` and `1,1` would have a spacing of `5/4` between them,
2561 and a padding of `3/8` from the formspec edge. It may be easiest to recreate old layouts
2562 in the new coordinate system from scratch.
2564 To recreate an old layout with padding, you'll need to pass the positions and sizes
2565 through the following formula to re-introduce padding:
2568 pos = (oldpos + 1)*spacing + padding
2574 You'll need to change the `size[]` tag like this:
2577 size = (oldsize-1)*spacing + padding*2 + 1
2580 A few elements had random offsets in the old system. Here is a table which shows these
2581 offsets when migrating:
2583 | Element | Position | Size | Notes
2584 |---------|------------|---------|-------
2585 | box | +0.3, +0.1 | 0, -0.4 |
2586 | button | | | Buttons now support height, so set h = 2 * 15/13 * 0.35, and reposition if h ~= 15/13 * 0.35 before
2587 | list | | | Spacing is now 0.25 for both directions, meaning lists will be taller in height
2588 | label | 0, +0.3 | | The first line of text is now positioned centered exactly at the position specified
2593 Formspec elements can be themed using the style elements:
2595 style[<name 1>,<name 2>;<prop1>;<prop2>;...]
2596 style[<name 1>:<state>,<name 2>:<state>;<prop1>;<prop2>;...]
2597 style_type[<type 1>,<type 2>;<prop1>;<prop2>;...]
2598 style_type[<type 1>:<state>,<type 2>:<state>;<prop1>;<prop2>;...]
2602 property_name=property_value
2606 style_type[button;bgcolor=#006699]
2607 style[world_delete;bgcolor=red;textcolor=yellow]
2608 button[4,3.95;2.6,1;world_delete;Delete]
2610 A name/type can optionally be a comma separated list of names/types, like so:
2612 world_delete,world_create,world_configure
2615 Any name/type in the list can also be accompanied by a `+`-separated list of states, like so:
2617 world_delete:hovered+pressed
2620 States allow you to apply styles in response to changes in the element, instead of applying at all times.
2622 Setting a property to nothing will reset it to the default value. For example:
2624 style_type[button;bgimg=button.png;bgimg_pressed=button_pressed.png;border=false]
2625 style[btn_exit;bgimg=;bgimg_pressed=;border=;bgcolor=red]
2628 ### Supported Element Types
2630 Some types may inherit styles from parent types.
2632 * animated_image, inherits from image
2634 * button_exit, inherits from button
2641 * pwdfield, inherits from field
2644 * vertlabel, inherits from field
2650 ### Valid Properties
2653 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2655 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2656 * Default to false in formspec_version version 3 or higher
2657 * button, button_exit, image_button, item_image_button
2658 * alpha - boolean, whether to draw alpha in bgimg. Default true.
2659 * bgcolor - color, sets button tint.
2660 * bgcolor_hovered - color when hovered. Defaults to a lighter bgcolor when not provided.
2661 * bgcolor_pressed - color when pressed. Defaults to a darker bgcolor when not provided.
2662 * bgimg - standard background image. Defaults to none.
2663 * bgimg_hovered - background image when hovered. Defaults to bgimg when not provided.
2664 * bgimg_middle - Makes the bgimg textures render in 9-sliced mode and defines the middle rect.
2665 See background9[] documentation for more details
2666 * bgimg_pressed - background image when pressed. Defaults to bgimg when not provided.
2667 * border - boolean, draw border. Set to false to hide the bevelled button pane. Default true.
2668 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2669 * textcolor - color, default white.
2671 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2673 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2675 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2677 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2678 * field, pwdfield, textarea
2679 * border - set to false to hide the textbox background and border. Default true.
2680 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2681 * textcolor - color. Default white.
2683 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2684 * Default to false in formspec_version version 3 or higher
2686 * noclip - boolean, set to true to allow the element to exceed formspec bounds. Default to false.
2688 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2689 * image_button (additional properties)
2690 * fgimg - standard image. Defaults to none.
2691 * fgimg_hovered - image when hovered. Defaults to fgimg when not provided.
2692 * fgimg_pressed - image when pressed. Defaults to fgimg when not provided.
2693 * NOTE: The parameters of any given image_button will take precedence over fgimg/fgimg_pressed
2695 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2696 * textcolor - color. Default white.
2701 * default - Equivalent to providing no states
2702 * button, button_exit, image_button, item_image_button
2703 * hovered - Active when the mouse is hovering over the element
2704 * pressed - Active when the button is pressed
2709 Markup language used in `hypertext[]` elements uses tags that look like HTML tags.
2710 The markup language is currently unstable and subject to change. Use with caution.
2711 Some tags can enclose text, they open with `<tagname>` and close with `</tagname>`.
2712 Tags can have attributes, in that case, attributes are in the opening tag in
2713 form of a key/value separated with equal signs. Attribute values should not be quoted.
2715 These are the technically basic tags but see below for usual tags. Base tags are:
2717 `<style color=... font=... size=...>...</style>`
2719 Changes the style of the text.
2721 * `color`: Text color. Given color is a `colorspec`.
2722 * `size`: Text size.
2723 * `font`: Text font (`mono` or `normal`).
2725 `<global background=... margin=... valign=... color=... hovercolor=... size=... font=... halign=... >`
2730 * `background`: Text background, a `colorspec` or `none`.
2731 * `margin`: Page margins in pixel.
2732 * `valign`: Text vertical alignment (`top`, `middle`, `bottom`).
2734 Inheriting styles (affects child elements):
2735 * `color`: Default text color. Given color is a `colorspec`.
2736 * `hovercolor`: Color of <action> tags when mouse is over.
2737 * `size`: Default text size.
2738 * `font`: Default text font (`mono` or `normal`).
2739 * `halign`: Default text horizontal alignment (`left`, `right`, `center`, `justify`).
2741 This tag needs to be placed only once as it changes the global settings of the
2742 text. Anyway, if several tags are placed, each changed will be made in the order
2745 `<tag name=... color=... hovercolor=... font=... size=...>`
2747 Defines or redefines tag style. This can be used to define new tags.
2748 * `name`: Name of the tag to define or change.
2749 * `color`: Text color. Given color is a `colorspec`.
2750 * `hovercolor`: Text color when element hovered (only for `action` tags). Given color is a `colorspec`.
2751 * `size`: Text size.
2752 * `font`: Text font (`mono` or `normal`).
2754 Following tags are the usual tags for text layout. They are defined by default.
2755 Other tags can be added using `<tag ...>` tag.
2757 `<normal>...</normal>`: Normal size text
2759 `<big>...</big>`: Big text
2761 `<bigger>...</bigger>`: Bigger text
2763 `<center>...</center>`: Centered text
2765 `<left>...</left>`: Left-aligned text
2767 `<right>...</right>`: Right-aligned text
2769 `<justify>...</justify>`: Justified text
2771 `<mono>...</mono>`: Monospaced font
2773 `<b>...</b>`, `<i>...</i>`, `<u>...</u>`: Bold, italic, underline styles.
2775 `<action name=...>...</action>`
2777 Make that text a clickable text triggering an action.
2779 * `name`: Name of the action (mandatory).
2781 When clicked, the formspec is send to the server. The value of the text field
2782 sent to `on_player_receive_fields` will be "action:" concatenated to the action
2785 `<img name=... float=... width=... height=...>`
2787 Draws an image which is present in the client media cache.
2789 * `name`: Name of the texture (mandatory).
2790 * `float`: If present, makes the image floating (`left` or `right`).
2791 * `width`: Force image width instead of taking texture width.
2792 * `height`: Force image height instead of taking texture height.
2794 If only width or height given, texture aspect is kept.
2796 `<item name=... float=... width=... height=... rotate=...>`
2798 Draws an item image.
2800 * `name`: Item string of the item to draw (mandatory).
2801 * `float`: If present, makes the image floating (`left` or `right`).
2802 * `width`: Item image width.
2803 * `height`: Item image height.
2804 * `rotate`: Rotate item image if set to `yes` or `X,Y,Z`. X, Y and Z being
2805 rotation speeds in percent of standard speed (-1000 to 1000). Works only if
2806 `inventory_items_animations` is set to true.
2807 * `angle`: Angle in which the item image is shown. Value has `X,Y,Z` form.
2808 X, Y and Z being angles around each three axes. Works only if
2809 `inventory_items_animations` is set to true.
2817 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
2818 * `"current_player"`: Player to whom the menu is shown
2819 * `"player:<name>"`: Any player
2820 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
2821 * `"detached:<name>"`: A detached inventory
2823 Player Inventory lists
2824 ----------------------
2826 * `main`: list containing the default inventory
2827 * `craft`: list containing the craft input
2828 * `craftpreview`: list containing the craft prediction
2829 * `craftresult`: list containing the crafted output
2830 * `hand`: list containing an override for the empty hand
2831 * Is not created automatically, use `InvRef:set_size`
2832 * Is only used to enhance the empty hand's tool capabilities
2840 `#RGB` defines a color in hexadecimal format.
2842 `#RGBA` defines a color in hexadecimal format and alpha channel.
2844 `#RRGGBB` defines a color in hexadecimal format.
2846 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
2848 Named colors are also supported and are equivalent to
2849 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
2850 To specify the value of the alpha channel, append `#AA` to the end of the color
2851 name (e.g. `colorname#08`). For named colors the hexadecimal string
2852 representing the alpha value must (always) be two hexadecimal digits.
2857 A ColorSpec specifies a 32-bit color. It can be written in any of the following
2860 * table form: Each element ranging from 0..255 (a, if absent, defaults to 255):
2861 * `colorspec = {a=255, r=0, g=255, b=0}`
2862 * numerical form: The raw integer value of an ARGB8 quad:
2863 * `colorspec = 0xFF00FF00`
2864 * string form: A ColorString (defined above):
2865 * `colorspec = "green"`
2873 Most text can contain escape sequences, that can for example color the text.
2874 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
2875 The following functions provide escape sequences:
2877 * `minetest.get_color_escape_sequence(color)`:
2878 * `color` is a ColorString
2879 * The escape sequence sets the text color to `color`
2880 * `minetest.colorize(color, message)`:
2882 `minetest.get_color_escape_sequence(color) ..
2884 minetest.get_color_escape_sequence("#ffffff")`
2885 * `minetest.get_background_escape_sequence(color)`
2886 * `color` is a ColorString
2887 * The escape sequence sets the background of the whole text element to
2888 `color`. Only defined for item descriptions and tooltips.
2889 * `minetest.strip_foreground_colors(str)`
2890 * Removes foreground colors added by `get_color_escape_sequence`.
2891 * `minetest.strip_background_colors(str)`
2892 * Removes background colors added by `get_background_escape_sequence`.
2893 * `minetest.strip_colors(str)`
2894 * Removes all color escape sequences.
2901 A spatial vector is similar to a position, but instead using
2902 absolute world coordinates, it uses *relative* coordinates, relative to
2903 no particular point.
2905 Internally, it is implemented as a table with the 3 fields
2906 `x`, `y` and `z`. Example: `{x = 0, y = 1, z = 0}`.
2908 For the following functions, `v`, `v1`, `v2` are vectors,
2909 `p1`, `p2` are positions:
2911 * `vector.new(a[, b, c])`:
2913 * A copy of `a` if `a` is a vector.
2914 * `{x = a, y = b, z = c}`, if all of `a`, `b`, `c` are defined numbers.
2915 * `vector.direction(p1, p2)`:
2916 * Returns a vector of length 1 with direction `p1` to `p2`.
2917 * If `p1` and `p2` are identical, returns `{x = 0, y = 0, z = 0}`.
2918 * `vector.distance(p1, p2)`:
2919 * Returns zero or a positive number, the distance between `p1` and `p2`.
2920 * `vector.length(v)`:
2921 * Returns zero or a positive number, the length of vector `v`.
2922 * `vector.normalize(v)`:
2923 * Returns a vector of length 1 with direction of vector `v`.
2924 * If `v` has zero length, returns `{x = 0, y = 0, z = 0}`.
2925 * `vector.floor(v)`:
2926 * Returns a vector, each dimension rounded down.
2927 * `vector.round(v)`:
2928 * Returns a vector, each dimension rounded to nearest integer.
2929 * `vector.apply(v, func)`:
2930 * Returns a vector where the function `func` has been applied to each
2932 * `vector.equals(v1, v2)`:
2933 * Returns a boolean, `true` if the vectors are identical.
2934 * `vector.sort(v1, v2)`:
2935 * Returns in order minp, maxp vectors of the cuboid defined by `v1`, `v2`.
2936 * `vector.angle(v1, v2)`:
2937 * Returns the angle between `v1` and `v2` in radians.
2938 * `vector.dot(v1, v2)`
2939 * Returns the dot product of `v1` and `v2`
2940 * `vector.cross(v1, v2)`
2941 * Returns the cross product of `v1` and `v2`
2943 For the following functions `x` can be either a vector or a number:
2945 * `vector.add(v, x)`:
2947 * If `x` is a vector: Returns the sum of `v` and `x`.
2948 * If `x` is a number: Adds `x` to each component of `v`.
2949 * `vector.subtract(v, x)`:
2951 * If `x` is a vector: Returns the difference of `v` subtracted by `x`.
2952 * If `x` is a number: Subtracts `x` from each component of `v`.
2953 * `vector.multiply(v, x)`:
2954 * Returns a scaled vector or Schur product.
2955 * `vector.divide(v, x)`:
2956 * Returns a scaled vector or Schur quotient.
2964 * `dump2(obj, name, dumped)`: returns a string which makes `obj`
2965 human-readable, handles reference loops.
2966 * `obj`: arbitrary variable
2967 * `name`: string, default: `"_"`
2968 * `dumped`: table, default: `{}`
2969 * `dump(obj, dumped)`: returns a string which makes `obj` human-readable
2970 * `obj`: arbitrary variable
2971 * `dumped`: table, default: `{}`
2972 * `math.hypot(x, y)`
2973 * Get the hypotenuse of a triangle with legs x and y.
2974 Useful for distance calculation.
2975 * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
2976 * Get the sign of a number.
2977 * tolerance: number, default: `0.0`
2978 * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
2980 * `math.factorial(x)`: returns the factorial of `x`
2981 * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
2982 * `separator`: string, default: `","`
2983 * `include_empty`: boolean, default: `false`
2984 * `max_splits`: number, if it's negative, splits aren't limited,
2986 * `sep_is_pattern`: boolean, it specifies whether separator is a plain
2987 string or a pattern (regex), default: `false`
2988 * e.g. `"a,b":split","` returns `{"a","b"}`
2989 * `string:trim()`: returns the string without whitespace pre- and suffixes
2990 * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
2991 * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
2992 * Adds newlines to the string to keep it within the specified character
2994 * Note that the returned lines may be longer than the limit since it only
2995 splits at word borders.
2996 * `limit`: number, maximal amount of characters in one line
2997 * `as_table`: boolean, if set to true, a table of lines instead of a string
2998 is returned, default: `false`
2999 * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
3000 * `pos`: table {x=X, y=Y, z=Z}
3001 * Converts the position `pos` to a human-readable, printable string
3002 * `decimal_places`: number, if specified, the x, y and z values of
3003 the position are rounded to the given decimal place.
3004 * `minetest.string_to_pos(string)`: returns a position or `nil`
3005 * Same but in reverse.
3006 * If the string can't be parsed to a position, nothing is returned.
3007 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
3008 * Converts a string representing an area box into two positions
3009 * `minetest.formspec_escape(string)`: returns a string
3010 * escapes the characters "[", "]", "\", "," and ";", which can not be used
3012 * `minetest.is_yes(arg)`
3013 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
3014 * `minetest.is_nan(arg)`
3015 * returns true when the passed number represents NaN.
3016 * `minetest.get_us_time()`
3017 * returns time with microsecond precision. May not return wall time.
3018 * `table.copy(table)`: returns a table
3019 * returns a deep copy of `table`
3020 * `table.indexof(list, val)`: returns the smallest numerical index containing
3021 the value `val` in the table `list`. Non-numerical indices are ignored.
3022 If `val` could not be found, `-1` is returned. `list` must not have
3024 * `table.insert_all(table, other_table)`:
3025 * Appends all values in `other_table` to `table` - uses `#table + 1` to
3027 * `table.key_value_swap(t)`: returns a table with keys and values swapped
3028 * If multiple keys in `t` map to the same value, the result is undefined.
3029 * `table.shuffle(table, [from], [to], [random_func])`:
3030 * Shuffles elements `from` to `to` in `table` in place
3031 * `from` defaults to `1`
3032 * `to` defaults to `#table`
3033 * `random_func` defaults to `math.random`. This function receives two
3034 integers as arguments and should return a random integer inclusively
3036 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
3038 * returns the exact position on the surface of a pointed node
3039 * `minetest.get_dig_params(groups, tool_capabilities)`: Simulates a tool
3041 Returns a table with the following fields:
3042 * `diggable`: `true` if node can be dug, `false` otherwise.
3043 * `time`: Time it would take to dig the node.
3044 * `wear`: How much wear would be added to the tool.
3045 `time` and `wear` are meaningless if node's not diggable
3047 * `groups`: Table of the node groups of the node that would be dug
3048 * `tool_capabilities`: Tool capabilities table of the tool
3049 * `minetest.get_hit_params(groups, tool_capabilities [, time_from_last_punch])`:
3050 Simulates an item that punches an object.
3051 Returns a table with the following fields:
3052 * `hp`: How much damage the punch would cause.
3053 * `wear`: How much wear would be added to the tool.
3055 * `groups`: Damage groups of the object
3056 * `tool_capabilities`: Tool capabilities table of the item
3057 * `time_from_last_punch`: time in seconds since last punch action
3065 Texts can be translated client-side with the help of `minetest.translate` and
3068 Translating a string
3069 --------------------
3071 Two functions are provided to translate strings: `minetest.translate` and
3072 `minetest.get_translator`.
3074 * `minetest.get_translator(textdomain)` is a simple wrapper around
3075 `minetest.translate`, and `minetest.get_translator(textdomain)(str, ...)` is
3076 equivalent to `minetest.translate(textdomain, str, ...)`.
3077 It is intended to be used in the following way, so that it avoids verbose
3078 repetitions of `minetest.translate`:
3080 local S = minetest.get_translator(textdomain)
3083 As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
3085 * `minetest.translate(textdomain, str, ...)` translates the string `str` with
3086 the given `textdomain` for disambiguation. The textdomain must match the
3087 textdomain specified in the translation file in order to get the string
3088 translated. This can be used so that a string is translated differently in
3090 It is advised to use the name of the mod as textdomain whenever possible, to
3091 avoid clashes with other mods.
3092 This function must be given a number of arguments equal to the number of
3093 arguments the translated string expects.
3094 Arguments are literal strings -- they will not be translated, so if you want
3095 them to be, they need to come as outputs of `minetest.translate` as well.
3097 For instance, suppose we want to translate "@1 Wool" with "@1" being replaced
3098 by the translation of "Red". We can do the following:
3100 local S = minetest.get_translator()
3101 S("@1 Wool", S("Red"))
3103 This will be displayed as "Red Wool" on old clients and on clients that do
3104 not have localization enabled. However, if we have for instance a translation
3105 file named `wool.fr.tr` containing the following:
3110 this will be displayed as "Laine Rouge" on clients with a French locale.
3112 Operations on translated strings
3113 --------------------------------
3115 The output of `minetest.translate` is a string, with escape sequences adding
3116 additional information to that string so that it can be translated on the
3117 different clients. In particular, you can't expect operations like string.length
3118 to work on them like you would expect them to, or string.gsub to work in the
3119 expected manner. However, string concatenation will still work as expected
3120 (note that you should only use this for things like formspecs; do not translate
3121 sentences by breaking them into parts; arguments should be used instead), and
3122 operations such as `minetest.colorize` which are also concatenation.
3124 Translation file format
3125 -----------------------
3127 A translation file has the suffix `.[lang].tr`, where `[lang]` is the language
3128 it corresponds to. It must be put into the `locale` subdirectory of the mod.
3129 The file should be a text file, with the following format:
3131 * Lines beginning with `# textdomain:` (the space is significant) can be used
3132 to specify the text domain of all following translations in the file.
3133 * All other empty lines or lines beginning with `#` are ignored.
3134 * Other lines should be in the format `original=translated`. Both `original`
3135 and `translated` can contain escape sequences beginning with `@` to insert
3136 arguments, literal `@`, `=` or newline (See [Escapes] below).
3137 There must be no extraneous whitespace around the `=` or at the beginning or
3138 the end of the line.
3143 Strings that need to be translated can contain several escapes, preceded by `@`.
3145 * `@@` acts as a literal `@`.
3146 * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated
3147 string that will be inlined when translated. Due to how translations are
3148 implemented, the original translation string **must** have its arguments in
3149 increasing order, without gaps or repetitions, starting from 1.
3150 * `@=` acts as a literal `=`. It is not required in strings given to
3151 `minetest.translate`, but is in translation files to avoid being confused
3152 with the `=` separating the original from the translation.
3153 * `@\n` (where the `\n` is a literal newline) acts as a literal newline.
3154 As with `@=`, this escape is not required in strings given to
3155 `minetest.translate`, but is in translation files.
3156 * `@n` acts as a literal newline as well.
3164 Perlin noise creates a continuously-varying value depending on the input values.
3165 Usually in Minetest the input values are either 2D or 3D co-ordinates in nodes.
3166 The result is used during map generation to create the terrain shape, vary heat
3167 and humidity to distribute biomes, vary the density of decorations or vary the
3170 Structure of perlin noise
3171 -------------------------
3173 An 'octave' is a simple noise generator that outputs a value between -1 and 1.
3174 The smooth wavy noise it generates has a single characteristic scale, almost
3175 like a 'wavelength', so on its own does not create fine detail.
3176 Due to this perlin noise combines several octaves to create variation on
3177 multiple scales. Each additional octave has a smaller 'wavelength' than the
3180 This combination results in noise varying very roughly between -2.0 and 2.0 and
3181 with an average value of 0.0, so `scale` and `offset` are then used to multiply
3182 and offset the noise variation.
3184 The final perlin noise variation is created as follows:
3186 noise = offset + scale * (octave1 +
3187 octave2 * persistence +
3188 octave3 * persistence ^ 2 +
3189 octave4 * persistence ^ 3 +
3195 Noise Parameters are commonly called `NoiseParams`.
3199 After the multiplication by `scale` this is added to the result and is the final
3200 step in creating the noise value.
3201 Can be positive or negative.
3205 Once all octaves have been combined, the result is multiplied by this.
3206 Can be positive or negative.
3210 For octave1, this is roughly the change of input value needed for a very large
3211 variation in the noise value generated by octave1. It is almost like a
3212 'wavelength' for the wavy noise variation.
3213 Each additional octave has a 'wavelength' that is smaller than the previous
3214 octave, to create finer detail. `spread` will therefore roughly be the typical
3215 size of the largest structures in the final noise variation.
3217 `spread` is a vector with values for x, y, z to allow the noise variation to be
3218 stretched or compressed in the desired axes.
3219 Values are positive numbers.
3223 This is a whole number that determines the entire pattern of the noise
3224 variation. Altering it enables different noise patterns to be created.
3225 With other parameters equal, different seeds produce different noise patterns
3226 and identical seeds produce identical noise patterns.
3228 For this parameter you can randomly choose any whole number. Usually it is
3229 preferable for this to be different from other seeds, but sometimes it is useful
3230 to be able to create identical noise patterns.
3232 When used in mapgen this is actually a 'seed offset', it is added to the
3233 'world seed' to create the seed used by the noise, to ensure the noise has a
3234 different pattern in different worlds.
3238 The number of simple noise generators that are combined.
3239 A whole number, 1 or more.
3240 Each additional octave adds finer detail to the noise but also increases the
3241 noise calculation load.
3242 3 is a typical minimum for a high quality, complex and natural-looking noise
3243 variation. 1 octave has a slight 'gridlike' appearence.
3245 Choose the number of octaves according to the `spread` and `lacunarity`, and the
3246 size of the finest detail you require. For example:
3247 if `spread` is 512 nodes, `lacunarity` is 2.0 and finest detail required is 16
3248 nodes, octaves will be 6 because the 'wavelengths' of the octaves will be
3249 512, 256, 128, 64, 32, 16 nodes.
3250 Warning: If the 'wavelength' of any octave falls below 1 an error will occur.
3254 Each additional octave has an amplitude that is the amplitude of the previous
3255 octave multiplied by `persistence`, to reduce the amplitude of finer details,
3256 as is often helpful and natural to do so.
3257 Since this controls the balance of fine detail to large-scale detail
3258 `persistence` can be thought of as the 'roughness' of the noise.
3260 A positive or negative non-zero number, often between 0.3 and 1.0.
3261 A common medium value is 0.5, such that each octave has half the amplitude of
3262 the previous octave.
3263 This may need to be tuned when altering `lacunarity`; when doing so consider
3264 that a common medium value is 1 / lacunarity.
3268 Each additional octave has a 'wavelength' that is the 'wavelength' of the
3269 previous octave multiplied by 1 / lacunarity, to create finer detail.
3270 'lacunarity' is often 2.0 so 'wavelength' often halves per octave.
3272 A positive number no smaller than 1.0.
3273 Values below 2.0 create higher quality noise at the expense of requiring more
3274 octaves to cover a paticular range of 'wavelengths'.
3278 Leave this field unset for no special handling.
3279 Currently supported are `defaults`, `eased` and `absvalue`:
3283 Specify this if you would like to keep auto-selection of eased/not-eased while
3284 specifying some other flags.
3288 Maps noise gradient values onto a quintic S-curve before performing
3289 interpolation. This results in smooth, rolling noise.
3290 Disable this (`noeased`) for sharp-looking noise with a slightly gridded
3292 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is
3294 Easing a 3D noise significantly increases the noise calculation load, so use
3299 The absolute value of each octave's noise variation is used when combining the
3300 octaves. The final perlin noise variation is created as follows:
3302 noise = offset + scale * (abs(octave1) +
3303 abs(octave2) * persistence +
3304 abs(octave3) * persistence ^ 2 +
3305 abs(octave4) * persistence ^ 3 +
3310 For 2D or 3D perlin noise or perlin noise maps:
3315 spread = {x = 500, y = 500, z = 500},
3320 flags = "defaults, absvalue",
3323 For 2D noise the Z component of `spread` is still defined but is ignored.
3324 A single noise parameter table can be used for 2D or 3D noise.
3335 These tell in what manner the ore is generated.
3337 All default ores are of the uniformly-distributed scatter type.
3341 Randomly chooses a location and generates a cluster of ore.
3343 If `noise_params` is specified, the ore will be placed if the 3D perlin noise
3344 at that point is greater than the `noise_threshold`, giving the ability to
3345 create a non-equal distribution of ore.
3349 Creates a sheet of ore in a blob shape according to the 2D perlin noise
3350 described by `noise_params` and `noise_threshold`. This is essentially an
3351 improved version of the so-called "stratus" ore seen in some unofficial mods.
3353 This sheet consists of vertical columns of uniform randomly distributed height,
3354 varying between the inclusive range `column_height_min` and `column_height_max`.
3355 If `column_height_min` is not specified, this parameter defaults to 1.
3356 If `column_height_max` is not specified, this parameter defaults to `clust_size`
3357 for reverse compatibility. New code should prefer `column_height_max`.
3359 The `column_midpoint_factor` parameter controls the position of the column at
3360 which ore emanates from.
3361 If 1, columns grow upward. If 0, columns grow downward. If 0.5, columns grow
3362 equally starting from each direction.
3363 `column_midpoint_factor` is a decimal number ranging in value from 0 to 1. If
3364 this parameter is not specified, the default is 0.5.
3366 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this
3371 Creates a sheet of ore in a cloud-like puff shape.
3373 As with the `sheet` ore type, the size and shape of puffs are described by
3374 `noise_params` and `noise_threshold` and are placed at random vertical
3375 positions within the currently generated chunk.
3377 The vertical top and bottom displacement of each puff are determined by the
3378 noise parameters `np_puff_top` and `np_puff_bottom`, respectively.
3382 Creates a deformed sphere of ore according to 3d perlin noise described by
3383 `noise_params`. The maximum size of the blob is `clust_size`, and
3384 `clust_scarcity` has the same meaning as with the `scatter` type.
3388 Creates veins of ore varying in density by according to the intersection of two
3389 instances of 3d perlin noise with different seeds, both described by
3392 `random_factor` varies the influence random chance has on placement of an ore
3393 inside the vein, which is `1` by default. Note that modifying this parameter
3394 may require adjusting `noise_threshold`.
3396 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
3399 This ore type is difficult to control since it is sensitive to small changes.
3400 The following is a decent set of parameters to work from:
3405 spread = {x=200, y=200, z=200},
3412 noise_threshold = 1.6
3414 **WARNING**: Use this ore type *very* sparingly since it is ~200x more
3415 computationally expensive than any other ore.
3419 Creates a single undulating ore stratum that is continuous across mapchunk
3420 borders and horizontally spans the world.
3422 The 2D perlin noise described by `noise_params` defines the Y co-ordinate of
3423 the stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
3424 defines the stratum's vertical thickness (in units of nodes). Due to being
3425 continuous across mapchunk borders the stratum's vertical thickness is
3428 If the noise parameter `noise_params` is omitted the ore will occur from y_min
3429 to y_max in a simple horizontal stratum.
3431 A parameter `stratum_thickness` can be provided instead of the noise parameter
3432 `np_stratum_thickness`, to create a constant thickness.
3434 Leaving out one or both noise parameters makes the ore generation less
3435 intensive, useful when adding multiple strata.
3437 `y_min` and `y_max` define the limits of the ore generation and for performance
3438 reasons should be set as close together as possible but without clipping the
3439 stratum's Y variation.
3441 Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
3442 solid-ore stratum would require a `clust_scarcity` of 1.
3444 The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
3445 `random_factor` are ignored by this ore type.
3450 See section [Flag Specifier Format].
3452 Currently supported flags:
3453 `puff_cliffs`, `puff_additive_composition`.
3457 If set, puff ore generation will not taper down large differences in
3458 displacement when approaching the edge of a puff. This flag has no effect for
3459 ore types other than `puff`.
3461 ### `puff_additive_composition`
3463 By default, when noise described by `np_puff_top` or `np_puff_bottom` results
3464 in a negative displacement, the sub-column at that point is not generated. With
3465 this attribute set, puff ore generation will instead generate the absolute
3466 difference in noise displacement values. This flag has no effect for ore types
3475 The varying types of decorations that can be placed.
3480 Creates a 1 times `H` times 1 column of a specified node (or a random node from
3481 a list, if a decoration list is specified). Can specify a certain node it must
3482 spawn next to, such as water or lava, for example. Can also generate a
3483 decoration of random height between a specified lower and upper bound.
3484 This type of decoration is intended for placement of grass, flowers, cacti,
3485 papyri, waterlilies and so on.
3490 Copies a box of `MapNodes` from a specified schematic file (or raw description).
3491 Can specify a probability of a node randomly appearing when placed.
3492 This decoration type is intended to be used for multi-node sized discrete
3493 structures, such as trees, cave spikes, rocks, and so on.
3502 --------------------
3504 A schematic specifier identifies a schematic by either a filename to a
3505 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
3506 in the form of a table. This table specifies the following fields:
3508 * The `size` field is a 3D vector containing the dimensions of the provided
3509 schematic. (required field)
3510 * The `yslice_prob` field is a table of {ypos, prob} slice tables. A slice table
3511 sets the probability of a particular horizontal slice of the schematic being
3512 placed. (optional field)
3513 `ypos` = 0 for the lowest horizontal slice of a schematic.
3514 The default of `prob` is 255.
3515 * The `data` field is a flat table of MapNode tables making up the schematic,
3516 in the order of `[z [y [x]]]`. (required field)
3517 Each MapNode table contains:
3518 * `name`: the name of the map node to place (required)
3519 * `prob` (alias `param1`): the probability of this node being placed
3521 * `param2`: the raw param2 value of the node being placed onto the map
3523 * `force_place`: boolean representing if the node should forcibly overwrite
3524 any previous contents (default: false)
3526 About probability values:
3528 * A probability value of `0` or `1` means that node will never appear
3530 * A probability value of `254` or `255` means the node will always appear
3532 * If the probability value `p` is greater than `1`, then there is a
3533 `(p / 256 * 100)` percent chance that node will appear when the schematic is
3536 Schematic attributes
3537 --------------------
3539 See section [Flag Specifier Format].
3541 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
3544 * `place_center_x`: Placement of this decoration is centered along the X axis.
3545 * `place_center_y`: Placement of this decoration is centered along the Y axis.
3546 * `place_center_z`: Placement of this decoration is centered along the Z axis.
3547 * `force_placement`: Schematic nodes other than "ignore" will replace existing
3553 Lua Voxel Manipulator
3554 =====================
3559 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator'
3560 facility. The purpose of this object is for fast, low-level, bulk access to
3561 reading and writing Map content. As such, setting map nodes through VoxelManip
3562 will lack many of the higher level features and concepts you may be used to
3563 with other methods of setting nodes. For example, nodes will not have their
3564 construction and destruction callbacks run, and no rollback information is
3567 It is important to note that VoxelManip is designed for speed, and *not* ease
3568 of use or flexibility. If your mod requires a map manipulation facility that
3569 will handle 100% of all edge cases, or the use of high level node placement
3570 features, perhaps `minetest.set_node()` is better suited for the job.
3572 In addition, VoxelManip might not be faster, or could even be slower, for your
3573 specific use case. VoxelManip is most effective when setting large areas of map
3574 at once - for example, if only setting a 3x3x3 node area, a
3575 `minetest.set_node()` loop may be more optimal. Always profile code using both
3576 methods of map manipulation to determine which is most appropriate for your
3579 A recent simple test of setting cubic areas showed that `minetest.set_node()`
3580 is faster than a VoxelManip for a 3x3x3 node cube or smaller.
3585 A VoxelManip object can be created any time using either:
3586 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
3588 If the optional position parameters are present for either of these routines,
3589 the specified region will be pre-loaded into the VoxelManip object on creation.
3590 Otherwise, the area of map you wish to manipulate must first be loaded into the
3591 VoxelManip object using `VoxelManip:read_from_map()`.
3593 Note that `VoxelManip:read_from_map()` returns two position vectors. The region
3594 formed by these positions indicate the minimum and maximum (respectively)
3595 positions of the area actually loaded in the VoxelManip, which may be larger
3596 than the area requested. For convenience, the loaded area coordinates can also
3597 be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
3599 Now that the VoxelManip object is populated with map data, your mod can fetch a
3600 copy of this data using either of two methods. `VoxelManip:get_node_at()`,
3601 which retrieves an individual node in a MapNode formatted table at the position
3602 requested is the simplest method to use, but also the slowest.
3604 Nodes in a VoxelManip object may also be read in bulk to a flat array table
3607 * `VoxelManip:get_data()` for node content (in Content ID form, see section
3609 * `VoxelManip:get_light_data()` for node light levels, and
3610 * `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
3612 See section [Flat array format] for more details.
3614 It is very important to understand that the tables returned by any of the above
3615 three functions represent a snapshot of the VoxelManip's internal state at the
3616 time of the call. This copy of the data will not magically update itself if
3617 another function modifies the internal VoxelManip state.
3618 Any functions that modify a VoxelManip's contents work on the VoxelManip's
3619 internal state unless otherwise explicitly stated.
3621 Once the bulk data has been edited to your liking, the internal VoxelManip
3622 state can be set using:
3624 * `VoxelManip:set_data()` for node content (in Content ID form, see section
3626 * `VoxelManip:set_light_data()` for node light levels, and
3627 * `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
3629 The parameter to each of the above three functions can use any table at all in
3630 the same flat array format as produced by `get_data()` etc. and is not required
3631 to be a table retrieved from `get_data()`.
3633 Once the internal VoxelManip state has been modified to your liking, the
3634 changes can be committed back to the map by calling `VoxelManip:write_to_map()`
3636 ### Flat array format
3639 `Nx = p2.X - p1.X + 1`,
3640 `Ny = p2.Y - p1.Y + 1`, and
3641 `Nz = p2.Z - p1.Z + 1`.
3643 Then, for a loaded region of p1..p2, this array ranges from `1` up to and
3644 including the value of the expression `Nx * Ny * Nz`.
3646 Positions offset from p1 are present in the array with the format of:
3649 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
3650 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
3652 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
3653 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
3655 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
3657 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
3660 and the array index for a position p contained completely in p1..p2 is:
3662 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
3664 Note that this is the same "flat 3D array" format as
3665 `PerlinNoiseMap:get3dMap_flat()`.
3666 VoxelArea objects (see section [`VoxelArea`]) can be used to simplify calculation
3667 of the index for a single point in a flat VoxelManip array.
3671 A Content ID is a unique integer identifier for a specific node type.
3672 These IDs are used by VoxelManip in place of the node name string for
3673 `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
3674 `minetest.get_content_id()` to look up the Content ID for the specified node
3675 name, and `minetest.get_name_from_content_id()` to look up the node name string
3676 for a given Content ID.
3677 After registration of a node, its Content ID will remain the same throughout
3678 execution of the mod.
3679 Note that the node being queried needs to have already been been registered.
3681 The following builtin node types have their Content IDs defined as constants:
3683 * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
3684 * `minetest.CONTENT_AIR`: ID for "air" nodes
3685 * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
3687 ### Mapgen VoxelManip objects
3689 Inside of `on_generated()` callbacks, it is possible to retrieve the same
3690 VoxelManip object used by the core's Map Generator (commonly abbreviated
3691 Mapgen). Most of the rules previously described still apply but with a few
3694 * The Mapgen VoxelManip object is retrieved using:
3695 `minetest.get_mapgen_object("voxelmanip")`
3696 * This VoxelManip object already has the region of map just generated loaded
3697 into it; it's not necessary to call `VoxelManip:read_from_map()` before using
3698 a Mapgen VoxelManip.
3699 * The `on_generated()` callbacks of some mods may place individual nodes in the
3700 generated area using non-VoxelManip map modification methods. Because the
3701 same Mapgen VoxelManip object is passed through each `on_generated()`
3702 callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3703 consistency with the current map state. For this reason, calling any of the
3704 following functions:
3705 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3706 will also update the Mapgen VoxelManip object's internal state active on the
3708 * After modifying the Mapgen VoxelManip object's internal buffer, it may be
3709 necessary to update lighting information using either:
3710 `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3712 ### Other API functions operating on a VoxelManip
3714 If any VoxelManip contents were set to a liquid node,
3715 `VoxelManip:update_liquids()` must be called for these liquid nodes to begin
3716 flowing. It is recommended to call this function only after having written all
3717 buffered data back to the VoxelManip object, save for special situations where
3718 the modder desires to only have certain liquid nodes begin flowing.
3720 The functions `minetest.generate_ores()` and `minetest.generate_decorations()`
3721 will generate all registered decorations and ores throughout the full area
3722 inside of the specified VoxelManip object.
3724 `minetest.place_schematic_on_vmanip()` is otherwise identical to
3725 `minetest.place_schematic()`, except instead of placing the specified schematic
3726 directly on the map at the specified position, it will place the schematic
3727 inside the VoxelManip.
3731 * Attempting to read data from a VoxelManip object before map is read will
3732 result in a zero-length array table for `VoxelManip:get_data()`, and an
3733 "ignore" node at any position for `VoxelManip:get_node_at()`.
3734 * If either a region of map has not yet been generated or is out-of-bounds of
3735 the map, that region is filled with "ignore" nodes.
3736 * Other mods, or the core itself, could possibly modify the area of map
3737 currently loaded into a VoxelManip object. With the exception of Mapgen
3738 VoxelManips (see above section), the internal buffers are not updated. For
3739 this reason, it is strongly encouraged to complete the usage of a particular
3740 VoxelManip object in the same callback it had been created.
3741 * If a VoxelManip object will be used often, such as in an `on_generated()`
3742 callback, consider passing a file-scoped table as the optional parameter to
3743 `VoxelManip:get_data()`, which serves as a static buffer the function can use
3744 to write map data to instead of returning a new table each call. This greatly
3745 enhances performance by avoiding unnecessary memory allocations.
3750 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object
3751 containing the region formed by `p1` and `p2`.
3752 * returns actual emerged `pmin`, actual emerged `pmax`
3753 * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to
3755 * **important**: data must be set using `VoxelManip:set_data()` before
3757 * if `light` is true, then lighting is automatically recalculated.
3758 The default value is true.
3759 If `light` is false, no light calculations happen, and you should correct
3760 all modified blocks with `minetest.fix_light()` as soon as possible.
3761 Keep in mind that modifying the map where light is incorrect can cause
3763 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
3764 the `VoxelManip` at that position
3765 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
3767 * `get_data([buffer])`: Retrieves the node content data loaded into the
3768 `VoxelManip` object.
3769 * returns raw node data in the form of an array of node content IDs
3770 * if the param `buffer` is present, this table will be used to store the
3772 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
3773 * `update_map()`: Does nothing, kept for compatibility.
3774 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to
3776 * `light` is a table, `{day=<0...15>, night=<0...15>}`
3777 * To be used only by a `VoxelManip` object from
3778 `minetest.get_mapgen_object`.
3779 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
3781 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
3782 * Returns an array (indices 1 to volume) of integers ranging from `0` to
3784 * Each value is the bitwise combination of day and night light values
3786 * `light = day + (night * 16)`
3787 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
3788 in the `VoxelManip`.
3789 * expects lighting data in the same format that `get_light_data()` returns
3790 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the
3791 `VoxelManip` object.
3792 * Returns an array (indices 1 to volume) of integers ranging from `0` to
3794 * If the param `buffer` is present, this table will be used to store the
3796 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in
3798 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the
3800 * To be used only by a `VoxelManip` object from
3801 `minetest.get_mapgen_object`.
3802 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
3803 area if left out or nil. For almost all uses these should be left out
3804 or nil to use the default.
3805 * `propagate_shadow` is an optional boolean deciding whether shadows in a
3806 generated mapchunk above are propagated down into the mapchunk, defaults
3807 to `true` if left out.
3808 * `update_liquids()`: Update liquid flow
3809 * `was_modified()`: Returns `true` or `false` if the data in the voxel
3810 manipulator had been modified since the last read from map, due to a call to
3811 `minetest.set_data()` on the loaded area elsewhere.
3812 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
3817 A helper class for voxel areas.
3818 It can be created via `VoxelArea:new{MinEdge = pmin, MaxEdge = pmax}`.
3819 The coordinates are *inclusive*, like most other things in Minetest.
3823 * `getExtent()`: returns a 3D vector containing the size of the area formed by
3824 `MinEdge` and `MaxEdge`.
3825 * `getVolume()`: returns the volume of the area formed by `MinEdge` and
3827 * `index(x, y, z)`: returns the index of an absolute position in a flat array
3829 * `x`, `y` and `z` must be integers to avoid an incorrect index result.
3830 * The position (x, y, z) is not checked for being inside the area volume,
3831 being outside can cause an incorrect index result.
3832 * Useful for things like `VoxelManip`, raw Schematic specifiers,
3833 `PerlinNoiseMap:get2d`/`3dMap`, and so on.
3834 * `indexp(p)`: same functionality as `index(x, y, z)` but takes a vector.
3835 * As with `index(x, y, z)`, the components of `p` must be integers, and `p`
3836 is not checked for being inside the area volume.
3837 * `position(i)`: returns the absolute position vector corresponding to index
3839 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by
3840 `MinEdge` and `MaxEdge`.
3841 * `containsp(p)`: same as above, except takes a vector
3842 * `containsi(i)`: same as above, except takes an index `i`
3843 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns
3845 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of
3847 * `iterp(minp, maxp)`: same as above, except takes a vector
3849 ### Y stride and z stride of a flat array
3851 For a particular position in a voxel area, whose flat array index is known,
3852 it is often useful to know the index of a neighboring or nearby position.
3853 The table below shows the changes of index required for 1 node movements along
3854 the axes in a voxel area:
3856 Movement Change of index
3866 local area = VoxelArea:new{MinEdge = emin, MaxEdge = emax}
3868 The values of `ystride` and `zstride` can be obtained using `area.ystride` and
3877 A mapgen object is a construct used in map generation. Mapgen objects can be
3878 used by an `on_generate` callback to speed up operations by avoiding
3879 unnecessary recalculations, these can be retrieved using the
3880 `minetest.get_mapgen_object()` function. If the requested Mapgen object is
3881 unavailable, or `get_mapgen_object()` was called outside of an `on_generate()`
3882 callback, `nil` is returned.
3884 The following Mapgen objects are currently available:
3888 This returns three values; the `VoxelManip` object to be used, minimum and
3889 maximum emerged position, in that order. All mapgens support this object.
3893 Returns an array containing the y coordinates of the ground levels of nodes in
3894 the most recently generated chunk by the current mapgen.
3898 Returns an array containing the biome IDs of nodes in the most recently
3899 generated chunk by the current mapgen.
3903 Returns an array containing the temperature values of nodes in the most
3904 recently generated chunk by the current mapgen.
3908 Returns an array containing the humidity values of nodes in the most recently
3909 generated chunk by the current mapgen.
3913 Returns a table mapping requested generation notification types to arrays of
3914 positions at which the corresponding generated structures are located within
3915 the current chunk. To set the capture of positions of interest to be recorded
3916 on generate, use `minetest.set_gen_notify()`.
3917 For decorations, the returned positions are the ground surface 'place_on'
3918 nodes, not the decorations themselves. A 'simple' type decoration is often 1
3919 node above the returned position and possibly displaced by 'place_offset_y'.
3921 Possible fields of the table returned are:
3927 * `large_cave_begin`
3931 Decorations have a key in the format of `"decoration#id"`, where `id` is the
3932 numeric unique decoration ID as returned by `minetest.get_decoration_id`.
3940 Functions receive a "luaentity" as `self`:
3942 * It has the member `.name`, which is the registered name `("mod:thing")`
3943 * It has the member `.object`, which is an `ObjectRef` pointing to the object
3944 * The original prototype stuff is visible directly via a metatable
3948 * `on_activate(self, staticdata, dtime_s)`
3949 * Called when the object is instantiated.
3950 * `dtime_s` is the time passed since the object was unloaded, which can be
3951 used for updating the entity state.
3952 * `on_step(self, dtime)`
3953 * Called on every server tick, after movement and collision processing.
3954 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
3956 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)`
3957 * Called when somebody punches the object.
3958 * Note that you probably want to handle most punches using the automatic
3960 * `puncher`: an `ObjectRef` (can be `nil`)
3961 * `time_from_last_punch`: Meant for disallowing spamming of clicks
3963 * `tool_capabilities`: capability table of used tool (can be `nil`)
3964 * `dir`: unit vector of direction of punch. Always defined. Points from the
3965 puncher to the punched.
3966 * `damage`: damage that will be done to entity.
3967 * Can return `true` to prevent the default damage mechanism.
3968 * `on_death(self, killer)`
3969 * Called when the object dies.
3970 * `killer`: an `ObjectRef` (can be `nil`)
3971 * `on_rightclick(self, clicker)`
3972 * `on_attach_child(self, child)`
3973 * `child`: an `ObjectRef` of the child that attaches
3974 * `on_detach_child(self, child)`
3975 * `child`: an `ObjectRef` of the child that detaches
3976 * `on_detach(self, parent)`
3977 * `parent`: an `ObjectRef` (can be `nil`) from where it got detached
3978 * This happens before the parent object is removed from the world
3979 * `get_staticdata(self)`
3980 * Should return a string that will be passed to `on_activate` when the
3981 object is instantiated the next time.
3993 axiom, --string initial tree axiom
3994 rules_a, --string rules set A
3995 rules_b, --string rules set B
3996 rules_c, --string rules set C
3997 rules_d, --string rules set D
3998 trunk, --string trunk node name
3999 leaves, --string leaves node name
4000 leaves2, --string secondary leaves node name
4001 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
4002 angle, --num angle in deg
4003 iterations, --num max # of iterations, usually 2 -5
4004 random_level, --num factor to lower nr of iterations, usually 0 - 3
4005 trunk_type, --string single/double/crossed) type of trunk: 1 node,
4006 -- 2x2 nodes or 3x3 in cross shape
4007 thin_branches, --boolean true -> use thin (1 node) branches
4008 fruit, --string fruit node name
4009 fruit_chance, --num chance (0-100) to replace leaves with fruit node
4010 seed, --num random seed, if no seed is provided, the engine
4014 Key for special L-System symbols used in axioms
4015 -----------------------------------------------
4017 * `G`: move forward one unit with the pen up
4018 * `F`: move forward one unit with the pen down drawing trunks and branches
4019 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
4020 * `T`: move forward one unit with the pen down drawing trunks only
4021 * `R`: move forward one unit with the pen down placing fruit
4022 * `A`: replace with rules set A
4023 * `B`: replace with rules set B
4024 * `C`: replace with rules set C
4025 * `D`: replace with rules set D
4026 * `a`: replace with rules set A, chance 90%
4027 * `b`: replace with rules set B, chance 80%
4028 * `c`: replace with rules set C, chance 70%
4029 * `d`: replace with rules set D, chance 60%
4030 * `+`: yaw the turtle right by `angle` parameter
4031 * `-`: yaw the turtle left by `angle` parameter
4032 * `&`: pitch the turtle down by `angle` parameter
4033 * `^`: pitch the turtle up by `angle` parameter
4034 * `/`: roll the turtle to the right by `angle` parameter
4035 * `*`: roll the turtle to the left by `angle` parameter
4036 * `[`: save in stack current state info
4037 * `]`: recover from stack state info
4042 Spawn a small apple tree:
4044 pos = {x=230,y=20,z=4}
4047 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
4048 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
4049 trunk="default:tree",
4050 leaves="default:leaves",
4054 trunk_type="single",
4057 fruit="default:apple"
4059 minetest.spawn_tree(pos,apple_tree)
4064 'minetest' namespace reference
4065 ==============================
4070 * `minetest.get_current_modname()`: returns the currently loading mod's name,
4072 * `minetest.get_modpath(modname)`: returns e.g.
4073 `"/home/user/.minetest/usermods/modname"`.
4074 * Useful for loading additional `.lua` modules or static data from mod
4075 * `minetest.get_modnames()`: returns a list of installed mods
4076 * Return a list of installed mods, sorted alphabetically
4077 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
4078 * Useful for storing custom data
4079 * `minetest.is_singleplayer()`
4080 * `minetest.features`: Table containing API feature flags
4083 glasslike_framed = true, -- 0.4.7
4084 nodebox_as_selectionbox = true, -- 0.4.7
4085 get_all_craft_recipes_works = true, -- 0.4.7
4086 -- The transparency channel of textures can optionally be used on
4088 use_texture_alpha = true,
4089 -- Tree and grass ABMs are no longer done from C++ (0.4.8)
4090 no_legacy_abms = true,
4091 -- Texture grouping is possible using parentheses (0.4.11)
4092 texture_names_parens = true,
4093 -- Unique Area ID for AreaStore:insert_area (0.4.14)
4094 area_store_custom_ids = true,
4095 -- add_entity supports passing initial staticdata to on_activate
4097 add_entity_with_staticdata = true,
4098 -- Chat messages are no longer predicted (0.4.16)
4099 no_chat_message_prediction = true,
4100 -- The transparency channel of textures can optionally be used on
4101 -- objects (ie: players and lua entities) (5.0.0)
4102 object_use_texture_alpha = true,
4103 -- Object selectionbox is settable independently from collisionbox
4105 object_independent_selectionbox = true,
4106 -- Specifies whether binary data can be uploaded or downloaded using
4107 -- the HTTP API (5.1.0)
4108 httpfetch_binary_data = true,
4109 -- Whether formspec_version[<version>] may be used (5.1.0)
4110 formspec_version_element = true,
4111 -- Whether AreaStore's IDs are kept on save/load (5.1.0)
4112 area_store_persistent_ids = true,
4113 -- Whether minetest.find_path is functional (5.2.0)
4114 pathfinder_works = true,
4117 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
4118 * `arg`: string or table in format `{foo=true, bar=true}`
4119 * `missing_features`: `{foo=true, bar=true}`
4120 * `minetest.get_player_information(player_name)`: Table containing information
4121 about a player. Example return value:
4124 address = "127.0.0.1", -- IP address of client
4125 ip_version = 4, -- IPv4 / IPv6
4126 min_rtt = 0.01, -- minimum round trip time
4127 max_rtt = 0.2, -- maximum round trip time
4128 avg_rtt = 0.02, -- average round trip time
4129 min_jitter = 0.01, -- minimum packet time jitter
4130 max_jitter = 0.5, -- maximum packet time jitter
4131 avg_jitter = 0.03, -- average packet time jitter
4132 connection_uptime = 200, -- seconds since client connected
4133 protocol_version = 32, -- protocol version used by client
4134 formspec_version = 2, -- supported formspec version
4135 -- following information is available on debug build only!!!
4136 -- DO NOT USE IN MODS
4137 --ser_vers = 26, -- serialization version used by client
4138 --major = 0, -- major version number
4139 --minor = 4, -- minor version number
4140 --patch = 10, -- patch version number
4141 --vers_string = "0.4.9-git", -- full version string
4142 --state = "Active" -- current client state
4145 * `minetest.mkdir(path)`: returns success.
4146 * Creates a directory specified by `path`, creating parent directories
4147 if they don't exist.
4148 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
4150 * nil: return all entries,
4151 * true: return only subdirectory names, or
4152 * false: return only file names.
4153 * `minetest.safe_file_write(path, content)`: returns boolean indicating success
4154 * Replaces contents of file at path with new contents in a safe (atomic)
4155 way. Use this instead of below code when writing e.g. database files:
4156 `local f = io.open(path, "wb"); f:write(content); f:close()`
4157 * `minetest.get_version()`: returns a table containing components of the
4158 engine version. Components:
4159 * `project`: Name of the project, eg, "Minetest"
4160 * `string`: Simple version, eg, "1.2.3-dev"
4161 * `hash`: Full git version (only set if available),
4162 eg, "1.2.3-dev-01234567-dirty".
4163 Use this for informational purposes only. The information in the returned
4164 table does not represent the capabilities of the engine, nor is it
4165 reliable or verifiable. Compatible forks will have a different name and
4166 version entirely. To check for the presence of engine features, test
4167 whether the functions exported by the wanted features exist. For example:
4168 `if minetest.check_for_falling then ... end`.
4169 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
4170 * `data`: string of data to hash
4171 * `raw`: return raw bytes instead of hex digits, default: false
4176 * `minetest.debug(...)`
4177 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
4178 * `minetest.log([level,] text)`
4179 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
4180 `"info"`, or `"verbose"`. Default is `"none"`.
4182 Registration functions
4183 ----------------------
4185 Call these functions only at load time!
4189 * `minetest.register_node(name, node definition)`
4190 * `minetest.register_craftitem(name, item definition)`
4191 * `minetest.register_tool(name, item definition)`
4192 * `minetest.override_item(name, redefinition)`
4193 * Overrides fields of an item registered with register_node/tool/craftitem.
4194 * Note: Item must already be defined, (opt)depend on the mod defining it.
4195 * Example: `minetest.override_item("default:mese",
4196 {light_source=minetest.LIGHT_MAX})`
4197 * `minetest.unregister_item(name)`
4198 * Unregisters the item from the engine, and deletes the entry with key
4199 `name` from `minetest.registered_items` and from the associated item table
4200 according to its nature: `minetest.registered_nodes`, etc.
4201 * `minetest.register_entity(name, entity definition)`
4202 * `minetest.register_abm(abm definition)`
4203 * `minetest.register_lbm(lbm definition)`
4204 * `minetest.register_alias(alias, original_name)`
4205 * Also use this to set the 'mapgen aliases' needed in a game for the core
4206 mapgens. See [Mapgen aliases] section above.
4207 * `minetest.register_alias_force(alias, original_name)`
4208 * `minetest.register_ore(ore definition)`
4209 * Returns an integer object handle uniquely identifying the registered
4211 * The order of ore registrations determines the order of ore generation.
4212 * `minetest.register_biome(biome definition)`
4213 * Returns an integer object handle uniquely identifying the registered
4214 biome on success. To get the biome ID, use `minetest.get_biome_id`.
4215 * `minetest.unregister_biome(name)`
4216 * Unregisters the biome from the engine, and deletes the entry with key
4217 `name` from `minetest.registered_biomes`.
4218 * Warning: This alters the biome to biome ID correspondences, so any
4219 decorations or ores using the 'biomes' field must afterwards be cleared
4221 * `minetest.register_decoration(decoration definition)`
4222 * Returns an integer object handle uniquely identifying the registered
4223 decoration on success. To get the decoration ID, use
4224 `minetest.get_decoration_id`.
4225 * The order of decoration registrations determines the order of decoration
4227 * `minetest.register_schematic(schematic definition)`
4228 * Returns an integer object handle uniquely identifying the registered
4229 schematic on success.
4230 * If the schematic is loaded from a file, the `name` field is set to the
4232 * If the function is called when loading the mod, and `name` is a relative
4233 path, then the current mod path will be prepended to the schematic
4235 * `minetest.clear_registered_biomes()`
4236 * Clears all biomes currently registered.
4237 * Warning: Clearing and re-registering biomes alters the biome to biome ID
4238 correspondences, so any decorations or ores using the 'biomes' field must
4239 afterwards be cleared and re-registered.
4240 * `minetest.clear_registered_decorations()`
4241 * Clears all decorations currently registered.
4242 * `minetest.clear_registered_ores()`
4243 * Clears all ores currently registered.
4244 * `minetest.clear_registered_schematics()`
4245 * Clears all schematics currently registered.
4249 * `minetest.register_craft(recipe)`
4250 * Check recipe table syntax for different types below.
4251 * `minetest.clear_craft(recipe)`
4252 * Will erase existing craft based either on output item or on input recipe.
4253 * Specify either output or input only. If you specify both, input will be
4254 ignored. For input use the same recipe table syntax as for
4255 `minetest.register_craft(recipe)`. For output specify only the item,
4257 * Returns false if no erase candidate could be found, otherwise returns true.
4258 * **Warning**! The type field ("shaped", "cooking" or any other) will be
4259 ignored if the recipe contains output. Erasing is then done independently
4260 from the crafting method.
4261 * `minetest.register_chatcommand(cmd, chatcommand definition)`
4262 * `minetest.override_chatcommand(name, redefinition)`
4263 * Overrides fields of a chatcommand registered with `register_chatcommand`.
4264 * `minetest.unregister_chatcommand(name)`
4265 * Unregisters a chatcommands registered with `register_chatcommand`.
4266 * `minetest.register_privilege(name, definition)`
4267 * `definition` can be a description or a definition table (see [Privilege
4269 * If it is a description, the priv will be granted to singleplayer and admin
4271 * To allow players with `basic_privs` to grant, see the `basic_privs`
4272 minetest.conf setting.
4273 * `minetest.register_authentication_handler(authentication handler definition)`
4274 * Registers an auth handler that overrides the builtin one.
4275 * This function can be called by a single mod once only.
4277 Global callback registration functions
4278 --------------------------------------
4280 Call these functions only at load time!
4282 * `minetest.register_globalstep(function(dtime))`
4283 * Called every server step, usually interval of 0.1s
4284 * `minetest.register_on_mods_loaded(function())`
4285 * Called after mods have finished loading and before the media is cached or the
4287 * `minetest.register_on_shutdown(function())`
4288 * Called before server shutdown
4289 * **Warning**: If the server terminates abnormally (i.e. crashes), the
4290 registered callbacks **will likely not be run**. Data should be saved at
4291 semi-frequent intervals as well as on server shutdown.
4292 * `minetest.register_on_placenode(function(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
4293 * Called when a node has been placed
4294 * If return `true` no item is taken from `itemstack`
4295 * `placer` may be any valid ObjectRef or nil.
4296 * **Not recommended**; use `on_construct` or `after_place_node` in node
4297 definition whenever possible.
4298 * `minetest.register_on_dignode(function(pos, oldnode, digger))`
4299 * Called when a node has been dug.
4300 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node
4301 definition whenever possible.
4302 * `minetest.register_on_punchnode(function(pos, node, puncher, pointed_thing))`
4303 * Called when a node is punched
4304 * `minetest.register_on_generated(function(minp, maxp, blockseed))`
4305 * Called after generating a piece of world. Modifying nodes inside the area
4306 is a bit faster than usually.
4307 * `minetest.register_on_newplayer(function(ObjectRef))`
4308 * Called after a new player has been created
4309 * `minetest.register_on_punchplayer(function(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
4310 * Called when a player is punched
4311 * Note: This callback is invoked even if the punched player is dead.
4312 * `player`: ObjectRef - Player that was punched
4313 * `hitter`: ObjectRef - Player that hit
4314 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4316 * `tool_capabilities`: Capability table of used tool (can be nil)
4317 * `dir`: Unit vector of direction of punch. Always defined. Points from
4318 the puncher to the punched.
4319 * `damage`: Number that represents the damage calculated by the engine
4320 * should return `true` to prevent the default damage mechanism
4321 * `minetest.register_on_player_hpchange(function(player, hp_change, reason), modifier)`
4322 * Called when the player gets damaged or healed
4323 * `player`: ObjectRef of the player
4324 * `hp_change`: the amount of change. Negative when it is damage.
4325 * `reason`: a PlayerHPChangeReason table.
4326 * The `type` field will have one of the following values:
4327 * `set_hp`: A mod or the engine called `set_hp` without
4328 giving a type - use this for custom damage types.
4329 * `punch`: Was punched. `reason.object` will hold the puncher, or nil if none.
4331 * `node_damage`: `damage_per_second` from a neighbouring node.
4332 `reason.node` will hold the node name or nil.
4335 * Any of the above types may have additional fields from mods.
4336 * `reason.from` will be `mod` or `engine`.
4337 * `modifier`: when true, the function should return the actual `hp_change`.
4338 Note: modifiers only get a temporary `hp_change` that can be modified by later modifiers.
4339 Modifiers can return true as a second argument to stop the execution of further functions.
4340 Non-modifiers receive the final HP change calculated by the modifiers.
4341 * `minetest.register_on_dieplayer(function(ObjectRef, reason))`
4342 * Called when a player dies
4343 * `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
4344 * `minetest.register_on_respawnplayer(function(ObjectRef))`
4345 * Called when player is to be respawned
4346 * Called _before_ repositioning of player occurs
4347 * return true in func to disable regular player placement
4348 * `minetest.register_on_prejoinplayer(function(name, ip))`
4349 * Called before a player joins the game
4350 * If it returns a string, the player is disconnected with that string as
4352 * `minetest.register_on_joinplayer(function(ObjectRef))`
4353 * Called when a player joins the game
4354 * `minetest.register_on_leaveplayer(function(ObjectRef, timed_out))`
4355 * Called when a player leaves the game
4356 * `timed_out`: True for timeout, false for other reasons.
4357 * `minetest.register_on_auth_fail(function(name, ip))`
4358 * Called when a client attempts to log into an account but supplies the
4360 * `ip`: The IP address of the client.
4361 * `name`: The account the client attempted to log into.
4362 * `minetest.register_on_cheat(function(ObjectRef, cheat))`
4363 * Called when a player cheats
4364 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
4366 * `interacted_too_far`
4367 * `interacted_while_dead`
4368 * `finished_unknown_dig`
4371 * `minetest.register_on_chat_message(function(name, message))`
4372 * Called always when a player says something
4373 * Return `true` to mark the message as handled, which means that it will
4374 not be sent to other players.
4375 * `minetest.register_on_player_receive_fields(function(player, formname, fields))`
4376 * Called when the server received input from `player` in a formspec with
4377 the given `formname`. Specifically, this is called on any of the
4379 * a button was pressed,
4380 * Enter was pressed while the focus was on a text field
4381 * a checkbox was toggled,
4382 * something was selecteed in a drop-down list,
4383 * a different tab was selected,
4384 * selection was changed in a textlist or table,
4385 * an entry was double-clicked in a textlist or table,
4386 * a scrollbar was moved, or
4387 * the form was actively closed by the player.
4388 * Fields are sent for formspec elements which define a field. `fields`
4389 is a table containing each formspecs element value (as string), with
4390 the `name` parameter as index for each. The value depends on the
4391 formspec element type:
4392 * `animated_image`: Returns the index of the current frame.
4393 * `button` and variants: If pressed, contains the user-facing button
4394 text as value. If not pressed, is `nil`
4395 * `field`, `textarea` and variants: Text in the field
4396 * `dropdown`: Text of selected item
4397 * `tabheader`: Tab index, starting with `"1"` (only if tab changed)
4398 * `checkbox`: `"true"` if checked, `"false"` if unchecked
4399 * `textlist`: See `minetest.explode_textlist_event`
4400 * `table`: See `minetest.explode_table_event`
4401 * `scrollbar`: See `minetest.explode_scrollbar_event`
4402 * Special case: `["quit"]="true"` is sent when the user actively
4403 closed the form by mouse click, keypress or through a button_exit[]
4405 * Special case: `["key_enter"]="true"` is sent when the user pressed
4406 the Enter key and the focus was either nowhere (causing the formspec
4407 to be closed) or on a button. If the focus was on a text field,
4408 additionally, the index `key_enter_field` contains the name of the
4409 text field. See also: `field_close_on_enter`.
4410 * Newest functions are called first
4411 * If function returns `true`, remaining functions are not called
4412 * `minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv))`
4413 * Called when `player` crafts something
4414 * `itemstack` is the output
4415 * `old_craft_grid` contains the recipe (Note: the one in the inventory is
4417 * `craft_inv` is the inventory with the crafting grid
4418 * Return either an `ItemStack`, to replace the output, or `nil`, to not
4420 * `minetest.register_craft_predict(function(itemstack, player, old_craft_grid, craft_inv))`
4421 * The same as before, except that it is called before the player crafts, to
4422 make craft prediction, and it should not change anything.
4423 * `minetest.register_allow_player_inventory_action(function(player, action, inventory, inventory_info))`
4424 * Determinates how much of a stack may be taken, put or moved to a
4426 * `player` (type `ObjectRef`) is the player who modified the inventory
4427 `inventory` (type `InvRef`).
4428 * List of possible `action` (string) values and their
4429 `inventory_info` (table) contents:
4430 * `move`: `{from_list=string, to_list=string, from_index=number, to_index=number, count=number}`
4431 * `put`: `{listname=string, index=number, stack=ItemStack}`
4432 * `take`: Same as `put`
4433 * Return a numeric value to limit the amount of items to be taken, put or
4434 moved. A value of `-1` for `take` will make the source stack infinite.
4435 * `minetest.register_on_player_inventory_action(function(player, action, inventory, inventory_info))`
4436 * Called after a take, put or move event from/to/in a player inventory
4437 * Function arguments: see `minetest.register_allow_player_inventory_action`
4438 * Does not accept or handle any return value.
4439 * `minetest.register_on_protection_violation(function(pos, name))`
4440 * Called by `builtin` and mods when a player violates protection at a
4441 position (eg, digs a node or punches a protected entity).
4442 * The registered functions can be called using
4443 `minetest.record_protection_violation`.
4444 * The provided function should check that the position is protected by the
4445 mod calling this function before it prints a message, if it does, to
4446 allow for multiple protection mods.
4447 * `minetest.register_on_item_eat(function(hp_change, replace_with_item, itemstack, user, pointed_thing))`
4448 * Called when an item is eaten, by `minetest.item_eat`
4449 * Return `itemstack` to cancel the default item eat response (i.e.: hp increase).
4450 * `minetest.register_on_priv_grant(function(name, granter, priv))`
4451 * Called when `granter` grants the priv `priv` to `name`.
4452 * Note that the callback will be called twice if it's done by a player,
4453 once with granter being the player name, and again with granter being nil.
4454 * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
4455 * Called when `revoker` revokes the priv `priv` from `name`.
4456 * Note that the callback will be called twice if it's done by a player,
4457 once with revoker being the player name, and again with revoker being nil.
4458 * `minetest.register_can_bypass_userlimit(function(name, ip))`
4459 * Called when `name` user connects with `ip`.
4460 * Return `true` to by pass the player limit
4461 * `minetest.register_on_modchannel_message(function(channel_name, sender, message))`
4462 * Called when an incoming mod channel message is received
4463 * You should have joined some channels to receive events.
4464 * If message comes from a server mod, `sender` field is an empty string.
4469 * `minetest.settings`: Settings object containing all of the settings from the
4470 main config file (`minetest.conf`).
4471 * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
4472 parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
4477 * `minetest.string_to_privs(str[, delim])`:
4478 * Converts string representation of privs into table form
4479 * `delim`: String separating the privs. Defaults to `","`.
4480 * Returns `{ priv1 = true, ... }`
4481 * `minetest.privs_to_string(privs[, delim])`:
4482 * Returns the string representation of `privs`
4483 * `delim`: String to delimit privs. Defaults to `","`.
4484 * `minetest.get_player_privs(name) -> {priv1=true,...}`
4485 * `minetest.check_player_privs(player_or_name, ...)`:
4486 returns `bool, missing_privs`
4487 * A quickhand for checking privileges.
4488 * `player_or_name`: Either a Player object or the name of a player.
4489 * `...` is either a list of strings, e.g. `"priva", "privb"` or
4490 a table, e.g. `{ priva = true, privb = true }`.
4492 * `minetest.check_password_entry(name, entry, password)`
4493 * Returns true if the "password entry" for a player with name matches given
4494 password, false otherwise.
4495 * The "password entry" is the password representation generated by the
4496 engine as returned as part of a `get_auth()` call on the auth handler.
4497 * Only use this function for making it possible to log in via password from
4498 external protocols such as IRC, other uses are frowned upon.
4499 * `minetest.get_password_hash(name, raw_password)`
4500 * Convert a name-password pair to a password hash that Minetest can use.
4501 * The returned value alone is not a good basis for password checks based
4502 on comparing the password hash in the database with the password hash
4503 from the function, with an externally provided password, as the hash
4504 in the db might use the new SRP verifier format.
4505 * For this purpose, use `minetest.check_password_entry` instead.
4506 * `minetest.get_player_ip(name)`: returns an IP address string for the player
4508 * The player needs to be online for this to be successful.
4510 * `minetest.get_auth_handler()`: Return the currently active auth handler
4511 * See the [Authentication handler definition]
4512 * Use this to e.g. get the authentication data for a player:
4513 `local auth_data = minetest.get_auth_handler().get_auth(playername)`
4514 * `minetest.notify_authentication_modified(name)`
4515 * Must be called by the authentication handler for privilege changes.
4516 * `name`: string; if omitted, all auth data should be considered modified
4517 * `minetest.set_player_password(name, password_hash)`: Set password hash of
4519 * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player
4521 * `minetest.auth_reload()`
4522 * See `reload()` in authentication handler definition
4524 `minetest.set_player_password`, `minetest.set_player_privs`,
4525 `minetest.get_player_privs` and `minetest.auth_reload` call the authentication
4531 * `minetest.chat_send_all(text)`
4532 * `minetest.chat_send_player(name, text)`
4533 * `minetest.format_chat_message(name, message)`
4534 * Used by the server to format a chat message, based on the setting `chat_message_format`.
4535 Refer to the documentation of the setting for a list of valid placeholders.
4536 * Takes player name and message, and returns the formatted string to be sent to players.
4537 * Can be redefined by mods if required, for things like colored names or messages.
4538 * **Only** the first occurrence of each placeholder will be replaced.
4543 * `minetest.set_node(pos, node)`
4544 * `minetest.add_node(pos, node)`: alias to `minetest.set_node`
4545 * Set node at position `pos`
4546 * `node`: table `{name=string, param1=number, param2=number}`
4547 * If param1 or param2 is omitted, it's set to `0`.
4548 * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
4549 * `minetest.bulk_set_node({pos1, pos2, pos3, ...}, node)`
4550 * Set node on all positions set in the first argument.
4551 * e.g. `minetest.bulk_set_node({{x=0, y=1, z=1}, {x=1, y=2, z=2}}, {name="default:stone"})`
4552 * For node specification or position syntax see `minetest.set_node` call
4553 * Faster than set_node due to single call, but still considerably slower
4554 than Lua Voxel Manipulators (LVM) for large numbers of nodes.
4555 Unlike LVMs, this will call node callbacks. It also allows setting nodes
4556 in spread out positions which would cause LVMs to waste memory.
4557 For setting a cube, this is 1.3x faster than set_node whereas LVM is 20
4559 * `minetest.swap_node(pos, node)`
4560 * Set node at position, but don't remove metadata
4561 * `minetest.remove_node(pos)`
4562 * By default it does the same as `minetest.set_node(pos, {name="air"})`
4563 * `minetest.get_node(pos)`
4564 * Returns the node at the given position as table in the format
4565 `{name="node_name", param1=0, param2=0}`,
4566 returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
4567 * `minetest.get_node_or_nil(pos)`
4568 * Same as `get_node` but returns `nil` for unloaded areas.
4569 * `minetest.get_node_light(pos, timeofday)`
4570 * Gets the light value at the given position. Note that the light value
4571 "inside" the node at the given position is returned, so you usually want
4572 to get the light value of a neighbor.
4573 * `pos`: The position where to measure the light.
4574 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
4575 * Returns a number between `0` and `15` or `nil`
4576 * `minetest.place_node(pos, node)`
4577 * Place node with the same effects that a player would cause
4578 * `minetest.dig_node(pos)`
4579 * Dig node with the same effects that a player would cause
4580 * Returns `true` if successful, `false` on failure (e.g. protected location)
4581 * `minetest.punch_node(pos)`
4582 * Punch node with the same effects that a player would cause
4583 * `minetest.spawn_falling_node(pos)`
4584 * Change node into falling node
4585 * Returns `true` if successful, `false` on failure
4587 * `minetest.find_nodes_with_meta(pos1, pos2)`
4588 * Get a table of positions of nodes that have metadata within a region
4590 * `minetest.get_meta(pos)`
4591 * Get a `NodeMetaRef` at that position
4592 * `minetest.get_node_timer(pos)`
4593 * Get `NodeTimerRef`
4595 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at
4597 * Returns `ObjectRef`, or `nil` if failed
4598 * `minetest.add_item(pos, item)`: Spawn item
4599 * Returns `ObjectRef`, or `nil` if failed
4600 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
4601 * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of
4603 * `radius`: using an euclidean metric
4604 * `minetest.set_timeofday(val)`
4605 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
4606 * `minetest.get_timeofday()`
4607 * `minetest.get_gametime()`: returns the time, in seconds, since the world was
4609 * `minetest.get_day_count()`: returns number days elapsed since world was
4611 * accounts for time changes.
4612 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns
4614 * `radius`: using a maximum metric
4615 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4616 * `search_center` is an optional boolean (default: `false`)
4617 If true `pos` is also checked for the nodes
4618 * `minetest.find_nodes_in_area(pos1, pos2, nodenames)`: returns a list of
4620 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4621 * First return value: Table with all node positions
4622 * Second return value: Table with the count of each node with the node name
4624 * Area volume is limited to 4,096,000 nodes
4625 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
4627 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4628 * Return value: Table with all node positions with a node air above
4629 * Area volume is limited to 4,096,000 nodes
4630 * `minetest.get_perlin(noiseparams)`
4631 * `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
4632 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
4633 * `minetest.get_voxel_manip([pos1, pos2])`
4634 * Return voxel manipulator object.
4635 * Loads the manipulator from the map if positions are passed.
4636 * `minetest.set_gen_notify(flags, {deco_ids})`
4637 * Set the types of on-generate notifications that should be collected.
4638 * `flags` is a flag field with the available flags:
4646 * The second parameter is a list of IDs of decorations which notification
4648 * `minetest.get_gen_notify()`
4649 * Returns a flagstring and a table with the `deco_id`s.
4650 * `minetest.get_decoration_id(decoration_name)`
4651 * Returns the decoration ID number for the provided decoration name string,
4652 or `nil` on failure.
4653 * `minetest.get_mapgen_object(objectname)`
4654 * Return requested mapgen object if available (see [Mapgen objects])
4655 * `minetest.get_heat(pos)`
4656 * Returns the heat at the position, or `nil` on failure.
4657 * `minetest.get_humidity(pos)`
4658 * Returns the humidity at the position, or `nil` on failure.
4659 * `minetest.get_biome_data(pos)`
4660 * Returns a table containing:
4661 * `biome` the biome id of the biome at that position
4662 * `heat` the heat at the position
4663 * `humidity` the humidity at the position
4664 * Or returns `nil` on failure.
4665 * `minetest.get_biome_id(biome_name)`
4666 * Returns the biome id, as used in the biomemap Mapgen object and returned
4667 by `minetest.get_biome_data(pos)`, for a given biome_name string.
4668 * `minetest.get_biome_name(biome_id)`
4669 * Returns the biome name string for the provided biome id, or `nil` on
4671 * If no biomes have been registered, such as in mgv6, returns `default`.
4672 * `minetest.get_mapgen_params()`
4673 * Deprecated: use `minetest.get_mapgen_setting(name)` instead.
4674 * Returns a table containing:
4680 * `minetest.set_mapgen_params(MapgenParams)`
4681 * Deprecated: use `minetest.set_mapgen_setting(name, value, override)`
4683 * Set map generation parameters.
4684 * Function cannot be called after the registration period; only
4685 initialization and `on_mapgen_init`.
4686 * Takes a table as an argument with the fields:
4692 * Leave field unset to leave that parameter unchanged.
4693 * `flags` contains a comma-delimited string of flags to set, or if the
4694 prefix `"no"` is attached, clears instead.
4695 * `flags` is in the same format and has the same options as `mg_flags` in
4697 * `minetest.get_mapgen_setting(name)`
4698 * Gets the *active* mapgen setting (or nil if none exists) in string
4699 format with the following order of precedence:
4700 1) Settings loaded from map_meta.txt or overrides set during mod
4702 2) Settings set by mods without a metafile override
4703 3) Settings explicitly set in the user config file, minetest.conf
4704 4) Settings set as the user config default
4705 * `minetest.get_mapgen_setting_noiseparams(name)`
4706 * Same as above, but returns the value as a NoiseParams table if the
4707 setting `name` exists and is a valid NoiseParams.
4708 * `minetest.set_mapgen_setting(name, value, [override_meta])`
4709 * Sets a mapgen param to `value`, and will take effect if the corresponding
4710 mapgen setting is not already present in map_meta.txt.
4711 * `override_meta` is an optional boolean (default: `false`). If this is set
4712 to true, the setting will become the active setting regardless of the map
4714 * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`.
4715 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
4716 * Same as above, except value is a NoiseParams table.
4717 * `minetest.set_noiseparams(name, noiseparams, set_default)`
4718 * Sets the noiseparams setting of `name` to the noiseparams table specified
4720 * `set_default` is an optional boolean (default: `true`) that specifies
4721 whether the setting should be applied to the default config or current
4723 * `minetest.get_noiseparams(name)`
4724 * Returns a table of the noiseparams for name.
4725 * `minetest.generate_ores(vm, pos1, pos2)`
4726 * Generate all registered ores within the VoxelManip `vm` and in the area
4727 from `pos1` to `pos2`.
4728 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
4729 * `minetest.generate_decorations(vm, pos1, pos2)`
4730 * Generate all registered decorations within the VoxelManip `vm` and in the
4731 area from `pos1` to `pos2`.
4732 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
4733 * `minetest.clear_objects([options])`
4734 * Clear all objects in the environment
4735 * Takes an optional table as an argument with the field `mode`.
4736 * mode = `"full"` : Load and go through every mapblock, clearing
4738 * mode = `"quick"`: Clear objects immediately in loaded mapblocks,
4739 clear objects in unloaded mapblocks only when the
4740 mapblocks are next activated.
4741 * `minetest.load_area(pos1[, pos2])`
4742 * Load the mapblocks containing the area from `pos1` to `pos2`.
4743 `pos2` defaults to `pos1` if not specified.
4744 * This function does not trigger map generation.
4745 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
4746 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be
4747 asynchronously fetched from memory, loaded from disk, or if inexistent,
4749 * If `callback` is a valid Lua function, this will be called for each block
4751 * The function signature of callback is:
4752 `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
4753 * `blockpos` is the *block* coordinates of the block that had been
4755 * `action` could be one of the following constant values:
4756 * `minetest.EMERGE_CANCELLED`
4757 * `minetest.EMERGE_ERRORED`
4758 * `minetest.EMERGE_FROM_MEMORY`
4759 * `minetest.EMERGE_FROM_DISK`
4760 * `minetest.EMERGE_GENERATED`
4761 * `calls_remaining` is the number of callbacks to be expected after
4763 * `param` is the user-defined parameter passed to emerge_area (or
4764 nil if the parameter was absent).
4765 * `minetest.delete_area(pos1, pos2)`
4766 * delete all mapblocks in the area from pos1 to pos2, inclusive
4767 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
4768 * Checks if there is anything other than air between pos1 and pos2.
4769 * Returns false if something is blocking the sight.
4770 * Returns the position of the blocking node when `false`
4771 * `pos1`: First position
4772 * `pos2`: Second position
4773 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
4774 * Creates a `Raycast` object.
4775 * `pos1`: start of the ray
4776 * `pos2`: end of the ray
4777 * `objects`: if false, only nodes will be returned. Default is `true`.
4778 * `liquids`: if false, liquid nodes won't be returned. Default is `false`.
4779 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
4780 * returns table containing path that can be walked on
4781 * returns a table of 3D points representing a path from `pos1` to `pos2` or
4783 * Reasons for failure:
4784 * No path exists at all
4785 * No path exists within `searchdistance` (see below)
4786 * Start or end pos is buried in land
4787 * `pos1`: start position
4788 * `pos2`: end position
4789 * `searchdistance`: maximum distance from the search positions to search in.
4790 In detail: Path must be completely inside a cuboid. The minimum
4791 `searchdistance` of 1 will confine search between `pos1` and `pos2`.
4792 Larger values will increase the size of this cuboid in all directions
4793 * `max_jump`: maximum height difference to consider walkable
4794 * `max_drop`: maximum height difference to consider droppable
4795 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`.
4796 Difference between `"A*"` and `"A*_noprefetch"` is that
4797 `"A*"` will pre-calculate the cost-data, the other will calculate it
4799 * `minetest.spawn_tree (pos, {treedef})`
4800 * spawns L-system tree at given `pos` with definition in `treedef` table
4801 * `minetest.transforming_liquid_add(pos)`
4802 * add node to liquid update queue
4803 * `minetest.get_node_max_level(pos)`
4804 * get max available level for leveled node
4805 * `minetest.get_node_level(pos)`
4806 * get level of leveled node (water, snow)
4807 * `minetest.set_node_level(pos, level)`
4808 * set level of leveled node, default `level` equals `1`
4809 * if `totallevel > maxlevel`, returns rest (`total-max`).
4810 * `minetest.add_node_level(pos, level)`
4811 * increase level of leveled node by level, default `level` equals `1`
4812 * if `totallevel > maxlevel`, returns rest (`total-max`)
4813 * can be negative for decreasing
4814 * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
4815 * resets the light in a cuboid-shaped part of
4816 the map and removes lighting bugs.
4817 * Loads the area if it is not loaded.
4818 * `pos1` is the corner of the cuboid with the least coordinates
4819 (in node coordinates), inclusive.
4820 * `pos2` is the opposite corner of the cuboid, inclusive.
4821 * The actual updated cuboid might be larger than the specified one,
4822 because only whole map blocks can be updated.
4823 The actual updated area consists of those map blocks that intersect
4824 with the given cuboid.
4825 * However, the neighborhood of the updated area might change
4826 as well, as light can spread out of the cuboid, also light
4828 * returns `false` if the area is not fully generated,
4830 * `minetest.check_single_for_falling(pos)`
4831 * causes an unsupported `group:falling_node` node to fall and causes an
4832 unattached `group:attached_node` node to fall.
4833 * does not spread these updates to neighbours.
4834 * `minetest.check_for_falling(pos)`
4835 * causes an unsupported `group:falling_node` node to fall and causes an
4836 unattached `group:attached_node` node to fall.
4837 * spread these updates to neighbours and can cause a cascade
4839 * `minetest.get_spawn_level(x, z)`
4840 * Returns a player spawn y co-ordinate for the provided (x, z)
4841 co-ordinates, or `nil` for an unsuitable spawn point.
4842 * For most mapgens a 'suitable spawn point' is one with y between
4843 `water_level` and `water_level + 16`, and in mgv7 well away from rivers,
4844 so `nil` will be returned for many (x, z) co-ordinates.
4845 * The spawn level returned is for a player spawn in unmodified terrain.
4846 * The spawn level is intentionally above terrain level to cope with
4847 full-node biome 'dust' nodes.
4852 You can find mod channels communication scheme in `doc/mod_channels.png`.
4854 * `minetest.mod_channel_join(channel_name)`
4855 * Server joins channel `channel_name`, and creates it if necessary. You
4856 should listen for incoming messages with
4857 `minetest.register_on_modchannel_message`
4862 `minetest.get_inventory(location)`: returns an `InvRef`
4865 * `{type="player", name="celeron55"}`
4866 * `{type="node", pos={x=, y=, z=}}`
4867 * `{type="detached", name="creative"}`
4868 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns
4870 * `callbacks`: See [Detached inventory callbacks]
4871 * `player_name`: Make detached inventory available to one player
4872 exclusively, by default they will be sent to every player (even if not
4874 Note that this parameter is mostly just a workaround and will be removed
4876 * Creates a detached inventory. If it already exists, it is cleared.
4877 * `minetest.remove_detached_inventory(name)`
4878 * Returns a `boolean` indicating whether the removal succeeded.
4879 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
4880 returns left over ItemStack.
4881 * See `minetest.item_eat` and `minetest.register_on_item_eat`
4886 * `minetest.show_formspec(playername, formname, formspec)`
4887 * `playername`: name of player to show formspec
4888 * `formname`: name passed to `on_player_receive_fields` callbacks.
4889 It should follow the `"modname:<whatever>"` naming convention
4890 * `formspec`: formspec to display
4891 * `minetest.close_formspec(playername, formname)`
4892 * `playername`: name of player to close formspec
4893 * `formname`: has to exactly match the one given in `show_formspec`, or the
4894 formspec will not close.
4895 * calling `show_formspec(playername, formname, "")` is equal to this
4897 * to close a formspec regardless of the formname, call
4898 `minetest.close_formspec(playername, "")`.
4899 **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
4900 * `minetest.formspec_escape(string)`: returns a string
4901 * escapes the characters "[", "]", "\", "," and ";", which can not be used
4903 * `minetest.explode_table_event(string)`: returns a table
4904 * returns e.g. `{type="CHG", row=1, column=2}`
4906 * `"INV"`: no row selected
4908 * `"DCL"`: double-click
4909 * `minetest.explode_textlist_event(string)`: returns a table
4910 * returns e.g. `{type="CHG", index=1}`
4912 * `"INV"`: no row selected
4914 * `"DCL"`: double-click
4915 * `minetest.explode_scrollbar_event(string)`: returns a table
4916 * returns e.g. `{type="CHG", value=500}`
4918 * `"INV"`: something failed
4919 * `"CHG"`: has been changed
4920 * `"VAL"`: not changed
4925 * `minetest.inventorycube(img1, img2, img3)`
4926 * Returns a string for making an image of a cube (useful as an item image)
4927 * `minetest.get_pointed_thing_position(pointed_thing, above)`
4928 * Returns the position of a `pointed_thing` or `nil` if the `pointed_thing`
4929 does not refer to a node or entity.
4930 * If the optional `above` parameter is true and the `pointed_thing` refers
4931 to a node, then it will return the `above` position of the `pointed_thing`.
4932 * `minetest.dir_to_facedir(dir, is6d)`
4933 * Convert a vector to a facedir value, used in `param2` for
4934 `paramtype2="facedir"`.
4935 * passing something non-`nil`/`false` for the optional second parameter
4936 causes it to take the y component into account.
4937 * `minetest.facedir_to_dir(facedir)`
4938 * Convert a facedir back into a vector aimed directly out the "back" of a
4940 * `minetest.dir_to_wallmounted(dir)`
4941 * Convert a vector to a wallmounted value, used for
4942 `paramtype2="wallmounted"`.
4943 * `minetest.wallmounted_to_dir(wallmounted)`
4944 * Convert a wallmounted value back into a vector aimed directly out the
4946 * `minetest.dir_to_yaw(dir)`
4947 * Convert a vector into a yaw (angle)
4948 * `minetest.yaw_to_dir(yaw)`
4949 * Convert yaw (angle) to a vector
4950 * `minetest.is_colored_paramtype(ptype)`
4951 * Returns a boolean. Returns `true` if the given `paramtype2` contains
4952 color information (`color`, `colorwallmounted` or `colorfacedir`).
4953 * `minetest.strip_param2_color(param2, paramtype2)`
4954 * Removes everything but the color information from the
4955 given `param2` value.
4956 * Returns `nil` if the given `paramtype2` does not contain color
4958 * `minetest.get_node_drops(node, toolname)`
4959 * Returns list of itemstrings that are dropped by `node` when dug
4961 * `node`: node as table or node name
4962 * `toolname`: name of the tool item (can be `nil`)
4963 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
4964 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
4965 * `input.width` = for example `3`
4966 * `input.items` = for example
4967 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
4968 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
4969 * `output.time` = a number, if unsuccessful: `0`
4970 * `output.replacements` = List of replacement `ItemStack`s that couldn't be
4971 placed in `decremented_input.items`. Replacements can be placed in
4972 `decremented_input` if the stack of the replaced item has a count of 1.
4973 * `decremented_input` = like `input`
4974 * `minetest.get_craft_recipe(output)`: returns input
4975 * returns last registered recipe for output item (node)
4976 * `output` is a node or item type such as `"default:torch"`
4977 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
4978 * `input.width` = for example `3`
4979 * `input.items` = for example
4980 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
4981 * `input.items` = `nil` if no recipe found
4982 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
4983 * returns indexed table with all registered recipes for query item (node)
4984 or `nil` if no recipe was found.
4985 * recipe entry table:
4986 * `method`: 'normal' or 'cooking' or 'fuel'
4987 * `width`: 0-3, 0 means shapeless recipe
4988 * `items`: indexed [1-9] table with recipe items
4989 * `output`: string with item name and quantity
4990 * Example query for `"default:gold_ingot"` will return table:
4993 [1]={method = "cooking", width = 3, output = "default:gold_ingot",
4994 items = {1 = "default:gold_lump"}},
4995 [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
4996 items = {1 = "default:goldblock"}}
4998 * `minetest.handle_node_drops(pos, drops, digger)`
4999 * `drops`: list of itemstrings
5000 * Handles drops from nodes after digging: Default action is to put them
5001 into digger's inventory.
5002 * Can be overridden to get different functionality (e.g. dropping items on
5004 * `minetest.itemstring_with_palette(item, palette_index)`: returns an item
5006 * Creates an item string which contains palette index information
5007 for hardware colorization. You can use the returned string
5008 as an output in a craft recipe.
5009 * `item`: the item stack which becomes colored. Can be in string,
5010 table and native form.
5011 * `palette_index`: this index is added to the item stack
5012 * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
5013 * Creates an item string which contains static color information
5014 for hardware colorization. Use this method if you wish to colorize
5015 an item that does not own a palette. You can use the returned string
5016 as an output in a craft recipe.
5017 * `item`: the item stack which becomes colored. Can be in string,
5018 table and native form.
5019 * `colorstring`: the new color of the item stack
5024 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
5025 returns `{{actor, pos, time, oldnode, newnode}, ...}`
5026 * Find who has done something to a node, or near a node
5027 * `actor`: `"player:<name>"`, also `"liquid"`.
5028 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns
5029 `boolean, log_messages`.
5030 * Revert latest actions of someone
5031 * `actor`: `"player:<name>"`, also `"liquid"`.
5033 Defaults for the `on_place` and `on_drop` item definition functions
5034 -------------------------------------------------------------------
5036 * `minetest.item_place_node(itemstack, placer, pointed_thing[, param2, prevent_after_place])`
5037 * Place item as a node
5038 * `param2` overrides `facedir` and wallmounted `param2`
5039 * `prevent_after_place`: if set to `true`, `after_place_node` is not called
5040 for the newly placed node to prevent a callback and placement loop
5041 * returns `itemstack, position`
5042 * `position`: the location the node was placed to. `nil` if nothing was placed.
5043 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
5045 * returns the leftover itemstack
5046 * **Note**: This function is deprecated and will never be called.
5047 * `minetest.item_place(itemstack, placer, pointed_thing[, param2])`
5048 * Wrapper that calls `minetest.item_place_node` if appropriate
5049 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
5050 * **Note**: is not called when wielded item overrides `on_place`
5051 * `param2` overrides facedir and wallmounted `param2`
5052 * returns `itemstack, position`
5053 * `position`: the location the node was placed to. `nil` if nothing was placed.
5054 * `minetest.item_drop(itemstack, dropper, pos)`
5056 * returns the leftover itemstack
5057 * `minetest.item_eat(hp_change[, replace_with_item])`
5058 * Returns `function(itemstack, user, pointed_thing)` as a
5059 function wrapper for `minetest.do_item_eat`.
5060 * `replace_with_item` is the itemstring which is added to the inventory.
5061 If the player is eating a stack, then replace_with_item goes to a
5064 Defaults for the `on_punch` and `on_dig` node definition callbacks
5065 ------------------------------------------------------------------
5067 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
5068 * Calls functions registered by `minetest.register_on_punchnode()`
5069 * `minetest.node_dig(pos, node, digger)`
5070 * Checks if node can be dug, puts item into inventory, removes node
5071 * Calls functions registered by `minetest.registered_on_dignodes()`
5076 * `minetest.sound_play(spec, parameters, [ephemeral])`: returns a handle
5077 * `spec` is a `SimpleSoundSpec`
5078 * `parameters` is a sound parameter table
5079 * `ephemeral` is a boolean (default: false)
5080 Ephemeral sounds will not return a handle and can't be stopped or faded.
5081 It is recommend to use this for short sounds that happen in response to
5082 player actions (e.g. door closing).
5083 * `minetest.sound_stop(handle)`
5084 * `handle` is a handle returned by `minetest.sound_play`
5085 * `minetest.sound_fade(handle, step, gain)`
5086 * `handle` is a handle returned by `minetest.sound_play`
5087 * `step` determines how fast a sound will fade.
5088 Negative step will lower the sound volume, positive step will increase
5090 * `gain` the target gain for the fade.
5095 * `minetest.after(time, func, ...)`
5096 * Call the function `func` after `time` seconds, may be fractional
5097 * Optional: Variable number of arguments that are passed to `func`
5102 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for
5103 server shutdown. Will display `message` to clients.
5104 * `reconnect` == true displays a reconnect button
5105 * `delay` adds an optional delay (in seconds) before shutdown.
5106 Negative delay cancels the current active shutdown.
5107 Zero delay triggers an immediate shutdown.
5108 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
5109 * `minetest.get_server_status(name, joined)`
5110 * Returns the server status string when a player joins or when the command
5111 `/status` is called. Returns `nil` or an empty string when the message is
5113 * `joined`: Boolean value, indicates whether the function was called when
5115 * This function may be overwritten by mods to customize the status message.
5116 * `minetest.get_server_uptime()`: returns the server uptime in seconds
5117 * `minetest.remove_player(name)`: remove player from database (if they are not
5119 * As auth data is not removed, minetest.player_exists will continue to
5120 return true. Call the below method as well if you want to remove auth
5122 * Returns a code (0: successful, 1: no such player, 2: player is connected)
5123 * `minetest.remove_player_auth(name)`: remove player authentication data
5124 * Returns boolean indicating success (false if player nonexistant)
5129 * `minetest.get_ban_list()`: returns a list of all bans formatted as string
5130 * `minetest.get_ban_description(ip_or_name)`: returns list of bans matching
5131 IP address or name formatted as string
5132 * `minetest.ban_player(name)`: ban the IP of a currently connected player
5133 * Returns boolean indicating success
5134 * `minetest.unban_player_or_ip(ip_or_name)`: remove ban record matching
5136 * `minetest.kick_player(name, [reason])`: disconnect a player with an optional
5138 * Returns boolean indicating success (false if player nonexistant)
5143 * `minetest.add_particle(particle definition)`
5144 * Deprecated: `minetest.add_particle(pos, velocity, acceleration,
5145 expirationtime, size, collisiondetection, texture, playername)`
5147 * `minetest.add_particlespawner(particlespawner definition)`
5148 * Add a `ParticleSpawner`, an object that spawns an amount of particles
5149 over `time` seconds.
5150 * Returns an `id`, and -1 if adding didn't succeed
5151 * Deprecated: `minetest.add_particlespawner(amount, time,
5155 minexptime, maxexptime,
5157 collisiondetection, texture, playername)`
5159 * `minetest.delete_particlespawner(id, player)`
5160 * Delete `ParticleSpawner` with `id` (return value from
5161 `minetest.add_particlespawner`).
5162 * If playername is specified, only deletes on the player's client,
5163 otherwise on all clients.
5168 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
5169 * Create a schematic from the volume of map specified by the box formed by
5171 * Apply the specified probability and per-node force-place to the specified
5172 nodes according to the `probability_list`.
5173 * `probability_list` is an array of tables containing two fields, `pos`
5175 * `pos` is the 3D vector specifying the absolute coordinates of the
5176 node being modified,
5177 * `prob` is an integer value from `0` to `255` that encodes
5178 probability and per-node force-place. Probability has levels
5179 0-127, then 128 may be added to encode per-node force-place.
5180 For probability stated as 0-255, divide by 2 and round down to
5181 get values 0-127, then add 128 to apply per-node force-place.
5182 * If there are two or more entries with the same pos value, the
5184 * If `pos` is not inside the box formed by `p1` and `p2`, it is
5186 * If `probability_list` equals `nil`, no probabilities are applied.
5187 * Apply the specified probability to the specified horizontal slices
5188 according to the `slice_prob_list`.
5189 * `slice_prob_list` is an array of tables containing two fields, `ypos`
5191 * `ypos` indicates the y position of the slice with a probability
5192 applied, the lowest slice being `ypos = 0`.
5193 * If slice probability list equals `nil`, no slice probabilities
5195 * Saves schematic in the Minetest Schematic format to filename.
5197 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement, flags)`
5198 * Place the schematic specified by schematic (see [Schematic specifier]) at
5200 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
5201 * If the `rotation` parameter is omitted, the schematic is not rotated.
5202 * `replacements` = `{["old_name"] = "convert_to", ...}`
5203 * `force_placement` is a boolean indicating whether nodes other than `air`
5204 and `ignore` are replaced by the schematic.
5205 * Returns nil if the schematic could not be loaded.
5206 * **Warning**: Once you have loaded a schematic from a file, it will be
5207 cached. Future calls will always use the cached version and the
5208 replacement list defined for it, regardless of whether the file or the
5209 replacement list parameter have changed. The only way to load the file
5210 anew is to restart the server.
5211 * `flags` is a flag field with the available flags:
5216 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement, flags)`:
5217 * This function is analogous to minetest.place_schematic, but places a
5218 schematic onto the specified VoxelManip object `vmanip` instead of the
5220 * Returns false if any part of the schematic was cut-off due to the
5221 VoxelManip not containing the full area required, and true if the whole
5222 schematic was able to fit.
5223 * Returns nil if the schematic could not be loaded.
5224 * After execution, any external copies of the VoxelManip contents are
5226 * `flags` is a flag field with the available flags:
5231 * `minetest.serialize_schematic(schematic, format, options)`
5232 * Return the serialized schematic specified by schematic
5233 (see [Schematic specifier])
5234 * in the `format` of either "mts" or "lua".
5235 * "mts" - a string containing the binary MTS data used in the MTS file
5237 * "lua" - a string containing Lua code representing the schematic in table
5239 * `options` is a table containing the following optional parameters:
5240 * If `lua_use_comments` is true and `format` is "lua", the Lua code
5241 generated will have (X, Z) position comments for every X row
5242 generated in the schematic data for easier reading.
5243 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua",
5244 the Lua code generated will use that number of spaces as indentation
5245 instead of a tab character.
5247 * `minetest.read_schematic(schematic, options)`
5248 * Returns a Lua table representing the schematic (see: [Schematic specifier])
5249 * `schematic` is the schematic to read (see: [Schematic specifier])
5250 * `options` is a table containing the following optional parameters:
5251 * `write_yslice_prob`: string value:
5252 * `none`: no `write_yslice_prob` table is inserted,
5253 * `low`: only probabilities that are not 254 or 255 are written in
5254 the `write_ylisce_prob` table,
5255 * `all`: write all probabilities to the `write_yslice_prob` table.
5256 * The default for this option is `all`.
5257 * Any invalid value will be interpreted as `all`.
5262 * `minetest.request_http_api()`:
5263 * returns `HTTPApiTable` containing http functions if the calling mod has
5264 been granted access by being listed in the `secure.http_mods` or
5265 `secure.trusted_mods` setting, otherwise returns `nil`.
5266 * The returned table contains the functions `fetch`, `fetch_async` and
5267 `fetch_async_get` described below.
5268 * Only works at init time and must be called from the mod's main scope
5269 (not from a function).
5270 * Function only exists if minetest server was built with cURL support.
5271 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
5273 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
5274 * Performs given request asynchronously and calls callback upon completion
5275 * callback: `function(HTTPRequestResult res)`
5276 * Use this HTTP function if you are unsure, the others are for advanced use
5277 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
5278 * Performs given request asynchronously and returns handle for
5279 `HTTPApiTable.fetch_async_get`
5280 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
5281 * Return response data for given asynchronous HTTP request
5286 * `minetest.get_mod_storage()`:
5287 * returns reference to mod private `StorageRef`
5288 * must be called during mod load time
5293 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
5294 * `minetest.is_player(obj)`: boolean, whether `obj` is a player
5295 * `minetest.player_exists(name)`: boolean, whether player exists
5296 (regardless of online status)
5297 * `minetest.hud_replace_builtin(name, hud_definition)`
5298 * Replaces definition of a builtin hud element
5299 * `name`: `"breath"` or `"health"`
5300 * `hud_definition`: definition to replace builtin definition
5301 * `minetest.send_join_message(player_name)`
5302 * This function can be overridden by mods to change the join message.
5303 * `minetest.send_leave_message(player_name, timed_out)`
5304 * This function can be overridden by mods to change the leave message.
5305 * `minetest.hash_node_position(pos)`: returns an 48-bit integer
5306 * `pos`: table {x=number, y=number, z=number},
5307 * Gives a unique hash number for a node position (16+16+16=48bit)
5308 * `minetest.get_position_from_hash(hash)`: returns a position
5309 * Inverse transform of `minetest.hash_node_position`
5310 * `minetest.get_item_group(name, group)`: returns a rating
5311 * Get rating of a group of an item. (`0` means: not in group)
5312 * `minetest.get_node_group(name, group)`: returns a rating
5313 * Deprecated: An alias for the former.
5314 * `minetest.raillike_group(name)`: returns a rating
5315 * Returns rating of the connect_to_raillike group corresponding to name
5316 * If name is not yet the name of a connect_to_raillike group, a new group
5317 id is created, with that name.
5318 * `minetest.get_content_id(name)`: returns an integer
5319 * Gets the internal content ID of `name`
5320 * `minetest.get_name_from_content_id(content_id)`: returns a string
5321 * Gets the name of the content with that content ID
5322 * `minetest.parse_json(string[, nullvalue])`: returns something
5323 * Convert a string containing JSON data into the Lua equivalent
5324 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
5325 * On success returns a table, a string, a number, a boolean or `nullvalue`
5326 * On failure outputs an error message and returns `nil`
5327 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
5328 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error
5330 * Convert a Lua table into a JSON string
5331 * styled: Outputs in a human-readable format if this is set, defaults to
5333 * Unserializable things like functions and userdata will cause an error.
5334 * **Warning**: JSON is more strict than the Lua table format.
5335 1. You can only use strings and positive integers of at least one as
5337 2. You can not mix string and integer keys.
5338 This is due to the fact that JSON has two distinct array and object
5340 * Example: `write_json({10, {a = false}})`,
5341 returns `"[10, {\"a\": false}]"`
5342 * `minetest.serialize(table)`: returns a string
5343 * Convert a table containing tables, strings, numbers, booleans and `nil`s
5344 into string form readable by `minetest.deserialize`
5345 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
5346 * `minetest.deserialize(string[, safe])`: returns a table
5347 * Convert a string returned by `minetest.serialize` into a table
5348 * `string` is loaded in an empty sandbox environment.
5349 * Will load functions if safe is false or omitted. Although these functions
5350 cannot directly access the global environment, they could bypass this
5351 restriction with maliciously crafted Lua bytecode if mod security is
5353 * This function should not be used on untrusted data, regardless of the
5354 value of `safe`. It is fine to serialize then deserialize user-provided
5355 data, but directly providing user input to deserialize is always unsafe.
5356 * Example: `deserialize('return { ["foo"] = "bar" }')`,
5357 returns `{foo='bar'}`
5358 * Example: `deserialize('print("foo")')`, returns `nil`
5359 (function call fails), returns
5360 `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
5361 * `minetest.compress(data, method, ...)`: returns `compressed_data`
5362 * Compress a string of data.
5363 * `method` is a string identifying the compression method to be used.
5364 * Supported compression methods:
5365 * Deflate (zlib): `"deflate"`
5366 * `...` indicates method-specific arguments. Currently defined arguments
5368 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
5369 * `minetest.decompress(compressed_data, method, ...)`: returns data
5370 * Decompress a string of data (using ZLib).
5371 * See documentation on `minetest.compress()` for supported compression
5373 * `...` indicates method-specific arguments. Currently, no methods use this
5374 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
5375 * Each argument is a 8 Bit unsigned integer
5376 * Returns the ColorString from rgb or rgba values
5377 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
5378 * `minetest.encode_base64(string)`: returns string encoded in base64
5379 * Encodes a string in base64.
5380 * `minetest.decode_base64(string)`: returns string
5381 * Decodes a string encoded in base64.
5382 * `minetest.is_protected(pos, name)`: returns boolean
5383 * Returning `true` restricts the player `name` from modifying (i.e. digging,
5384 placing) the node at position `pos`.
5385 * `name` will be `""` for non-players or unknown players.
5386 * This function should be overridden by protection mods. It is highly
5387 recommended to grant access to players with the `protection_bypass` privilege.
5388 * Cache and call the old version of this function if the position is
5389 not protected by the mod. This will allow using multiple protection mods.
5392 local old_is_protected = minetest.is_protected
5393 function minetest.is_protected(pos, name)
5394 if mymod:position_protected_from(pos, name) then
5397 return old_is_protected(pos, name)
5399 * `minetest.record_protection_violation(pos, name)`
5400 * This function calls functions registered with
5401 `minetest.register_on_protection_violation`.
5402 * `minetest.is_area_protected(pos1, pos2, player_name, interval)`
5403 * Returns the position of the first node that `player_name` may not modify
5404 in the specified cuboid between `pos1` and `pos2`.
5405 * Returns `false` if no protections were found.
5406 * Applies `is_protected()` to a 3D lattice of points in the defined volume.
5407 The points are spaced evenly throughout the volume and have a spacing
5408 similar to, but no larger than, `interval`.
5409 * All corners and edges of the defined volume are checked.
5410 * `interval` defaults to 4.
5411 * `interval` should be carefully chosen and maximised to avoid an excessive
5412 number of points being checked.
5413 * Like `minetest.is_protected`, this function may be extended or
5414 overwritten by mods to provide a faster implementation to check the
5415 cuboid for intersections.
5416 * `minetest.rotate_and_place(itemstack, placer, pointed_thing[, infinitestacks,
5417 orient_flags, prevent_after_place])`
5418 * Attempt to predict the desired orientation of the facedir-capable node
5419 defined by `itemstack`, and place it accordingly (on-wall, on the floor,
5420 or hanging from the ceiling).
5421 * `infinitestacks`: if `true`, the itemstack is not changed. Otherwise the
5422 stacks are handled normally.
5423 * `orient_flags`: Optional table containing extra tweaks to the placement code:
5424 * `invert_wall`: if `true`, place wall-orientation on the ground and
5425 ground-orientation on the wall.
5426 * `force_wall` : if `true`, always place the node in wall orientation.
5427 * `force_ceiling`: if `true`, always place on the ceiling.
5428 * `force_floor`: if `true`, always place the node on the floor.
5429 * `force_facedir`: if `true`, forcefully reset the facedir to north
5430 when placing on the floor or ceiling.
5431 * The first four options are mutually-exclusive; the last in the list
5432 takes precedence over the first.
5433 * `prevent_after_place` is directly passed to `minetest.item_place_node`
5434 * Returns the new itemstack after placement
5435 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
5436 * calls `rotate_and_place()` with `infinitestacks` set according to the state
5437 of the creative mode setting, checks for "sneak" to set the `invert_wall`
5438 parameter and `prevent_after_place` set to `true`.
5440 * `minetest.calculate_knockback(player, hitter, time_from_last_punch,
5441 tool_capabilities, dir, distance, damage)`
5442 * Returns the amount of knockback applied on the punched player.
5443 * Arguments are equivalent to `register_on_punchplayer`, except the following:
5444 * `distance`: distance between puncher and punched player
5445 * This function can be overriden by mods that wish to modify this behaviour.
5446 * You may want to cache and call the old function to allow multiple mods to
5447 change knockback behaviour.
5449 * `minetest.forceload_block(pos[, transient])`
5450 * forceloads the position `pos`.
5451 * returns `true` if area could be forceloaded
5452 * If `transient` is `false` or absent, the forceload will be persistent
5453 (saved between server runs). If `true`, the forceload will be transient
5454 (not saved between server runs).
5456 * `minetest.forceload_free_block(pos[, transient])`
5457 * stops forceloading the position `pos`
5458 * If `transient` is `false` or absent, frees a persistent forceload.
5459 If `true`, frees a transient forceload.
5461 * `minetest.request_insecure_environment()`: returns an environment containing
5462 insecure functions if the calling mod has been listed as trusted in the
5463 `secure.trusted_mods` setting or security is disabled, otherwise returns
5465 * Only works at init time and must be called from the mod's main scope
5466 (ie: the init.lua of the mod, not from another Lua file or within a function).
5467 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE
5468 IT IN A LOCAL VARIABLE!**
5470 * `minetest.global_exists(name)`
5471 * Checks if a global variable has been set, without triggering a warning.
5476 * `minetest.env`: `EnvRef` of the server environment and world.
5477 * Any function in the minetest namespace can be called using the syntax
5478 `minetest.env:somefunction(somearguments)`
5479 instead of `minetest.somefunction(somearguments)`
5480 * Deprecated, but support is not to be dropped soon
5485 ### Registered definition tables
5487 * `minetest.registered_items`
5488 * Map of registered items, indexed by name
5489 * `minetest.registered_nodes`
5490 * Map of registered node definitions, indexed by name
5491 * `minetest.registered_craftitems`
5492 * Map of registered craft item definitions, indexed by name
5493 * `minetest.registered_tools`
5494 * Map of registered tool definitions, indexed by name
5495 * `minetest.registered_entities`
5496 * Map of registered entity prototypes, indexed by name
5497 * `minetest.object_refs`
5498 * Map of object references, indexed by active object id
5499 * `minetest.luaentities`
5500 * Map of Lua entities, indexed by active object id
5501 * `minetest.registered_abms`
5502 * List of ABM definitions
5503 * `minetest.registered_lbms`
5504 * List of LBM definitions
5505 * `minetest.registered_aliases`
5506 * Map of registered aliases, indexed by name
5507 * `minetest.registered_ores`
5508 * Map of registered ore definitions, indexed by the `name` field.
5509 * If `name` is nil, the key is the object handle returned by
5510 `minetest.register_ore`.
5511 * `minetest.registered_biomes`
5512 * Map of registered biome definitions, indexed by the `name` field.
5513 * If `name` is nil, the key is the object handle returned by
5514 `minetest.register_biome`.
5515 * `minetest.registered_decorations`
5516 * Map of registered decoration definitions, indexed by the `name` field.
5517 * If `name` is nil, the key is the object handle returned by
5518 `minetest.register_decoration`.
5519 * `minetest.registered_schematics`
5520 * Map of registered schematic definitions, indexed by the `name` field.
5521 * If `name` is nil, the key is the object handle returned by
5522 `minetest.register_schematic`.
5523 * `minetest.registered_chatcommands`
5524 * Map of registered chat command definitions, indexed by name
5525 * `minetest.registered_privileges`
5526 * Map of registered privilege definitions, indexed by name
5528 ### Registered callback tables
5530 All callbacks registered with [Global callback registration functions] are added
5531 to corresponding `minetest.registered_*` tables.
5539 Sorted alphabetically.
5544 A fast access data structure to store areas, and find areas near a given
5546 Every area has a `data` string attribute to store additional information.
5547 You can create an empty `AreaStore` by calling `AreaStore()`, or
5548 `AreaStore(type_name)`. The mod decides where to save and load AreaStore.
5549 If you chose the parameter-less constructor, a fast implementation will be
5550 automatically chosen for you.
5554 * `get_area(id, include_borders, include_data)`
5555 * Returns the area information about the specified ID.
5556 * Returned values are either of these:
5558 nil -- Area not found
5559 true -- Without `include_borders` and `include_data`
5561 min = pos, max = pos -- `include_borders == true`
5562 data = string -- `include_data == true`
5565 * `get_areas_for_pos(pos, include_borders, include_data)`
5566 * Returns all areas as table, indexed by the area ID.
5567 * Table values: see `get_area`.
5568 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`
5569 * Returns all areas that contain all nodes inside the area specified by `edge1`
5570 and `edge2` (inclusive).
5571 * `accept_overlap`: if `true`, areas are returned that have nodes in
5572 common (intersect) with the specified area.
5573 * Returns the same values as `get_areas_for_pos`.
5574 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store.
5575 * Returns the new area's ID, or nil if the insertion failed.
5576 * The (inclusive) positions `edge1` and `edge2` describe the area.
5577 * `data` is a string stored with the area.
5578 * `id` (optional): will be used as the internal area ID if it is an unique
5579 number between 0 and 2^32-2.
5580 * `reserve(count)`: reserves resources for at most `count` many contained
5582 Only needed for efficiency, and only some implementations profit.
5583 * `remove_area(id)`: removes the area with the given id from the store, returns
5585 * `set_cache_params(params)`: sets params for the included prefiltering cache.
5586 Calling invalidates the cache, so that its elements have to be newly
5588 * `params` is a table with the following fields:
5590 enabled = boolean, -- Whether to enable, default true
5591 block_radius = int, -- The radius (in nodes) of the areas the cache
5592 -- generates prefiltered lists for, minimum 16,
5594 limit = int, -- The cache size, minimum 20, default 1000
5595 * `to_string()`: Experimental. Returns area store serialized as a (binary)
5597 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to
5599 * `from_string(str)`: Experimental. Deserializes string and loads it into the
5601 Returns success and, optionally, an error message.
5602 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data
5608 An `InvRef` is a reference to an inventory.
5612 * `is_empty(listname)`: return `true` if list is empty
5613 * `get_size(listname)`: get size of a list
5614 * `set_size(listname, size)`: set size of a list
5615 * returns `false` on error (e.g. invalid `listname` or `size`)
5616 * `get_width(listname)`: get width of a list
5617 * `set_width(listname, width)`: set width of list; currently used for crafting
5618 * `get_stack(listname, i)`: get a copy of stack index `i` in list
5619 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
5620 * `get_list(listname)`: return full list
5621 * `set_list(listname, list)`: set full list (size will not change)
5622 * `get_lists()`: returns list of inventory lists
5623 * `set_lists(lists)`: sets inventory lists (size will not change)
5624 * `add_item(listname, stack)`: add item somewhere in list, returns leftover
5626 * `room_for_item(listname, stack):` returns `true` if the stack of items
5627 can be fully added to the list
5628 * `contains_item(listname, stack, [match_meta])`: returns `true` if
5629 the stack of items can be fully taken from the list.
5630 If `match_meta` is false, only the items' names are compared
5632 * `remove_item(listname, stack)`: take as many items as specified from the
5633 list, returns the items that were actually removed (as an `ItemStack`)
5634 -- note that any item metadata is ignored, so attempting to remove a specific
5635 unique item this way will likely remove the wrong one -- to do that use
5636 `set_stack` with an empty `ItemStack`.
5637 * `get_location()`: returns a location compatible to
5638 `minetest.get_inventory(location)`.
5639 * returns `{type="undefined"}` in case location is not known
5644 An `ItemStack` is a stack of items.
5646 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
5647 an itemstring, a table or `nil`.
5651 * `is_empty()`: returns `true` if stack is empty.
5652 * `get_name()`: returns item name (e.g. `"default:stone"`).
5653 * `set_name(item_name)`: returns a boolean indicating whether the item was
5655 * `get_count()`: Returns number of items on the stack.
5656 * `set_count(count)`: returns a boolean indicating whether the item was cleared
5657 * `count`: number, unsigned 16 bit integer
5658 * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
5659 * `set_wear(wear)`: returns boolean indicating whether item was cleared
5660 * `wear`: number, unsigned 16 bit integer
5661 * `get_meta()`: returns ItemStackMetaRef. See section for more details
5662 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
5664 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
5665 * `get_description()`: returns the description shown in inventory list tooltips.
5666 * `clear()`: removes all items from the stack, making it empty.
5667 * `replace(item)`: replace the contents of this stack.
5668 * `item` can also be an itemstring or table.
5669 * `to_string()`: returns the stack in itemstring form.
5670 * `to_table()`: returns the stack in Lua table form.
5671 * `get_stack_max()`: returns the maximum size of the stack (depends on the
5673 * `get_free_space()`: returns `get_stack_max() - get_count()`.
5674 * `is_known()`: returns `true` if the item name refers to a defined item type.
5675 * `get_definition()`: returns the item definition table.
5676 * `get_tool_capabilities()`: returns the digging properties of the item,
5677 or those of the hand if none are defined for this item type
5678 * `add_wear(amount)`
5679 * Increases wear by `amount` if the item is a tool
5680 * `amount`: number, integer
5681 * `add_item(item)`: returns leftover `ItemStack`
5682 * Put some item or stack onto this stack
5683 * `item_fits(item)`: returns `true` if item or stack can be fully added to
5685 * `take_item(n)`: returns taken `ItemStack`
5686 * Take (and remove) up to `n` items from this stack
5687 * `n`: number, default: `1`
5688 * `peek_item(n)`: returns taken `ItemStack`
5689 * Copy (don't remove) up to `n` items from this stack
5690 * `n`: number, default: `1`
5695 ItemStack metadata: reference extra data and functionality stored in a stack.
5696 Can be obtained via `item:get_meta()`.
5700 * All methods in MetaDataRef
5701 * `set_tool_capabilities([tool_capabilities])`
5702 * Overrides the item's tool capabilities
5703 * A nil value will clear the override data and restore the original
5709 Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],
5710 and [`PlayerMetaRef`].
5714 * `contains(key)`: Returns true if key present, otherwise false.
5715 * Returns `nil` when the MetaData is inexistent.
5716 * `get(key)`: Returns `nil` if key not present, else the stored string.
5717 * `set_string(key, value)`: Value of `""` will delete the key.
5718 * `get_string(key)`: Returns `""` if key not present.
5719 * `set_int(key, value)`
5720 * `get_int(key)`: Returns `0` if key not present.
5721 * `set_float(key, value)`
5722 * `get_float(key)`: Returns `0` if key not present.
5723 * `to_table()`: returns `nil` or a table with keys:
5724 * `fields`: key-value storage
5725 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
5726 * `from_table(nil or {})`
5727 * Any non-table value will clear the metadata
5728 * See [Node Metadata] for an example
5729 * returns `true` on success
5731 * returns `true` if this metadata has the same key-value pairs as `other`
5736 An interface to use mod channels on client and server
5740 * `leave()`: leave the mod channel.
5741 * Server leaves channel `channel_name`.
5742 * No more incoming or outgoing messages can be sent to this channel from
5744 * This invalidate all future object usage.
5745 * Ensure you set mod_channel to nil after that to free Lua resources.
5746 * `is_writeable()`: returns true if channel is writeable and mod can send over
5748 * `send_all(message)`: Send `message` though the mod channel.
5749 * If mod channel is not writeable or invalid, message will be dropped.
5750 * Message size is limited to 65535 characters by protocol.
5755 Node metadata: reference extra data and functionality stored in a node.
5756 Can be obtained via `minetest.get_meta(pos)`.
5760 * All methods in MetaDataRef
5761 * `get_inventory()`: returns `InvRef`
5762 * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
5763 This will prevent them from being sent to the client. Note that the "private"
5764 status will only be remembered if an associated key-value pair exists,
5765 meaning it's best to call this when initializing all other meta (e.g.
5771 Node Timers: a high resolution persistent per-node timer.
5772 Can be gotten via `minetest.get_node_timer(pos)`.
5776 * `set(timeout,elapsed)`
5777 * set a timer's state
5778 * `timeout` is in seconds, and supports fractional values (0.1 etc)
5779 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
5780 * will trigger the node's `on_timer` function after `(timeout - elapsed)`
5784 * equivalent to `set(timeout,0)`
5787 * `get_timeout()`: returns current timeout in seconds
5788 * if `timeout` equals `0`, timer is inactive
5789 * `get_elapsed()`: returns current elapsed time in seconds
5790 * the node's `on_timer` function will be called after `(timeout - elapsed)`
5792 * `is_started()`: returns boolean state of timer
5793 * returns `true` if timer is started, otherwise `false`
5798 Moving things in the game are generally these.
5799 This is basically a reference to a C++ `ServerActiveObject`.
5801 ### Advice on handling `ObjectRefs`
5803 When you receive an `ObjectRef` as a callback argument or from another API
5804 function, it is possible to store the reference somewhere and keep it around.
5805 It will keep functioning until the object is unloaded or removed.
5807 However, doing this is **NOT** recommended as there is (intentionally) no method
5808 to test if a previously acquired `ObjectRef` is still valid.
5809 Instead, `ObjectRefs` should be "let go" of as soon as control is returned from
5810 Lua back to the engine.
5811 Doing so is much less error-prone and you will never need to wonder if the
5812 object you are working with still exists.
5817 * `get_pos()`: returns `{x=num, y=num, z=num}`
5818 * `set_pos(pos)`: `pos`=`{x=num, y=num, z=num}`
5819 * `move_to(pos, continuous=false)`
5820 * Does an interpolated move for Lua entities for visually smooth transitions.
5821 * If `continuous` is true, the Lua entity will not be moved to the current
5822 position before starting the interpolated move.
5823 * For players this does the same as `set_pos`,`continuous` is ignored.
5824 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
5825 * `puncher` = another `ObjectRef`,
5826 * `time_from_last_punch` = time since last punch action of the puncher
5827 * `direction`: can be `nil`
5828 * `right_click(clicker)`; `clicker` is another `ObjectRef`
5829 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
5830 * `set_hp(hp, reason)`: set number of hitpoints (2 * number of hearts).
5831 * See reason in register_on_player_hpchange
5832 * Is limited to the range of 0 ... 65535 (2^16 - 1)
5833 * For players: HP are also limited by `hp_max` specified in the player's
5835 * `get_inventory()`: returns an `InvRef` for players, otherwise returns `nil`
5836 * `get_wield_list()`: returns the name of the inventory list the wielded item
5838 * `get_wield_index()`: returns the index of the wielded item
5839 * `get_wielded_item()`: returns an `ItemStack`
5840 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if
5842 * `set_armor_groups({group1=rating, group2=rating, ...})`
5843 * `get_armor_groups()`: returns a table with the armor group ratings
5844 * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
5845 * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
5846 * `frame_speed`: number, default: `15.0`
5847 * `frame_blend`: number, default: `0.0`
5848 * `frame_loop`: boolean, default: `true`
5849 * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and
5851 * `set_animation_frame_speed(frame_speed)`
5852 * `frame_speed`: number, default: `15.0`
5853 * `set_attach(parent, bone, position, rotation)`
5855 * `position`: `{x=num, y=num, z=num}` (relative)
5856 * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees
5857 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't
5860 * `set_bone_position(bone, position, rotation)`
5862 * `position`: `{x=num, y=num, z=num}` (relative)
5863 * `rotation`: `{x=num, y=num, z=num}`
5864 * `get_bone_position(bone)`: returns position and rotation of the bone
5865 * `set_properties(object property table)`
5866 * `get_properties()`: returns object property table
5867 * `is_player()`: returns true for players, false otherwise
5868 * `get_nametag_attributes()`
5869 * returns a table with the attributes of the nametag of an object
5871 color = {a=0..255, r=0..255, g=0..255, b=0..255},
5874 * `set_nametag_attributes(attributes)`
5875 * sets the attributes of the nametag of an object
5879 text = "My Nametag",
5882 #### Lua entity only (no-op for other objects)
5884 * `remove()`: remove object
5885 * The object is removed after returning from Lua. However the `ObjectRef`
5886 itself instantly becomes unusable with all further method calls having
5887 no effect and returning `nil`.
5888 * `set_velocity(vel)`
5889 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
5890 * `add_velocity(vel)`
5891 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
5892 * In comparison to using get_velocity, adding the velocity and then using
5893 set_velocity, add_velocity is supposed to avoid synchronization problems.
5894 * `get_velocity()`: returns the velocity, a vector
5895 * `set_acceleration(acc)`
5897 * `get_acceleration()`: returns the acceleration, a vector
5898 * `set_rotation(rot)`
5899 * `rot` is a vector (radians). X is pitch (elevation), Y is yaw (heading)
5900 and Z is roll (bank).
5901 * `get_rotation()`: returns the rotation, a vector (radians)
5902 * `set_yaw(radians)`: sets the yaw (heading).
5903 * `get_yaw()`: returns number in radians
5904 * `set_texture_mod(mod)`
5905 * `get_texture_mod()` returns current texture modifier
5906 * `set_sprite(p, num_frames, framelength, select_horiz_by_yawpitch)`
5907 * Select sprite from spritesheet with optional animation and Dungeon Master
5908 style texture selection based on yaw relative to camera
5909 * `p`: {x=number, y=number}, the coordinate of the first frame
5910 (x: column, y: row), default: `{x=0, y=0}`
5911 * `num_frames`: number, default: `1`
5912 * `framelength`: number, default: `0.2`
5913 * `select_horiz_by_yawpitch`: boolean, this was once used for the Dungeon
5914 Master mob, default: `false`
5915 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
5918 #### Player only (no-op for other objects)
5920 * `get_player_name()`: returns `""` if is not a player
5921 * `get_player_velocity()`: returns `nil` if is not a player, otherwise a
5922 table {x, y, z} representing the player's instantaneous velocity in nodes/s
5923 * `add_player_velocity(vel)`
5924 * Adds to player velocity, this happens client-side and only once.
5925 * Does not apply during free_move.
5926 * Note that since the player speed is normalized at each move step,
5927 increasing e.g. Y velocity beyond what would usually be achieved
5928 (see: physics overrides) will cause existing X/Z velocity to be reduced.
5929 * Example: `add_player_velocity({x=0, y=6.5, z=0})` is equivalent to
5930 pressing the jump key (assuming default settings)
5931 * `get_look_dir()`: get camera direction as a unit vector
5932 * `get_look_vertical()`: pitch in radians
5933 * Angle ranges between -pi/2 and pi/2, which are straight up and down
5935 * `get_look_horizontal()`: yaw in radians
5936 * Angle is counter-clockwise from the +z direction.
5937 * `set_look_vertical(radians)`: sets look pitch
5938 * radians: Angle from looking forward, where positive is downwards.
5939 * `set_look_horizontal(radians)`: sets look yaw
5940 * radians: Angle from the +z direction, where positive is counter-clockwise.
5941 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use
5942 `get_look_vertical`.
5943 * Angle ranges between -pi/2 and pi/2, which are straight down and up
5945 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use
5946 `get_look_horizontal`.
5947 * Angle is counter-clockwise from the +x direction.
5948 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use
5949 `set_look_vertical`.
5950 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use
5951 `set_look_horizontal`.
5952 * `get_breath()`: returns player's breath
5953 * `set_breath(value)`: sets player's breath
5955 * `0`: player is drowning
5956 * max: bubbles bar is not shown
5957 * See [Object properties] for more information
5958 * Is limited to range 0 ... 65535 (2^16 - 1)
5959 * `set_fov(fov, is_multiplier)`: Sets player's FOV
5961 * `is_multiplier`: Set to `true` if the FOV value is a multiplier.
5962 Defaults to `false`.
5963 * Set to 0 to clear FOV override.
5965 * Returns player's FOV override in degrees, and a boolean depending on whether
5966 the value is a multiplier.
5967 * Returns 0 as first value if player's FOV hasn't been overridden.
5968 * `set_attribute(attribute, value)`: DEPRECATED, use get_meta() instead
5969 * Sets an extra attribute with value on player.
5970 * `value` must be a string, or a number which will be converted to a
5972 * If `value` is `nil`, remove attribute from player.
5973 * `get_attribute(attribute)`: DEPRECATED, use get_meta() instead
5974 * Returns value (a string) for extra attribute.
5975 * Returns `nil` if no attribute found.
5976 * `get_meta()`: Returns a PlayerMetaRef.
5977 * `set_inventory_formspec(formspec)`
5978 * Redefine player's inventory form
5979 * Should usually be called in `on_joinplayer`
5980 * `get_inventory_formspec()`: returns a formspec string
5981 * `set_formspec_prepend(formspec)`:
5982 * the formspec string will be added to every formspec shown to the user,
5983 except for those with a no_prepend[] tag.
5984 * This should be used to set style elements such as background[] and
5985 bgcolor[], any non-style elements (eg: label) may result in weird behaviour.
5986 * Only affects formspecs shown after this is called.
5987 * `get_formspec_prepend(formspec)`: returns a formspec string.
5988 * `get_player_control()`: returns table with player pressed keys
5989 * The table consists of fields with boolean value representing the pressed
5990 keys, the fields are jump, right, left, LMB, RMB, sneak, aux1, down, up.
5991 * example: `{jump=false, right=true, left=false, LMB=false, RMB=false,
5992 sneak=true, aux1=false, down=false, up=false}`
5993 * `get_player_control_bits()`: returns integer with bit packed player pressed
5995 * bit nr/meaning: 0/up, 1/down, 2/left, 3/right, 4/jump, 5/aux1, 6/sneak,
5997 * `set_physics_override(override_table)`
5998 * `override_table` is a table with the following fields:
5999 * `speed`: multiplier to default walking speed value (default: `1`)
6000 * `jump`: multiplier to default jump value (default: `1`)
6001 * `gravity`: multiplier to default gravity value (default: `1`)
6002 * `sneak`: whether player can sneak (default: `true`)
6003 * `sneak_glitch`: whether player can use the new move code replications
6004 of the old sneak side-effects: sneak ladders and 2 node sneak jump
6006 * `new_move`: use new move/sneak code. When `false` the exact old code
6007 is used for the specific old sneak behaviour (default: `true`)
6008 * `get_physics_override()`: returns the table given to `set_physics_override`
6009 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
6011 * `hud_remove(id)`: remove the HUD element of the specified id
6012 * `hud_change(id, stat, value)`: change a value of a previously added HUD
6014 * element `stat` values:
6015 `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
6016 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
6017 * `hud_set_flags(flags)`: sets specified HUD flags of player.
6018 * `flags`: A table with the following fields set to boolean values
6026 * If a flag equals `nil`, the flag is not modified
6027 * `minimap`: Modifies the client's permission to view the minimap.
6028 The client may locally elect to not view the minimap.
6029 * `minimap_radar` is only usable when `minimap` is true
6030 * `hud_get_flags()`: returns a table of player HUD flags with boolean values.
6031 * See `hud_set_flags` for a list of flags that can be toggled.
6032 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
6033 * `count`: number of items, must be between `1` and `32`
6034 * `hud_get_hotbar_itemcount`: returns number of visible items
6035 * `hud_set_hotbar_image(texturename)`
6036 * sets background image for hotbar
6037 * `hud_get_hotbar_image`: returns texturename
6038 * `hud_set_hotbar_selected_image(texturename)`
6039 * sets image for selected item of hotbar
6040 * `hud_get_hotbar_selected_image`: returns texturename
6041 * `set_sky(parameters)`
6042 * `parameters` is a table with the following optional fields:
6043 * `base_color`: ColorSpec, changes fog in "skybox" and "plain".
6044 * `type`: Available types:
6045 * `"regular"`: Uses 0 textures, `base_color` ignored
6046 * `"skybox"`: Uses 6 textures, `base_color` used as fog.
6047 * `"plain"`: Uses 0 textures, `base_color` used as both fog and sky.
6048 * `textures`: A table containing up to six textures in the following
6049 order: Y+ (top), Y- (bottom), X- (west), X+ (east), Z+ (north), Z- (south).
6050 * `clouds`: Boolean for whether clouds appear. (default: `true`)
6051 * `sky_color`: A table containing the following values, alpha is ignored:
6052 * `day_sky`: ColorSpec, for the top half of the `"regular"`
6053 sky during the day. (default: `#8cbafa`)
6054 * `day_horizon`: ColorSpec, for the bottom half of the
6055 `"regular"` sky during the day. (default: `#9bc1f0`)
6056 * `dawn_sky`: ColorSpec, for the top half of the `"regular"`
6057 sky during dawn/sunset. (default: `#b4bafa`)
6058 The resulting sky color will be a darkened version of the ColorSpec.
6059 Warning: The darkening of the ColorSpec is subject to change.
6060 * `dawn_horizon`: ColorSpec, for the bottom half of the `"regular"`
6061 sky during dawn/sunset. (default: `#bac1f0`)
6062 The resulting sky color will be a darkened version of the ColorSpec.
6063 Warning: The darkening of the ColorSpec is subject to change.
6064 * `night_sky`: ColorSpec, for the top half of the `"regular"`
6065 sky during the night. (default: `#006aff`)
6066 The resulting sky color will be a dark version of the ColorSpec.
6067 Warning: The darkening of the ColorSpec is subject to change.
6068 * `night_horizon`: ColorSpec, for the bottom half of the `"regular"`
6069 sky during the night. (default: `#4090ff`)
6070 The resulting sky color will be a dark version of the ColorSpec.
6071 Warning: The darkening of the ColorSpec is subject to change.
6072 * `indoors`: ColorSpec, for when you're either indoors or
6073 underground. Only applies to the `"regular"` sky.
6074 (default: `#646464`)
6075 * `fog_sun_tint`: ColorSpec, changes the fog tinting for the sun
6076 at sunrise and sunset.
6077 * `fog_moon_tint`: ColorSpec, changes the fog tinting for the moon
6078 at sunrise and sunset.
6079 * `fog_tint_type`: string, changes which mode the directional fog
6080 abides by, `"custom"` uses `sun_tint` and `moon_tint`, while
6081 `"default"` uses the classic Minetest sun and moon tinting.
6082 Will use tonemaps, if set to `"default"`. (default: `"default"`)
6083 * `get_sky()`: returns base_color, type, table of textures, clouds.
6084 * `get_sky_color()`: returns a table with the `sky_color` parameters as in
6086 * `set_sun(parameters)`:
6087 * `parameters` is a table with the following optional fields:
6088 * `visible`: Boolean for whether the sun is visible.
6090 * `texture`: A regular texture for the sun. Setting to `""`
6091 will re-enable the mesh sun. (default: `"sun.png"`)
6092 * `tonemap`: A 512x1 texture containing the tonemap for the sun
6093 (default: `"sun_tonemap.png"`)
6094 * `sunrise`: A regular texture for the sunrise texture.
6095 (default: `"sunrisebg.png"`)
6096 * `sunrise_visible`: Boolean for whether the sunrise texture is visible.
6098 * `scale`: Float controlling the overall size of the sun. (default: `1`)
6099 * `get_sun()`: returns a table with the current sun parameters as in
6101 * `set_moon(parameters)`:
6102 * `parameters` is a table with the following optional fields:
6103 * `visible`: Boolean for whether the moon is visible.
6105 * `texture`: A regular texture for the moon. Setting to `""`
6106 will re-enable the mesh moon. (default: `"moon.png"`)
6107 * `tonemap`: A 512x1 texture containing the tonemap for the moon
6108 (default: `"moon_tonemap.png"`)
6109 * `scale`: Float controlling the overall size of the moon (default: `1`)
6110 * `get_moon()`: returns a table with the current moon parameters as in
6112 * `set_stars(parameters)`:
6113 * `parameters` is a table with the following optional fields:
6114 * `visible`: Boolean for whether the stars are visible.
6116 * `count`: Integer number to set the number of stars in
6117 the skybox. Only applies to `"skybox"` and `"regular"` sky types.
6119 * `star_color`: ColorSpec, sets the colors of the stars,
6120 alpha channel is used to set overall star brightness.
6121 (default: `#ebebff69`)
6122 * `scale`: Float controlling the overall size of the stars (default: `1`)
6123 * `get_stars()`: returns a table with the current stars parameters as in
6125 * `set_clouds(parameters)`: set cloud parameters
6126 * `parameters` is a table with the following optional fields:
6127 * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
6128 * `color`: basic cloud color with alpha channel, ColorSpec
6129 (default `#fff0f0e5`).
6130 * `ambient`: cloud color lower bound, use for a "glow at night" effect.
6131 ColorSpec (alpha ignored, default `#000000`)
6132 * `height`: cloud height, i.e. y of cloud base (default per conf,
6134 * `thickness`: cloud thickness in nodes (default `16`)
6135 * `speed`: 2D cloud speed + direction in nodes per second
6136 (default `{x=0, z=-2}`).
6137 * `get_clouds()`: returns a table with the current cloud parameters as in
6139 * `override_day_night_ratio(ratio or nil)`
6140 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific
6142 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
6143 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
6144 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`:
6145 set animation for player model in third person view
6147 set_local_animation({x=0, y=79}, -- stand/idle animation key frames
6148 {x=168, y=187}, -- walk animation key frames
6149 {x=189, y=198}, -- dig animation key frames
6150 {x=200, y=219}, -- walk+dig animation key frames
6151 frame_speed=30) -- animation frame speed
6152 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and
6154 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for
6156 * in first person view
6157 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
6158 * `get_eye_offset()`: returns `offset_first` and `offset_third`
6159 * `send_mapblock(blockpos)`:
6160 * Sends a server-side loaded mapblock to the player.
6161 * Returns `false` if failed.
6162 * Resource intensive - use sparsely
6163 * To get blockpos, integer divide pos by 16
6168 A 32-bit pseudorandom number generator.
6169 Uses PCG32, an algorithm of the permuted congruential generator family,
6170 offering very strong randomness.
6172 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
6176 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
6177 * `next(min, max)`: return next integer random number [`min`...`max`]
6178 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed
6179 random number [`min`...`max`].
6180 * This is only a rough approximation of a normal distribution with:
6181 * `mean = (max - min) / 2`, and
6182 * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
6183 * Increasing `num_trials` improves accuracy of the approximation
6188 A perlin noise generator.
6189 It can be created via `PerlinNoise(seed, octaves, persistence, spread)`
6190 or `PerlinNoise(noiseparams)`.
6191 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
6192 or `minetest.get_perlin(noiseparams)`.
6196 * `get_2d(pos)`: returns 2D noise value at `pos={x=,y=}`
6197 * `get_3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
6202 A fast, bulk perlin noise generator.
6204 It can be created via `PerlinNoiseMap(noiseparams, size)` or
6205 `minetest.get_perlin_map(noiseparams, size)`.
6207 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
6208 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
6211 For each of the functions with an optional `buffer` parameter: If `buffer` is
6212 not nil, this table will be used to store the result instead of creating a new
6217 * `get_2d_map(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
6218 with values starting at `pos={x=,y=}`
6219 * `get_3d_map(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>`
6220 3D array of 3D noise with values starting at `pos={x=,y=,z=}`.
6221 * `get_2d_map_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element
6222 array of 2D noise with values starting at `pos={x=,y=}`
6223 * `get_3d_map_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
6224 * `calc_2d_map(pos)`: Calculates the 2d noise map starting at `pos`. The result
6225 is stored internally.
6226 * `calc_3d_map(pos)`: Calculates the 3d noise map starting at `pos`. The result
6227 is stored internally.
6228 * `get_map_slice(slice_offset, slice_size, buffer)`: In the form of an array,
6229 returns a slice of the most recently computed noise results. The result slice
6230 begins at coordinates `slice_offset` and takes a chunk of `slice_size`.
6231 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer
6233 `noisevals = noise:get_map_slice({y=20}, {y=2})`
6234 It is important to note that `slice_offset` offset coordinates begin at 1,
6235 and are relative to the starting position of the most recently calculated
6237 To grab a single vertical column of noise starting at map coordinates
6238 x = 1023, y=1000, z = 1000:
6239 `noise:calc_3d_map({x=1000, y=1000, z=1000})`
6240 `noisevals = noise:get_map_slice({x=24, z=1}, {x=1, z=1})`
6246 Uses the same method of storage as the deprecated player attribute API, so
6247 data there will also be in player meta.
6248 Can be obtained using `player:get_meta()`.
6252 * All methods in MetaDataRef
6257 A 16-bit pseudorandom number generator.
6258 Uses a well-known LCG algorithm introduced by K&R.
6260 It can be created via `PseudoRandom(seed)`.
6264 * `next()`: return next integer random number [`0`...`32767`]
6265 * `next(min, max)`: return next integer random number [`min`...`max`]
6266 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
6267 due to the simple implementation making bad distribution otherwise.
6272 A raycast on the map. It works with selection boxes.
6273 Can be used as an iterator in a for loop as:
6275 local ray = Raycast(...)
6276 for pointed_thing in ray do
6280 The map is loaded as the ray advances. If the map is modified after the
6281 `Raycast` is created, the changes may or may not have an effect on the object.
6283 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
6284 `minetest.raycast(pos1, pos2, objects, liquids)` where:
6286 * `pos1`: start of the ray
6287 * `pos2`: end of the ray
6288 * `objects`: if false, only nodes will be returned. Default is true.
6289 * `liquids`: if false, liquid nodes won't be returned. Default is false.
6293 * `next()`: returns a `pointed_thing` with exact pointing location
6294 * Returns the next thing pointed by the ray or nil.
6299 Interface for the operating system's crypto-secure PRNG.
6301 It can be created via `SecureRandom()`. The constructor returns nil if a
6302 secure random device cannot be found on the system.
6306 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many
6307 random bytes, as a string.
6312 An interface to read config files in the format of `minetest.conf`.
6314 It can be created via `Settings(filename)`.
6318 * `get(key)`: returns a value
6319 * `get_bool(key, [default])`: returns a boolean
6320 * `default` is the value returned if `key` is not found.
6321 * Returns `nil` if `key` is not found and `default` not specified.
6322 * `get_np_group(key)`: returns a NoiseParams table
6324 * Returns `{flag = true/false, ...}` according to the set flags.
6325 * Is currently limited to mapgen flags `mg_flags` and mapgen-specific
6326 flags like `mgv5_spflags`.
6328 * Setting names can't contain whitespace or any of `="{}#`.
6329 * Setting values can't contain the sequence `\n"""`.
6330 * Setting names starting with "secure." can't be set on the main settings
6331 object (`minetest.settings`).
6332 * `set_bool(key, value)`
6333 * See documentation for set() above.
6334 * `set_np_group(key, value)`
6335 * `value` is a NoiseParams table.
6336 * Also, see documentation for set() above.
6337 * `remove(key)`: returns a boolean (`true` for success)
6338 * `get_names()`: returns `{key1,...}`
6339 * `write()`: returns a boolean (`true` for success)
6340 * Writes changes to file.
6341 * `to_table()`: returns `{[key1]=value1,...}`
6345 The settings have the format `key = value`. Example:
6357 Mod metadata: per mod metadata, saved automatically.
6358 Can be obtained via `minetest.get_mod_storage()` during load time.
6360 WARNING: This storage backend is incaptable to save raw binary data due
6361 to restrictions of JSON.
6365 * All methods in MetaDataRef
6376 Used by `ObjectRef` methods. Part of an Entity definition.
6377 These properties are not persistent, but are applied automatically to the
6378 corresponding Lua entity using the given registration fields.
6379 Player properties need to be saved manually.
6383 -- For players only. Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`.
6386 -- For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`.
6389 -- For players only. Zoom FOV in degrees.
6390 -- Note that zoom loads and/or generates world beyond the server's
6391 -- maximum send and generate distances, so acts like a telescope.
6392 -- Smaller zoom_fov values increase the distance loaded/generated.
6393 -- Defaults to 15 in creative mode, 0 in survival mode.
6394 -- zoom_fov = 0 disables zooming for the player.
6397 -- For players only. Camera height above feet position in nodes.
6398 -- Defaults to 1.625.
6401 -- Collide with `walkable` nodes.
6403 collide_with_objects = true,
6404 -- Collide with other objects if physical = true
6406 collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5}, -- Default
6407 selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
6408 -- Selection box uses collision box dimensions when not set.
6409 -- For both boxes: {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from
6413 -- Overrides selection box when false
6415 visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem" / "item",
6416 -- "cube" is a node-sized cube.
6417 -- "sprite" is a flat texture always facing the player.
6418 -- "upright_sprite" is a vertical flat texture.
6419 -- "mesh" uses the defined mesh model.
6420 -- "wielditem" is used for dropped items.
6421 -- (see builtin/game/item_entity.lua).
6422 -- For this use 'wield_item = itemname' (Deprecated: 'textures = {itemname}').
6423 -- If the item has a 'wield_image' the object will be an extrusion of
6425 -- If 'itemname' is a cubic node or nodebox the object will appear
6426 -- identical to 'itemname'.
6427 -- If 'itemname' is a plantlike node the object will be an extrusion
6429 -- Otherwise for non-node items, the object will be an extrusion of
6430 -- 'inventory_image'.
6431 -- If 'itemname' contains a ColorString or palette index (e.g. from
6432 -- `minetest.itemstring_with_palette()`), the entity will inherit the color.
6433 -- "item" is similar to "wielditem" but ignores the 'wield_image' parameter.
6435 visual_size = {x = 1, y = 1, z = 1},
6436 -- Multipliers for the visual size. If `z` is not specified, `x` will be used
6437 -- to scale the entity along both horizontal axes.
6440 -- File name of mesh when using "mesh" visual
6443 -- Number of required textures depends on visual.
6444 -- "cube" uses 6 textures just like a node, but all 6 must be defined.
6445 -- "sprite" uses 1 texture.
6446 -- "upright_sprite" uses 2 textures: {front, back}.
6447 -- "wielditem" expects 'textures = {itemname}' (see 'visual' above).
6450 -- Number of required colors depends on visual
6452 use_texture_alpha = false,
6453 -- Use texture's alpha channel.
6454 -- Excludes "upright_sprite" and "wielditem".
6455 -- Note: currently causes visual issues when viewed through other
6456 -- semi-transparent materials such as water.
6458 spritediv = {x = 1, y = 1},
6459 -- Used with spritesheet textures for animation and/or frame selection
6460 -- according to position relative to player.
6461 -- Defines the number of columns and rows in the spritesheet:
6464 initial_sprite_basepos = {x = 0, y = 0},
6465 -- Used with spritesheet textures.
6466 -- Defines the {column, row} position of the initially used frame in the
6470 -- If false, object is invisible and can't be pointed.
6472 makes_footstep_sound = false,
6473 -- If true, is able to make footstep sounds of nodes
6474 -- (see node sound definition for details).
6476 automatic_rotate = 0,
6477 -- Set constant rotation in radians per second, positive or negative.
6478 -- Set to 0 to disable constant rotation.
6481 -- If positive number, object will climb upwards when it moves
6482 -- horizontally against a `walkable` node, if the height difference
6483 -- is within `stepheight`.
6485 automatic_face_movement_dir = 0.0,
6486 -- Automatically set yaw to movement direction, offset in degrees.
6487 -- 'false' to disable.
6489 automatic_face_movement_max_rotation_per_sec = -1,
6490 -- Limit automatic rotation to this value in degrees per second.
6491 -- No limit if value <= 0.
6493 backface_culling = true,
6494 -- Set to false to disable backface_culling for model
6497 -- Add this much extra lighting when calculating texture color.
6498 -- Value < 0 disables light's effect on texture color.
6499 -- For faking self-lighting, UI style entities, or programmatic coloring
6503 -- By default empty, for players their name is shown if empty
6505 nametag_color = <ColorSpec>,
6506 -- Sets color of nametag
6509 -- By default empty, text to be shown when pointed at object
6512 -- If false, never save this object statically. It will simply be
6513 -- deleted when the block gets unloaded.
6514 -- The get_staticdata() callback is never called then.
6515 -- Defaults to 'true'.
6521 Used by `minetest.register_entity`.
6524 initial_properties = {
6526 mesh = "boats_boat.obj",
6529 -- A table of object properties, see the `Object properties` section.
6530 -- Object properties being read directly from the entity definition
6531 -- table is deprecated. Define object properties in this
6532 -- `initial_properties` table instead.
6534 on_activate = function(self, staticdata, dtime_s),
6536 on_step = function(self, dtime),
6538 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
6540 on_rightclick = function(self, clicker),
6542 get_staticdata = function(self),
6543 -- Called sometimes; the string returned is passed to on_activate when
6544 -- the entity is re-activated from static state
6546 _custom_field = whatever,
6547 -- You can define arbitrary member variables here (see Item definition
6548 -- for more info) by using a '_' prefix
6551 ABM (ActiveBlockModifier) definition
6552 ------------------------------------
6554 Used by `minetest.register_abm`.
6557 label = "Lava cooling",
6558 -- Descriptive label for profiling purposes (optional).
6559 -- Definitions with identical labels will be listed as one.
6561 nodenames = {"default:lava_source"},
6562 -- Apply `action` function to these nodes.
6563 -- `group:groupname` can also be used here.
6565 neighbors = {"default:water_source", "default:water_flowing"},
6566 -- Only apply `action` to nodes that have one of, or any
6567 -- combination of, these neighbors.
6568 -- If left out or empty, any neighbor will do.
6569 -- `group:groupname` can also be used here.
6572 -- Operation interval in seconds
6575 -- Chance of triggering `action` per-node per-interval is 1.0 / this
6579 -- If true, catch-up behaviour is enabled: The `chance` value is
6580 -- temporarily reduced when returning to an area to simulate time lost
6581 -- by the area being unattended. Note that the `chance` value can often
6584 action = function(pos, node, active_object_count, active_object_count_wider),
6585 -- Function triggered for each qualifying node.
6586 -- `active_object_count` is number of active objects in the node's
6588 -- `active_object_count_wider` is number of active objects in the node's
6589 -- mapblock plus all 26 neighboring mapblocks. If any neighboring
6590 -- mapblocks are unloaded an estmate is calculated for them based on
6591 -- loaded mapblocks.
6594 LBM (LoadingBlockModifier) definition
6595 -------------------------------------
6597 Used by `minetest.register_lbm`.
6599 A loading block modifier (LBM) is used to define a function that is called for
6600 specific nodes (defined by `nodenames`) when a mapblock which contains such nodes
6604 label = "Upgrade legacy doors",
6605 -- Descriptive label for profiling purposes (optional).
6606 -- Definitions with identical labels will be listed as one.
6608 name = "modname:replace_legacy_door",
6610 nodenames = {"default:lava_source"},
6611 -- List of node names to trigger the LBM on.
6612 -- Also non-registered nodes will work.
6613 -- Groups (as of group:groupname) will work as well.
6615 run_at_every_load = false,
6616 -- Whether to run the LBM's action every time a block gets loaded,
6617 -- and not only the first time the block gets loaded after the LBM
6620 action = function(pos, node),
6627 * `{name="image.png", animation={Tile Animation definition}}`
6628 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
6629 tileable_horizontal=bool, align_style="node"/"world"/"user", scale=int}`
6630 * backface culling enabled by default for most nodes
6631 * tileable flags are info for shaders, how they should treat texture
6632 when displacement mapping is used.
6633 Directions are from the point of view of the tile texture,
6634 not the node it's on.
6635 * align style determines whether the texture will be rotated with the node
6636 or kept aligned with its surroundings. "user" means that client
6637 setting will be used, similar to `glasslike_framed_optional`.
6638 Note: supported by solid nodes and nodeboxes only.
6639 * scale is used to make texture span several (exactly `scale`) nodes,
6640 instead of just one, in each direction. Works for world-aligned
6642 Note that as the effect is applied on per-mapblock basis, `16` should
6643 be equally divisible by `scale` or you may get wrong results.
6644 * `{name="image.png", color=ColorSpec}`
6645 * the texture's color will be multiplied with this color.
6646 * the tile's color overrides the owning node's color in all cases.
6647 * deprecated, yet still supported field names:
6650 Tile animation definition
6651 -------------------------
6654 type = "vertical_frames",
6657 -- Width of a frame in pixels
6660 -- Height of a frame in pixels
6670 -- Width in number of frames
6673 -- Height in number of frames
6676 -- Length of a single frame
6682 Used by `minetest.register_node`, `minetest.register_craftitem`, and
6683 `minetest.register_tool`.
6686 description = "Steel Axe",
6689 -- key = name, value = rating; rating = 1..3.
6690 -- If rating not applicable, use 1.
6691 -- e.g. {wool = 1, fluffy = 3}
6692 -- {soil = 2, outerspace = 1, crumbly = 1}
6693 -- {bendy = 2, snappy = 1},
6694 -- {hard = 1, metal = 1, spikes = 1}
6696 inventory_image = "default_tool_steelaxe.png",
6698 inventory_overlay = "overlay.png",
6699 -- An overlay which does not get colorized
6706 -- An image file containing the palette of a node.
6707 -- You can set the currently used color as the "palette_index" field of
6708 -- the item stack metadata.
6709 -- The palette is always stretched to fit indices between 0 and 255, to
6710 -- ensure compatibility with "colorfacedir" and "colorwallmounted" nodes.
6712 color = "0xFFFFFFFF",
6713 -- The color of the item. The palette overrides this.
6715 wield_scale = {x = 1, y = 1, z = 1},
6721 liquids_pointable = false,
6723 -- See "Tools" section for an example including explanation
6724 tool_capabilities = {
6725 full_punch_interval = 1.0,
6729 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00},
6730 uses = 20, maxlevel = 2},
6732 damage_groups = {groupname = damage},
6733 -- Damage values must be between -32768 and 32767 (2^15)
6735 punch_attack_uses = nil,
6736 -- Amount of uses this tool has for attacking players and entities
6737 -- by punching them (0 = infinite uses).
6738 -- For compatibility, this is automatically set from the first
6739 -- suitable groupcap using the forumla "uses * 3^(maxlevel - 1)".
6740 -- It is recommend to set this explicitly instead of relying on the
6741 -- fallback behavior.
6744 node_placement_prediction = nil,
6745 -- If nil and item is node, prediction is made automatically.
6746 -- If nil and item is not a node, no prediction is made.
6747 -- If "" and item is anything, no prediction is made.
6748 -- Otherwise should be name of node which the client immediately places
6749 -- on ground when the player places the item. Server will always update
6750 -- actual result to client in a short moment.
6752 node_dig_prediction = "air",
6753 -- if "", no prediction is made.
6754 -- if "air", node is removed.
6755 -- Otherwise should be name of node which the client immediately places
6756 -- upon digging. Server will always update actual result shortly.
6759 -- Definition of items sounds to be played at various events.
6760 -- All fields in this table are optional.
6762 breaks = <SimpleSoundSpec>,
6763 -- When tool breaks due to wear. Ignored for non-tools
6765 eat = <SimpleSoundSpec>,
6766 -- When item is eaten with `minetest.do_item_eat`
6769 on_place = function(itemstack, placer, pointed_thing),
6770 -- Shall place item and return the leftover itemstack.
6771 -- The placer may be any ObjectRef or nil.
6772 -- default: minetest.item_place
6774 on_secondary_use = function(itemstack, user, pointed_thing),
6775 -- Same as on_place but called when not pointing at a node.
6776 -- The user may be any ObjectRef or nil.
6779 on_drop = function(itemstack, dropper, pos),
6780 -- Shall drop item and return the leftover itemstack.
6781 -- The dropper may be any ObjectRef or nil.
6782 -- default: minetest.item_drop
6784 on_use = function(itemstack, user, pointed_thing),
6786 -- Function must return either nil if no item shall be removed from
6787 -- inventory, or an itemstack to replace the original itemstack.
6788 -- e.g. itemstack:take_item(); return itemstack
6789 -- Otherwise, the function is free to do what it wants.
6790 -- The user may be any ObjectRef or nil.
6791 -- The default functions handle regular use cases.
6793 after_use = function(itemstack, user, node, digparams),
6795 -- If defined, should return an itemstack and will be called instead of
6796 -- wearing out the tool. If returns nil, does nothing.
6797 -- If after_use doesn't exist, it is the same as:
6798 -- function(itemstack, user, node, digparams)
6799 -- itemstack:add_wear(digparams.wear)
6802 -- The user may be any ObjectRef or nil.
6804 _custom_field = whatever,
6805 -- Add your own custom fields. By convention, all custom field names
6806 -- should start with `_` to avoid naming collisions with future engine
6813 Used by `minetest.register_node`.
6816 -- <all fields allowed in item definitions>,
6818 drawtype = "normal", -- See "Node drawtypes"
6821 -- Supported for drawtypes "plantlike", "signlike", "torchlike",
6822 -- "firelike", "mesh".
6823 -- For plantlike and firelike, the image will start at the bottom of the
6824 -- node. For torchlike, the image will start at the surface to which the
6825 -- node "attaches". For the other drawtypes the image will be centered
6828 tiles = {tile definition 1, def2, def3, def4, def5, def6},
6829 -- Textures of node; +Y, -Y, +X, -X, +Z, -Z
6830 -- Old field name was 'tile_images'.
6831 -- List can be shortened to needed length.
6833 overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6},
6834 -- Same as `tiles`, but these textures are drawn on top of the base
6835 -- tiles. You can use this to colorize only specific parts of your
6836 -- texture. If the texture name is an empty string, that overlay is not
6837 -- drawn. Since such tiles are drawn twice, it is not recommended to use
6838 -- overlays on very common nodes.
6840 special_tiles = {tile definition 1, Tile definition 2},
6841 -- Special textures of node; used rarely.
6842 -- Old field name was 'special_materials'.
6843 -- List can be shortened to needed length.
6846 -- The node's original color will be multiplied with this color.
6847 -- If the node has a palette, then this setting only has an effect in
6848 -- the inventory and on the wield item.
6850 use_texture_alpha = false,
6851 -- Use texture's alpha channel
6853 palette = "palette.png",
6854 -- The node's `param2` is used to select a pixel from the image.
6855 -- Pixels are arranged from left to right and from top to bottom.
6856 -- The node's color will be multiplied with the selected pixel's color.
6857 -- Tiles can override this behavior.
6858 -- Only when `paramtype2` supports palettes.
6860 post_effect_color = "green#0F",
6861 -- Screen tint if player is inside node, see "ColorSpec"
6863 paramtype = "none", -- See "Nodes"
6865 paramtype2 = "none", -- See "Nodes"
6867 place_param2 = nil, -- Force value for param2 when player places node
6869 is_ground_content = true,
6870 -- If false, the cave generator and dungeon generator will not carve
6871 -- through this node.
6872 -- Specifically, this stops mod-added nodes being removed by caves and
6873 -- dungeons when those generate in a neighbor mapchunk and extend out
6874 -- beyond the edge of that mapchunk.
6876 sunlight_propagates = false,
6877 -- If true, sunlight will go infinitely through this node
6879 walkable = true, -- If true, objects collide with node
6881 pointable = true, -- If true, can be pointed at
6883 diggable = true, -- If false, can never be dug
6885 climbable = false, -- If true, can be climbed on (ladder)
6887 buildable_to = false, -- If true, placed nodes can replace this node
6890 -- If true, liquids flow into and replace this node.
6891 -- Warning: making a liquid node 'floodable' will cause problems.
6893 liquidtype = "none", -- "none" / "source" / "flowing"
6895 liquid_alternative_flowing = "", -- Flowing version of source liquid
6897 liquid_alternative_source = "", -- Source version of flowing liquid
6899 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
6901 liquid_renewable = true,
6902 -- If true, a new liquid source can be created by placing two or more
6906 -- Only valid for "nodebox" drawtype with 'type = "leveled"'.
6907 -- Allows defining the nodebox height without using param2.
6908 -- The nodebox height is 'leveled' / 64 nodes.
6909 -- The maximum value of 'leveled' is 127.
6911 liquid_range = 8, -- Number of flowing nodes around source (max. 8)
6914 -- Player will take this amount of damage if no bubbles are left
6917 -- Amount of light emitted by node.
6918 -- To set the maximum (14), use the value 'minetest.LIGHT_MAX'.
6919 -- A value outside the range 0 to minetest.LIGHT_MAX causes undefined
6922 damage_per_second = 0,
6923 -- If player is inside node, this damage is caused
6925 node_box = {type="regular"}, -- See "Node boxes"
6927 connects_to = nodenames,
6928 -- Used for nodebox nodes with the type == "connected".
6929 -- Specifies to what neighboring nodes connections will be drawn.
6930 -- e.g. `{"group:fence", "default:wood"}` or `"default:stone"`
6932 connect_sides = { "top", "bottom", "front", "left", "back", "right" },
6933 -- Tells connected nodebox nodes to connect only to these sides of this
6937 -- File name of mesh when using "mesh" drawtype
6942 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
6945 -- Custom selection box definition. Multiple boxes can be defined.
6946 -- If "nodebox" drawtype is used and selection_box is nil, then node_box
6947 -- definition is used for the selection box.
6952 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
6955 -- Custom collision box definition. Multiple boxes can be defined.
6956 -- If "nodebox" drawtype is used and collision_box is nil, then node_box
6957 -- definition is used for the collision box.
6958 -- Both of the boxes above are defined as:
6959 -- {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from node center.
6961 -- Support maps made in and before January 2012
6962 legacy_facedir_simple = false,
6963 legacy_wallmounted = false,
6966 -- Valid for drawtypes:
6967 -- mesh, nodebox, plantlike, allfaces_optional, liquid, flowingliquid.
6968 -- 1 - wave node like plants (node top moves side-to-side, bottom is fixed)
6969 -- 2 - wave node like leaves (whole node moves side-to-side)
6970 -- 3 - wave node like liquids (whole node moves up and down)
6971 -- Not all models will properly wave.
6972 -- plantlike drawtype can only wave like plants.
6973 -- allfaces_optional drawtype can only wave like leaves.
6974 -- liquid, flowingliquid drawtypes can only wave like liquids.
6977 -- Definition of node sounds to be played at various events.
6978 -- All fields in this table are optional.
6980 footstep = <SimpleSoundSpec>,
6981 -- If walkable, played when object walks on it. If node is
6982 -- climbable or a liquid, played when object moves through it
6984 dig = <SimpleSoundSpec> or "__group",
6985 -- While digging node.
6986 -- If `"__group"`, then the sound will be
6987 -- `default_dig_<groupname>`, where `<groupname>` is the
6988 -- name of the tool's digging group with the fastest digging time.
6989 -- In case of a tie, one of the sounds will be played (but we
6990 -- cannot predict which one)
6991 -- Default value: `"__group"`
6993 dug = <SimpleSoundSpec>,
6996 place = <SimpleSoundSpec>,
6997 -- Node was placed. Also played after falling
6999 place_failed = <SimpleSoundSpec>,
7000 -- When node placement failed
7002 fall = <SimpleSoundSpec>,
7003 -- When node starts to fall
7007 -- Name of dropped item when dug.
7008 -- Default dropped item is the node itself.
7009 -- Using a table allows multiple items, drop chances and tool filtering.
7010 -- Tool filtering was undocumented until recently, tool filtering by string
7011 -- matching is deprecated.
7014 -- Maximum number of item lists to drop.
7015 -- The entries in 'items' are processed in order. For each:
7016 -- Tool filtering is applied, chance of drop is applied, if both are
7017 -- successful the entire item list is dropped.
7018 -- Entry processing continues until the number of dropped item lists
7019 -- equals 'max_items'.
7020 -- Therefore, entries should progress from low to high drop chance.
7024 -- 1 in 1000 chance of dropping a diamond.
7025 -- Default rarity is '1'.
7027 items = {"default:diamond"},
7030 -- Only drop if using a tool whose name is identical to one
7032 tools = {"default:shovel_mese", "default:shovel_diamond"},
7034 items = {"default:dirt"},
7035 -- Whether all items in the dropped item list inherit the
7036 -- hardware coloring palette color from the dug node.
7037 -- Default is 'false'.
7038 inherit_color = true,
7041 -- Only drop if using a tool whose name contains
7042 -- "default:shovel_" (this tool filtering by string matching
7044 tools = {"~default:shovel_"},
7046 -- The item list dropped.
7047 items = {"default:sand", "default:desert_sand"},
7052 on_construct = function(pos),
7053 -- Node constructor; called after adding node.
7054 -- Can set up metadata and stuff like that.
7055 -- Not called for bulk node placement (i.e. schematics and VoxelManip).
7058 on_destruct = function(pos),
7059 -- Node destructor; called before removing node.
7060 -- Not called for bulk node placement.
7063 after_destruct = function(pos, oldnode),
7064 -- Node destructor; called after removing node.
7065 -- Not called for bulk node placement.
7068 on_flood = function(pos, oldnode, newnode),
7069 -- Called when a liquid (newnode) is about to flood oldnode, if it has
7070 -- `floodable = true` in the nodedef. Not called for bulk node placement
7071 -- (i.e. schematics and VoxelManip) or air nodes. If return true the
7072 -- node is not flooded, but on_flood callback will most likely be called
7073 -- over and over again every liquid update interval.
7075 -- Warning: making a liquid node 'floodable' will cause problems.
7077 preserve_metadata = function(pos, oldnode, oldmeta, drops),
7078 -- Called when oldnode is about be converted to an item, but before the
7079 -- node is deleted from the world or the drops are added. This is
7080 -- generally the result of either the node being dug or an attached node
7081 -- becoming detached.
7082 -- oldmeta is the NodeMetaRef of the oldnode before deletion.
7083 -- drops is a table of ItemStacks, so any metadata to be preserved can
7084 -- be added directly to one or more of the dropped items. See
7085 -- "ItemStackMetaRef".
7088 after_place_node = function(pos, placer, itemstack, pointed_thing),
7089 -- Called after constructing node when node was placed using
7090 -- minetest.item_place_node / minetest.place_node.
7091 -- If return true no item is taken from itemstack.
7092 -- `placer` may be any valid ObjectRef or nil.
7095 after_dig_node = function(pos, oldnode, oldmetadata, digger),
7096 -- oldmetadata is in table format.
7097 -- Called after destructing node when node was dug using
7098 -- minetest.node_dig / minetest.dig_node.
7101 can_dig = function(pos, [player]),
7102 -- Returns true if node can be dug, or false if not.
7105 on_punch = function(pos, node, puncher, pointed_thing),
7106 -- default: minetest.node_punch
7107 -- Called when puncher (an ObjectRef) punches the node at pos.
7108 -- By default calls minetest.register_on_punchnode callbacks.
7110 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing),
7112 -- Called when clicker (an ObjectRef) "rightclicks"
7113 -- ("rightclick" here stands for the placement key) while pointing at
7114 -- the node at pos with 'node' being the node table.
7115 -- itemstack will hold clicker's wielded item.
7116 -- Shall return the leftover itemstack.
7117 -- Note: pointed_thing can be nil, if a mod calls this function.
7118 -- This function does not get triggered by clients <=0.4.16 if the
7119 -- "formspec" node metadata field is set.
7121 on_dig = function(pos, node, digger),
7122 -- default: minetest.node_dig
7123 -- By default checks privileges, wears out tool and removes node.
7125 on_timer = function(pos, elapsed),
7127 -- called by NodeTimers, see minetest.get_node_timer and NodeTimerRef.
7128 -- elapsed is the total time passed since the timer was started.
7129 -- return true to run the timer for another cycle with the same timeout
7132 on_receive_fields = function(pos, formname, fields, sender),
7133 -- fields = {name1 = value1, name2 = value2, ...}
7134 -- Called when an UI form (e.g. sign text input) returns data.
7135 -- See minetest.register_on_player_receive_fields for more info.
7138 allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7139 -- Called when a player wants to move items inside the inventory.
7140 -- Return value: number of items allowed to move.
7142 allow_metadata_inventory_put = function(pos, listname, index, stack, player),
7143 -- Called when a player wants to put something into the inventory.
7144 -- Return value: number of items allowed to put.
7145 -- Return value -1: Allow and don't modify item count in inventory.
7147 allow_metadata_inventory_take = function(pos, listname, index, stack, player),
7148 -- Called when a player wants to take something out of the inventory.
7149 -- Return value: number of items allowed to take.
7150 -- Return value -1: Allow and don't modify item count in inventory.
7152 on_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7153 on_metadata_inventory_put = function(pos, listname, index, stack, player),
7154 on_metadata_inventory_take = function(pos, listname, index, stack, player),
7155 -- Called after the actual action has happened, according to what was
7159 on_blast = function(pos, intensity),
7160 -- intensity: 1.0 = mid range of regular TNT.
7161 -- If defined, called when an explosion touches the node, instead of
7162 -- removing the node.
7168 Used by `minetest.register_craft`.
7173 output = 'default:pick_stone',
7175 {'default:cobble', 'default:cobble', 'default:cobble'},
7176 {'', 'default:stick', ''},
7177 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
7179 replacements = <list of item pairs>,
7180 -- replacements: replace one input item with another item on crafting
7188 output = 'mushrooms:mushroom_stew',
7191 "mushrooms:mushroom_brown",
7192 "mushrooms:mushroom_red",
7194 replacements = <list of item pairs>,
7200 type = "toolrepair",
7201 additional_wear = -0.02,
7204 Note: Tools with group `disable_repair=1` will not repairable by this recipe.
7210 output = "default:glass",
7211 recipe = "default:sand",
7219 recipe = "bucket:bucket_lava",
7221 replacements = {{"bucket:bucket_lava", "bucket:bucket_empty"}},
7227 Used by `minetest.register_ore`.
7229 See [Ores] section above for essential information.
7232 ore_type = "scatter",
7234 ore = "default:stone_with_coal",
7237 -- Facedir rotation. Default is 0 (unchanged rotation)
7239 wherein = "default:stone",
7240 -- A list of nodenames is supported too
7242 clust_scarcity = 8 * 8 * 8,
7243 -- Ore has a 1 out of clust_scarcity chance of spawning in a node.
7244 -- If the desired average distance between ores is 'd', set this to
7248 -- Number of ores in a cluster
7251 -- Size of the bounding box of the cluster.
7252 -- In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27
7253 -- nodes are coal ore.
7257 -- Lower and upper limits for ore
7260 -- Attributes for the ore generation, see 'Ore attributes' section above
7262 noise_threshold = 0.5,
7263 -- If noise is above this threshold, ore is placed. Not needed for a
7264 -- uniform distribution.
7269 spread = {x = 100, y = 100, z = 100},
7274 -- NoiseParams structure describing one of the perlin noises used for
7275 -- ore distribution.
7276 -- Needed by "sheet", "puff", "blob" and "vein" ores.
7277 -- Omit from "scatter" ore for a uniform ore distribution.
7278 -- Omit from "stratum" ore for a simple horizontal strata from y_min to
7281 biomes = {"desert", "rainforest"},
7282 -- List of biomes in which this ore occurs.
7283 -- Occurs in all biomes if this is omitted, and ignored if the Mapgen
7284 -- being used does not support biomes.
7285 -- Can be a list of (or a single) biome names, IDs, or definitions.
7287 -- Type-specific parameters
7290 column_height_min = 1,
7291 column_height_max = 16,
7292 column_midpoint_factor = 0.5,
7298 spread = {x = 100, y = 100, z = 100},
7306 spread = {x = 100, y = 100, z = 100},
7313 random_factor = 1.0,
7316 np_stratum_thickness = {
7319 spread = {x = 100, y = 100, z = 100},
7324 stratum_thickness = 8,
7330 Used by `minetest.register_biome`.
7335 node_dust = "default:snow",
7336 -- Node dropped onto upper surface after all else is generated
7338 node_top = "default:dirt_with_snow",
7340 -- Node forming surface layer of biome and thickness of this layer
7342 node_filler = "default:permafrost",
7344 -- Node forming lower layer of biome and thickness of this layer
7346 node_stone = "default:bluestone",
7347 -- Node that replaces all stone nodes between roughly y_min and y_max.
7349 node_water_top = "default:ice",
7350 depth_water_top = 10,
7351 -- Node forming a surface layer in seawater with the defined thickness
7354 -- Node that replaces all seawater nodes not in the surface layer
7356 node_river_water = "default:ice",
7357 -- Node that replaces river water in mapgens that use
7358 -- default:river_water
7360 node_riverbed = "default:gravel",
7362 -- Node placed under river water and thickness of this layer
7364 node_cave_liquid = "default:lava_source",
7365 node_cave_liquid = {"default:water_source", "default:lava_source"},
7366 -- Nodes placed inside 50% of the medium size caves.
7367 -- Multiple nodes can be specified, each cave will use a randomly
7368 -- chosen node from the list.
7369 -- If this field is left out or 'nil', cave liquids fall back to
7370 -- classic behaviour of lava and water distributed using 3D noise.
7371 -- For no cave liquid, specify "air".
7373 node_dungeon = "default:cobble",
7374 -- Node used for primary dungeon structure.
7375 -- If absent, dungeon nodes fall back to the 'mapgen_cobble' mapgen
7376 -- alias, if that is also absent, dungeon nodes fall back to the biome
7378 -- If present, the following two nodes are also used.
7380 node_dungeon_alt = "default:mossycobble",
7381 -- Node used for randomly-distributed alternative structure nodes.
7382 -- If alternative structure nodes are not wanted leave this absent for
7383 -- performance reasons.
7385 node_dungeon_stair = "stairs:stair_cobble",
7386 -- Node used for dungeon stairs.
7387 -- If absent, stairs fall back to 'node_dungeon'.
7391 -- Upper and lower limits for biome.
7392 -- Alternatively you can use xyz limits as shown below.
7394 max_pos = {x = 31000, y = 128, z = 31000},
7395 min_pos = {x = -31000, y = 9, z = -31000},
7396 -- xyz limits for biome, an alternative to using 'y_min' and 'y_max'.
7397 -- Biome is limited to a cuboid defined by these positions.
7398 -- Any x, y or z field left undefined defaults to -31000 in 'min_pos' or
7399 -- 31000 in 'max_pos'.
7402 -- Vertical distance in nodes above 'y_max' over which the biome will
7403 -- blend with the biome above.
7404 -- Set to 0 for no vertical blend. Defaults to 0.
7407 humidity_point = 50,
7408 -- Characteristic temperature and humidity for the biome.
7409 -- These values create 'biome points' on a voronoi diagram with heat and
7410 -- humidity as axes. The resulting voronoi cells determine the
7411 -- distribution of the biomes.
7412 -- Heat and humidity have average values of 50, vary mostly between
7413 -- 0 and 100 but can exceed these values.
7416 Decoration definition
7417 ---------------------
7419 See [Decoration types]. Used by `minetest.register_decoration`.
7422 deco_type = "simple",
7424 place_on = "default:dirt_with_grass",
7425 -- Node (or list of nodes) that the decoration can be placed on
7428 -- Size of the square divisions of the mapchunk being generated.
7429 -- Determines the resolution of noise variation if used.
7430 -- If the chunk size is not evenly divisible by sidelen, sidelen is made
7431 -- equal to the chunk size.
7434 -- The value determines 'decorations per surface node'.
7435 -- Used only if noise_params is not specified.
7436 -- If >= 10.0 complete coverage is enabled and decoration placement uses
7437 -- a different and much faster method.
7442 spread = {x = 100, y = 100, z = 100},
7449 -- NoiseParams structure describing the perlin noise used for decoration
7451 -- A noise value is calculated for each square division and determines
7452 -- 'decorations per surface node' within each division.
7453 -- If the noise value >= 10.0 complete coverage is enabled and
7454 -- decoration placement uses a different and much faster method.
7456 biomes = {"Oceanside", "Hills", "Plains"},
7457 -- List of biomes in which this decoration occurs. Occurs in all biomes
7458 -- if this is omitted, and ignored if the Mapgen being used does not
7460 -- Can be a list of (or a single) biome names, IDs, or definitions.
7464 -- Lower and upper limits for decoration.
7465 -- These parameters refer to the Y co-ordinate of the 'place_on' node.
7467 spawn_by = "default:water",
7468 -- Node (or list of nodes) that the decoration only spawns next to.
7469 -- Checks two horizontal planes of 8 neighbouring nodes (including
7470 -- diagonal neighbours), one plane level with the 'place_on' node and a
7471 -- plane one node above that.
7474 -- Number of spawn_by nodes that must be surrounding the decoration
7475 -- position to occur.
7476 -- If absent or -1, decorations occur next to any nodes.
7478 flags = "liquid_surface, force_placement, all_floors, all_ceilings",
7479 -- Flags for all decoration types.
7480 -- "liquid_surface": Instead of placement on the highest solid surface
7481 -- in a mapchunk column, placement is on the highest liquid surface.
7482 -- Placement is disabled if solid nodes are found above the liquid
7484 -- "force_placement": Nodes other than "air" and "ignore" are replaced
7485 -- by the decoration.
7486 -- "all_floors", "all_ceilings": Instead of placement on the highest
7487 -- surface in a mapchunk the decoration is placed on all floor and/or
7488 -- ceiling surfaces, for example in caves and dungeons.
7489 -- Ceiling decorations act as an inversion of floor decorations so the
7490 -- effect of 'place_offset_y' is inverted.
7491 -- Y-slice probabilities do not function correctly for ceiling
7492 -- schematic decorations as the behaviour is unchanged.
7493 -- If a single decoration registration has both flags the floor and
7494 -- ceiling decorations will be aligned vertically.
7496 ----- Simple-type parameters
7498 decoration = "default:grass",
7499 -- The node name used as the decoration.
7500 -- If instead a list of strings, a randomly selected node from the list
7501 -- is placed as the decoration.
7504 -- Decoration height in nodes.
7505 -- If height_max is not 0, this is the lower limit of a randomly
7509 -- Upper limit of the randomly selected height.
7510 -- If absent, the parameter 'height' is used as a constant.
7513 -- Param2 value of decoration nodes.
7514 -- If param2_max is not 0, this is the lower limit of a randomly
7518 -- Upper limit of the randomly selected param2.
7519 -- If absent, the parameter 'param2' is used as a constant.
7522 -- Y offset of the decoration base node relative to the standard base
7524 -- Can be positive or negative. Default is 0.
7525 -- Effect is inverted for "all_ceilings" decorations.
7526 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
7527 -- to the 'place_on' node.
7529 ----- Schematic-type parameters
7531 schematic = "foobar.mts",
7532 -- If schematic is a string, it is the filepath relative to the current
7533 -- working directory of the specified Minetest schematic file.
7534 -- Could also be the ID of a previously registered schematic.
7537 size = {x = 4, y = 6, z = 4},
7539 {name = "default:cobble", param1 = 255, param2 = 0},
7540 {name = "default:dirt_with_grass", param1 = 255, param2 = 0},
7541 {name = "air", param1 = 255, param2 = 0},
7545 {ypos = 2, prob = 128},
7546 {ypos = 5, prob = 64},
7550 -- Alternative schematic specification by supplying a table. The fields
7551 -- size and data are mandatory whereas yslice_prob is optional.
7552 -- See 'Schematic specifier' for details.
7554 replacements = {["oldname"] = "convert_to", ...},
7556 flags = "place_center_x, place_center_y, place_center_z",
7557 -- Flags for schematic decorations. See 'Schematic attributes'.
7560 -- Rotation can be "0", "90", "180", "270", or "random"
7563 -- If the flag 'place_center_y' is set this parameter is ignored.
7564 -- Y offset of the schematic base node layer relative to the 'place_on'
7566 -- Can be positive or negative. Default is 0.
7567 -- Effect is inverted for "all_ceilings" decorations.
7568 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
7569 -- to the 'place_on' node.
7572 Chat command definition
7573 -----------------------
7575 Used by `minetest.register_chatcommand`.
7578 params = "<name> <privilege>", -- Short parameter description
7580 description = "Remove privilege from player", -- Full description
7582 privs = {privs=true}, -- Require the "privs" privilege to run
7584 func = function(name, param),
7585 -- Called when command is run. Returns boolean success and text output.
7588 Note that in params, use of symbols is as follows:
7590 * `<>` signifies a placeholder to be replaced when the command is used. For
7591 example, when a player name is needed: `<name>`
7592 * `[]` signifies param is optional and not required when the command is used.
7593 For example, if you require param1 but param2 is optional:
7594 `<param1> [<param2>]`
7595 * `|` signifies exclusive or. The command requires one param from the options
7596 provided. For example: `<param1> | <param2>`
7597 * `()` signifies grouping. For example, when param1 and param2 are both
7598 required, or only param3 is required: `(<param1> <param2>) | <param3>`
7600 Privilege definition
7601 --------------------
7603 Used by `minetest.register_privilege`.
7607 -- Privilege description
7609 give_to_singleplayer = true,
7610 -- Whether to grant the privilege to singleplayer.
7612 give_to_admin = true,
7613 -- Whether to grant the privilege to the server admin.
7614 -- Uses value of 'give_to_singleplayer' by default.
7616 on_grant = function(name, granter_name),
7617 -- Called when given to player 'name' by 'granter_name'.
7618 -- 'granter_name' will be nil if the priv was granted by a mod.
7620 on_revoke = function(name, revoker_name),
7621 -- Called when taken from player 'name' by 'revoker_name'.
7622 -- 'revoker_name' will be nil if the priv was revoked by a mod.
7624 -- Note that the above two callbacks will be called twice if a player is
7625 -- responsible, once with the player name, and then with a nil player
7627 -- Return true in the above callbacks to stop register_on_priv_grant or
7628 -- revoke being called.
7631 Detached inventory callbacks
7632 ----------------------------
7634 Used by `minetest.create_detached_inventory`.
7637 allow_move = function(inv, from_list, from_index, to_list, to_index, count, player),
7638 -- Called when a player wants to move items inside the inventory.
7639 -- Return value: number of items allowed to move.
7641 allow_put = function(inv, listname, index, stack, player),
7642 -- Called when a player wants to put something into the inventory.
7643 -- Return value: number of items allowed to put.
7644 -- Return value -1: Allow and don't modify item count in inventory.
7646 allow_take = function(inv, listname, index, stack, player),
7647 -- Called when a player wants to take something out of the inventory.
7648 -- Return value: number of items allowed to take.
7649 -- Return value -1: Allow and don't modify item count in inventory.
7651 on_move = function(inv, from_list, from_index, to_list, to_index, count, player),
7652 on_put = function(inv, listname, index, stack, player),
7653 on_take = function(inv, listname, index, stack, player),
7654 -- Called after the actual action has happened, according to what was
7664 Used by `Player:hud_add`. Returned by `Player:hud_get`.
7667 hud_elem_type = "image", -- See HUD element types
7668 -- Type of element, can be "image", "text", "statbar", or "inventory"
7670 position = {x=0.5, y=0.5},
7671 -- Left corner position of element
7675 scale = {x = 2, y = 2},
7682 -- Selected item in inventory. 0 for no item selected.
7685 -- Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
7687 alignment = {x=0, y=0},
7689 offset = {x=0, y=0},
7691 size = { x=100, y=100 },
7692 -- Size of element in pixels
7695 -- Z index : lower z-index HUDs are displayed behind higher z-index HUDs
7701 Used by `minetest.add_particle`.
7704 pos = {x=0, y=0, z=0},
7705 velocity = {x=0, y=0, z=0},
7706 acceleration = {x=0, y=0, z=0},
7707 -- Spawn particle at pos with velocity and acceleration
7710 -- Disappears after expirationtime seconds
7713 -- Scales the visual size of the particle texture.
7715 collisiondetection = false,
7716 -- If true collides with `walkable` nodes and, depending on the
7717 -- `object_collision` field, objects too.
7719 collision_removal = false,
7720 -- If true particle is removed when it collides.
7721 -- Requires collisiondetection = true to have any effect.
7723 object_collision = false,
7724 -- If true particle collides with objects that are defined as
7725 -- `physical = true,` and `collide_with_objects = true,`.
7726 -- Requires collisiondetection = true to have any effect.
7729 -- If true faces player using y axis only
7731 texture = "image.png",
7733 playername = "singleplayer",
7734 -- Optional, if specified spawns particle only on the player's client
7736 animation = {Tile Animation definition},
7737 -- Optional, specifies how to animate the particle texture
7740 -- Optional, specify particle self-luminescence in darkness.
7745 `ParticleSpawner` definition
7746 ----------------------------
7748 Used by `minetest.add_particlespawner`.
7752 -- Number of particles spawned over the time period `time`.
7755 -- Lifespan of spawner in seconds.
7756 -- If time is 0 spawner has infinite lifespan and spawns the `amount` on
7757 -- a per-second basis.
7759 minpos = {x=0, y=0, z=0},
7760 maxpos = {x=0, y=0, z=0},
7761 minvel = {x=0, y=0, z=0},
7762 maxvel = {x=0, y=0, z=0},
7763 minacc = {x=0, y=0, z=0},
7764 maxacc = {x=0, y=0, z=0},
7769 -- The particles' properties are random values between the min and max
7771 -- pos, velocity, acceleration, expirationtime, size
7773 collisiondetection = false,
7774 -- If true collide with `walkable` nodes and, depending on the
7775 -- `object_collision` field, objects too.
7777 collision_removal = false,
7778 -- If true particles are removed when they collide.
7779 -- Requires collisiondetection = true to have any effect.
7781 object_collision = false,
7782 -- If true particles collide with objects that are defined as
7783 -- `physical = true,` and `collide_with_objects = true,`.
7784 -- Requires collisiondetection = true to have any effect.
7786 attached = ObjectRef,
7787 -- If defined, particle positions, velocities and accelerations are
7788 -- relative to this object's position and yaw
7791 -- If true face player using y axis only
7793 texture = "image.png",
7795 playername = "singleplayer",
7796 -- Optional, if specified spawns particles only on the player's client
7798 animation = {Tile Animation definition},
7799 -- Optional, specifies how to animate the particles' texture
7802 -- Optional, specify particle self-luminescence in darkness.
7806 `HTTPRequest` definition
7807 ------------------------
7809 Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
7812 url = "http://example.org",
7815 -- Timeout for connection in seconds. Default is 3 seconds.
7817 post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
7818 -- Optional, if specified a POST request with post_data is performed.
7819 -- Accepts both a string and a table. If a table is specified, encodes
7820 -- table as x-www-form-urlencoded key-value pairs.
7821 -- If post_data is not specified, a GET request is performed instead.
7823 user_agent = "ExampleUserAgent",
7824 -- Optional, if specified replaces the default minetest user agent with
7827 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
7828 -- Optional, if specified adds additional headers to the HTTP request.
7829 -- You must make sure that the header strings follow HTTP specification
7833 -- Optional, if true performs a multipart HTTP request.
7834 -- Default is false.
7837 `HTTPRequestResult` definition
7838 ------------------------------
7840 Passed to `HTTPApiTable.fetch` callback. Returned by
7841 `HTTPApiTable.fetch_async_get`.
7845 -- If true, the request has finished (either succeeded, failed or timed
7849 -- If true, the request was successful
7852 -- If true, the request timed out
7860 Authentication handler definition
7861 ---------------------------------
7863 Used by `minetest.register_authentication_handler`.
7866 get_auth = function(name),
7867 -- Get authentication data for existing player `name` (`nil` if player
7869 -- Returns following structure:
7870 -- `{password=<string>, privileges=<table>, last_login=<number or nil>}`
7872 create_auth = function(name, password),
7873 -- Create new auth data for player `name`.
7874 -- Note that `password` is not plain-text but an arbitrary
7875 -- representation decided by the engine.
7877 delete_auth = function(name),
7878 -- Delete auth data of player `name`.
7879 -- Returns boolean indicating success (false if player is nonexistent).
7881 set_password = function(name, password),
7882 -- Set password of player `name` to `password`.
7883 -- Auth data should be created if not present.
7885 set_privileges = function(name, privileges),
7886 -- Set privileges of player `name`.
7887 -- `privileges` is in table form, auth data should be created if not
7890 reload = function(),
7891 -- Reload authentication data from the storage location.
7892 -- Returns boolean indicating success.
7894 record_login = function(name),
7895 -- Called when player joins, used for keeping track of last_login
7897 iterate = function(),
7898 -- Returns an iterator (use with `for` loops) for all player names
7899 -- currently in the auth database