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 * `disallowed_mapgens = <comma-separated mapgens>`
68 e.g. `disallowed_mapgens = v5,v6,flat`
69 These mapgens are removed from the list of mapgens for the game.
71 Used to set default settings when running this game.
73 In the same format as the one in builtin.
74 This settingtypes.txt will be parsed by the menu and the settings will be
75 displayed in the "Games" category in the advanced settings tab.
76 * If the game contains a folder called `textures` the server will load it as a
77 texturepack, overriding mod textures.
78 Any server texturepack will override mod textures and the game texturepack.
83 Games can provide custom main menu images. They are put inside a `menu`
84 directory inside the game directory.
86 The images are named `$identifier.png`, where `$identifier` is one of
87 `overlay`, `background`, `footer`, `header`.
88 If you want to specify multiple images for one identifier, add additional
89 images named like `$identifier.$n.png`, with an ascending number $n starting
90 with 1, and a random image will be chosen from the provided ones.
101 Paths are relative to the directories listed in the [Paths] section above.
103 * `games/<gameid>/mods/`
105 * `worlds/<worldname>/worldmods/`
110 It is possible to include a game in a world; in this case, no mods or
111 games are loaded or checked from anywhere else.
113 This is useful for e.g. adventure worlds and happens if the `<worldname>/game/`
116 Mods should then be placed in `<worldname>/game/mods/`.
121 Mods can be put in a subdirectory, if the parent directory, which otherwise
122 should be a mod, contains a file named `modpack.conf`.
123 The file is a key-value store of modpack details.
125 * `name`: The modpack name.
126 * `description`: Description of mod to be shown in the Mods tab of the main
129 Note: to support 0.4.x, please also create an empty modpack.txt file.
131 Mod directory structure
132 -----------------------
138 │ ├── settingtypes.txt
142 │ │ ├── modname_stuff.png
143 │ │ └── modname_something_else.png
152 The location of this directory can be fetched by using
153 `minetest.get_modpath(modname)`.
157 A `Settings` file that provides meta information about the mod.
159 * `name`: The mod name. Allows Minetest to determine the mod name even if the
160 folder is wrongly named.
161 * `description`: Description of mod to be shown in the Mods tab of the main
163 * `depends`: A comma separated list of dependencies. These are mods that must be
164 loaded before this mod.
165 * `optional_depends`: A comma separated list of optional dependencies.
166 Like a dependency, but no error if the mod doesn't exist.
168 Note: to support 0.4.x, please also provide depends.txt.
172 A screenshot shown in the mod manager within the main menu. It should
173 have an aspect ratio of 3:2 and a minimum size of 300×200 pixels.
177 **Deprecated:** you should use mod.conf instead.
179 This file is used if there are no dependencies in mod.conf.
181 List of mods that have to be loaded before loading this mod.
183 A single line contains a single modname.
185 Optional dependencies can be defined by appending a question mark
186 to a single modname. This means that if the specified mod
187 is missing, it does not prevent this mod from being loaded.
189 ### `description.txt`
191 **Deprecated:** you should use mod.conf instead.
193 This file is used if there is no description in mod.conf.
195 A file containing a description to be shown in the Mods tab of the main menu.
197 ### `settingtypes.txt`
199 The format is documented in `builtin/settingtypes.txt`.
200 It is parsed by the main menu settings dialogue to list mod-specific
201 settings in the "Mods" category.
205 The main Lua script. Running this script should register everything it
206 wants to register. Subsequent execution depends on minetest calling the
207 registered callbacks.
209 `minetest.settings` can be used to read custom or existing settings at load
210 time, if necessary. (See [`Settings`])
214 Models for entities or meshnodes.
216 ### `textures`, `sounds`, `media`
218 Media files (textures, sounds, whatever) that will be transferred to the
219 client and will be available for use by the mod.
223 Translation files for the clients. (See [Translations])
228 Registered names should generally be in this format:
232 `<whatever>` can have these characters:
236 This is to prevent conflicting names from corrupting maps and is
237 enforced by the mod loader.
239 Registered names can be overridden by prefixing the name with `:`. This can
240 be used for overriding the registrations of some other mod.
242 The `:` prefix can also be used for maintaining backwards compatibility.
246 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
247 So the name should be `experimental:tnt`.
249 Any mod can redefine `experimental:tnt` by using the name
253 when registering it. That mod is required to have `experimental` as a
262 Aliases of itemnames can be added by using
263 `minetest.register_alias(alias, original_name)` or
264 `minetest.register_alias_force(alias, original_name)`.
266 This adds an alias `alias` for the item called `original_name`.
267 From now on, you can use `alias` to refer to the item `original_name`.
269 The only difference between `minetest.register_alias` and
270 `minetest.register_alias_force` is that if an item named `alias` already exists,
271 `minetest.register_alias` will do nothing while
272 `minetest.register_alias_force` will unregister it.
274 This can be used for maintaining backwards compatibility.
276 This can also set quick access names for things, e.g. if
277 you have an item called `epiclylongmodname:stuff`, you could do
279 minetest.register_alias("stuff", "epiclylongmodname:stuff")
281 and be able to use `/giveme stuff`.
286 In a game, a certain number of these must be set to tell core mapgens which
287 of the game's nodes are to be used for core mapgen generation. For example:
289 minetest.register_alias("mapgen_stone", "default:stone")
291 ### Aliases for non-V6 mapgens
293 #### Essential aliases
296 * mapgen_water_source
297 * mapgen_river_water_source
299 `mapgen_river_water_source` is required for mapgens with sloping rivers where
300 it is necessary to have a river liquid node with a short `liquid_range` and
301 `liquid_renewable = false` to avoid flooding.
303 #### Optional aliases
307 Fallback lava node used if cave liquids are not defined in biome definitions.
308 Deprecated for non-V6 mapgens, define cave liquids in biome definitions instead.
312 Fallback node used if dungeon nodes are not defined in biome definitions.
313 Deprecated for non-V6 mapgens, define dungeon nodes in biome definitions instead.
315 ### Aliases needed for Mapgen V6
318 * mapgen_water_source
321 * mapgen_dirt_with_grass
324 * mapgen_desert_stone
326 * mapgen_dirt_with_snow
335 * mapgen_jungleleaves
338 * mapgen_pine_needles
341 * mapgen_stair_cobble
343 * mapgen_stair_desert_stone
345 ### Setting the node used in Mapgen Singlenode
347 By default the world is filled with air nodes. To set a different node use, for
350 minetest.register_alias("mapgen_singlenode", "default:stone")
358 Mods should generally prefix their textures with `modname_`, e.g. given
359 the mod name `foomod`, a texture could be called:
363 Textures are referred to by their complete name, or alternatively by
364 stripping out the file extension:
366 * e.g. `foomod_foothing.png`
367 * e.g. `foomod_foothing`
372 There are various texture modifiers that can be used
373 to generate textures on-the-fly.
375 ### Texture overlaying
377 Textures can be overlaid by putting a `^` between them.
381 default_dirt.png^default_grass_side.png
383 `default_grass_side.png` is overlaid over `default_dirt.png`.
384 The texture with the lower resolution will be automatically upscaled to
385 the higher resolution texture.
389 Textures can be grouped together by enclosing them in `(` and `)`.
391 Example: `cobble.png^(thing1.png^thing2.png)`
393 A texture for `thing1.png^thing2.png` is created and the resulting
394 texture is overlaid on top of `cobble.png`.
398 Modifiers that accept texture names (e.g. `[combine`) accept escaping to allow
399 passing complex texture names as arguments. Escaping is done with backslash and
400 is required for `^` and `:`.
402 Example: `cobble.png^[lowpart:50:color.png\^[mask\:trans.png`
404 The lower 50 percent of `color.png^[mask:trans.png` are overlaid
405 on top of `cobble.png`.
407 ### Advanced texture modifiers
413 * `[crack:<t>:<n>:<p>`
414 * `[cracko:<t>:<n>:<p>`
418 * `<t>`: tile count (in each direction)
419 * `<n>`: animation frame count
420 * `<p>`: current animation frame
422 Draw a step of the crack animation on the texture.
423 `crack` draws it normally, while `cracko` lays it over, keeping transparent
428 default_cobble.png^[crack:10:1
430 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
436 * `<file>`: texture to combine
438 Creates a texture of size `<w>` times `<h>` and blits the listed files to their
439 specified coordinates.
443 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
445 #### `[resize:<w>x<h>`
447 Resizes the texture to the given dimensions.
451 default_sandstone.png^[resize:16x16
455 Makes the base image transparent according to the given ratio.
457 `r` must be between 0 (transparent) and 255 (opaque).
461 default_sandstone.png^[opacity:127
463 #### `[invert:<mode>`
465 Inverts the given channels of the base image.
466 Mode may contain the characters "r", "g", "b", "a".
467 Only the channels that are mentioned in the mode string will be inverted.
471 default_apple.png^[invert:rgb
475 Brightens the texture.
479 tnt_tnt_side.png^[brighten
483 Makes the texture completely opaque.
487 default_leaves.png^[noalpha
489 #### `[makealpha:<r>,<g>,<b>`
491 Convert one color to transparency.
495 default_cobble.png^[makealpha:128,128,128
499 * `<t>`: transformation(s) to apply
501 Rotates and/or flips the image.
503 `<t>` can be a number (between 0 and 7) or a transform name.
504 Rotations are counter-clockwise.
507 1 R90 rotate by 90 degrees
508 2 R180 rotate by 180 degrees
509 3 R270 rotate by 270 degrees
511 5 FXR90 flip X then rotate by 90 degrees
513 7 FYR90 flip Y then rotate by 90 degrees
517 default_stone.png^[transformFXR90
519 #### `[inventorycube{<top>{<left>{<right>`
521 Escaping does not apply here and `^` is replaced by `&` in texture names
524 Create an inventory cube texture using the side textures.
528 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
530 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
531 `dirt.png^grass_side.png` textures
533 #### `[lowpart:<percent>:<file>`
535 Blit the lower `<percent>`% part of `<file>` on the texture.
539 base.png^[lowpart:25:overlay.png
541 #### `[verticalframe:<t>:<n>`
543 * `<t>`: animation frame count
544 * `<n>`: current animation frame
546 Crops the texture to a frame of a vertical animation.
550 default_torch_animated.png^[verticalframe:16:8
554 Apply a mask to the base image.
556 The mask is applied using binary AND.
558 #### `[sheet:<w>x<h>:<x>,<y>`
560 Retrieves a tile at position x,y from the base image
561 which it assumes to be a tilesheet with dimensions w,h.
563 #### `[colorize:<color>:<ratio>`
565 Colorize the textures with the given color.
566 `<color>` is specified as a `ColorString`.
567 `<ratio>` is an int ranging from 0 to 255 or the word "`alpha`". If
568 it is an int, then it specifies how far to interpolate between the
569 colors where 0 is only the texture color and 255 is only `<color>`. If
570 omitted, the alpha of `<color>` will be used as the ratio. If it is
571 the word "`alpha`", then each texture pixel will contain the RGB of
572 `<color>` and the alpha of `<color>` multiplied by the alpha of the
575 #### `[multiply:<color>`
577 Multiplies texture colors with the given color.
578 `<color>` is specified as a `ColorString`.
579 Result is more like what you'd expect if you put a color on top of another
580 color, meaning white surfaces get a lot of your new color while black parts
581 don't change very much.
586 The goal of hardware coloring is to simplify the creation of
587 colorful nodes. If your textures use the same pattern, and they only
588 differ in their color (like colored wool blocks), you can use hardware
589 coloring instead of creating and managing many texture files.
590 All of these methods use color multiplication (so a white-black texture
591 with red coloring will result in red-black color).
595 This method is useful if you wish to create nodes/items with
596 the same texture, in different colors, each in a new node/item definition.
600 When you register an item or node, set its `color` field (which accepts a
601 `ColorSpec`) to the desired color.
603 An `ItemStack`'s static color can be overwritten by the `color` metadata
604 field. If you set that field to a `ColorString`, that color will be used.
608 Each tile may have an individual static color, which overwrites every
609 other coloring method. To disable the coloring of a face,
610 set its color to white (because multiplying with white does nothing).
611 You can set the `color` property of the tiles in the node's definition
612 if the tile is in table format.
616 For nodes and items which can have many colors, a palette is more
617 suitable. A palette is a texture, which can contain up to 256 pixels.
618 Each pixel is one possible color for the node/item.
619 You can register one node/item, which can have up to 256 colors.
621 #### Palette indexing
623 When using palettes, you always provide a pixel index for the given
624 node or `ItemStack`. The palette is read from left to right and from
625 top to bottom. If the palette has less than 256 pixels, then it is
626 stretched to contain exactly 256 pixels (after arranging the pixels
627 to one line). The indexing starts from 0.
631 * 16x16 palette, index = 0: the top left corner
632 * 16x16 palette, index = 4: the fifth pixel in the first row
633 * 16x16 palette, index = 16: the pixel below the top left corner
634 * 16x16 palette, index = 255: the bottom right corner
635 * 2 (width) x 4 (height) palette, index = 31: the top left corner.
636 The palette has 8 pixels, so each pixel is stretched to 32 pixels,
637 to ensure the total 256 pixels.
638 * 2x4 palette, index = 32: the top right corner
639 * 2x4 palette, index = 63: the top right corner
640 * 2x4 palette, index = 64: the pixel below the top left corner
642 #### Using palettes with items
644 When registering an item, set the item definition's `palette` field to
645 a texture. You can also use texture modifiers.
647 The `ItemStack`'s color depends on the `palette_index` field of the
648 stack's metadata. `palette_index` is an integer, which specifies the
649 index of the pixel to use.
651 #### Linking palettes with nodes
653 When registering a node, set the item definition's `palette` field to
654 a texture. You can also use texture modifiers.
655 The node's color depends on its `param2`, so you also must set an
656 appropriate `paramtype2`:
658 * `paramtype2 = "color"` for nodes which use their full `param2` for
659 palette indexing. These nodes can have 256 different colors.
660 The palette should contain 256 pixels.
661 * `paramtype2 = "colorwallmounted"` for nodes which use the first
662 five bits (most significant) of `param2` for palette indexing.
663 The remaining three bits are describing rotation, as in `wallmounted`
664 paramtype2. Division by 8 yields the palette index (without stretching the
665 palette). These nodes can have 32 different colors, and the palette
666 should contain 32 pixels.
668 * `param2 = 17` is 2 * 8 + 1, so the rotation is 1 and the third (= 2 + 1)
669 pixel will be picked from the palette.
670 * `param2 = 35` is 4 * 8 + 3, so the rotation is 3 and the fifth (= 4 + 1)
671 pixel will be picked from the palette.
672 * `paramtype2 = "colorfacedir"` for nodes which use the first
673 three bits of `param2` for palette indexing. The remaining
674 five bits are describing rotation, as in `facedir` paramtype2.
675 Division by 32 yields the palette index (without stretching the
676 palette). These nodes can have 8 different colors, and the
677 palette should contain 8 pixels.
679 * `param2 = 17` is 0 * 32 + 17, so the rotation is 17 and the
680 first (= 0 + 1) pixel will be picked from the palette.
681 * `param2 = 35` is 1 * 32 + 3, so the rotation is 3 and the
682 second (= 1 + 1) pixel will be picked from the palette.
684 To colorize a node on the map, set its `param2` value (according
685 to the node's paramtype2).
687 ### Conversion between nodes in the inventory and on the map
689 Static coloring is the same for both cases, there is no need
692 If the `ItemStack`'s metadata contains the `color` field, it will be
693 lost on placement, because nodes on the map can only use palettes.
695 If the `ItemStack`'s metadata contains the `palette_index` field, it is
696 automatically transferred between node and item forms by the engine,
697 when a player digs or places a colored node.
698 You can disable this feature by setting the `drop` field of the node
699 to itself (without metadata).
700 To transfer the color to a special drop, you need a drop table.
704 minetest.register_node("mod:stone", {
705 description = "Stone",
706 tiles = {"default_stone.png"},
707 paramtype2 = "color",
708 palette = "palette.png",
711 -- assume that mod:cobblestone also has the same palette
712 {items = {"mod:cobblestone"}, inherit_color = true },
717 ### Colored items in craft recipes
719 Craft recipes only support item strings, but fortunately item strings
720 can also contain metadata. Example craft recipe registration:
722 minetest.register_craft({
723 output = minetest.itemstring_with_palette("wool:block", 3),
731 To set the `color` field, you can use `minetest.itemstring_with_color`.
733 Metadata field filtering in the `recipe` field are not supported yet,
734 so the craft output is independent of the color of the ingredients.
739 Sometimes hardware coloring is not enough, because it affects the
740 whole tile. Soft texture overlays were added to Minetest to allow
741 the dynamic coloring of only specific parts of the node's texture.
742 For example a grass block may have colored grass, while keeping the
745 These overlays are 'soft', because unlike texture modifiers, the layers
746 are not merged in the memory, but they are simply drawn on top of each
747 other. This allows different hardware coloring, but also means that
748 tiles with overlays are drawn slower. Using too much overlays might
751 For inventory and wield images you can specify overlays which
752 hardware coloring does not modify. You have to set `inventory_overlay`
753 and `wield_overlay` fields to an image name.
755 To define a node overlay, simply set the `overlay_tiles` field of the node
756 definition. These tiles are defined in the same way as plain tiles:
757 they can have a texture name, color etc.
758 To skip one face, set that overlay tile to an empty string.
760 Example (colored grass block):
762 minetest.register_node("default:dirt_with_grass", {
763 description = "Dirt with Grass",
764 -- Regular tiles, as usual
765 -- The dirt tile disables palette coloring
766 tiles = {{name = "default_grass.png"},
767 {name = "default_dirt.png", color = "white"}},
768 -- Overlay tiles: define them in the same style
769 -- The top and bottom tile does not have overlay
770 overlay_tiles = {"", "",
771 {name = "default_grass_side.png", tileable_vertical = false}},
772 -- Global color, used in inventory
774 -- Palette in the world
775 paramtype2 = "color",
776 palette = "default_foilage.png",
785 Only Ogg Vorbis files are supported.
787 For positional playing of sounds, only single-channel (mono) files are
788 supported. Otherwise OpenAL will play them non-positionally.
790 Mods should generally prefix their sounds with `modname_`, e.g. given
791 the mod name "`foomod`", a sound could be called:
795 Sounds are referred to by their name with a dot, a single digit and the
796 file extension stripped out. When a sound is played, the actual sound file
797 is chosen randomly from the matching sounds.
799 When playing the sound `foomod_foosound`, the sound is chosen randomly
800 from the available ones of the following files:
802 * `foomod_foosound.ogg`
803 * `foomod_foosound.0.ogg`
804 * `foomod_foosound.1.ogg`
806 * `foomod_foosound.9.ogg`
808 Examples of sound parameter tables:
810 -- Play locationless on all clients
812 gain = 1.0, -- default
813 fade = 0.0, -- default, change to a value > 0 to fade the sound in
814 pitch = 1.0, -- default
816 -- Play locationless to one player
819 gain = 1.0, -- default
820 fade = 0.0, -- default, change to a value > 0 to fade the sound in
821 pitch = 1.0, -- default
823 -- Play locationless to one player, looped
826 gain = 1.0, -- default
829 -- Play at a location
831 pos = {x = 1, y = 2, z = 3},
832 gain = 1.0, -- default
833 max_hear_distance = 32, -- default, uses an euclidean metric
835 -- Play connected to an object, looped
837 object = <an ObjectRef>,
838 gain = 1.0, -- default
839 max_hear_distance = 32, -- default, uses an euclidean metric
842 -- Play at a location, heard by anyone *but* the given player
844 pos = {x = 32, y = 0, z = 100},
845 max_hear_distance = 40,
846 exclude_player = name,
849 Looped sounds must either be connected to an object or played locationless to
850 one player using `to_player = name`.
852 A positional sound will only be heard by players that are within
853 `max_hear_distance` of the sound position, at the start of the sound.
855 `exclude_player = name` can be applied to locationless, positional and object-
856 bound sounds to exclude a single player from hearing them.
861 Specifies a sound name, gain (=volume) and pitch.
862 This is either a string or a table.
864 In string form, you just specify the sound name or
865 the empty string for no sound.
867 Table form has the following fields:
870 * `gain`: Volume (`1.0` = 100%)
871 * `pitch`: Pitch (`1.0` = 100%)
873 `gain` and `pitch` are optional and default to `1.0`.
879 * `"default_place_node"`: Play e.g. `default_place_node.ogg`
880 * `{name = "default_place_node"}`: Same as above
881 * `{name = "default_place_node", gain = 0.5}`: 50% volume
882 * `{name = "default_place_node", gain = 0.9, pitch = 1.1}`: 90% volume, 110% pitch
887 These sound files are played back by the engine if provided.
889 * `player_damage`: Played when the local player takes damage (gain = 0.5)
890 * `player_falling_damage`: Played when the local player takes
891 damage by falling (gain = 0.5)
892 * `default_dig_<groupname>`: Default node digging sound
893 (see node sound definition for details)
895 Registered definitions
896 ======================
898 Anything added using certain [Registration functions] gets added to one or more
899 of the global [Registered definition tables].
901 Note that in some cases you will stumble upon things that are not contained
902 in these tables (e.g. when a mod has been removed). Always check for
903 existence before trying to access the fields.
907 All nodes register with `minetest.register_node` get added to the table
908 `minetest.registered_nodes`.
910 If you want to check the drawtype of a node, you could do:
912 local function get_nodedef_field(nodename, fieldname)
913 if not minetest.registered_nodes[nodename] then
916 return minetest.registered_nodes[nodename][fieldname]
918 local drawtype = get_nodedef_field(nodename, "drawtype")
926 Nodes are the bulk data of the world: cubes and other things that take the
927 space of a cube. Huge amounts of them are handled efficiently, but they
930 The definition of a node is stored and can be accessed by using
932 minetest.registered_nodes[node.name]
934 See [Registered definitions].
936 Nodes are passed by value between Lua and the engine.
937 They are represented by a table:
939 {name="name", param1=num, param2=num}
941 `param1` and `param2` are 8-bit integers ranging from 0 to 255. The engine uses
942 them for certain automated functions. If you don't use these functions, you can
943 use them to store arbitrary values.
948 The functions of `param1` and `param2` are determined by certain fields in the
951 The function of `param1` is determined by `paramtype` in node definition.
952 `param1` is reserved for the engine when `paramtype != "none"`.
954 * `paramtype = "light"`
955 * The value stores light with and without sun in its upper and lower 4 bits
957 * Required by a light source node to enable spreading its light.
958 * Required by the following drawtypes as they determine their visual
959 brightness from their internal light value:
969 * `paramtype = "none"`
970 * `param1` will not be used by the engine and can be used to store
973 The function of `param2` is determined by `paramtype2` in node definition.
974 `param2` is reserved for the engine when `paramtype2 != "none"`.
976 * `paramtype2 = "flowingliquid"`
977 * Used by `drawtype = "flowingliquid"` and `liquidtype = "flowing"`
978 * The liquid level and a flag of the liquid are stored in `param2`
979 * Bits 0-2: Liquid level (0-7). The higher, the more liquid is in this node
980 * Bit 3: If set, liquid is flowing downwards (no graphical effect)
981 * `paramtype2 = "wallmounted"`
982 * Supported drawtypes: "torchlike", "signlike", "normal", "nodebox", "mesh"
983 * The rotation of the node is stored in `param2`
984 * You can make this value by using `minetest.dir_to_wallmounted()`
986 * The value denotes at which direction the node is "mounted":
987 0 = y+, 1 = y-, 2 = x+, 3 = x-, 4 = z+, 5 = z-
988 * `paramtype2 = "facedir"`
989 * Supported drawtypes: "normal", "nodebox", "mesh"
990 * The rotation of the node is stored in `param2`. Furnaces and chests are
991 rotated this way. Can be made by using `minetest.dir_to_facedir()`.
992 * Values range 0 - 23
993 * facedir / 4 = axis direction:
994 0 = y+, 1 = z+, 2 = z-, 3 = x+, 4 = x-, 5 = y-
995 * facedir modulo 4 = rotation around that axis
996 * `paramtype2 = "leveled"`
997 * Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
999 * The level of the top face of the nodebox is stored in `param2`.
1000 * The other faces are defined by 'fixed = {}' like 'type = "fixed"'
1002 * The nodebox height is (`param2` / 64) nodes.
1003 * The maximum accepted value of `param2` is 127.
1005 * The height of the 'plantlike' section is stored in `param2`.
1006 * The height is (`param2` / 16) nodes.
1007 * `paramtype2 = "degrotate"`
1008 * Only valid for "plantlike" drawtype. The rotation of the node is stored in
1010 * Values range 0 - 179. The value stored in `param2` is multiplied by two to
1011 get the actual rotation in degrees of the node.
1012 * `paramtype2 = "meshoptions"`
1013 * Only valid for "plantlike" drawtype. The value of `param2` becomes a
1014 bitfield which can be used to change how the client draws plantlike nodes.
1015 * Bits 0, 1 and 2 form a mesh selector.
1016 Currently the following meshes are choosable:
1017 * 0 = a "x" shaped plant (ordinary plant)
1018 * 1 = a "+" shaped plant (just rotated 45 degrees)
1019 * 2 = a "*" shaped plant with 3 faces instead of 2
1020 * 3 = a "#" shaped plant with 4 faces instead of 2
1021 * 4 = a "#" shaped plant with 4 faces that lean outwards
1022 * 5-7 are unused and reserved for future meshes.
1023 * Bits 3 through 7 are optional flags that can be combined and give these
1025 * bit 3 (0x08) - Makes the plant slightly vary placement horizontally
1026 * bit 4 (0x10) - Makes the plant mesh 1.4x larger
1027 * bit 5 (0x20) - Moves each face randomly a small bit down (1/8 max)
1028 * bits 6-7 are reserved for future use.
1029 * `paramtype2 = "color"`
1030 * `param2` tells which color is picked from the palette.
1031 The palette should have 256 pixels.
1032 * `paramtype2 = "colorfacedir"`
1033 * Same as `facedir`, but with colors.
1034 * The first three bits of `param2` tells which color is picked from the
1035 palette. The palette should have 8 pixels.
1036 * `paramtype2 = "colorwallmounted"`
1037 * Same as `wallmounted`, but with colors.
1038 * The first five bits of `param2` tells which color is picked from the
1039 palette. The palette should have 32 pixels.
1040 * `paramtype2 = "glasslikeliquidlevel"`
1041 * Only valid for "glasslike_framed" or "glasslike_framed_optional"
1043 * `param2` values 0-63 define 64 levels of internal liquid, 0 being empty
1045 * Liquid texture is defined using `special_tiles = {"modname_tilename.png"}`
1046 * `paramtype2 = "none"`
1047 * `param2` will not be used by the engine and can be used to store
1050 Nodes can also contain extra data. See [Node Metadata].
1055 There are a bunch of different looking node types.
1057 Look for examples in `games/minimal` or `games/minetest_game`.
1060 * A node-sized cube.
1062 * Invisible, uses no texture.
1064 * The cubic source node for a liquid.
1066 * The flowing version of a liquid, appears with various heights and slopes.
1068 * Often used for partially-transparent nodes.
1069 * Only external sides of textures are visible.
1070 * `glasslike_framed`
1071 * All face-connected nodes are drawn as one volume within a surrounding
1073 * The frame appearance is generated from the edges of the first texture
1074 specified in `tiles`. The width of the edges used are 1/16th of texture
1075 size: 1 pixel for 16x16, 2 pixels for 32x32 etc.
1076 * The glass 'shine' (or other desired detail) on each node face is supplied
1077 by the second texture specified in `tiles`.
1078 * `glasslike_framed_optional`
1079 * This switches between the above 2 drawtypes according to the menu setting
1082 * Often used for partially-transparent nodes.
1083 * External and internal sides of textures are visible.
1084 * `allfaces_optional`
1085 * Often used for leaves nodes.
1086 * This switches between `normal`, `glasslike` and `allfaces` according to
1087 the menu setting: Opaque Leaves / Simple Leaves / Fancy Leaves.
1088 * With 'Simple Leaves' selected, the texture specified in `special_tiles`
1089 is used instead, if present. This allows a visually thicker texture to be
1090 used to compensate for how `glasslike` reduces visual thickness.
1092 * A single vertical texture.
1093 * If placed on top of a node, uses the first texture specified in `tiles`.
1094 * If placed against the underside of a node, uses the second texture
1095 specified in `tiles`.
1096 * If placed on the side of a node, uses the third texture specified in
1097 `tiles` and is perpendicular to that node.
1099 * A single texture parallel to, and mounted against, the top, underside or
1102 * Two vertical and diagonal textures at right-angles to each other.
1103 * See `paramtype2 = "meshoptions"` above for other options.
1105 * When above a flat surface, appears as 6 textures, the central 2 as
1106 `plantlike` plus 4 more surrounding those.
1107 * If not above a surface the central 2 do not appear, but the texture
1108 appears against the faces of surrounding nodes if they are present.
1110 * A 3D model suitable for a wooden fence.
1111 * One placed node appears as a single vertical post.
1112 * Adjacently-placed nodes cause horizontal bars to appear between them.
1114 * Often used for tracks for mining carts.
1115 * Requires 4 textures to be specified in `tiles`, in order: Straight,
1116 curved, t-junction, crossing.
1117 * Each placed node automatically switches to a suitable rotated texture
1118 determined by the adjacent `raillike` nodes, in order to create a
1119 continuous track network.
1120 * Becomes a sloping node if placed against stepped nodes.
1122 * Often used for stairs and slabs.
1123 * Allows defining nodes consisting of an arbitrary number of boxes.
1124 * See [Node boxes] below for more information.
1126 * Uses models for nodes.
1127 * Tiles should hold model materials textures.
1128 * Only static meshes are implemented.
1129 * For supported model formats see Irrlicht engine documentation.
1130 * `plantlike_rooted`
1131 * Enables underwater `plantlike` without air bubbles around the nodes.
1132 * Consists of a base cube at the co-ordinates of the node plus a
1133 `plantlike` extension above with a height of `param2 / 16` nodes.
1134 * The `plantlike` extension visually passes through any nodes above the
1135 base cube without affecting them.
1136 * The base cube texture tiles are defined as normal, the `plantlike`
1137 extension uses the defined special tile, for example:
1138 `special_tiles = {{name = "default_papyrus.png", tileable_vertical = true}},`
1140 `*_optional` drawtypes need less rendering time if deactivated
1141 (always client-side).
1146 Node selection boxes are defined using "node boxes".
1148 A nodebox is defined as any of:
1151 -- A normal cube; the default in most things
1155 -- A fixed box (or boxes) (facedir param2 is used, if applicable)
1157 fixed = box OR {box1, box2, ...}
1160 -- A variable height box (or boxes) with the top face position defined
1161 -- by the node parameter 'leveled = ', or if 'paramtype2 == "leveled"'
1163 -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
1165 fixed = box OR {box1, box2, ...}
1168 -- A box like the selection box for torches
1169 -- (wallmounted param2 is used, if applicable)
1170 type = "wallmounted",
1176 -- A node that has optional boxes depending on neighbouring nodes'
1177 -- presence and type. See also `connects_to`.
1179 fixed = box OR {box1, box2, ...}
1180 connect_top = box OR {box1, box2, ...}
1181 connect_bottom = box OR {box1, box2, ...}
1182 connect_front = box OR {box1, box2, ...}
1183 connect_left = box OR {box1, box2, ...}
1184 connect_back = box OR {box1, box2, ...}
1185 connect_right = box OR {box1, box2, ...}
1186 -- The following `disconnected_*` boxes are the opposites of the
1187 -- `connect_*` ones above, i.e. when a node has no suitable neighbour
1188 -- on the respective side, the corresponding disconnected box is drawn.
1189 disconnected_top = box OR {box1, box2, ...}
1190 disconnected_bottom = box OR {box1, box2, ...}
1191 disconnected_front = box OR {box1, box2, ...}
1192 disconnected_left = box OR {box1, box2, ...}
1193 disconnected_back = box OR {box1, box2, ...}
1194 disconnected_right = box OR {box1, box2, ...}
1195 disconnected = box OR {box1, box2, ...} -- when there is *no* neighbour
1196 disconnected_sides = box OR {box1, box2, ...} -- when there are *no*
1197 -- neighbours to the sides
1200 A `box` is defined as:
1202 {x1, y1, z1, x2, y2, z2}
1204 A box of a regular node would look like:
1206 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
1211 Map terminology and coordinates
1212 ===============================
1214 Nodes, mapblocks, mapchunks
1215 ---------------------------
1217 A 'node' is the fundamental cubic unit of a world and appears to a player as
1218 roughly 1x1x1 meters in size.
1220 A 'mapblock' (often abbreviated to 'block') is 16x16x16 nodes and is the
1221 fundamental region of a world that is stored in the world database, sent to
1222 clients and handled by many parts of the engine.
1223 'mapblock' is preferred terminology to 'block' to help avoid confusion with
1224 'node', however 'block' often appears in the API.
1226 A 'mapchunk' (sometimes abbreviated to 'chunk') is usually 5x5x5 mapblocks
1227 (80x80x80 nodes) and is the volume of world generated in one operation by
1229 The size in mapblocks has been chosen to optimise map generation.
1234 ### Orientation of axes
1236 For node and mapblock coordinates, +X is East, +Y is up, +Z is North.
1238 ### Node coordinates
1240 Almost all positions used in the API use node coordinates.
1242 ### Mapblock coordinates
1244 Occasionally the API uses 'blockpos' which refers to mapblock coordinates that
1245 specify a particular mapblock.
1246 For example blockpos (0,0,0) specifies the mapblock that extends from
1247 node position (0,0,0) to node position (15,15,15).
1249 #### Converting node position to the containing blockpos
1251 To calculate the blockpos of the mapblock that contains the node at 'nodepos',
1254 * blockpos = math.floor(nodepos / 16)
1256 #### Converting blockpos to min/max node positions
1258 To calculate the min/max node positions contained in the mapblock at 'blockpos',
1262 nodepos = blockpos * 16
1264 nodepos = blockpos * 16 + 15
1275 The position field is used for all element types.
1277 To account for differing resolutions, the position coordinates are the
1278 percentage of the screen, ranging in value from `0` to `1`.
1280 The name field is not yet used, but should contain a description of what the
1281 HUD element represents. The direction field is the direction in which something
1284 `0` draws from left to right, `1` draws from right to left, `2` draws from
1285 top to bottom, and `3` draws from bottom to top.
1287 The `alignment` field specifies how the item will be aligned. It is a table
1288 where `x` and `y` range from `-1` to `1`, with `0` being central. `-1` is
1289 moved to the left/up, and `1` is to the right/down. Fractional values can be
1292 The `offset` field specifies a pixel offset from the position. Contrary to
1293 position, the offset is not scaled to screen size. This allows for some
1294 precisely positioned items in the HUD.
1296 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
1299 The `z_index` field specifies the order of HUD elements from back to front.
1300 Lower z-index elements are displayed behind higher z-index elements. Elements
1301 with same z-index are displayed in an arbitrary order. Default 0.
1302 Supports negative values.
1304 Below are the specific uses for fields in each type; fields not listed for that
1309 Displays an image on the HUD.
1311 * `scale`: The scale of the image, with 1 being the original texture size.
1312 Only the X coordinate scale is used (positive values).
1313 Negative values represent that percentage of the screen it
1314 should take; e.g. `x=-100` means 100% (width).
1315 * `text`: The name of the texture that is displayed.
1316 * `alignment`: The alignment of the image.
1317 * `offset`: offset in pixels from position.
1321 Displays text on the HUD.
1323 * `scale`: Defines the bounding rectangle of the text.
1324 A value such as `{x=100, y=100}` should work.
1325 * `text`: The text to be displayed in the HUD element.
1326 * `number`: An integer containing the RGB value of the color used to draw the
1327 text. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1328 * `alignment`: The alignment of the text.
1329 * `offset`: offset in pixels from position.
1333 Displays a horizontal bar made up of half-images.
1335 * `text`: The name of the texture that is used.
1336 * `number`: The number of half-textures that are displayed.
1337 If odd, will end with a vertically center-split texture.
1339 * `offset`: offset in pixels from position.
1340 * `size`: If used, will force full-image size to this value (override texture
1345 * `text`: The name of the inventory list to be displayed.
1346 * `number`: Number of items in the inventory to be displayed.
1347 * `item`: Position of item that is selected.
1349 * `offset`: offset in pixels from position.
1353 Displays distance to selected world position.
1355 * `name`: The name of the waypoint.
1356 * `text`: Distance suffix. Can be blank.
1357 * `number:` An integer containing the RGB value of the color used to draw the
1359 * `world_pos`: World position of the waypoint.
1364 Representations of simple things
1365 ================================
1370 {x=num, y=num, z=num}
1372 For helper functions see [Spatial Vectors].
1377 * `{type="nothing"}`
1378 * `{type="node", under=pos, above=pos}`
1379 * Indicates a pointed node selection box.
1380 * `under` refers to the node position behind the pointed face.
1381 * `above` refers to the node position in front of the pointed face.
1382 * `{type="object", ref=ObjectRef}`
1384 Exact pointing location (currently only `Raycast` supports these fields):
1386 * `pointed_thing.intersection_point`: The absolute world coordinates of the
1387 point on the selection box which is pointed at. May be in the selection box
1388 if the pointer is in the box too.
1389 * `pointed_thing.box_id`: The ID of the pointed selection box (counting starts
1391 * `pointed_thing.intersection_normal`: Unit vector, points outwards of the
1392 selected selection box. This specifies which face is pointed at.
1393 Is a null vector `{x = 0, y = 0, z = 0}` when the pointer is inside the
1399 Flag Specifier Format
1400 =====================
1402 Flags using the standardized flag specifier format can be specified in either
1403 of two ways, by string or table.
1405 The string format is a comma-delimited set of flag names; whitespace and
1406 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1407 flag, and specifying a flag prefixed by the string `"no"` explicitly
1408 clears the flag from whatever the default may be.
1410 In addition to the standard string flag format, the schematic flags field can
1411 also be a table of flag names to boolean values representing whether or not the
1412 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1413 is present, mapped to a boolean of any value, the specified flag is unset.
1415 E.g. A flag field of value
1417 {place_center_x = true, place_center_y=false, place_center_z=true}
1421 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1423 which is equivalent to
1425 "place_center_x, noplace_center_y, place_center_z"
1429 "place_center_x, place_center_z"
1431 since, by default, no schematic attributes are set.
1442 There are three kinds of items: nodes, tools and craftitems.
1444 * Node: Can be placed in the world's voxel grid
1445 * Tool: Has a wear property but cannot be stacked. The default use action is to
1446 dig nodes or hit objects according to its tool capabilities.
1447 * Craftitem: Cannot dig nodes or be placed
1452 All item stacks have an amount between 0 and 65535. It is 1 by
1453 default. Tool item stacks can not have an amount greater than 1.
1455 Tools use a wear (damage) value ranging from 0 to 65535. The
1456 value 0 is the default and is used for unworn tools. The values
1457 1 to 65535 are used for worn tools, where a higher value stands for
1458 a higher wear. Non-tools always have a wear value of 0.
1463 Items and item stacks can exist in three formats: Serializes, table format
1466 When an item must be passed to a function, it can usually be in any of
1471 This is called "stackstring" or "itemstring". It is a simple string with
1472 1-3 components: the full item identifier, an optional amount and an optional
1475 <identifier> [<amount>[ <wear>]]
1479 * `'default:apple'`: 1 apple
1480 * `'default:dirt 5'`: 5 dirt
1481 * `'default:pick_stone'`: a new stone pickaxe
1482 * `'default:pick_wood 1 21323'`: a wooden pickaxe, ca. 1/3 worn out
1490 {name="default:dirt", count=5, wear=0, metadata=""}
1492 A wooden pick about 1/3 worn out:
1494 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1498 {name="default:apple", count=1, wear=0, metadata=""}
1502 A native C++ format with many helper methods. Useful for converting
1503 between formats. See the [Class reference] section for details.
1511 In a number of places, there is a group table. Groups define the
1512 properties of a thing (item, node, armor of entity, capabilities of
1513 tool) in such a way that the engine and other mods can can interact with
1514 the thing without actually knowing what the thing is.
1519 Groups are stored in a table, having the group names with keys and the
1520 group ratings as values. Group ratings are integer values within the
1521 range [-32767, 32767]. For example:
1524 groups = {crumbly=3, soil=1}
1526 -- A more special dirt-kind of thing
1527 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1529 Groups always have a rating associated with them. If there is no
1530 useful meaning for a rating for an enabled group, it shall be `1`.
1532 When not defined, the rating of a group defaults to `0`. Thus when you
1533 read groups, you must interpret `nil` and `0` as the same value, `0`.
1535 You can read the rating of a group for an item or a node by using
1537 minetest.get_item_group(itemname, groupname)
1542 Groups of items can define what kind of an item it is (e.g. wool).
1547 In addition to the general item things, groups are used to define whether
1548 a node is destroyable and how long it takes to destroy by a tool.
1553 For entities, groups are, as of now, used only for calculating damage.
1554 The rating is the percentage of damage caused by tools with this damage group.
1555 See [Entity damage mechanism].
1557 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1558 object.set_armor_groups({fleshy=30, cracky=80})
1563 Groups in tools define which groups of nodes and entities they are
1566 Groups in crafting recipes
1567 --------------------------
1569 An example: Make meat soup from any meat, any water and any bowl:
1572 output = 'food:meat_soup_raw',
1578 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1581 Another example: Make red wool from white wool and red dye:
1585 output = 'wool:red',
1586 recipe = {'wool:white', 'group:dye,basecolor_red'},
1592 The asterisk `(*)` after a group name describes that there is no engine
1593 functionality bound to it, and implementation is left up as a suggestion
1596 ### Node, item and tool groups
1598 * `not_in_creative_inventory`: (*) Special group for inventory mods to indicate
1599 that the item should be hidden in item lists.
1602 ### Node-only groups
1604 * `attached_node`: if the node under it is not a walkable block the node will be
1605 dropped as an item. If the node is wallmounted the wallmounted direction is
1607 * `bouncy`: value is bounce speed in percent
1608 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1609 connect to each other
1610 * `dig_immediate`: Player can always pick up node without reducing tool wear
1611 * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
1612 * `3`: the node always gets the digging time 0 seconds (torch)
1613 * `disable_jump`: Player (and possibly other things) cannot jump from node
1614 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1615 * `falling_node`: if there is no walkable block under the node it will fall
1616 * `float`: the node will not fall through liquids
1617 * `level`: Can be used to give an additional sense of progression in the game.
1618 * A larger level will cause e.g. a weapon of a lower level make much less
1619 damage, and get worn out much faster, or not be able to get drops
1620 from destroyed nodes.
1621 * `0` is something that is directly accessible at the start of gameplay
1622 * There is no upper limit
1623 * See also: `leveldiff` in [Tools]
1624 * `slippery`: Players and items will slide on the node.
1625 Slipperiness rises steadily with `slippery` value, starting at 1.
1628 ### Tool-only groups
1630 * `disable_repair`: If set to 1 for a tool, it cannot be repaired using the
1631 `"toolrepair"` crafting recipe
1634 ### `ObjectRef` groups
1636 * `immortal`: Skips all damage and breath handling for an object. This group
1637 will also hide the integrated HUD status bars for players, and is
1638 automatically set to all players when damage is disabled on the server.
1639 * `punch_operable`: For entities; disables the regular damage mechanism for
1640 players punching it by hand or a non-tool item, so that it can do something
1641 else than take damage.
1645 Known damage and digging time defining groups
1646 ---------------------------------------------
1648 * `crumbly`: dirt, sand
1649 * `cracky`: tough but crackable stuff like stone.
1650 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1651 plants, wire, sheets of metal
1652 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1653 * `fleshy`: Living things like animals and the player. This could imply
1654 some blood effects when hitting.
1655 * `explody`: Especially prone to explosions
1656 * `oddly_breakable_by_hand`:
1657 Can be added to nodes that shouldn't logically be breakable by the
1658 hand but are. Somewhat similar to `dig_immediate`, but times are more
1659 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1660 speed of a tool if the tool can dig at a faster speed than this
1661 suggests for the hand.
1663 Examples of custom groups
1664 -------------------------
1666 Item groups are often used for defining, well, _groups of items_.
1668 * `meat`: any meat-kind of a thing (rating might define the size or healing
1669 ability or be irrelevant -- it is not defined as of yet)
1670 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1672 * `flammable`: can be set on fire. Rating might define the intensity of the
1673 fire, affecting e.g. the speed of the spreading of an open fire.
1674 * `wool`: any wool (any origin, any color)
1675 * `metal`: any metal
1676 * `weapon`: any weapon
1677 * `heavy`: anything considerably heavy
1679 Digging time calculation specifics
1680 ----------------------------------
1682 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1683 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1684 faster digging time.
1686 The `level` group is used to limit the toughness of nodes a tool can dig
1687 and to scale the digging times / damage to a greater extent.
1689 **Please do understand this**, otherwise you cannot use the system to it's
1692 Tools define their properties by a list of parameters for groups. They
1693 cannot dig other groups; thus it is important to use a standard bunch of
1694 groups to enable interaction with tools.
1707 * Full punch interval
1708 * Maximum drop level
1709 * For an arbitrary list of groups:
1710 * Uses (until the tool breaks)
1711 * Maximum level (usually `0`, `1`, `2` or `3`)
1715 ### Full punch interval
1717 When used as a weapon, the tool will do full damage if this time is spent
1718 between punches. If e.g. half the time is spent, the tool will do half
1721 ### Maximum drop level
1723 Suggests the maximum level of node, when dug with the tool, that will drop
1724 it's useful item. (e.g. iron ore to drop a lump of iron).
1726 This is not automated; it is the responsibility of the node definition
1731 Determines how many uses the tool has when it is used for digging a node,
1732 of this group, of the maximum level. For lower leveled nodes, the use count
1733 is multiplied by `3^leveldiff`.
1734 `leveldiff` is the difference of the tool's `maxlevel` `groupcaps` and the
1735 node's `level` group. The node cannot be dug if `leveldiff` is less than zero.
1737 * `uses=10, leveldiff=0`: actual uses: 10
1738 * `uses=10, leveldiff=1`: actual uses: 30
1739 * `uses=10, leveldiff=2`: actual uses: 90
1743 Tells what is the maximum level of a node of this group that the tool will
1748 List of digging times for different ratings of the group, for nodes of the
1751 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1752 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1753 for this group, and unable to dig the rating `1`, which is the toughest.
1754 Unless there is a matching group that enables digging otherwise.
1756 If the result digging time is 0, a delay of 0.15 seconds is added between
1757 digging nodes; If the player releases LMB after digging, this delay is set to 0,
1758 i.e. players can more quickly click the nodes away instead of holding LMB.
1762 List of damage for groups of entities. See [Entity damage mechanism].
1764 Example definition of the capabilities of a tool
1765 ------------------------------------------------
1767 tool_capabilities = {
1768 full_punch_interval=1.5,
1771 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1773 damage_groups = {fleshy=2},
1776 This makes the tool be able to dig nodes that fulfil both of these:
1778 * Have the `crumbly` group
1779 * Have a `level` group less or equal to `2`
1781 Table of resulting digging times:
1783 crumbly 0 1 2 3 4 <- level
1785 1 0.80 1.60 1.60 - -
1786 2 0.60 1.20 1.20 - -
1787 3 0.40 0.80 0.80 - -
1789 level diff: 2 1 0 -1 -2
1791 Table of resulting tool uses:
1800 * At `crumbly==0`, the node is not diggable.
1801 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1802 easy nodes to be quickly breakable.
1803 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1808 Entity damage mechanism
1809 =======================
1814 foreach group in cap.damage_groups:
1815 damage += cap.damage_groups[group]
1816 * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
1817 * (object.armor_groups[group] / 100.0)
1818 -- Where object.armor_groups[group] is 0 for inexistent values
1821 Client predicts damage based on damage groups. Because of this, it is able to
1822 give an immediate response when an entity is damaged or dies; the response is
1823 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1825 Currently a smoke puff will appear when an entity dies.
1827 The group `immortal` completely disables normal damage.
1829 Entities can define a special armor group, which is `punch_operable`. This
1830 group disables the regular damage mechanism for players punching it by hand or
1831 a non-tool item, so that it can do something else than take damage.
1833 On the Lua side, every punch calls:
1835 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction,
1838 This should never be called directly, because damage is usually not handled by
1841 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1842 accessed unless absolutely required, to encourage interoperability.
1843 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1844 * `tool_capabilities` can be `nil`.
1845 * `direction` is a unit vector, pointing from the source of the punch to
1847 * `damage` damage that will be done to entity
1848 Return value of this function will determine if damage is done by this function
1849 (retval true) or shall be done by engine (retval false)
1851 To punch an entity/object in Lua, call:
1853 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1855 * Return value is tool wear.
1856 * Parameters are equal to the above callback.
1857 * If `direction` equals `nil` and `puncher` does not equal `nil`, `direction`
1858 will be automatically filled in based on the location of `puncher`.
1869 The instance of a node in the world normally only contains the three values
1870 mentioned in [Nodes]. However, it is possible to insert extra data into a node.
1871 It is called "node metadata"; See `NodeMetaRef`.
1873 Node metadata contains two things:
1878 Some of the values in the key-value store are handled specially:
1880 * `formspec`: Defines a right-click inventory menu. See [Formspec].
1881 * `infotext`: Text shown on the screen when the node is pointed at
1885 local meta = minetest.get_meta(pos)
1886 meta:set_string("formspec",
1888 "list[context;main;0,0;8,4;]"..
1889 "list[current_player;main;0,5;8,4;]")
1890 meta:set_string("infotext", "Chest");
1891 local inv = meta:get_inventory()
1892 inv:set_size("main", 8*4)
1893 print(dump(meta:to_table()))
1896 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1897 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1898 [10] = "", [11] = "", [12] = "", [13] = "",
1899 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1900 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1901 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1902 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1906 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1914 Item stacks can store metadata too. See [`ItemStackMetaRef`].
1916 Item metadata only contains a key-value store.
1918 Some of the values in the key-value store are handled specially:
1920 * `description`: Set the item stack's description. Defaults to
1922 * `color`: A `ColorString`, which sets the stack's color.
1923 * `palette_index`: If the item has a palette, this is used to get the
1924 current color from the palette.
1928 local meta = stack:get_meta()
1929 meta:set_string("key", "value")
1930 print(dump(meta:to_table()))
1938 Formspec defines a menu. This supports inventories and some of the
1939 typical widgets like buttons, checkboxes, text input fields, etc.
1940 It is a string, with a somewhat strange format.
1942 A formspec is made out of formspec elements, which includes widgets
1943 like buttons but also can be used to set stuff like background color.
1945 Many formspec elements have a `name`, which is a unique identifier which
1946 is used when the server receives user input. You must not use the name
1947 "quit" for formspec elements.
1949 Spaces and newlines can be inserted between the blocks, as is used in the
1952 Position and size units are inventory slots unless the new coordinate system
1953 is enabled. `X` and `Y` position the formspec element relative to the top left
1954 of the menu or container. `W` and `H` are its width and height values.
1956 If the new system is enabled, all elements have unified coordinates for all
1957 elements with no padding or spacing in between. This is highly recommended
1958 for new forms. See `real_coordinates[<bool>]` and `Migrating to Real
1961 Inventories with a `player:<name>` inventory location are only sent to the
1962 player named `<name>`.
1964 When displaying text which can contain formspec code, e.g. text set by a player,
1965 use `minetest.formspec_escape`.
1966 For coloured text you can use `minetest.colorize`.
1968 Since formspec version 3, elements drawn in the order they are defined. All
1969 background elements are drawn before all other elements.
1971 **WARNING**: do _not_ use a element name starting with `key_`; those names are
1972 reserved to pass key press events to formspec!
1974 **WARNING**: Minetest allows you to add elements to every single formspec instance
1975 using `player:set_formspec_prepend()`, which may be the reason backgrounds are
1976 appearing when you don't expect them to, or why things are styled differently
1977 to normal. See [`no_prepend[]`] and [Styling Formspecs].
1985 list[context;main;0,0;8,4;]
1986 list[current_player;main;0,5;8,4;]
1991 list[context;fuel;2,3;1,1;]
1992 list[context;src;2,1;1,1;]
1993 list[context;dst;5,1;2,2;]
1994 list[current_player;main;0,5;8,4;]
1996 ### Minecraft-like player inventory
1999 image[1,0.6;1,2;player.png]
2000 list[current_player;main;0,3.5;8,4;]
2001 list[current_player;craft;3,0;3,3;]
2002 list[current_player;craftpreview;7,1;1,1;]
2007 ### `formspec_version[<version>]`
2009 * Set the formspec version to a certain number. If not specified,
2010 version 1 is assumed.
2011 * Must be specified before `size` element.
2012 * Clients older than this version can neither show newer elements nor display
2013 elements with new arguments correctly.
2014 * Available since feature `formspec_version_element`.
2016 ### `size[<W>,<H>,<fixed_size>]`
2018 * Define the size of the menu in inventory slots
2019 * `fixed_size`: `true`/`false` (optional)
2020 * deprecated: `invsize[<W>,<H>;]`
2022 ### `position[<X>,<Y>]`
2024 * Must be used after `size` element.
2025 * Defines the position on the game window of the formspec's `anchor` point.
2026 * For X and Y, 0.0 and 1.0 represent opposite edges of the game window,
2028 * [0.0, 0.0] sets the position to the top left corner of the game window.
2029 * [1.0, 1.0] sets the position to the bottom right of the game window.
2030 * Defaults to the center of the game window [0.5, 0.5].
2032 ### `anchor[<X>,<Y>]`
2034 * Must be used after both `size` and `position` (if present) elements.
2035 * Defines the location of the anchor point within the formspec.
2036 * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec,
2038 * [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
2039 * [1.0, 0.0] sets the anchor to the top right of the formspec.
2040 * Defaults to the center of the formspec [0.5, 0.5].
2042 * `position` and `anchor` elements need suitable values to avoid a formspec
2043 extending off the game window due to particular game window sizes.
2047 * Must be used after the `size`, `position`, and `anchor` elements (if present).
2048 * Disables player:set_formspec_prepend() from applying to this formspec.
2050 ### `real_coordinates[<bool>]`
2052 * INFORMATION: Enable it automatically using `formspec_version` version 2 or newer.
2053 * When set to true, all following formspec elements will use the new coordinate system.
2054 * If used immediately after `size`, `position`, `anchor`, and `no_prepend` elements
2055 (if present), the form size will use the new coordinate system.
2056 * **Note**: Formspec prepends are not affected by the coordinates in the main form.
2057 They must enable it explicitly.
2058 * For information on converting forms to the new coordinate system, see `Migrating
2059 to Real Coordinates`.
2061 ### `container[<X>,<Y>]`
2063 * Start of a container block, moves all physical elements in the container by
2065 * Must have matching `container_end`
2066 * Containers can be nested, in which case the offsets are added
2067 (child containers are relative to parent containers)
2069 ### `container_end[]`
2071 * End of a container, following elements are no longer relative to this
2074 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
2076 * Show an inventory list if it has been sent to the client. Nothing will
2077 be shown if the inventory list is of size 0.
2078 * **Note**: With the new coordinate system, the spacing between inventory
2079 slots is one-fourth the size of an inventory slot.
2081 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
2083 * Show an inventory list if it has been sent to the client. Nothing will
2084 be shown if the inventory list is of size 0.
2085 * **Note**: With the new coordinate system, the spacing between inventory
2086 slots is one-fourth the size of an inventory slot.
2088 ### `listring[<inventory location>;<list name>]`
2090 * Allows to create a ring of inventory lists
2091 * Shift-clicking on items in one element of the ring
2092 will send them to the next inventory list inside the ring
2093 * The first occurrence of an element inside the ring will
2094 determine the inventory where items will be sent to
2098 * Shorthand for doing `listring[<inventory location>;<list name>]`
2099 for the last two inventory lists added by list[...]
2101 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
2103 * Sets background color of slots as `ColorString`
2104 * Sets background color of slots on mouse hovering
2106 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
2108 * Sets background color of slots as `ColorString`
2109 * Sets background color of slots on mouse hovering
2110 * Sets color of slots border
2112 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
2114 * Sets background color of slots as `ColorString`
2115 * Sets background color of slots on mouse hovering
2116 * Sets color of slots border
2117 * Sets default background color of tooltips
2118 * Sets default font color of tooltips
2120 ### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2122 * Adds tooltip for an element
2123 * `bgcolor` tooltip background color as `ColorString` (optional)
2124 * `fontcolor` tooltip font color as `ColorString` (optional)
2126 ### `tooltip[<X>,<Y>;<W>,<H>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2128 * Adds tooltip for an area. Other tooltips will take priority when present.
2129 * `bgcolor` tooltip background color as `ColorString` (optional)
2130 * `fontcolor` tooltip font color as `ColorString` (optional)
2132 ### `image[<X>,<Y>;<W>,<H>;<texture name>]`
2136 ### `animated_image[<X>,<Y>;<W>,<H>;<name>;<texture name>;<frame count>;<frame duration>;<frame start>]`
2138 * Show an animated image. The image is drawn like a "vertical_frames" tile
2139 animation (See [Tile animation definition]), but uses a frame count/duration
2141 * `name`: Element name to send when an event occurs. The event value is the index of the current frame.
2142 * `texture name`: The image to use.
2143 * `frame count`: The number of frames animating the image.
2144 * `frame duration`: Milliseconds between each frame. `0` means the frames don't advance.
2145 * `frame start` (Optional): The index of the frame to start on. Default `1`.
2147 ### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
2149 * Show an inventory image of registered item/node
2151 ### `bgcolor[<bgcolor>;<fullscreen>;<fbgcolor>]`
2153 * Sets background color of formspec.
2154 * `bgcolor` and `fbgcolor` (optional) are `ColorString`s, they define the color
2155 of the non-fullscreen and the fullscreen background.
2156 * `fullscreen` (optional) can be one of the following:
2157 * `false`: Only the non-fullscreen background color is drawn. (default)
2158 * `true`: Only the fullscreen background color is drawn.
2159 * `both`: The non-fullscreen and the fullscreen background color are drawn.
2160 * `neither`: No background color is drawn.
2161 * Note: Leave a parameter empty to not modify the value.
2162 * Note: `fbgcolor`, leaving parameters empty and values for `fullscreen` that
2163 are not bools are only available since formspec version 3.
2165 ### `background[<X>,<Y>;<W>,<H>;<texture name>]`
2167 * Example for formspec 8x4 in 16x resolution: image shall be sized
2168 8 times 16px times 4 times 16px.
2170 ### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
2172 * Example for formspec 8x4 in 16x resolution:
2173 image shall be sized 8 times 16px times 4 times 16px
2174 * If `auto_clip` is `true`, the background is clipped to the formspec size
2175 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2177 ### `background9[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>;<middle>]`
2179 * 9-sliced background. See https://en.wikipedia.org/wiki/9-slice_scaling
2180 * Middle is a rect which defines the middle of the 9-slice.
2181 * `x` - The middle will be x pixels from all sides.
2182 * `x,y` - The middle will be x pixels from the horizontal and y from the vertical.
2183 * `x,y,x2,y2` - The middle will start at x,y, and end at x2, y2. Negative x2 and y2 values
2184 will be added to the width and height of the texture, allowing it to be used as the
2185 distance from the far end.
2186 * All numbers in middle are integers.
2187 * Example for formspec 8x4 in 16x resolution:
2188 image shall be sized 8 times 16px times 4 times 16px
2189 * If `auto_clip` is `true`, the background is clipped to the formspec size
2190 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2191 * Available since formspec version 2
2193 ### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
2195 * Textual password style field; will be sent to server when a button is clicked
2196 * When enter is pressed in field, fields.key_enter_field will be sent with the
2198 * With the old coordinate system, fields are a set height, but will be vertically
2199 centred on `H`. With the new coordinate system, `H` will modify the height.
2200 * `name` is the name of the field as returned in fields to `on_receive_fields`
2201 * `label`, if not blank, will be text printed on the top left above the field
2202 * See `field_close_on_enter` to stop enter closing the formspec
2204 ### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2206 * Textual field; will be sent to server when a button is clicked
2207 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2208 the name of this field.
2209 * With the old coordinate system, fields are a set height, but will be vertically
2210 centred on `H`. With the new coordinate system, `H` will modify the height.
2211 * `name` is the name of the field as returned in fields to `on_receive_fields`
2212 * `label`, if not blank, will be text printed on the top left above the field
2213 * `default` is the default value of the field
2214 * `default` may contain variable references such as `${text}` which
2215 will fill the value from the metadata value `text`
2216 * **Note**: no extra text or more than a single variable is supported ATM.
2217 * See `field_close_on_enter` to stop enter closing the formspec
2219 ### `field[<name>;<label>;<default>]`
2221 * As above, but without position/size units
2222 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2223 the name of this field.
2224 * Special field for creating simple forms, such as sign text input
2225 * Must be used without a `size[]` element
2226 * A "Proceed" button will be added automatically
2227 * See `field_close_on_enter` to stop enter closing the formspec
2229 ### `field_close_on_enter[<name>;<close_on_enter>]`
2231 * <name> is the name of the field
2232 * if <close_on_enter> is false, pressing enter in the field will submit the
2233 form but not close it.
2234 * defaults to true when not specified (ie: no tag for a field)
2236 ### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2238 * Same as fields above, but with multi-line input
2239 * If the text overflows, a vertical scrollbar is added.
2240 * If the name is empty, the textarea is read-only and
2241 the background is not shown, which corresponds to a multi-line label.
2243 ### `label[<X>,<Y>;<label>]`
2245 * The label formspec element displays the text set in `label`
2246 at the specified position.
2247 * **Note**: If the new coordinate system is enabled, labels are
2248 positioned from the center of the text, not the top.
2249 * The text is displayed directly without automatic line breaking,
2250 so label should not be used for big text chunks. Newlines can be
2251 used to make labels multiline.
2252 * **Note**: With the new coordinate system, newlines are spaced with
2253 half a coordinate. With the old system, newlines are spaced 2/5 of
2256 ### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]`
2257 * Displays a static formatted text with hyperlinks.
2258 * **Note**: This element is currently unstable and subject to change.
2259 * `x`, `y`, `w` and `h` work as per field
2260 * `name` is the name of the field as returned in fields to `on_receive_fields` in case of action in text.
2261 * `text` is the formatted text using `Markup Language` described below.
2263 ### `vertlabel[<X>,<Y>;<label>]`
2264 * Textual label drawn vertically
2265 * `label` is the text on the label
2266 * **Note**: If the new coordinate system is enabled, vertlabels are
2267 positioned from the center of the text, not the left.
2269 ### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
2271 * Clickable button. When clicked, fields will be sent.
2272 * With the old coordinate system, buttons are a set height, but will be vertically
2273 centred on `H`. With the new coordinate system, `H` will modify the height.
2274 * `label` is the text on the button
2276 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2278 * `texture name` is the filename of an image
2279 * **Note**: Height is supported on both the old and new coordinate systems
2282 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
2284 * `texture name` is the filename of an image
2285 * `noclip=true` means the image button doesn't need to be within specified
2287 * `drawborder`: draw button border or not
2288 * `pressed texture name` is the filename of an image on pressed state
2290 ### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
2292 * `item name` is the registered name of an item/node
2293 * The item description will be used as the tooltip. This can be overridden with
2296 ### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
2298 * When clicked, fields will be sent and the form will quit.
2299 * Same as `button` in all other respects.
2301 ### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2303 * When clicked, fields will be sent and the form will quit.
2304 * Same as `image_button` in all other respects.
2306 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
2308 * Scrollable item list showing arbitrary text elements
2309 * `name` fieldname sent to server on doubleclick value is current selected
2311 * `listelements` can be prepended by #color in hexadecimal format RRGGBB
2313 * if you want a listelement to start with "#" write "##".
2315 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
2317 * Scrollable itemlist showing arbitrary text elements
2318 * `name` fieldname sent to server on doubleclick value is current selected
2320 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
2321 * if you want a listelement to start with "#" write "##"
2322 * Index to be selected within textlist
2323 * `true`/`false`: draw transparent background
2324 * See also `minetest.explode_textlist_event`
2325 (main menu: `core.explode_textlist_event`).
2327 ### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2329 * Show a tab**header** at specific position (ignores formsize)
2330 * `X` and `Y`: position of the tabheader
2331 * *Note*: Width and height are automatically chosen with this syntax
2332 * `name` fieldname data is transferred to Lua
2333 * `caption 1`...: name shown on top of tab
2334 * `current_tab`: index of selected tab 1...
2335 * `transparent` (optional): show transparent
2336 * `draw_border` (optional): draw border
2338 ### `tabheader[<X>,<Y>;<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2340 * Show a tab**header** at specific position (ignores formsize)
2341 * **Important note**: This syntax for tabheaders can only be used with the
2342 new coordinate system.
2343 * `X` and `Y`: position of the tabheader
2344 * `H`: height of the tabheader. Width is automatically determined with this syntax.
2345 * `name` fieldname data is transferred to Lua
2346 * `caption 1`...: name shown on top of tab
2347 * `current_tab`: index of selected tab 1...
2348 * `transparent` (optional): show transparent
2349 * `draw_border` (optional): draw border
2351 ### `tabheader[<X>,<Y>;<W>,<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2353 * Show a tab**header** at specific position (ignores formsize)
2354 * **Important note**: This syntax for tabheaders can only be used with the
2355 new coordinate system.
2356 * `X` and `Y`: position of the tabheader
2357 * `W` and `H`: width and height of the tabheader
2358 * `name` fieldname data is transferred to Lua
2359 * `caption 1`...: name shown on top of tab
2360 * `current_tab`: index of selected tab 1...
2361 * `transparent` (optional): show transparent
2362 * `draw_border` (optional): draw border
2364 ### `box[<X>,<Y>;<W>,<H>;<color>]`
2366 * Simple colored box
2367 * `color` is color specified as a `ColorString`.
2368 If the alpha component is left blank, the box will be semitransparent.
2370 ### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
2372 * Show a dropdown field
2373 * **Important note**: There are two different operation modes:
2374 1. handle directly on change (only changed dropdown is submitted)
2375 2. read the value on pressing a button (all dropdown values are available)
2376 * `X` and `Y`: position of the dropdown
2377 * `W`: width of the dropdown. Height is automatically chosen with this syntax.
2378 * Fieldname data is transferred to Lua
2379 * Items to be shown in dropdown
2380 * Index of currently selected dropdown item
2382 ### `dropdown[<X>,<Y>;<W>,<H>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
2384 * Show a dropdown field
2385 * **Important note**: This syntax for dropdowns can only be used with the
2386 new coordinate system.
2387 * **Important note**: There are two different operation modes:
2388 1. handle directly on change (only changed dropdown is submitted)
2389 2. read the value on pressing a button (all dropdown values are available)
2390 * `X` and `Y`: position of the dropdown
2391 * `W` and `H`: width and height of the dropdown
2392 * Fieldname data is transferred to Lua
2393 * Items to be shown in dropdown
2394 * Index of currently selected dropdown item
2396 ### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
2399 * `name` fieldname data is transferred to Lua
2400 * `label` to be shown left of checkbox
2401 * `selected` (optional): `true`/`false`
2402 * **Note**: If the new coordinate system is enabled, checkboxes are
2403 positioned from the center of the checkbox, not the top.
2405 ### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
2407 * Show a scrollbar using options defined by the previous `scrollbaroptions[]`
2408 * There are two ways to use it:
2409 1. handle the changed event (only changed scrollbar is available)
2410 2. read the value on pressing a button (all scrollbars are available)
2411 * `orientation`: `vertical`/`horizontal`
2412 * Fieldname data is transferred to Lua
2413 * Value of this trackbar is set to (`0`-`1000`) by default
2414 * See also `minetest.explode_scrollbar_event`
2415 (main menu: `core.explode_scrollbar_event`).
2417 ### `scrollbaroptions[opt1;opt2;...]`
2418 * Sets options for all following `scrollbar[]` elements
2420 * Sets scrollbar minimum value, defaults to `0`.
2422 * Sets scrollbar maximum value, defaults to `1000`.
2423 If the max is equal to the min, the scrollbar will be disabled.
2425 * Sets scrollbar step value when the arrows are clicked or the mouse wheel is
2427 * If this is set to a negative number, the value will be reset to `10`.
2429 * Sets scrollbar step value used by page up and page down.
2430 * If this is set to a negative number, the value will be reset to `100`.
2432 * Sets size of the thumb on the scrollbar. Size is calculated in the number of
2433 units the thumb spans out of the range of the scrollbar values.
2434 * Example: If a scrollbar has a `min` of 1 and a `max` of 100, a thumbsize of 10
2435 would span a tenth of the scrollbar space.
2436 * If this is set to zero or less, the value will be reset to `1`.
2437 * `arrows=<show/hide/default>`
2438 * Whether to show the arrow buttons on the scrollbar. `default` hides the arrows
2439 when the scrollbar gets too small, but shows them otherwise.
2441 ### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
2443 * Show scrollable table using options defined by the previous `tableoptions[]`
2444 * Displays cells as defined by the previous `tablecolumns[]`
2445 * `name`: fieldname sent to server on row select or doubleclick
2446 * `cell 1`...`cell n`: cell contents given in row-major order
2447 * `selected idx`: index of row to be selected within table (first row = `1`)
2448 * See also `minetest.explode_table_event`
2449 (main menu: `core.explode_table_event`).
2451 ### `tableoptions[<opt 1>;<opt 2>;...]`
2453 * Sets options for `table[]`
2455 * default text color (`ColorString`), defaults to `#FFFFFF`
2456 * `background=#RRGGBB`
2457 * table background color (`ColorString`), defaults to `#000000`
2458 * `border=<true/false>`
2459 * should the table be drawn with a border? (default: `true`)
2460 * `highlight=#RRGGBB`
2461 * highlight background color (`ColorString`), defaults to `#466432`
2462 * `highlight_text=#RRGGBB`
2463 * highlight text color (`ColorString`), defaults to `#FFFFFF`
2464 * `opendepth=<value>`
2465 * all subtrees up to `depth < value` are open (default value = `0`)
2466 * only useful when there is a column of type "tree"
2468 ### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
2470 * Sets columns for `table[]`
2471 * Types: `text`, `image`, `color`, `indent`, `tree`
2472 * `text`: show cell contents as text
2473 * `image`: cell contents are an image index, use column options to define
2475 * `color`: cell contents are a ColorString and define color of following
2477 * `indent`: cell contents are a number and define indentation of following
2479 * `tree`: same as indent, but user can open and close subtrees
2483 * for `text` and `image`: content alignment within cells.
2484 Available values: `left` (default), `center`, `right`, `inline`
2486 * for `text` and `image`: minimum width in em (default: `0`)
2487 * for `indent` and `tree`: indent width in em (default: `1.5`)
2488 * `padding=<value>`: padding left of the column, in em (default `0.5`).
2489 Exception: defaults to 0 for indent columns
2490 * `tooltip=<value>`: tooltip text (default: empty)
2491 * `image` column options:
2492 * `0=<value>` sets image for image index 0
2493 * `1=<value>` sets image for image index 1
2494 * `2=<value>` sets image for image index 2
2495 * and so on; defined indices need not be contiguous empty or
2496 non-numeric cells are treated as `0`.
2497 * `color` column options:
2498 * `span=<value>`: number of following columns to affect
2499 (default: infinite).
2501 ### `style[<name 1>,<name 2>,...;<prop1>;<prop2>;...]`
2503 * Set the style for the named element(s) `name`.
2504 * Note: this **must** be before the element is defined.
2505 * See [Styling Formspecs].
2508 ### `style_type[<type 1>,<type 2>,...;<prop1>;<prop2>;...]`
2510 * Sets the style for all elements of type(s) `type` which appear after this element.
2511 * See [Styling Formspecs].
2513 Migrating to Real Coordinates
2514 -----------------------------
2516 In the old system, positions included padding and spacing. Padding is a gap between
2517 the formspec window edges and content, and spacing is the gaps between items. For
2518 example, two `1x1` elements at `0,0` and `1,1` would have a spacing of `5/4` between them,
2519 and a padding of `3/8` from the formspec edge. It may be easiest to recreate old layouts
2520 in the new coordinate system from scratch.
2522 To recreate an old layout with padding, you'll need to pass the positions and sizes
2523 through the following formula to re-introduce padding:
2526 pos = (oldpos + 1)*spacing + padding
2532 You'll need to change the `size[]` tag like this:
2535 size = (oldsize-1)*spacing + padding*2 + 1
2538 A few elements had random offsets in the old system. Here is a table which shows these
2539 offsets when migrating:
2541 | Element | Position | Size | Notes
2542 |---------|------------|---------|-------
2543 | box | +0.3, +0.1 | 0, -0.4 |
2544 | button | | | Buttons now support height, so set h = 2 * 15/13 * 0.35, and reposition if h ~= 15/13 * 0.35 before
2545 | list | | | Spacing is now 0.25 for both directions, meaning lists will be taller in height
2546 | label | 0, +0.3 | | The first line of text is now positioned centered exactly at the position specified
2551 Formspec elements can be themed using the style elements:
2553 style[<name 1>,<name 2>,...;<prop1>;<prop2>;...]
2554 style_type[<type 1>,<type 2>,...;<prop1>;<prop2>;...]
2558 property_name=property_value
2560 A name/type can optionally be a comma separated list of names/types, like so:
2562 world_delete,world_create,world_configure
2567 style_type[button;bgcolor=#006699]
2568 style[world_delete;bgcolor=red;textcolor=yellow]
2569 button[4,3.95;2.6,1;world_delete;Delete]
2571 Setting a property to nothing will reset it to the default value. For example:
2573 style_type[button;bgimg=button.png;bgimg_pressed=button_pressed.png;border=false]
2574 style[btn_exit;bgimg=;bgimg_pressed=;border=;bgcolor=red]
2577 ### Supported Element Types
2579 Some types may inherit styles from parent types.
2581 * animated_image, inherits from image
2583 * button_exit, inherits from button
2590 * pwdfield, inherits from field
2593 * vertlabel, inherits from field
2599 ### Valid Properties
2602 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2604 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2605 * Default to false in formspec_version version 3 or higher
2606 * button, button_exit, image_button, item_image_button
2607 * alpha - boolean, whether to draw alpha in bgimg. Default true.
2608 * bgcolor - color, sets button tint.
2609 * bgcolor_hovered - color when hovered. Defaults to a lighter bgcolor when not provided.
2610 * bgcolor_pressed - color when pressed. Defaults to a darker bgcolor when not provided.
2611 * bgimg - standard background image. Defaults to none.
2612 * bgimg_hovered - background image when hovered. Defaults to bgimg when not provided.
2613 * bgimg_middle - Makes the bgimg textures render in 9-sliced mode and defines the middle rect.
2614 See background9[] documentation for more details
2615 * bgimg_pressed - background image when pressed. Defaults to bgimg when not provided.
2616 * border - boolean, draw border. Set to false to hide the bevelled button pane. Default true.
2617 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2618 * textcolor - color, default white.
2620 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2622 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2624 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2626 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2627 * field, pwdfield, textarea
2628 * border - set to false to hide the textbox background and border. Default true.
2629 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2630 * textcolor - color. Default white.
2632 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2633 * Default to false in formspec_version version 3 or higher
2635 * noclip - boolean, set to true to allow the element to exceed formspec bounds. Default to false.
2637 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2638 * image_button (additional properties)
2639 * fgimg - standard image. Defaults to none.
2640 * fgimg_hovered - image when hovered. Defaults to fgimg when not provided.
2641 * fgimg_pressed - image when pressed. Defaults to fgimg when not provided.
2642 * NOTE: The parameters of any given image_button will take precedence over fgimg/fgimg_pressed
2644 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2645 * textcolor - color. Default white.
2650 Markup language used in `hypertext[]` elements uses tags that look like HTML tags.
2651 The markup language is currently unstable and subject to change. Use with caution.
2652 Some tags can enclose text, they open with `<tagname>` and close with `</tagname>`.
2653 Tags can have attributes, in that case, attributes are in the opening tag in
2654 form of a key/value separated with equal signs. Attribute values should not be quoted.
2656 These are the technically basic tags but see below for usual tags. Base tags are:
2658 `<style color=... font=... size=...>...</style>`
2660 Changes the style of the text.
2662 * `color`: Text color. Given color is a `colorspec`.
2663 * `size`: Text size.
2664 * `font`: Text font (`mono` or `normal`).
2666 `<global background=... margin=... valign=... color=... hovercolor=... size=... font=... halign=... >`
2671 * `background`: Text background, a `colorspec` or `none`.
2672 * `margin`: Page margins in pixel.
2673 * `valign`: Text vertical alignment (`top`, `middle`, `bottom`).
2675 Inheriting styles (affects child elements):
2676 * `color`: Default text color. Given color is a `colorspec`.
2677 * `hovercolor`: Color of <action> tags when mouse is over.
2678 * `size`: Default text size.
2679 * `font`: Default text font (`mono` or `normal`).
2680 * `halign`: Default text horizontal alignment (`left`, `right`, `center`, `justify`).
2682 This tag needs to be placed only once as it changes the global settings of the
2683 text. Anyway, if several tags are placed, each changed will be made in the order
2686 `<tag name=... color=... hovercolor=... font=... size=...>`
2688 Defines or redefines tag style. This can be used to define new tags.
2689 * `name`: Name of the tag to define or change.
2690 * `color`: Text color. Given color is a `colorspec`.
2691 * `hovercolor`: Text color when element hovered (only for `action` tags). Given color is a `colorspec`.
2692 * `size`: Text size.
2693 * `font`: Text font (`mono` or `normal`).
2695 Following tags are the usual tags for text layout. They are defined by default.
2696 Other tags can be added using `<tag ...>` tag.
2698 `<normal>...</normal>`: Normal size text
2700 `<big>...</big>`: Big text
2702 `<bigger>...</bigger>`: Bigger text
2704 `<center>...</center>`: Centered text
2706 `<left>...</left>`: Left-aligned text
2708 `<right>...</right>`: Right-aligned text
2710 `<justify>...</justify>`: Justified text
2712 `<mono>...</mono>`: Monospaced font
2714 `<b>...</b>`, `<i>...</i>`, `<u>...</u>`: Bold, italic, underline styles.
2716 `<action name=...>...</action>`
2718 Make that text a clickable text triggering an action.
2720 * `name`: Name of the action (mandatory).
2722 When clicked, the formspec is send to the server. The value of the text field
2723 sent to `on_player_receive_fields` will be "action:" concatenated to the action
2726 `<img name=... float=... width=... height=...>`
2728 Draws an image which is present in the client media cache.
2730 * `name`: Name of the texture (mandatory).
2731 * `float`: If present, makes the image floating (`left` or `right`).
2732 * `width`: Force image width instead of taking texture width.
2733 * `height`: Force image height instead of taking texture height.
2735 If only width or height given, texture aspect is kept.
2737 `<item name=... float=... width=... height=... rotate=...>`
2739 Draws an item image.
2741 * `name`: Item string of the item to draw (mandatory).
2742 * `float`: If present, makes the image floating (`left` or `right`).
2743 * `width`: Item image width.
2744 * `height`: Item image height.
2745 * `rotate`: Rotate item image if set to `yes` or `X,Y,Z`. X, Y and Z being
2746 rotation speeds in percent of standard speed (-1000 to 1000). Works only if
2747 `inventory_items_animations` is set to true.
2748 * `angle`: Angle in which the item image is shown. Value has `X,Y,Z` form.
2749 X, Y and Z being angles around each three axes. Works only if
2750 `inventory_items_animations` is set to true.
2758 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
2759 * `"current_player"`: Player to whom the menu is shown
2760 * `"player:<name>"`: Any player
2761 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
2762 * `"detached:<name>"`: A detached inventory
2764 Player Inventory lists
2765 ----------------------
2767 * `main`: list containing the default inventory
2768 * `craft`: list containing the craft input
2769 * `craftpreview`: list containing the craft prediction
2770 * `craftresult`: list containing the crafted output
2771 * `hand`: list containing an override for the empty hand
2772 * Is not created automatically, use `InvRef:set_size`
2773 * Is only used to enhance the empty hand's tool capabilities
2781 `#RGB` defines a color in hexadecimal format.
2783 `#RGBA` defines a color in hexadecimal format and alpha channel.
2785 `#RRGGBB` defines a color in hexadecimal format.
2787 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
2789 Named colors are also supported and are equivalent to
2790 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
2791 To specify the value of the alpha channel, append `#AA` to the end of the color
2792 name (e.g. `colorname#08`). For named colors the hexadecimal string
2793 representing the alpha value must (always) be two hexadecimal digits.
2798 A ColorSpec specifies a 32-bit color. It can be written in any of the following
2801 * table form: Each element ranging from 0..255 (a, if absent, defaults to 255):
2802 * `colorspec = {a=255, r=0, g=255, b=0}`
2803 * numerical form: The raw integer value of an ARGB8 quad:
2804 * `colorspec = 0xFF00FF00`
2805 * string form: A ColorString (defined above):
2806 * `colorspec = "green"`
2814 Most text can contain escape sequences, that can for example color the text.
2815 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
2816 The following functions provide escape sequences:
2818 * `minetest.get_color_escape_sequence(color)`:
2819 * `color` is a ColorString
2820 * The escape sequence sets the text color to `color`
2821 * `minetest.colorize(color, message)`:
2823 `minetest.get_color_escape_sequence(color) ..
2825 minetest.get_color_escape_sequence("#ffffff")`
2826 * `minetest.get_background_escape_sequence(color)`
2827 * `color` is a ColorString
2828 * The escape sequence sets the background of the whole text element to
2829 `color`. Only defined for item descriptions and tooltips.
2830 * `minetest.strip_foreground_colors(str)`
2831 * Removes foreground colors added by `get_color_escape_sequence`.
2832 * `minetest.strip_background_colors(str)`
2833 * Removes background colors added by `get_background_escape_sequence`.
2834 * `minetest.strip_colors(str)`
2835 * Removes all color escape sequences.
2842 A spatial vector is similar to a position, but instead using
2843 absolute world coordinates, it uses *relative* coordinates, relative to
2844 no particular point.
2846 Internally, it is implemented as a table with the 3 fields
2847 `x`, `y` and `z`. Example: `{x = 0, y = 1, z = 0}`.
2849 For the following functions, `v`, `v1`, `v2` are vectors,
2850 `p1`, `p2` are positions:
2852 * `vector.new(a[, b, c])`:
2854 * A copy of `a` if `a` is a vector.
2855 * `{x = a, y = b, z = c}`, if all of `a`, `b`, `c` are defined numbers.
2856 * `vector.direction(p1, p2)`:
2857 * Returns a vector of length 1 with direction `p1` to `p2`.
2858 * If `p1` and `p2` are identical, returns `{x = 0, y = 0, z = 0}`.
2859 * `vector.distance(p1, p2)`:
2860 * Returns zero or a positive number, the distance between `p1` and `p2`.
2861 * `vector.length(v)`:
2862 * Returns zero or a positive number, the length of vector `v`.
2863 * `vector.normalize(v)`:
2864 * Returns a vector of length 1 with direction of vector `v`.
2865 * If `v` has zero length, returns `{x = 0, y = 0, z = 0}`.
2866 * `vector.floor(v)`:
2867 * Returns a vector, each dimension rounded down.
2868 * `vector.round(v)`:
2869 * Returns a vector, each dimension rounded to nearest integer.
2870 * `vector.apply(v, func)`:
2871 * Returns a vector where the function `func` has been applied to each
2873 * `vector.equals(v1, v2)`:
2874 * Returns a boolean, `true` if the vectors are identical.
2875 * `vector.sort(v1, v2)`:
2876 * Returns in order minp, maxp vectors of the cuboid defined by `v1`, `v2`.
2877 * `vector.angle(v1, v2)`:
2878 * Returns the angle between `v1` and `v2` in radians.
2879 * `vector.dot(v1, v2)`
2880 * Returns the dot product of `v1` and `v2`
2881 * `vector.cross(v1, v2)`
2882 * Returns the cross product of `v1` and `v2`
2884 For the following functions `x` can be either a vector or a number:
2886 * `vector.add(v, x)`:
2888 * If `x` is a vector: Returns the sum of `v` and `x`.
2889 * If `x` is a number: Adds `x` to each component of `v`.
2890 * `vector.subtract(v, x)`:
2892 * If `x` is a vector: Returns the difference of `v` subtracted by `x`.
2893 * If `x` is a number: Subtracts `x` from each component of `v`.
2894 * `vector.multiply(v, x)`:
2895 * Returns a scaled vector or Schur product.
2896 * `vector.divide(v, x)`:
2897 * Returns a scaled vector or Schur quotient.
2905 * `dump2(obj, name, dumped)`: returns a string which makes `obj`
2906 human-readable, handles reference loops.
2907 * `obj`: arbitrary variable
2908 * `name`: string, default: `"_"`
2909 * `dumped`: table, default: `{}`
2910 * `dump(obj, dumped)`: returns a string which makes `obj` human-readable
2911 * `obj`: arbitrary variable
2912 * `dumped`: table, default: `{}`
2913 * `math.hypot(x, y)`
2914 * Get the hypotenuse of a triangle with legs x and y.
2915 Useful for distance calculation.
2916 * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
2917 * Get the sign of a number.
2918 * tolerance: number, default: `0.0`
2919 * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
2921 * `math.factorial(x)`: returns the factorial of `x`
2922 * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
2923 * `separator`: string, default: `","`
2924 * `include_empty`: boolean, default: `false`
2925 * `max_splits`: number, if it's negative, splits aren't limited,
2927 * `sep_is_pattern`: boolean, it specifies whether separator is a plain
2928 string or a pattern (regex), default: `false`
2929 * e.g. `"a,b":split","` returns `{"a","b"}`
2930 * `string:trim()`: returns the string without whitespace pre- and suffixes
2931 * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
2932 * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
2933 * Adds newlines to the string to keep it within the specified character
2935 * Note that the returned lines may be longer than the limit since it only
2936 splits at word borders.
2937 * `limit`: number, maximal amount of characters in one line
2938 * `as_table`: boolean, if set to true, a table of lines instead of a string
2939 is returned, default: `false`
2940 * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
2941 * `pos`: table {x=X, y=Y, z=Z}
2942 * Converts the position `pos` to a human-readable, printable string
2943 * `decimal_places`: number, if specified, the x, y and z values of
2944 the position are rounded to the given decimal place.
2945 * `minetest.string_to_pos(string)`: returns a position or `nil`
2946 * Same but in reverse.
2947 * If the string can't be parsed to a position, nothing is returned.
2948 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
2949 * Converts a string representing an area box into two positions
2950 * `minetest.formspec_escape(string)`: returns a string
2951 * escapes the characters "[", "]", "\", "," and ";", which can not be used
2953 * `minetest.is_yes(arg)`
2954 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
2955 * `minetest.is_nan(arg)`
2956 * returns true when the passed number represents NaN.
2957 * `minetest.get_us_time()`
2958 * returns time with microsecond precision. May not return wall time.
2959 * `table.copy(table)`: returns a table
2960 * returns a deep copy of `table`
2961 * `table.indexof(list, val)`: returns the smallest numerical index containing
2962 the value `val` in the table `list`. Non-numerical indices are ignored.
2963 If `val` could not be found, `-1` is returned. `list` must not have
2965 * `table.insert_all(table, other_table)`:
2966 * Appends all values in `other_table` to `table` - uses `#table + 1` to
2968 * `table.key_value_swap(t)`: returns a table with keys and values swapped
2969 * If multiple keys in `t` map to the same value, the result is undefined.
2970 * `table.shuffle(table, [from], [to], [random_func])`:
2971 * Shuffles elements `from` to `to` in `table` in place
2972 * `from` defaults to `1`
2973 * `to` defaults to `#table`
2974 * `random_func` defaults to `math.random`. This function receives two
2975 integers as arguments and should return a random integer inclusively
2977 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
2979 * returns the exact position on the surface of a pointed node
2980 * `minetest.get_dig_params(groups, tool_capabilities)`: Simulates a tool
2982 Returns a table with the following fields:
2983 * `diggable`: `true` if node can be dug, `false` otherwise.
2984 * `time`: Time it would take to dig the node.
2985 * `wear`: How much wear would be added to the tool.
2986 `time` and `wear` are meaningless if node's not diggable
2988 * `groups`: Table of the node groups of the node that would be dug
2989 * `tool_capabilities`: Tool capabilities table of the tool
2990 * `minetest.get_hit_params(groups, tool_capabilities [, time_from_last_punch])`:
2991 Simulates an item that punches an object.
2992 Returns a table with the following fields:
2993 * `hp`: How much damage the punch would cause.
2994 * `wear`: How much wear would be added to the tool.
2996 * `groups`: Damage groups of the object
2997 * `tool_capabilities`: Tool capabilities table of the item
2998 * `time_from_last_punch`: time in seconds since last punch action
3006 Texts can be translated client-side with the help of `minetest.translate` and
3009 Translating a string
3010 --------------------
3012 Two functions are provided to translate strings: `minetest.translate` and
3013 `minetest.get_translator`.
3015 * `minetest.get_translator(textdomain)` is a simple wrapper around
3016 `minetest.translate`, and `minetest.get_translator(textdomain)(str, ...)` is
3017 equivalent to `minetest.translate(textdomain, str, ...)`.
3018 It is intended to be used in the following way, so that it avoids verbose
3019 repetitions of `minetest.translate`:
3021 local S = minetest.get_translator(textdomain)
3024 As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
3026 * `minetest.translate(textdomain, str, ...)` translates the string `str` with
3027 the given `textdomain` for disambiguation. The textdomain must match the
3028 textdomain specified in the translation file in order to get the string
3029 translated. This can be used so that a string is translated differently in
3031 It is advised to use the name of the mod as textdomain whenever possible, to
3032 avoid clashes with other mods.
3033 This function must be given a number of arguments equal to the number of
3034 arguments the translated string expects.
3035 Arguments are literal strings -- they will not be translated, so if you want
3036 them to be, they need to come as outputs of `minetest.translate` as well.
3038 For instance, suppose we want to translate "@1 Wool" with "@1" being replaced
3039 by the translation of "Red". We can do the following:
3041 local S = minetest.get_translator()
3042 S("@1 Wool", S("Red"))
3044 This will be displayed as "Red Wool" on old clients and on clients that do
3045 not have localization enabled. However, if we have for instance a translation
3046 file named `wool.fr.tr` containing the following:
3051 this will be displayed as "Laine Rouge" on clients with a French locale.
3053 Operations on translated strings
3054 --------------------------------
3056 The output of `minetest.translate` is a string, with escape sequences adding
3057 additional information to that string so that it can be translated on the
3058 different clients. In particular, you can't expect operations like string.length
3059 to work on them like you would expect them to, or string.gsub to work in the
3060 expected manner. However, string concatenation will still work as expected
3061 (note that you should only use this for things like formspecs; do not translate
3062 sentences by breaking them into parts; arguments should be used instead), and
3063 operations such as `minetest.colorize` which are also concatenation.
3065 Translation file format
3066 -----------------------
3068 A translation file has the suffix `.[lang].tr`, where `[lang]` is the language
3069 it corresponds to. It must be put into the `locale` subdirectory of the mod.
3070 The file should be a text file, with the following format:
3072 * Lines beginning with `# textdomain:` (the space is significant) can be used
3073 to specify the text domain of all following translations in the file.
3074 * All other empty lines or lines beginning with `#` are ignored.
3075 * Other lines should be in the format `original=translated`. Both `original`
3076 and `translated` can contain escape sequences beginning with `@` to insert
3077 arguments, literal `@`, `=` or newline (See [Escapes] below).
3078 There must be no extraneous whitespace around the `=` or at the beginning or
3079 the end of the line.
3084 Strings that need to be translated can contain several escapes, preceded by `@`.
3086 * `@@` acts as a literal `@`.
3087 * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated
3088 string that will be inlined when translated. Due to how translations are
3089 implemented, the original translation string **must** have its arguments in
3090 increasing order, without gaps or repetitions, starting from 1.
3091 * `@=` acts as a literal `=`. It is not required in strings given to
3092 `minetest.translate`, but is in translation files to avoid being confused
3093 with the `=` separating the original from the translation.
3094 * `@\n` (where the `\n` is a literal newline) acts as a literal newline.
3095 As with `@=`, this escape is not required in strings given to
3096 `minetest.translate`, but is in translation files.
3097 * `@n` acts as a literal newline as well.
3105 Perlin noise creates a continuously-varying value depending on the input values.
3106 Usually in Minetest the input values are either 2D or 3D co-ordinates in nodes.
3107 The result is used during map generation to create the terrain shape, vary heat
3108 and humidity to distribute biomes, vary the density of decorations or vary the
3111 Structure of perlin noise
3112 -------------------------
3114 An 'octave' is a simple noise generator that outputs a value between -1 and 1.
3115 The smooth wavy noise it generates has a single characteristic scale, almost
3116 like a 'wavelength', so on its own does not create fine detail.
3117 Due to this perlin noise combines several octaves to create variation on
3118 multiple scales. Each additional octave has a smaller 'wavelength' than the
3121 This combination results in noise varying very roughly between -2.0 and 2.0 and
3122 with an average value of 0.0, so `scale` and `offset` are then used to multiply
3123 and offset the noise variation.
3125 The final perlin noise variation is created as follows:
3127 noise = offset + scale * (octave1 +
3128 octave2 * persistence +
3129 octave3 * persistence ^ 2 +
3130 octave4 * persistence ^ 3 +
3136 Noise Parameters are commonly called `NoiseParams`.
3140 After the multiplication by `scale` this is added to the result and is the final
3141 step in creating the noise value.
3142 Can be positive or negative.
3146 Once all octaves have been combined, the result is multiplied by this.
3147 Can be positive or negative.
3151 For octave1, this is roughly the change of input value needed for a very large
3152 variation in the noise value generated by octave1. It is almost like a
3153 'wavelength' for the wavy noise variation.
3154 Each additional octave has a 'wavelength' that is smaller than the previous
3155 octave, to create finer detail. `spread` will therefore roughly be the typical
3156 size of the largest structures in the final noise variation.
3158 `spread` is a vector with values for x, y, z to allow the noise variation to be
3159 stretched or compressed in the desired axes.
3160 Values are positive numbers.
3164 This is a whole number that determines the entire pattern of the noise
3165 variation. Altering it enables different noise patterns to be created.
3166 With other parameters equal, different seeds produce different noise patterns
3167 and identical seeds produce identical noise patterns.
3169 For this parameter you can randomly choose any whole number. Usually it is
3170 preferable for this to be different from other seeds, but sometimes it is useful
3171 to be able to create identical noise patterns.
3173 When used in mapgen this is actually a 'seed offset', it is added to the
3174 'world seed' to create the seed used by the noise, to ensure the noise has a
3175 different pattern in different worlds.
3179 The number of simple noise generators that are combined.
3180 A whole number, 1 or more.
3181 Each additional octave adds finer detail to the noise but also increases the
3182 noise calculation load.
3183 3 is a typical minimum for a high quality, complex and natural-looking noise
3184 variation. 1 octave has a slight 'gridlike' appearence.
3186 Choose the number of octaves according to the `spread` and `lacunarity`, and the
3187 size of the finest detail you require. For example:
3188 if `spread` is 512 nodes, `lacunarity` is 2.0 and finest detail required is 16
3189 nodes, octaves will be 6 because the 'wavelengths' of the octaves will be
3190 512, 256, 128, 64, 32, 16 nodes.
3191 Warning: If the 'wavelength' of any octave falls below 1 an error will occur.
3195 Each additional octave has an amplitude that is the amplitude of the previous
3196 octave multiplied by `persistence`, to reduce the amplitude of finer details,
3197 as is often helpful and natural to do so.
3198 Since this controls the balance of fine detail to large-scale detail
3199 `persistence` can be thought of as the 'roughness' of the noise.
3201 A positive or negative non-zero number, often between 0.3 and 1.0.
3202 A common medium value is 0.5, such that each octave has half the amplitude of
3203 the previous octave.
3204 This may need to be tuned when altering `lacunarity`; when doing so consider
3205 that a common medium value is 1 / lacunarity.
3209 Each additional octave has a 'wavelength' that is the 'wavelength' of the
3210 previous octave multiplied by 1 / lacunarity, to create finer detail.
3211 'lacunarity' is often 2.0 so 'wavelength' often halves per octave.
3213 A positive number no smaller than 1.0.
3214 Values below 2.0 create higher quality noise at the expense of requiring more
3215 octaves to cover a paticular range of 'wavelengths'.
3219 Leave this field unset for no special handling.
3220 Currently supported are `defaults`, `eased` and `absvalue`:
3224 Specify this if you would like to keep auto-selection of eased/not-eased while
3225 specifying some other flags.
3229 Maps noise gradient values onto a quintic S-curve before performing
3230 interpolation. This results in smooth, rolling noise.
3231 Disable this (`noeased`) for sharp-looking noise with a slightly gridded
3233 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is
3235 Easing a 3D noise significantly increases the noise calculation load, so use
3240 The absolute value of each octave's noise variation is used when combining the
3241 octaves. The final perlin noise variation is created as follows:
3243 noise = offset + scale * (abs(octave1) +
3244 abs(octave2) * persistence +
3245 abs(octave3) * persistence ^ 2 +
3246 abs(octave4) * persistence ^ 3 +
3251 For 2D or 3D perlin noise or perlin noise maps:
3256 spread = {x = 500, y = 500, z = 500},
3261 flags = "defaults, absvalue",
3264 For 2D noise the Z component of `spread` is still defined but is ignored.
3265 A single noise parameter table can be used for 2D or 3D noise.
3276 These tell in what manner the ore is generated.
3278 All default ores are of the uniformly-distributed scatter type.
3282 Randomly chooses a location and generates a cluster of ore.
3284 If `noise_params` is specified, the ore will be placed if the 3D perlin noise
3285 at that point is greater than the `noise_threshold`, giving the ability to
3286 create a non-equal distribution of ore.
3290 Creates a sheet of ore in a blob shape according to the 2D perlin noise
3291 described by `noise_params` and `noise_threshold`. This is essentially an
3292 improved version of the so-called "stratus" ore seen in some unofficial mods.
3294 This sheet consists of vertical columns of uniform randomly distributed height,
3295 varying between the inclusive range `column_height_min` and `column_height_max`.
3296 If `column_height_min` is not specified, this parameter defaults to 1.
3297 If `column_height_max` is not specified, this parameter defaults to `clust_size`
3298 for reverse compatibility. New code should prefer `column_height_max`.
3300 The `column_midpoint_factor` parameter controls the position of the column at
3301 which ore emanates from.
3302 If 1, columns grow upward. If 0, columns grow downward. If 0.5, columns grow
3303 equally starting from each direction.
3304 `column_midpoint_factor` is a decimal number ranging in value from 0 to 1. If
3305 this parameter is not specified, the default is 0.5.
3307 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this
3312 Creates a sheet of ore in a cloud-like puff shape.
3314 As with the `sheet` ore type, the size and shape of puffs are described by
3315 `noise_params` and `noise_threshold` and are placed at random vertical
3316 positions within the currently generated chunk.
3318 The vertical top and bottom displacement of each puff are determined by the
3319 noise parameters `np_puff_top` and `np_puff_bottom`, respectively.
3323 Creates a deformed sphere of ore according to 3d perlin noise described by
3324 `noise_params`. The maximum size of the blob is `clust_size`, and
3325 `clust_scarcity` has the same meaning as with the `scatter` type.
3329 Creates veins of ore varying in density by according to the intersection of two
3330 instances of 3d perlin noise with different seeds, both described by
3333 `random_factor` varies the influence random chance has on placement of an ore
3334 inside the vein, which is `1` by default. Note that modifying this parameter
3335 may require adjusting `noise_threshold`.
3337 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
3340 This ore type is difficult to control since it is sensitive to small changes.
3341 The following is a decent set of parameters to work from:
3346 spread = {x=200, y=200, z=200},
3353 noise_threshold = 1.6
3355 **WARNING**: Use this ore type *very* sparingly since it is ~200x more
3356 computationally expensive than any other ore.
3360 Creates a single undulating ore stratum that is continuous across mapchunk
3361 borders and horizontally spans the world.
3363 The 2D perlin noise described by `noise_params` defines the Y co-ordinate of
3364 the stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
3365 defines the stratum's vertical thickness (in units of nodes). Due to being
3366 continuous across mapchunk borders the stratum's vertical thickness is
3369 If the noise parameter `noise_params` is omitted the ore will occur from y_min
3370 to y_max in a simple horizontal stratum.
3372 A parameter `stratum_thickness` can be provided instead of the noise parameter
3373 `np_stratum_thickness`, to create a constant thickness.
3375 Leaving out one or both noise parameters makes the ore generation less
3376 intensive, useful when adding multiple strata.
3378 `y_min` and `y_max` define the limits of the ore generation and for performance
3379 reasons should be set as close together as possible but without clipping the
3380 stratum's Y variation.
3382 Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
3383 solid-ore stratum would require a `clust_scarcity` of 1.
3385 The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
3386 `random_factor` are ignored by this ore type.
3391 See section [Flag Specifier Format].
3393 Currently supported flags:
3394 `puff_cliffs`, `puff_additive_composition`.
3398 If set, puff ore generation will not taper down large differences in
3399 displacement when approaching the edge of a puff. This flag has no effect for
3400 ore types other than `puff`.
3402 ### `puff_additive_composition`
3404 By default, when noise described by `np_puff_top` or `np_puff_bottom` results
3405 in a negative displacement, the sub-column at that point is not generated. With
3406 this attribute set, puff ore generation will instead generate the absolute
3407 difference in noise displacement values. This flag has no effect for ore types
3416 The varying types of decorations that can be placed.
3421 Creates a 1 times `H` times 1 column of a specified node (or a random node from
3422 a list, if a decoration list is specified). Can specify a certain node it must
3423 spawn next to, such as water or lava, for example. Can also generate a
3424 decoration of random height between a specified lower and upper bound.
3425 This type of decoration is intended for placement of grass, flowers, cacti,
3426 papyri, waterlilies and so on.
3431 Copies a box of `MapNodes` from a specified schematic file (or raw description).
3432 Can specify a probability of a node randomly appearing when placed.
3433 This decoration type is intended to be used for multi-node sized discrete
3434 structures, such as trees, cave spikes, rocks, and so on.
3443 --------------------
3445 A schematic specifier identifies a schematic by either a filename to a
3446 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
3447 in the form of a table. This table specifies the following fields:
3449 * The `size` field is a 3D vector containing the dimensions of the provided
3450 schematic. (required field)
3451 * The `yslice_prob` field is a table of {ypos, prob} slice tables. A slice table
3452 sets the probability of a particular horizontal slice of the schematic being
3453 placed. (optional field)
3454 `ypos` = 0 for the lowest horizontal slice of a schematic.
3455 The default of `prob` is 255.
3456 * The `data` field is a flat table of MapNode tables making up the schematic,
3457 in the order of `[z [y [x]]]`. (required field)
3458 Each MapNode table contains:
3459 * `name`: the name of the map node to place (required)
3460 * `prob` (alias `param1`): the probability of this node being placed
3462 * `param2`: the raw param2 value of the node being placed onto the map
3464 * `force_place`: boolean representing if the node should forcibly overwrite
3465 any previous contents (default: false)
3467 About probability values:
3469 * A probability value of `0` or `1` means that node will never appear
3471 * A probability value of `254` or `255` means the node will always appear
3473 * If the probability value `p` is greater than `1`, then there is a
3474 `(p / 256 * 100)` percent chance that node will appear when the schematic is
3477 Schematic attributes
3478 --------------------
3480 See section [Flag Specifier Format].
3482 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
3485 * `place_center_x`: Placement of this decoration is centered along the X axis.
3486 * `place_center_y`: Placement of this decoration is centered along the Y axis.
3487 * `place_center_z`: Placement of this decoration is centered along the Z axis.
3488 * `force_placement`: Schematic nodes other than "ignore" will replace existing
3494 Lua Voxel Manipulator
3495 =====================
3500 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator'
3501 facility. The purpose of this object is for fast, low-level, bulk access to
3502 reading and writing Map content. As such, setting map nodes through VoxelManip
3503 will lack many of the higher level features and concepts you may be used to
3504 with other methods of setting nodes. For example, nodes will not have their
3505 construction and destruction callbacks run, and no rollback information is
3508 It is important to note that VoxelManip is designed for speed, and *not* ease
3509 of use or flexibility. If your mod requires a map manipulation facility that
3510 will handle 100% of all edge cases, or the use of high level node placement
3511 features, perhaps `minetest.set_node()` is better suited for the job.
3513 In addition, VoxelManip might not be faster, or could even be slower, for your
3514 specific use case. VoxelManip is most effective when setting large areas of map
3515 at once - for example, if only setting a 3x3x3 node area, a
3516 `minetest.set_node()` loop may be more optimal. Always profile code using both
3517 methods of map manipulation to determine which is most appropriate for your
3520 A recent simple test of setting cubic areas showed that `minetest.set_node()`
3521 is faster than a VoxelManip for a 3x3x3 node cube or smaller.
3526 A VoxelManip object can be created any time using either:
3527 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
3529 If the optional position parameters are present for either of these routines,
3530 the specified region will be pre-loaded into the VoxelManip object on creation.
3531 Otherwise, the area of map you wish to manipulate must first be loaded into the
3532 VoxelManip object using `VoxelManip:read_from_map()`.
3534 Note that `VoxelManip:read_from_map()` returns two position vectors. The region
3535 formed by these positions indicate the minimum and maximum (respectively)
3536 positions of the area actually loaded in the VoxelManip, which may be larger
3537 than the area requested. For convenience, the loaded area coordinates can also
3538 be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
3540 Now that the VoxelManip object is populated with map data, your mod can fetch a
3541 copy of this data using either of two methods. `VoxelManip:get_node_at()`,
3542 which retrieves an individual node in a MapNode formatted table at the position
3543 requested is the simplest method to use, but also the slowest.
3545 Nodes in a VoxelManip object may also be read in bulk to a flat array table
3548 * `VoxelManip:get_data()` for node content (in Content ID form, see section
3550 * `VoxelManip:get_light_data()` for node light levels, and
3551 * `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
3553 See section [Flat array format] for more details.
3555 It is very important to understand that the tables returned by any of the above
3556 three functions represent a snapshot of the VoxelManip's internal state at the
3557 time of the call. This copy of the data will not magically update itself if
3558 another function modifies the internal VoxelManip state.
3559 Any functions that modify a VoxelManip's contents work on the VoxelManip's
3560 internal state unless otherwise explicitly stated.
3562 Once the bulk data has been edited to your liking, the internal VoxelManip
3563 state can be set using:
3565 * `VoxelManip:set_data()` for node content (in Content ID form, see section
3567 * `VoxelManip:set_light_data()` for node light levels, and
3568 * `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
3570 The parameter to each of the above three functions can use any table at all in
3571 the same flat array format as produced by `get_data()` etc. and is not required
3572 to be a table retrieved from `get_data()`.
3574 Once the internal VoxelManip state has been modified to your liking, the
3575 changes can be committed back to the map by calling `VoxelManip:write_to_map()`
3577 ### Flat array format
3580 `Nx = p2.X - p1.X + 1`,
3581 `Ny = p2.Y - p1.Y + 1`, and
3582 `Nz = p2.Z - p1.Z + 1`.
3584 Then, for a loaded region of p1..p2, this array ranges from `1` up to and
3585 including the value of the expression `Nx * Ny * Nz`.
3587 Positions offset from p1 are present in the array with the format of:
3590 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
3591 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
3593 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
3594 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
3596 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
3598 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
3601 and the array index for a position p contained completely in p1..p2 is:
3603 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
3605 Note that this is the same "flat 3D array" format as
3606 `PerlinNoiseMap:get3dMap_flat()`.
3607 VoxelArea objects (see section [`VoxelArea`]) can be used to simplify calculation
3608 of the index for a single point in a flat VoxelManip array.
3612 A Content ID is a unique integer identifier for a specific node type.
3613 These IDs are used by VoxelManip in place of the node name string for
3614 `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
3615 `minetest.get_content_id()` to look up the Content ID for the specified node
3616 name, and `minetest.get_name_from_content_id()` to look up the node name string
3617 for a given Content ID.
3618 After registration of a node, its Content ID will remain the same throughout
3619 execution of the mod.
3620 Note that the node being queried needs to have already been been registered.
3622 The following builtin node types have their Content IDs defined as constants:
3624 * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
3625 * `minetest.CONTENT_AIR`: ID for "air" nodes
3626 * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
3628 ### Mapgen VoxelManip objects
3630 Inside of `on_generated()` callbacks, it is possible to retrieve the same
3631 VoxelManip object used by the core's Map Generator (commonly abbreviated
3632 Mapgen). Most of the rules previously described still apply but with a few
3635 * The Mapgen VoxelManip object is retrieved using:
3636 `minetest.get_mapgen_object("voxelmanip")`
3637 * This VoxelManip object already has the region of map just generated loaded
3638 into it; it's not necessary to call `VoxelManip:read_from_map()` before using
3639 a Mapgen VoxelManip.
3640 * The `on_generated()` callbacks of some mods may place individual nodes in the
3641 generated area using non-VoxelManip map modification methods. Because the
3642 same Mapgen VoxelManip object is passed through each `on_generated()`
3643 callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3644 consistency with the current map state. For this reason, calling any of the
3645 following functions:
3646 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3647 will also update the Mapgen VoxelManip object's internal state active on the
3649 * After modifying the Mapgen VoxelManip object's internal buffer, it may be
3650 necessary to update lighting information using either:
3651 `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3653 ### Other API functions operating on a VoxelManip
3655 If any VoxelManip contents were set to a liquid node,
3656 `VoxelManip:update_liquids()` must be called for these liquid nodes to begin
3657 flowing. It is recommended to call this function only after having written all
3658 buffered data back to the VoxelManip object, save for special situations where
3659 the modder desires to only have certain liquid nodes begin flowing.
3661 The functions `minetest.generate_ores()` and `minetest.generate_decorations()`
3662 will generate all registered decorations and ores throughout the full area
3663 inside of the specified VoxelManip object.
3665 `minetest.place_schematic_on_vmanip()` is otherwise identical to
3666 `minetest.place_schematic()`, except instead of placing the specified schematic
3667 directly on the map at the specified position, it will place the schematic
3668 inside the VoxelManip.
3672 * Attempting to read data from a VoxelManip object before map is read will
3673 result in a zero-length array table for `VoxelManip:get_data()`, and an
3674 "ignore" node at any position for `VoxelManip:get_node_at()`.
3675 * If either a region of map has not yet been generated or is out-of-bounds of
3676 the map, that region is filled with "ignore" nodes.
3677 * Other mods, or the core itself, could possibly modify the area of map
3678 currently loaded into a VoxelManip object. With the exception of Mapgen
3679 VoxelManips (see above section), the internal buffers are not updated. For
3680 this reason, it is strongly encouraged to complete the usage of a particular
3681 VoxelManip object in the same callback it had been created.
3682 * If a VoxelManip object will be used often, such as in an `on_generated()`
3683 callback, consider passing a file-scoped table as the optional parameter to
3684 `VoxelManip:get_data()`, which serves as a static buffer the function can use
3685 to write map data to instead of returning a new table each call. This greatly
3686 enhances performance by avoiding unnecessary memory allocations.
3691 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object
3692 containing the region formed by `p1` and `p2`.
3693 * returns actual emerged `pmin`, actual emerged `pmax`
3694 * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to
3696 * **important**: data must be set using `VoxelManip:set_data()` before
3698 * if `light` is true, then lighting is automatically recalculated.
3699 The default value is true.
3700 If `light` is false, no light calculations happen, and you should correct
3701 all modified blocks with `minetest.fix_light()` as soon as possible.
3702 Keep in mind that modifying the map where light is incorrect can cause
3704 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
3705 the `VoxelManip` at that position
3706 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
3708 * `get_data([buffer])`: Retrieves the node content data loaded into the
3709 `VoxelManip` object.
3710 * returns raw node data in the form of an array of node content IDs
3711 * if the param `buffer` is present, this table will be used to store the
3713 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
3714 * `update_map()`: Does nothing, kept for compatibility.
3715 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to
3717 * `light` is a table, `{day=<0...15>, night=<0...15>}`
3718 * To be used only by a `VoxelManip` object from
3719 `minetest.get_mapgen_object`.
3720 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
3722 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
3723 * Returns an array (indices 1 to volume) of integers ranging from `0` to
3725 * Each value is the bitwise combination of day and night light values
3727 * `light = day + (night * 16)`
3728 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
3729 in the `VoxelManip`.
3730 * expects lighting data in the same format that `get_light_data()` returns
3731 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the
3732 `VoxelManip` object.
3733 * Returns an array (indices 1 to volume) of integers ranging from `0` to
3735 * If the param `buffer` is present, this table will be used to store the
3737 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in
3739 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the
3741 * To be used only by a `VoxelManip` object from
3742 `minetest.get_mapgen_object`.
3743 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
3744 area if left out or nil. For almost all uses these should be left out
3745 or nil to use the default.
3746 * `propagate_shadow` is an optional boolean deciding whether shadows in a
3747 generated mapchunk above are propagated down into the mapchunk, defaults
3748 to `true` if left out.
3749 * `update_liquids()`: Update liquid flow
3750 * `was_modified()`: Returns `true` or `false` if the data in the voxel
3751 manipulator had been modified since the last read from map, due to a call to
3752 `minetest.set_data()` on the loaded area elsewhere.
3753 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
3758 A helper class for voxel areas.
3759 It can be created via `VoxelArea:new{MinEdge = pmin, MaxEdge = pmax}`.
3760 The coordinates are *inclusive*, like most other things in Minetest.
3764 * `getExtent()`: returns a 3D vector containing the size of the area formed by
3765 `MinEdge` and `MaxEdge`.
3766 * `getVolume()`: returns the volume of the area formed by `MinEdge` and
3768 * `index(x, y, z)`: returns the index of an absolute position in a flat array
3770 * `x`, `y` and `z` must be integers to avoid an incorrect index result.
3771 * The position (x, y, z) is not checked for being inside the area volume,
3772 being outside can cause an incorrect index result.
3773 * Useful for things like `VoxelManip`, raw Schematic specifiers,
3774 `PerlinNoiseMap:get2d`/`3dMap`, and so on.
3775 * `indexp(p)`: same functionality as `index(x, y, z)` but takes a vector.
3776 * As with `index(x, y, z)`, the components of `p` must be integers, and `p`
3777 is not checked for being inside the area volume.
3778 * `position(i)`: returns the absolute position vector corresponding to index
3780 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by
3781 `MinEdge` and `MaxEdge`.
3782 * `containsp(p)`: same as above, except takes a vector
3783 * `containsi(i)`: same as above, except takes an index `i`
3784 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns
3786 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of
3788 * `iterp(minp, maxp)`: same as above, except takes a vector
3790 ### Y stride and z stride of a flat array
3792 For a particular position in a voxel area, whose flat array index is known,
3793 it is often useful to know the index of a neighboring or nearby position.
3794 The table below shows the changes of index required for 1 node movements along
3795 the axes in a voxel area:
3797 Movement Change of index
3807 local area = VoxelArea:new{MinEdge = emin, MaxEdge = emax}
3809 The values of `ystride` and `zstride` can be obtained using `area.ystride` and
3818 A mapgen object is a construct used in map generation. Mapgen objects can be
3819 used by an `on_generate` callback to speed up operations by avoiding
3820 unnecessary recalculations, these can be retrieved using the
3821 `minetest.get_mapgen_object()` function. If the requested Mapgen object is
3822 unavailable, or `get_mapgen_object()` was called outside of an `on_generate()`
3823 callback, `nil` is returned.
3825 The following Mapgen objects are currently available:
3829 This returns three values; the `VoxelManip` object to be used, minimum and
3830 maximum emerged position, in that order. All mapgens support this object.
3834 Returns an array containing the y coordinates of the ground levels of nodes in
3835 the most recently generated chunk by the current mapgen.
3839 Returns an array containing the biome IDs of nodes in the most recently
3840 generated chunk by the current mapgen.
3844 Returns an array containing the temperature values of nodes in the most
3845 recently generated chunk by the current mapgen.
3849 Returns an array containing the humidity values of nodes in the most recently
3850 generated chunk by the current mapgen.
3854 Returns a table mapping requested generation notification types to arrays of
3855 positions at which the corresponding generated structures are located within
3856 the current chunk. To set the capture of positions of interest to be recorded
3857 on generate, use `minetest.set_gen_notify()`.
3858 For decorations, the returned positions are the ground surface 'place_on'
3859 nodes, not the decorations themselves. A 'simple' type decoration is often 1
3860 node above the returned position and possibly displaced by 'place_offset_y'.
3862 Possible fields of the table returned are:
3868 * `large_cave_begin`
3872 Decorations have a key in the format of `"decoration#id"`, where `id` is the
3873 numeric unique decoration ID as returned by `minetest.get_decoration_id`.
3881 Functions receive a "luaentity" as `self`:
3883 * It has the member `.name`, which is the registered name `("mod:thing")`
3884 * It has the member `.object`, which is an `ObjectRef` pointing to the object
3885 * The original prototype stuff is visible directly via a metatable
3889 * `on_activate(self, staticdata, dtime_s)`
3890 * Called when the object is instantiated.
3891 * `dtime_s` is the time passed since the object was unloaded, which can be
3892 used for updating the entity state.
3893 * `on_step(self, dtime)`
3894 * Called on every server tick, after movement and collision processing.
3895 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
3897 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)`
3898 * Called when somebody punches the object.
3899 * Note that you probably want to handle most punches using the automatic
3901 * `puncher`: an `ObjectRef` (can be `nil`)
3902 * `time_from_last_punch`: Meant for disallowing spamming of clicks
3904 * `tool_capabilities`: capability table of used tool (can be `nil`)
3905 * `dir`: unit vector of direction of punch. Always defined. Points from the
3906 puncher to the punched.
3907 * `damage`: damage that will be done to entity.
3908 * Can return `true` to prevent the default damage mechanism.
3909 * `on_death(self, killer)`
3910 * Called when the object dies.
3911 * `killer`: an `ObjectRef` (can be `nil`)
3912 * `on_rightclick(self, clicker)`
3913 * `on_attach_child(self, child)`
3914 * `child`: an `ObjectRef` of the child that attaches
3915 * `on_detach_child(self, child)`
3916 * `child`: an `ObjectRef` of the child that detaches
3917 * `on_detach(self, parent)`
3918 * `parent`: an `ObjectRef` (can be `nil`) from where it got detached
3919 * This happens before the parent object is removed from the world
3920 * `get_staticdata(self)`
3921 * Should return a string that will be passed to `on_activate` when the
3922 object is instantiated the next time.
3934 axiom, --string initial tree axiom
3935 rules_a, --string rules set A
3936 rules_b, --string rules set B
3937 rules_c, --string rules set C
3938 rules_d, --string rules set D
3939 trunk, --string trunk node name
3940 leaves, --string leaves node name
3941 leaves2, --string secondary leaves node name
3942 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
3943 angle, --num angle in deg
3944 iterations, --num max # of iterations, usually 2 -5
3945 random_level, --num factor to lower nr of iterations, usually 0 - 3
3946 trunk_type, --string single/double/crossed) type of trunk: 1 node,
3947 -- 2x2 nodes or 3x3 in cross shape
3948 thin_branches, --boolean true -> use thin (1 node) branches
3949 fruit, --string fruit node name
3950 fruit_chance, --num chance (0-100) to replace leaves with fruit node
3951 seed, --num random seed, if no seed is provided, the engine
3955 Key for special L-System symbols used in axioms
3956 -----------------------------------------------
3958 * `G`: move forward one unit with the pen up
3959 * `F`: move forward one unit with the pen down drawing trunks and branches
3960 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
3961 * `T`: move forward one unit with the pen down drawing trunks only
3962 * `R`: move forward one unit with the pen down placing fruit
3963 * `A`: replace with rules set A
3964 * `B`: replace with rules set B
3965 * `C`: replace with rules set C
3966 * `D`: replace with rules set D
3967 * `a`: replace with rules set A, chance 90%
3968 * `b`: replace with rules set B, chance 80%
3969 * `c`: replace with rules set C, chance 70%
3970 * `d`: replace with rules set D, chance 60%
3971 * `+`: yaw the turtle right by `angle` parameter
3972 * `-`: yaw the turtle left by `angle` parameter
3973 * `&`: pitch the turtle down by `angle` parameter
3974 * `^`: pitch the turtle up by `angle` parameter
3975 * `/`: roll the turtle to the right by `angle` parameter
3976 * `*`: roll the turtle to the left by `angle` parameter
3977 * `[`: save in stack current state info
3978 * `]`: recover from stack state info
3983 Spawn a small apple tree:
3985 pos = {x=230,y=20,z=4}
3988 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
3989 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
3990 trunk="default:tree",
3991 leaves="default:leaves",
3995 trunk_type="single",
3998 fruit="default:apple"
4000 minetest.spawn_tree(pos,apple_tree)
4005 'minetest' namespace reference
4006 ==============================
4011 * `minetest.get_current_modname()`: returns the currently loading mod's name,
4013 * `minetest.get_modpath(modname)`: returns e.g.
4014 `"/home/user/.minetest/usermods/modname"`.
4015 * Useful for loading additional `.lua` modules or static data from mod
4016 * `minetest.get_modnames()`: returns a list of installed mods
4017 * Return a list of installed mods, sorted alphabetically
4018 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
4019 * Useful for storing custom data
4020 * `minetest.is_singleplayer()`
4021 * `minetest.features`: Table containing API feature flags
4024 glasslike_framed = true, -- 0.4.7
4025 nodebox_as_selectionbox = true, -- 0.4.7
4026 get_all_craft_recipes_works = true, -- 0.4.7
4027 -- The transparency channel of textures can optionally be used on
4029 use_texture_alpha = true,
4030 -- Tree and grass ABMs are no longer done from C++ (0.4.8)
4031 no_legacy_abms = true,
4032 -- Texture grouping is possible using parentheses (0.4.11)
4033 texture_names_parens = true,
4034 -- Unique Area ID for AreaStore:insert_area (0.4.14)
4035 area_store_custom_ids = true,
4036 -- add_entity supports passing initial staticdata to on_activate
4038 add_entity_with_staticdata = true,
4039 -- Chat messages are no longer predicted (0.4.16)
4040 no_chat_message_prediction = true,
4041 -- The transparency channel of textures can optionally be used on
4042 -- objects (ie: players and lua entities) (5.0.0)
4043 object_use_texture_alpha = true,
4044 -- Object selectionbox is settable independently from collisionbox
4046 object_independent_selectionbox = true,
4047 -- Specifies whether binary data can be uploaded or downloaded using
4048 -- the HTTP API (5.1.0)
4049 httpfetch_binary_data = true,
4050 -- Whether formspec_version[<version>] may be used (5.1.0)
4051 formspec_version_element = true,
4052 -- Whether AreaStore's IDs are kept on save/load (5.1.0)
4053 area_store_persistent_ids = true,
4054 -- Whether minetest.find_path is functional (5.2.0)
4055 pathfinder_works = true,
4058 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
4059 * `arg`: string or table in format `{foo=true, bar=true}`
4060 * `missing_features`: `{foo=true, bar=true}`
4061 * `minetest.get_player_information(player_name)`: Table containing information
4062 about a player. Example return value:
4065 address = "127.0.0.1", -- IP address of client
4066 ip_version = 4, -- IPv4 / IPv6
4067 min_rtt = 0.01, -- minimum round trip time
4068 max_rtt = 0.2, -- maximum round trip time
4069 avg_rtt = 0.02, -- average round trip time
4070 min_jitter = 0.01, -- minimum packet time jitter
4071 max_jitter = 0.5, -- maximum packet time jitter
4072 avg_jitter = 0.03, -- average packet time jitter
4073 connection_uptime = 200, -- seconds since client connected
4074 protocol_version = 32, -- protocol version used by client
4075 formspec_version = 2, -- supported formspec version
4076 -- following information is available on debug build only!!!
4077 -- DO NOT USE IN MODS
4078 --ser_vers = 26, -- serialization version used by client
4079 --major = 0, -- major version number
4080 --minor = 4, -- minor version number
4081 --patch = 10, -- patch version number
4082 --vers_string = "0.4.9-git", -- full version string
4083 --state = "Active" -- current client state
4086 * `minetest.mkdir(path)`: returns success.
4087 * Creates a directory specified by `path`, creating parent directories
4088 if they don't exist.
4089 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
4091 * nil: return all entries,
4092 * true: return only subdirectory names, or
4093 * false: return only file names.
4094 * `minetest.safe_file_write(path, content)`: returns boolean indicating success
4095 * Replaces contents of file at path with new contents in a safe (atomic)
4096 way. Use this instead of below code when writing e.g. database files:
4097 `local f = io.open(path, "wb"); f:write(content); f:close()`
4098 * `minetest.get_version()`: returns a table containing components of the
4099 engine version. Components:
4100 * `project`: Name of the project, eg, "Minetest"
4101 * `string`: Simple version, eg, "1.2.3-dev"
4102 * `hash`: Full git version (only set if available),
4103 eg, "1.2.3-dev-01234567-dirty".
4104 Use this for informational purposes only. The information in the returned
4105 table does not represent the capabilities of the engine, nor is it
4106 reliable or verifiable. Compatible forks will have a different name and
4107 version entirely. To check for the presence of engine features, test
4108 whether the functions exported by the wanted features exist. For example:
4109 `if minetest.check_for_falling then ... end`.
4110 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
4111 * `data`: string of data to hash
4112 * `raw`: return raw bytes instead of hex digits, default: false
4117 * `minetest.debug(...)`
4118 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
4119 * `minetest.log([level,] text)`
4120 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
4121 `"info"`, or `"verbose"`. Default is `"none"`.
4123 Registration functions
4124 ----------------------
4126 Call these functions only at load time!
4130 * `minetest.register_node(name, node definition)`
4131 * `minetest.register_craftitem(name, item definition)`
4132 * `minetest.register_tool(name, item definition)`
4133 * `minetest.override_item(name, redefinition)`
4134 * Overrides fields of an item registered with register_node/tool/craftitem.
4135 * Note: Item must already be defined, (opt)depend on the mod defining it.
4136 * Example: `minetest.override_item("default:mese",
4137 {light_source=minetest.LIGHT_MAX})`
4138 * `minetest.unregister_item(name)`
4139 * Unregisters the item from the engine, and deletes the entry with key
4140 `name` from `minetest.registered_items` and from the associated item table
4141 according to its nature: `minetest.registered_nodes`, etc.
4142 * `minetest.register_entity(name, entity definition)`
4143 * `minetest.register_abm(abm definition)`
4144 * `minetest.register_lbm(lbm definition)`
4145 * `minetest.register_alias(alias, original_name)`
4146 * Also use this to set the 'mapgen aliases' needed in a game for the core
4147 mapgens. See [Mapgen aliases] section above.
4148 * `minetest.register_alias_force(alias, original_name)`
4149 * `minetest.register_ore(ore definition)`
4150 * Returns an integer object handle uniquely identifying the registered
4152 * The order of ore registrations determines the order of ore generation.
4153 * `minetest.register_biome(biome definition)`
4154 * Returns an integer object handle uniquely identifying the registered
4155 biome on success. To get the biome ID, use `minetest.get_biome_id`.
4156 * `minetest.unregister_biome(name)`
4157 * Unregisters the biome from the engine, and deletes the entry with key
4158 `name` from `minetest.registered_biomes`.
4159 * Warning: This alters the biome to biome ID correspondences, so any
4160 decorations or ores using the 'biomes' field must afterwards be cleared
4162 * `minetest.register_decoration(decoration definition)`
4163 * Returns an integer object handle uniquely identifying the registered
4164 decoration on success. To get the decoration ID, use
4165 `minetest.get_decoration_id`.
4166 * The order of decoration registrations determines the order of decoration
4168 * `minetest.register_schematic(schematic definition)`
4169 * Returns an integer object handle uniquely identifying the registered
4170 schematic on success.
4171 * If the schematic is loaded from a file, the `name` field is set to the
4173 * If the function is called when loading the mod, and `name` is a relative
4174 path, then the current mod path will be prepended to the schematic
4176 * `minetest.clear_registered_biomes()`
4177 * Clears all biomes currently registered.
4178 * Warning: Clearing and re-registering biomes alters the biome to biome ID
4179 correspondences, so any decorations or ores using the 'biomes' field must
4180 afterwards be cleared and re-registered.
4181 * `minetest.clear_registered_decorations()`
4182 * Clears all decorations currently registered.
4183 * `minetest.clear_registered_ores()`
4184 * Clears all ores currently registered.
4185 * `minetest.clear_registered_schematics()`
4186 * Clears all schematics currently registered.
4190 * `minetest.register_craft(recipe)`
4191 * Check recipe table syntax for different types below.
4192 * `minetest.clear_craft(recipe)`
4193 * Will erase existing craft based either on output item or on input recipe.
4194 * Specify either output or input only. If you specify both, input will be
4195 ignored. For input use the same recipe table syntax as for
4196 `minetest.register_craft(recipe)`. For output specify only the item,
4198 * Returns false if no erase candidate could be found, otherwise returns true.
4199 * **Warning**! The type field ("shaped", "cooking" or any other) will be
4200 ignored if the recipe contains output. Erasing is then done independently
4201 from the crafting method.
4202 * `minetest.register_chatcommand(cmd, chatcommand definition)`
4203 * `minetest.override_chatcommand(name, redefinition)`
4204 * Overrides fields of a chatcommand registered with `register_chatcommand`.
4205 * `minetest.unregister_chatcommand(name)`
4206 * Unregisters a chatcommands registered with `register_chatcommand`.
4207 * `minetest.register_privilege(name, definition)`
4208 * `definition` can be a description or a definition table (see [Privilege
4210 * If it is a description, the priv will be granted to singleplayer and admin
4212 * To allow players with `basic_privs` to grant, see the `basic_privs`
4213 minetest.conf setting.
4214 * `minetest.register_authentication_handler(authentication handler definition)`
4215 * Registers an auth handler that overrides the builtin one.
4216 * This function can be called by a single mod once only.
4218 Global callback registration functions
4219 --------------------------------------
4221 Call these functions only at load time!
4223 * `minetest.register_globalstep(function(dtime))`
4224 * Called every server step, usually interval of 0.1s
4225 * `minetest.register_on_mods_loaded(function())`
4226 * Called after mods have finished loading and before the media is cached or the
4228 * `minetest.register_on_shutdown(function())`
4229 * Called before server shutdown
4230 * **Warning**: If the server terminates abnormally (i.e. crashes), the
4231 registered callbacks **will likely not be run**. Data should be saved at
4232 semi-frequent intervals as well as on server shutdown.
4233 * `minetest.register_on_placenode(function(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
4234 * Called when a node has been placed
4235 * If return `true` no item is taken from `itemstack`
4236 * `placer` may be any valid ObjectRef or nil.
4237 * **Not recommended**; use `on_construct` or `after_place_node` in node
4238 definition whenever possible.
4239 * `minetest.register_on_dignode(function(pos, oldnode, digger))`
4240 * Called when a node has been dug.
4241 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node
4242 definition whenever possible.
4243 * `minetest.register_on_punchnode(function(pos, node, puncher, pointed_thing))`
4244 * Called when a node is punched
4245 * `minetest.register_on_generated(function(minp, maxp, blockseed))`
4246 * Called after generating a piece of world. Modifying nodes inside the area
4247 is a bit faster than usually.
4248 * `minetest.register_on_newplayer(function(ObjectRef))`
4249 * Called after a new player has been created
4250 * `minetest.register_on_punchplayer(function(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
4251 * Called when a player is punched
4252 * Note: This callback is invoked even if the punched player is dead.
4253 * `player`: ObjectRef - Player that was punched
4254 * `hitter`: ObjectRef - Player that hit
4255 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4257 * `tool_capabilities`: Capability table of used tool (can be nil)
4258 * `dir`: Unit vector of direction of punch. Always defined. Points from
4259 the puncher to the punched.
4260 * `damage`: Number that represents the damage calculated by the engine
4261 * should return `true` to prevent the default damage mechanism
4262 * `minetest.register_on_player_hpchange(function(player, hp_change, reason), modifier)`
4263 * Called when the player gets damaged or healed
4264 * `player`: ObjectRef of the player
4265 * `hp_change`: the amount of change. Negative when it is damage.
4266 * `reason`: a PlayerHPChangeReason table.
4267 * The `type` field will have one of the following values:
4268 * `set_hp`: A mod or the engine called `set_hp` without
4269 giving a type - use this for custom damage types.
4270 * `punch`: Was punched. `reason.object` will hold the puncher, or nil if none.
4272 * `node_damage`: `damage_per_second` from a neighbouring node.
4273 `reason.node` will hold the node name or nil.
4276 * Any of the above types may have additional fields from mods.
4277 * `reason.from` will be `mod` or `engine`.
4278 * `modifier`: when true, the function should return the actual `hp_change`.
4279 Note: modifiers only get a temporary `hp_change` that can be modified by later modifiers.
4280 Modifiers can return true as a second argument to stop the execution of further functions.
4281 Non-modifiers receive the final HP change calculated by the modifiers.
4282 * `minetest.register_on_dieplayer(function(ObjectRef, reason))`
4283 * Called when a player dies
4284 * `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
4285 * `minetest.register_on_respawnplayer(function(ObjectRef))`
4286 * Called when player is to be respawned
4287 * Called _before_ repositioning of player occurs
4288 * return true in func to disable regular player placement
4289 * `minetest.register_on_prejoinplayer(function(name, ip))`
4290 * Called before a player joins the game
4291 * If it returns a string, the player is disconnected with that string as
4293 * `minetest.register_on_joinplayer(function(ObjectRef))`
4294 * Called when a player joins the game
4295 * `minetest.register_on_leaveplayer(function(ObjectRef, timed_out))`
4296 * Called when a player leaves the game
4297 * `timed_out`: True for timeout, false for other reasons.
4298 * `minetest.register_on_auth_fail(function(name, ip))`
4299 * Called when a client attempts to log into an account but supplies the
4301 * `ip`: The IP address of the client.
4302 * `name`: The account the client attempted to log into.
4303 * `minetest.register_on_cheat(function(ObjectRef, cheat))`
4304 * Called when a player cheats
4305 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
4307 * `interacted_too_far`
4308 * `interacted_while_dead`
4309 * `finished_unknown_dig`
4312 * `minetest.register_on_chat_message(function(name, message))`
4313 * Called always when a player says something
4314 * Return `true` to mark the message as handled, which means that it will
4315 not be sent to other players.
4316 * `minetest.register_on_player_receive_fields(function(player, formname, fields))`
4317 * Called when the server received input from `player` in a formspec with
4318 the given `formname`. Specifically, this is called on any of the
4320 * a button was pressed,
4321 * Enter was pressed while the focus was on a text field
4322 * a checkbox was toggled,
4323 * something was selecteed in a drop-down list,
4324 * a different tab was selected,
4325 * selection was changed in a textlist or table,
4326 * an entry was double-clicked in a textlist or table,
4327 * a scrollbar was moved, or
4328 * the form was actively closed by the player.
4329 * Fields are sent for formspec elements which define a field. `fields`
4330 is a table containing each formspecs element value (as string), with
4331 the `name` parameter as index for each. The value depends on the
4332 formspec element type:
4333 * `animated_image`: Returns the index of the current frame.
4334 * `button` and variants: If pressed, contains the user-facing button
4335 text as value. If not pressed, is `nil`
4336 * `field`, `textarea` and variants: Text in the field
4337 * `dropdown`: Text of selected item
4338 * `tabheader`: Tab index, starting with `"1"` (only if tab changed)
4339 * `checkbox`: `"true"` if checked, `"false"` if unchecked
4340 * `textlist`: See `minetest.explode_textlist_event`
4341 * `table`: See `minetest.explode_table_event`
4342 * `scrollbar`: See `minetest.explode_scrollbar_event`
4343 * Special case: `["quit"]="true"` is sent when the user actively
4344 closed the form by mouse click, keypress or through a button_exit[]
4346 * Special case: `["key_enter"]="true"` is sent when the user pressed
4347 the Enter key and the focus was either nowhere (causing the formspec
4348 to be closed) or on a button. If the focus was on a text field,
4349 additionally, the index `key_enter_field` contains the name of the
4350 text field. See also: `field_close_on_enter`.
4351 * Newest functions are called first
4352 * If function returns `true`, remaining functions are not called
4353 * `minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv))`
4354 * Called when `player` crafts something
4355 * `itemstack` is the output
4356 * `old_craft_grid` contains the recipe (Note: the one in the inventory is
4358 * `craft_inv` is the inventory with the crafting grid
4359 * Return either an `ItemStack`, to replace the output, or `nil`, to not
4361 * `minetest.register_craft_predict(function(itemstack, player, old_craft_grid, craft_inv))`
4362 * The same as before, except that it is called before the player crafts, to
4363 make craft prediction, and it should not change anything.
4364 * `minetest.register_allow_player_inventory_action(function(player, action, inventory, inventory_info))`
4365 * Determinates how much of a stack may be taken, put or moved to a
4367 * `player` (type `ObjectRef`) is the player who modified the inventory
4368 `inventory` (type `InvRef`).
4369 * List of possible `action` (string) values and their
4370 `inventory_info` (table) contents:
4371 * `move`: `{from_list=string, to_list=string, from_index=number, to_index=number, count=number}`
4372 * `put`: `{listname=string, index=number, stack=ItemStack}`
4373 * `take`: Same as `put`
4374 * Return a numeric value to limit the amount of items to be taken, put or
4375 moved. A value of `-1` for `take` will make the source stack infinite.
4376 * `minetest.register_on_player_inventory_action(function(player, action, inventory, inventory_info))`
4377 * Called after a take, put or move event from/to/in a player inventory
4378 * Function arguments: see `minetest.register_allow_player_inventory_action`
4379 * Does not accept or handle any return value.
4380 * `minetest.register_on_protection_violation(function(pos, name))`
4381 * Called by `builtin` and mods when a player violates protection at a
4382 position (eg, digs a node or punches a protected entity).
4383 * The registered functions can be called using
4384 `minetest.record_protection_violation`.
4385 * The provided function should check that the position is protected by the
4386 mod calling this function before it prints a message, if it does, to
4387 allow for multiple protection mods.
4388 * `minetest.register_on_item_eat(function(hp_change, replace_with_item, itemstack, user, pointed_thing))`
4389 * Called when an item is eaten, by `minetest.item_eat`
4390 * Return `itemstack` to cancel the default item eat response (i.e.: hp increase).
4391 * `minetest.register_on_priv_grant(function(name, granter, priv))`
4392 * Called when `granter` grants the priv `priv` to `name`.
4393 * Note that the callback will be called twice if it's done by a player,
4394 once with granter being the player name, and again with granter being nil.
4395 * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
4396 * Called when `revoker` revokes the priv `priv` from `name`.
4397 * Note that the callback will be called twice if it's done by a player,
4398 once with revoker being the player name, and again with revoker being nil.
4399 * `minetest.register_can_bypass_userlimit(function(name, ip))`
4400 * Called when `name` user connects with `ip`.
4401 * Return `true` to by pass the player limit
4402 * `minetest.register_on_modchannel_message(function(channel_name, sender, message))`
4403 * Called when an incoming mod channel message is received
4404 * You should have joined some channels to receive events.
4405 * If message comes from a server mod, `sender` field is an empty string.
4410 * `minetest.settings`: Settings object containing all of the settings from the
4411 main config file (`minetest.conf`).
4412 * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
4413 parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
4418 * `minetest.string_to_privs(str[, delim])`:
4419 * Converts string representation of privs into table form
4420 * `delim`: String separating the privs. Defaults to `","`.
4421 * Returns `{ priv1 = true, ... }`
4422 * `minetest.privs_to_string(privs[, delim])`:
4423 * Returns the string representation of `privs`
4424 * `delim`: String to delimit privs. Defaults to `","`.
4425 * `minetest.get_player_privs(name) -> {priv1=true,...}`
4426 * `minetest.check_player_privs(player_or_name, ...)`:
4427 returns `bool, missing_privs`
4428 * A quickhand for checking privileges.
4429 * `player_or_name`: Either a Player object or the name of a player.
4430 * `...` is either a list of strings, e.g. `"priva", "privb"` or
4431 a table, e.g. `{ priva = true, privb = true }`.
4433 * `minetest.check_password_entry(name, entry, password)`
4434 * Returns true if the "password entry" for a player with name matches given
4435 password, false otherwise.
4436 * The "password entry" is the password representation generated by the
4437 engine as returned as part of a `get_auth()` call on the auth handler.
4438 * Only use this function for making it possible to log in via password from
4439 external protocols such as IRC, other uses are frowned upon.
4440 * `minetest.get_password_hash(name, raw_password)`
4441 * Convert a name-password pair to a password hash that Minetest can use.
4442 * The returned value alone is not a good basis for password checks based
4443 on comparing the password hash in the database with the password hash
4444 from the function, with an externally provided password, as the hash
4445 in the db might use the new SRP verifier format.
4446 * For this purpose, use `minetest.check_password_entry` instead.
4447 * `minetest.get_player_ip(name)`: returns an IP address string for the player
4449 * The player needs to be online for this to be successful.
4451 * `minetest.get_auth_handler()`: Return the currently active auth handler
4452 * See the [Authentication handler definition]
4453 * Use this to e.g. get the authentication data for a player:
4454 `local auth_data = minetest.get_auth_handler().get_auth(playername)`
4455 * `minetest.notify_authentication_modified(name)`
4456 * Must be called by the authentication handler for privilege changes.
4457 * `name`: string; if omitted, all auth data should be considered modified
4458 * `minetest.set_player_password(name, password_hash)`: Set password hash of
4460 * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player
4462 * `minetest.auth_reload()`
4463 * See `reload()` in authentication handler definition
4465 `minetest.set_player_password`, `minetest.set_player_privs`,
4466 `minetest.get_player_privs` and `minetest.auth_reload` call the authentication
4472 * `minetest.chat_send_all(text)`
4473 * `minetest.chat_send_player(name, text)`
4474 * `minetest.format_chat_message(name, message)`
4475 * Used by the server to format a chat message, based on the setting `chat_message_format`.
4476 Refer to the documentation of the setting for a list of valid placeholders.
4477 * Takes player name and message, and returns the formatted string to be sent to players.
4478 * Can be redefined by mods if required, for things like colored names or messages.
4479 * **Only** the first occurrence of each placeholder will be replaced.
4484 * `minetest.set_node(pos, node)`
4485 * `minetest.add_node(pos, node)`: alias to `minetest.set_node`
4486 * Set node at position `pos`
4487 * `node`: table `{name=string, param1=number, param2=number}`
4488 * If param1 or param2 is omitted, it's set to `0`.
4489 * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
4490 * `minetest.bulk_set_node({pos1, pos2, pos3, ...}, node)`
4491 * Set node on all positions set in the first argument.
4492 * e.g. `minetest.bulk_set_node({{x=0, y=1, z=1}, {x=1, y=2, z=2}}, {name="default:stone"})`
4493 * For node specification or position syntax see `minetest.set_node` call
4494 * Faster than set_node due to single call, but still considerably slower
4495 than Lua Voxel Manipulators (LVM) for large numbers of nodes.
4496 Unlike LVMs, this will call node callbacks. It also allows setting nodes
4497 in spread out positions which would cause LVMs to waste memory.
4498 For setting a cube, this is 1.3x faster than set_node whereas LVM is 20
4500 * `minetest.swap_node(pos, node)`
4501 * Set node at position, but don't remove metadata
4502 * `minetest.remove_node(pos)`
4503 * By default it does the same as `minetest.set_node(pos, {name="air"})`
4504 * `minetest.get_node(pos)`
4505 * Returns the node at the given position as table in the format
4506 `{name="node_name", param1=0, param2=0}`,
4507 returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
4508 * `minetest.get_node_or_nil(pos)`
4509 * Same as `get_node` but returns `nil` for unloaded areas.
4510 * `minetest.get_node_light(pos, timeofday)`
4511 * Gets the light value at the given position. Note that the light value
4512 "inside" the node at the given position is returned, so you usually want
4513 to get the light value of a neighbor.
4514 * `pos`: The position where to measure the light.
4515 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
4516 * Returns a number between `0` and `15` or `nil`
4517 * `minetest.place_node(pos, node)`
4518 * Place node with the same effects that a player would cause
4519 * `minetest.dig_node(pos)`
4520 * Dig node with the same effects that a player would cause
4521 * Returns `true` if successful, `false` on failure (e.g. protected location)
4522 * `minetest.punch_node(pos)`
4523 * Punch node with the same effects that a player would cause
4524 * `minetest.spawn_falling_node(pos)`
4525 * Change node into falling node
4526 * Returns `true` if successful, `false` on failure
4528 * `minetest.find_nodes_with_meta(pos1, pos2)`
4529 * Get a table of positions of nodes that have metadata within a region
4531 * `minetest.get_meta(pos)`
4532 * Get a `NodeMetaRef` at that position
4533 * `minetest.get_node_timer(pos)`
4534 * Get `NodeTimerRef`
4536 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at
4538 * Returns `ObjectRef`, or `nil` if failed
4539 * `minetest.add_item(pos, item)`: Spawn item
4540 * Returns `ObjectRef`, or `nil` if failed
4541 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
4542 * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of
4544 * `radius`: using an euclidean metric
4545 * `minetest.set_timeofday(val)`
4546 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
4547 * `minetest.get_timeofday()`
4548 * `minetest.get_gametime()`: returns the time, in seconds, since the world was
4550 * `minetest.get_day_count()`: returns number days elapsed since world was
4552 * accounts for time changes.
4553 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns
4555 * `radius`: using a maximum metric
4556 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4557 * `search_center` is an optional boolean (default: `false`)
4558 If true `pos` is also checked for the nodes
4559 * `minetest.find_nodes_in_area(pos1, pos2, nodenames)`: returns a list of
4561 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4562 * First return value: Table with all node positions
4563 * Second return value: Table with the count of each node with the node name
4565 * Area volume is limited to 4,096,000 nodes
4566 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
4568 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4569 * Return value: Table with all node positions with a node air above
4570 * Area volume is limited to 4,096,000 nodes
4571 * `minetest.get_perlin(noiseparams)`
4572 * `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
4573 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
4574 * `minetest.get_voxel_manip([pos1, pos2])`
4575 * Return voxel manipulator object.
4576 * Loads the manipulator from the map if positions are passed.
4577 * `minetest.set_gen_notify(flags, {deco_ids})`
4578 * Set the types of on-generate notifications that should be collected.
4579 * `flags` is a flag field with the available flags:
4587 * The second parameter is a list of IDs of decorations which notification
4589 * `minetest.get_gen_notify()`
4590 * Returns a flagstring and a table with the `deco_id`s.
4591 * `minetest.get_decoration_id(decoration_name)`
4592 * Returns the decoration ID number for the provided decoration name string,
4593 or `nil` on failure.
4594 * `minetest.get_mapgen_object(objectname)`
4595 * Return requested mapgen object if available (see [Mapgen objects])
4596 * `minetest.get_heat(pos)`
4597 * Returns the heat at the position, or `nil` on failure.
4598 * `minetest.get_humidity(pos)`
4599 * Returns the humidity at the position, or `nil` on failure.
4600 * `minetest.get_biome_data(pos)`
4601 * Returns a table containing:
4602 * `biome` the biome id of the biome at that position
4603 * `heat` the heat at the position
4604 * `humidity` the humidity at the position
4605 * Or returns `nil` on failure.
4606 * `minetest.get_biome_id(biome_name)`
4607 * Returns the biome id, as used in the biomemap Mapgen object and returned
4608 by `minetest.get_biome_data(pos)`, for a given biome_name string.
4609 * `minetest.get_biome_name(biome_id)`
4610 * Returns the biome name string for the provided biome id, or `nil` on
4612 * If no biomes have been registered, such as in mgv6, returns `default`.
4613 * `minetest.get_mapgen_params()`
4614 * Deprecated: use `minetest.get_mapgen_setting(name)` instead.
4615 * Returns a table containing:
4621 * `minetest.set_mapgen_params(MapgenParams)`
4622 * Deprecated: use `minetest.set_mapgen_setting(name, value, override)`
4624 * Set map generation parameters.
4625 * Function cannot be called after the registration period; only
4626 initialization and `on_mapgen_init`.
4627 * Takes a table as an argument with the fields:
4633 * Leave field unset to leave that parameter unchanged.
4634 * `flags` contains a comma-delimited string of flags to set, or if the
4635 prefix `"no"` is attached, clears instead.
4636 * `flags` is in the same format and has the same options as `mg_flags` in
4638 * `minetest.get_mapgen_setting(name)`
4639 * Gets the *active* mapgen setting (or nil if none exists) in string
4640 format with the following order of precedence:
4641 1) Settings loaded from map_meta.txt or overrides set during mod
4643 2) Settings set by mods without a metafile override
4644 3) Settings explicitly set in the user config file, minetest.conf
4645 4) Settings set as the user config default
4646 * `minetest.get_mapgen_setting_noiseparams(name)`
4647 * Same as above, but returns the value as a NoiseParams table if the
4648 setting `name` exists and is a valid NoiseParams.
4649 * `minetest.set_mapgen_setting(name, value, [override_meta])`
4650 * Sets a mapgen param to `value`, and will take effect if the corresponding
4651 mapgen setting is not already present in map_meta.txt.
4652 * `override_meta` is an optional boolean (default: `false`). If this is set
4653 to true, the setting will become the active setting regardless of the map
4655 * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`.
4656 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
4657 * Same as above, except value is a NoiseParams table.
4658 * `minetest.set_noiseparams(name, noiseparams, set_default)`
4659 * Sets the noiseparams setting of `name` to the noiseparams table specified
4661 * `set_default` is an optional boolean (default: `true`) that specifies
4662 whether the setting should be applied to the default config or current
4664 * `minetest.get_noiseparams(name)`
4665 * Returns a table of the noiseparams for name.
4666 * `minetest.generate_ores(vm, pos1, pos2)`
4667 * Generate all registered ores within the VoxelManip `vm` and in the area
4668 from `pos1` to `pos2`.
4669 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
4670 * `minetest.generate_decorations(vm, pos1, pos2)`
4671 * Generate all registered decorations within the VoxelManip `vm` and in the
4672 area from `pos1` to `pos2`.
4673 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
4674 * `minetest.clear_objects([options])`
4675 * Clear all objects in the environment
4676 * Takes an optional table as an argument with the field `mode`.
4677 * mode = `"full"` : Load and go through every mapblock, clearing
4679 * mode = `"quick"`: Clear objects immediately in loaded mapblocks,
4680 clear objects in unloaded mapblocks only when the
4681 mapblocks are next activated.
4682 * `minetest.load_area(pos1[, pos2])`
4683 * Load the mapblocks containing the area from `pos1` to `pos2`.
4684 `pos2` defaults to `pos1` if not specified.
4685 * This function does not trigger map generation.
4686 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
4687 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be
4688 asynchronously fetched from memory, loaded from disk, or if inexistent,
4690 * If `callback` is a valid Lua function, this will be called for each block
4692 * The function signature of callback is:
4693 `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
4694 * `blockpos` is the *block* coordinates of the block that had been
4696 * `action` could be one of the following constant values:
4697 * `minetest.EMERGE_CANCELLED`
4698 * `minetest.EMERGE_ERRORED`
4699 * `minetest.EMERGE_FROM_MEMORY`
4700 * `minetest.EMERGE_FROM_DISK`
4701 * `minetest.EMERGE_GENERATED`
4702 * `calls_remaining` is the number of callbacks to be expected after
4704 * `param` is the user-defined parameter passed to emerge_area (or
4705 nil if the parameter was absent).
4706 * `minetest.delete_area(pos1, pos2)`
4707 * delete all mapblocks in the area from pos1 to pos2, inclusive
4708 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
4709 * Checks if there is anything other than air between pos1 and pos2.
4710 * Returns false if something is blocking the sight.
4711 * Returns the position of the blocking node when `false`
4712 * `pos1`: First position
4713 * `pos2`: Second position
4714 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
4715 * Creates a `Raycast` object.
4716 * `pos1`: start of the ray
4717 * `pos2`: end of the ray
4718 * `objects`: if false, only nodes will be returned. Default is `true`.
4719 * `liquids`: if false, liquid nodes won't be returned. Default is `false`.
4720 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
4721 * returns table containing path that can be walked on
4722 * returns a table of 3D points representing a path from `pos1` to `pos2` or
4724 * Reasons for failure:
4725 * No path exists at all
4726 * No path exists within `searchdistance` (see below)
4727 * Start or end pos is buried in land
4728 * `pos1`: start position
4729 * `pos2`: end position
4730 * `searchdistance`: maximum distance from the search positions to search in.
4731 In detail: Path must be completely inside a cuboid. The minimum
4732 `searchdistance` of 1 will confine search between `pos1` and `pos2`.
4733 Larger values will increase the size of this cuboid in all directions
4734 * `max_jump`: maximum height difference to consider walkable
4735 * `max_drop`: maximum height difference to consider droppable
4736 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`.
4737 Difference between `"A*"` and `"A*_noprefetch"` is that
4738 `"A*"` will pre-calculate the cost-data, the other will calculate it
4740 * `minetest.spawn_tree (pos, {treedef})`
4741 * spawns L-system tree at given `pos` with definition in `treedef` table
4742 * `minetest.transforming_liquid_add(pos)`
4743 * add node to liquid update queue
4744 * `minetest.get_node_max_level(pos)`
4745 * get max available level for leveled node
4746 * `minetest.get_node_level(pos)`
4747 * get level of leveled node (water, snow)
4748 * `minetest.set_node_level(pos, level)`
4749 * set level of leveled node, default `level` equals `1`
4750 * if `totallevel > maxlevel`, returns rest (`total-max`).
4751 * `minetest.add_node_level(pos, level)`
4752 * increase level of leveled node by level, default `level` equals `1`
4753 * if `totallevel > maxlevel`, returns rest (`total-max`)
4754 * can be negative for decreasing
4755 * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
4756 * resets the light in a cuboid-shaped part of
4757 the map and removes lighting bugs.
4758 * Loads the area if it is not loaded.
4759 * `pos1` is the corner of the cuboid with the least coordinates
4760 (in node coordinates), inclusive.
4761 * `pos2` is the opposite corner of the cuboid, inclusive.
4762 * The actual updated cuboid might be larger than the specified one,
4763 because only whole map blocks can be updated.
4764 The actual updated area consists of those map blocks that intersect
4765 with the given cuboid.
4766 * However, the neighborhood of the updated area might change
4767 as well, as light can spread out of the cuboid, also light
4769 * returns `false` if the area is not fully generated,
4771 * `minetest.check_single_for_falling(pos)`
4772 * causes an unsupported `group:falling_node` node to fall and causes an
4773 unattached `group:attached_node` node to fall.
4774 * does not spread these updates to neighbours.
4775 * `minetest.check_for_falling(pos)`
4776 * causes an unsupported `group:falling_node` node to fall and causes an
4777 unattached `group:attached_node` node to fall.
4778 * spread these updates to neighbours and can cause a cascade
4780 * `minetest.get_spawn_level(x, z)`
4781 * Returns a player spawn y co-ordinate for the provided (x, z)
4782 co-ordinates, or `nil` for an unsuitable spawn point.
4783 * For most mapgens a 'suitable spawn point' is one with y between
4784 `water_level` and `water_level + 16`, and in mgv7 well away from rivers,
4785 so `nil` will be returned for many (x, z) co-ordinates.
4786 * The spawn level returned is for a player spawn in unmodified terrain.
4787 * The spawn level is intentionally above terrain level to cope with
4788 full-node biome 'dust' nodes.
4793 You can find mod channels communication scheme in `doc/mod_channels.png`.
4795 * `minetest.mod_channel_join(channel_name)`
4796 * Server joins channel `channel_name`, and creates it if necessary. You
4797 should listen for incoming messages with
4798 `minetest.register_on_modchannel_message`
4803 `minetest.get_inventory(location)`: returns an `InvRef`
4806 * `{type="player", name="celeron55"}`
4807 * `{type="node", pos={x=, y=, z=}}`
4808 * `{type="detached", name="creative"}`
4809 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns
4811 * `callbacks`: See [Detached inventory callbacks]
4812 * `player_name`: Make detached inventory available to one player
4813 exclusively, by default they will be sent to every player (even if not
4815 Note that this parameter is mostly just a workaround and will be removed
4817 * Creates a detached inventory. If it already exists, it is cleared.
4818 * `minetest.remove_detached_inventory(name)`
4819 * Returns a `boolean` indicating whether the removal succeeded.
4820 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
4821 returns left over ItemStack.
4822 * See `minetest.item_eat` and `minetest.register_on_item_eat`
4827 * `minetest.show_formspec(playername, formname, formspec)`
4828 * `playername`: name of player to show formspec
4829 * `formname`: name passed to `on_player_receive_fields` callbacks.
4830 It should follow the `"modname:<whatever>"` naming convention
4831 * `formspec`: formspec to display
4832 * `minetest.close_formspec(playername, formname)`
4833 * `playername`: name of player to close formspec
4834 * `formname`: has to exactly match the one given in `show_formspec`, or the
4835 formspec will not close.
4836 * calling `show_formspec(playername, formname, "")` is equal to this
4838 * to close a formspec regardless of the formname, call
4839 `minetest.close_formspec(playername, "")`.
4840 **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
4841 * `minetest.formspec_escape(string)`: returns a string
4842 * escapes the characters "[", "]", "\", "," and ";", which can not be used
4844 * `minetest.explode_table_event(string)`: returns a table
4845 * returns e.g. `{type="CHG", row=1, column=2}`
4847 * `"INV"`: no row selected
4849 * `"DCL"`: double-click
4850 * `minetest.explode_textlist_event(string)`: returns a table
4851 * returns e.g. `{type="CHG", index=1}`
4853 * `"INV"`: no row selected
4855 * `"DCL"`: double-click
4856 * `minetest.explode_scrollbar_event(string)`: returns a table
4857 * returns e.g. `{type="CHG", value=500}`
4859 * `"INV"`: something failed
4860 * `"CHG"`: has been changed
4861 * `"VAL"`: not changed
4866 * `minetest.inventorycube(img1, img2, img3)`
4867 * Returns a string for making an image of a cube (useful as an item image)
4868 * `minetest.get_pointed_thing_position(pointed_thing, above)`
4869 * Returns the position of a `pointed_thing` or `nil` if the `pointed_thing`
4870 does not refer to a node or entity.
4871 * If the optional `above` parameter is true and the `pointed_thing` refers
4872 to a node, then it will return the `above` position of the `pointed_thing`.
4873 * `minetest.dir_to_facedir(dir, is6d)`
4874 * Convert a vector to a facedir value, used in `param2` for
4875 `paramtype2="facedir"`.
4876 * passing something non-`nil`/`false` for the optional second parameter
4877 causes it to take the y component into account.
4878 * `minetest.facedir_to_dir(facedir)`
4879 * Convert a facedir back into a vector aimed directly out the "back" of a
4881 * `minetest.dir_to_wallmounted(dir)`
4882 * Convert a vector to a wallmounted value, used for
4883 `paramtype2="wallmounted"`.
4884 * `minetest.wallmounted_to_dir(wallmounted)`
4885 * Convert a wallmounted value back into a vector aimed directly out the
4887 * `minetest.dir_to_yaw(dir)`
4888 * Convert a vector into a yaw (angle)
4889 * `minetest.yaw_to_dir(yaw)`
4890 * Convert yaw (angle) to a vector
4891 * `minetest.is_colored_paramtype(ptype)`
4892 * Returns a boolean. Returns `true` if the given `paramtype2` contains
4893 color information (`color`, `colorwallmounted` or `colorfacedir`).
4894 * `minetest.strip_param2_color(param2, paramtype2)`
4895 * Removes everything but the color information from the
4896 given `param2` value.
4897 * Returns `nil` if the given `paramtype2` does not contain color
4899 * `minetest.get_node_drops(node, toolname)`
4900 * Returns list of itemstrings that are dropped by `node` when dug
4902 * `node`: node as table or node name
4903 * `toolname`: name of the tool item (can be `nil`)
4904 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
4905 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
4906 * `input.width` = for example `3`
4907 * `input.items` = for example
4908 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
4909 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
4910 * `output.time` = a number, if unsuccessful: `0`
4911 * `output.replacements` = List of replacement `ItemStack`s that couldn't be
4912 placed in `decremented_input.items`. Replacements can be placed in
4913 `decremented_input` if the stack of the replaced item has a count of 1.
4914 * `decremented_input` = like `input`
4915 * `minetest.get_craft_recipe(output)`: returns input
4916 * returns last registered recipe for output item (node)
4917 * `output` is a node or item type such as `"default:torch"`
4918 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
4919 * `input.width` = for example `3`
4920 * `input.items` = for example
4921 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
4922 * `input.items` = `nil` if no recipe found
4923 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
4924 * returns indexed table with all registered recipes for query item (node)
4925 or `nil` if no recipe was found.
4926 * recipe entry table:
4927 * `method`: 'normal' or 'cooking' or 'fuel'
4928 * `width`: 0-3, 0 means shapeless recipe
4929 * `items`: indexed [1-9] table with recipe items
4930 * `output`: string with item name and quantity
4931 * Example query for `"default:gold_ingot"` will return table:
4934 [1]={method = "cooking", width = 3, output = "default:gold_ingot",
4935 items = {1 = "default:gold_lump"}},
4936 [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
4937 items = {1 = "default:goldblock"}}
4939 * `minetest.handle_node_drops(pos, drops, digger)`
4940 * `drops`: list of itemstrings
4941 * Handles drops from nodes after digging: Default action is to put them
4942 into digger's inventory.
4943 * Can be overridden to get different functionality (e.g. dropping items on
4945 * `minetest.itemstring_with_palette(item, palette_index)`: returns an item
4947 * Creates an item string which contains palette index information
4948 for hardware colorization. You can use the returned string
4949 as an output in a craft recipe.
4950 * `item`: the item stack which becomes colored. Can be in string,
4951 table and native form.
4952 * `palette_index`: this index is added to the item stack
4953 * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
4954 * Creates an item string which contains static color information
4955 for hardware colorization. Use this method if you wish to colorize
4956 an item that does not own a palette. You can use the returned string
4957 as an output in a craft recipe.
4958 * `item`: the item stack which becomes colored. Can be in string,
4959 table and native form.
4960 * `colorstring`: the new color of the item stack
4965 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
4966 returns `{{actor, pos, time, oldnode, newnode}, ...}`
4967 * Find who has done something to a node, or near a node
4968 * `actor`: `"player:<name>"`, also `"liquid"`.
4969 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns
4970 `boolean, log_messages`.
4971 * Revert latest actions of someone
4972 * `actor`: `"player:<name>"`, also `"liquid"`.
4974 Defaults for the `on_place` and `on_drop` item definition functions
4975 -------------------------------------------------------------------
4977 * `minetest.item_place_node(itemstack, placer, pointed_thing[, param2, prevent_after_place])`
4978 * Place item as a node
4979 * `param2` overrides `facedir` and wallmounted `param2`
4980 * `prevent_after_place`: if set to `true`, `after_place_node` is not called
4981 for the newly placed node to prevent a callback and placement loop
4982 * returns `itemstack, position`
4983 * `position`: the location the node was placed to. `nil` if nothing was placed.
4984 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
4986 * returns the leftover itemstack
4987 * **Note**: This function is deprecated and will never be called.
4988 * `minetest.item_place(itemstack, placer, pointed_thing[, param2])`
4989 * Wrapper that calls `minetest.item_place_node` if appropriate
4990 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
4991 * **Note**: is not called when wielded item overrides `on_place`
4992 * `param2` overrides facedir and wallmounted `param2`
4993 * returns `itemstack, position`
4994 * `position`: the location the node was placed to. `nil` if nothing was placed.
4995 * `minetest.item_drop(itemstack, dropper, pos)`
4997 * returns the leftover itemstack
4998 * `minetest.item_eat(hp_change[, replace_with_item])`
4999 * Returns `function(itemstack, user, pointed_thing)` as a
5000 function wrapper for `minetest.do_item_eat`.
5001 * `replace_with_item` is the itemstring which is added to the inventory.
5002 If the player is eating a stack, then replace_with_item goes to a
5005 Defaults for the `on_punch` and `on_dig` node definition callbacks
5006 ------------------------------------------------------------------
5008 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
5009 * Calls functions registered by `minetest.register_on_punchnode()`
5010 * `minetest.node_dig(pos, node, digger)`
5011 * Checks if node can be dug, puts item into inventory, removes node
5012 * Calls functions registered by `minetest.registered_on_dignodes()`
5017 * `minetest.sound_play(spec, parameters, [ephemeral])`: returns a handle
5018 * `spec` is a `SimpleSoundSpec`
5019 * `parameters` is a sound parameter table
5020 * `ephemeral` is a boolean (default: false)
5021 Ephemeral sounds will not return a handle and can't be stopped or faded.
5022 It is recommend to use this for short sounds that happen in response to
5023 player actions (e.g. door closing).
5024 * `minetest.sound_stop(handle)`
5025 * `handle` is a handle returned by `minetest.sound_play`
5026 * `minetest.sound_fade(handle, step, gain)`
5027 * `handle` is a handle returned by `minetest.sound_play`
5028 * `step` determines how fast a sound will fade.
5029 Negative step will lower the sound volume, positive step will increase
5031 * `gain` the target gain for the fade.
5036 * `minetest.after(time, func, ...)`
5037 * Call the function `func` after `time` seconds, may be fractional
5038 * Optional: Variable number of arguments that are passed to `func`
5043 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for
5044 server shutdown. Will display `message` to clients.
5045 * `reconnect` == true displays a reconnect button
5046 * `delay` adds an optional delay (in seconds) before shutdown.
5047 Negative delay cancels the current active shutdown.
5048 Zero delay triggers an immediate shutdown.
5049 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
5050 * `minetest.get_server_status(name, joined)`
5051 * Returns the server status string when a player joins or when the command
5052 `/status` is called. Returns `nil` or an empty string when the message is
5054 * `joined`: Boolean value, indicates whether the function was called when
5056 * This function may be overwritten by mods to customize the status message.
5057 * `minetest.get_server_uptime()`: returns the server uptime in seconds
5058 * `minetest.remove_player(name)`: remove player from database (if they are not
5060 * As auth data is not removed, minetest.player_exists will continue to
5061 return true. Call the below method as well if you want to remove auth
5063 * Returns a code (0: successful, 1: no such player, 2: player is connected)
5064 * `minetest.remove_player_auth(name)`: remove player authentication data
5065 * Returns boolean indicating success (false if player nonexistant)
5070 * `minetest.get_ban_list()`: returns a list of all bans formatted as string
5071 * `minetest.get_ban_description(ip_or_name)`: returns list of bans matching
5072 IP address or name formatted as string
5073 * `minetest.ban_player(name)`: ban the IP of a currently connected player
5074 * Returns boolean indicating success
5075 * `minetest.unban_player_or_ip(ip_or_name)`: remove ban record matching
5077 * `minetest.kick_player(name, [reason])`: disconnect a player with an optional
5079 * Returns boolean indicating success (false if player nonexistant)
5084 * `minetest.add_particle(particle definition)`
5085 * Deprecated: `minetest.add_particle(pos, velocity, acceleration,
5086 expirationtime, size, collisiondetection, texture, playername)`
5088 * `minetest.add_particlespawner(particlespawner definition)`
5089 * Add a `ParticleSpawner`, an object that spawns an amount of particles
5090 over `time` seconds.
5091 * Returns an `id`, and -1 if adding didn't succeed
5092 * Deprecated: `minetest.add_particlespawner(amount, time,
5096 minexptime, maxexptime,
5098 collisiondetection, texture, playername)`
5100 * `minetest.delete_particlespawner(id, player)`
5101 * Delete `ParticleSpawner` with `id` (return value from
5102 `minetest.add_particlespawner`).
5103 * If playername is specified, only deletes on the player's client,
5104 otherwise on all clients.
5109 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
5110 * Create a schematic from the volume of map specified by the box formed by
5112 * Apply the specified probability and per-node force-place to the specified
5113 nodes according to the `probability_list`.
5114 * `probability_list` is an array of tables containing two fields, `pos`
5116 * `pos` is the 3D vector specifying the absolute coordinates of the
5117 node being modified,
5118 * `prob` is an integer value from `0` to `255` that encodes
5119 probability and per-node force-place. Probability has levels
5120 0-127, then 128 may be added to encode per-node force-place.
5121 For probability stated as 0-255, divide by 2 and round down to
5122 get values 0-127, then add 128 to apply per-node force-place.
5123 * If there are two or more entries with the same pos value, the
5125 * If `pos` is not inside the box formed by `p1` and `p2`, it is
5127 * If `probability_list` equals `nil`, no probabilities are applied.
5128 * Apply the specified probability to the specified horizontal slices
5129 according to the `slice_prob_list`.
5130 * `slice_prob_list` is an array of tables containing two fields, `ypos`
5132 * `ypos` indicates the y position of the slice with a probability
5133 applied, the lowest slice being `ypos = 0`.
5134 * If slice probability list equals `nil`, no slice probabilities
5136 * Saves schematic in the Minetest Schematic format to filename.
5138 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement, flags)`
5139 * Place the schematic specified by schematic (see [Schematic specifier]) at
5141 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
5142 * If the `rotation` parameter is omitted, the schematic is not rotated.
5143 * `replacements` = `{["old_name"] = "convert_to", ...}`
5144 * `force_placement` is a boolean indicating whether nodes other than `air`
5145 and `ignore` are replaced by the schematic.
5146 * Returns nil if the schematic could not be loaded.
5147 * **Warning**: Once you have loaded a schematic from a file, it will be
5148 cached. Future calls will always use the cached version and the
5149 replacement list defined for it, regardless of whether the file or the
5150 replacement list parameter have changed. The only way to load the file
5151 anew is to restart the server.
5152 * `flags` is a flag field with the available flags:
5157 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement, flags)`:
5158 * This function is analogous to minetest.place_schematic, but places a
5159 schematic onto the specified VoxelManip object `vmanip` instead of the
5161 * Returns false if any part of the schematic was cut-off due to the
5162 VoxelManip not containing the full area required, and true if the whole
5163 schematic was able to fit.
5164 * Returns nil if the schematic could not be loaded.
5165 * After execution, any external copies of the VoxelManip contents are
5167 * `flags` is a flag field with the available flags:
5172 * `minetest.serialize_schematic(schematic, format, options)`
5173 * Return the serialized schematic specified by schematic
5174 (see [Schematic specifier])
5175 * in the `format` of either "mts" or "lua".
5176 * "mts" - a string containing the binary MTS data used in the MTS file
5178 * "lua" - a string containing Lua code representing the schematic in table
5180 * `options` is a table containing the following optional parameters:
5181 * If `lua_use_comments` is true and `format` is "lua", the Lua code
5182 generated will have (X, Z) position comments for every X row
5183 generated in the schematic data for easier reading.
5184 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua",
5185 the Lua code generated will use that number of spaces as indentation
5186 instead of a tab character.
5188 * `minetest.read_schematic(schematic, options)`
5189 * Returns a Lua table representing the schematic (see: [Schematic specifier])
5190 * `schematic` is the schematic to read (see: [Schematic specifier])
5191 * `options` is a table containing the following optional parameters:
5192 * `write_yslice_prob`: string value:
5193 * `none`: no `write_yslice_prob` table is inserted,
5194 * `low`: only probabilities that are not 254 or 255 are written in
5195 the `write_ylisce_prob` table,
5196 * `all`: write all probabilities to the `write_yslice_prob` table.
5197 * The default for this option is `all`.
5198 * Any invalid value will be interpreted as `all`.
5203 * `minetest.request_http_api()`:
5204 * returns `HTTPApiTable` containing http functions if the calling mod has
5205 been granted access by being listed in the `secure.http_mods` or
5206 `secure.trusted_mods` setting, otherwise returns `nil`.
5207 * The returned table contains the functions `fetch`, `fetch_async` and
5208 `fetch_async_get` described below.
5209 * Only works at init time and must be called from the mod's main scope
5210 (not from a function).
5211 * Function only exists if minetest server was built with cURL support.
5212 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
5214 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
5215 * Performs given request asynchronously and calls callback upon completion
5216 * callback: `function(HTTPRequestResult res)`
5217 * Use this HTTP function if you are unsure, the others are for advanced use
5218 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
5219 * Performs given request asynchronously and returns handle for
5220 `HTTPApiTable.fetch_async_get`
5221 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
5222 * Return response data for given asynchronous HTTP request
5227 * `minetest.get_mod_storage()`:
5228 * returns reference to mod private `StorageRef`
5229 * must be called during mod load time
5234 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
5235 * `minetest.is_player(obj)`: boolean, whether `obj` is a player
5236 * `minetest.player_exists(name)`: boolean, whether player exists
5237 (regardless of online status)
5238 * `minetest.hud_replace_builtin(name, hud_definition)`
5239 * Replaces definition of a builtin hud element
5240 * `name`: `"breath"` or `"health"`
5241 * `hud_definition`: definition to replace builtin definition
5242 * `minetest.send_join_message(player_name)`
5243 * This function can be overridden by mods to change the join message.
5244 * `minetest.send_leave_message(player_name, timed_out)`
5245 * This function can be overridden by mods to change the leave message.
5246 * `minetest.hash_node_position(pos)`: returns an 48-bit integer
5247 * `pos`: table {x=number, y=number, z=number},
5248 * Gives a unique hash number for a node position (16+16+16=48bit)
5249 * `minetest.get_position_from_hash(hash)`: returns a position
5250 * Inverse transform of `minetest.hash_node_position`
5251 * `minetest.get_item_group(name, group)`: returns a rating
5252 * Get rating of a group of an item. (`0` means: not in group)
5253 * `minetest.get_node_group(name, group)`: returns a rating
5254 * Deprecated: An alias for the former.
5255 * `minetest.raillike_group(name)`: returns a rating
5256 * Returns rating of the connect_to_raillike group corresponding to name
5257 * If name is not yet the name of a connect_to_raillike group, a new group
5258 id is created, with that name.
5259 * `minetest.get_content_id(name)`: returns an integer
5260 * Gets the internal content ID of `name`
5261 * `minetest.get_name_from_content_id(content_id)`: returns a string
5262 * Gets the name of the content with that content ID
5263 * `minetest.parse_json(string[, nullvalue])`: returns something
5264 * Convert a string containing JSON data into the Lua equivalent
5265 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
5266 * On success returns a table, a string, a number, a boolean or `nullvalue`
5267 * On failure outputs an error message and returns `nil`
5268 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
5269 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error
5271 * Convert a Lua table into a JSON string
5272 * styled: Outputs in a human-readable format if this is set, defaults to
5274 * Unserializable things like functions and userdata will cause an error.
5275 * **Warning**: JSON is more strict than the Lua table format.
5276 1. You can only use strings and positive integers of at least one as
5278 2. You can not mix string and integer keys.
5279 This is due to the fact that JSON has two distinct array and object
5281 * Example: `write_json({10, {a = false}})`,
5282 returns `"[10, {\"a\": false}]"`
5283 * `minetest.serialize(table)`: returns a string
5284 * Convert a table containing tables, strings, numbers, booleans and `nil`s
5285 into string form readable by `minetest.deserialize`
5286 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
5287 * `minetest.deserialize(string[, safe])`: returns a table
5288 * Convert a string returned by `minetest.serialize` into a table
5289 * `string` is loaded in an empty sandbox environment.
5290 * Will load functions if safe is false or omitted. Although these functions
5291 cannot directly access the global environment, they could bypass this
5292 restriction with maliciously crafted Lua bytecode if mod security is
5294 * This function should not be used on untrusted data, regardless of the
5295 value of `safe`. It is fine to serialize then deserialize user-provided
5296 data, but directly providing user input to deserialize is always unsafe.
5297 * Example: `deserialize('return { ["foo"] = "bar" }')`,
5298 returns `{foo='bar'}`
5299 * Example: `deserialize('print("foo")')`, returns `nil`
5300 (function call fails), returns
5301 `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
5302 * `minetest.compress(data, method, ...)`: returns `compressed_data`
5303 * Compress a string of data.
5304 * `method` is a string identifying the compression method to be used.
5305 * Supported compression methods:
5306 * Deflate (zlib): `"deflate"`
5307 * `...` indicates method-specific arguments. Currently defined arguments
5309 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
5310 * `minetest.decompress(compressed_data, method, ...)`: returns data
5311 * Decompress a string of data (using ZLib).
5312 * See documentation on `minetest.compress()` for supported compression
5314 * `...` indicates method-specific arguments. Currently, no methods use this
5315 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
5316 * Each argument is a 8 Bit unsigned integer
5317 * Returns the ColorString from rgb or rgba values
5318 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
5319 * `minetest.encode_base64(string)`: returns string encoded in base64
5320 * Encodes a string in base64.
5321 * `minetest.decode_base64(string)`: returns string
5322 * Decodes a string encoded in base64.
5323 * `minetest.is_protected(pos, name)`: returns boolean
5324 * Returning `true` restricts the player `name` from modifying (i.e. digging,
5325 placing) the node at position `pos`.
5326 * `name` will be `""` for non-players or unknown players.
5327 * This function should be overridden by protection mods. It is highly
5328 recommended to grant access to players with the `protection_bypass` privilege.
5329 * Cache and call the old version of this function if the position is
5330 not protected by the mod. This will allow using multiple protection mods.
5333 local old_is_protected = minetest.is_protected
5334 function minetest.is_protected(pos, name)
5335 if mymod:position_protected_from(pos, name) then
5338 return old_is_protected(pos, name)
5340 * `minetest.record_protection_violation(pos, name)`
5341 * This function calls functions registered with
5342 `minetest.register_on_protection_violation`.
5343 * `minetest.is_area_protected(pos1, pos2, player_name, interval)`
5344 * Returns the position of the first node that `player_name` may not modify
5345 in the specified cuboid between `pos1` and `pos2`.
5346 * Returns `false` if no protections were found.
5347 * Applies `is_protected()` to a 3D lattice of points in the defined volume.
5348 The points are spaced evenly throughout the volume and have a spacing
5349 similar to, but no larger than, `interval`.
5350 * All corners and edges of the defined volume are checked.
5351 * `interval` defaults to 4.
5352 * `interval` should be carefully chosen and maximised to avoid an excessive
5353 number of points being checked.
5354 * Like `minetest.is_protected`, this function may be extended or
5355 overwritten by mods to provide a faster implementation to check the
5356 cuboid for intersections.
5357 * `minetest.rotate_and_place(itemstack, placer, pointed_thing[, infinitestacks,
5358 orient_flags, prevent_after_place])`
5359 * Attempt to predict the desired orientation of the facedir-capable node
5360 defined by `itemstack`, and place it accordingly (on-wall, on the floor,
5361 or hanging from the ceiling).
5362 * `infinitestacks`: if `true`, the itemstack is not changed. Otherwise the
5363 stacks are handled normally.
5364 * `orient_flags`: Optional table containing extra tweaks to the placement code:
5365 * `invert_wall`: if `true`, place wall-orientation on the ground and
5366 ground-orientation on the wall.
5367 * `force_wall` : if `true`, always place the node in wall orientation.
5368 * `force_ceiling`: if `true`, always place on the ceiling.
5369 * `force_floor`: if `true`, always place the node on the floor.
5370 * `force_facedir`: if `true`, forcefully reset the facedir to north
5371 when placing on the floor or ceiling.
5372 * The first four options are mutually-exclusive; the last in the list
5373 takes precedence over the first.
5374 * `prevent_after_place` is directly passed to `minetest.item_place_node`
5375 * Returns the new itemstack after placement
5376 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
5377 * calls `rotate_and_place()` with `infinitestacks` set according to the state
5378 of the creative mode setting, checks for "sneak" to set the `invert_wall`
5379 parameter and `prevent_after_place` set to `true`.
5381 * `minetest.calculate_knockback(player, hitter, time_from_last_punch,
5382 tool_capabilities, dir, distance, damage)`
5383 * Returns the amount of knockback applied on the punched player.
5384 * Arguments are equivalent to `register_on_punchplayer`, except the following:
5385 * `distance`: distance between puncher and punched player
5386 * This function can be overriden by mods that wish to modify this behaviour.
5387 * You may want to cache and call the old function to allow multiple mods to
5388 change knockback behaviour.
5390 * `minetest.forceload_block(pos[, transient])`
5391 * forceloads the position `pos`.
5392 * returns `true` if area could be forceloaded
5393 * If `transient` is `false` or absent, the forceload will be persistent
5394 (saved between server runs). If `true`, the forceload will be transient
5395 (not saved between server runs).
5397 * `minetest.forceload_free_block(pos[, transient])`
5398 * stops forceloading the position `pos`
5399 * If `transient` is `false` or absent, frees a persistent forceload.
5400 If `true`, frees a transient forceload.
5402 * `minetest.request_insecure_environment()`: returns an environment containing
5403 insecure functions if the calling mod has been listed as trusted in the
5404 `secure.trusted_mods` setting or security is disabled, otherwise returns
5406 * Only works at init time and must be called from the mod's main scope (not
5408 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE
5409 IT IN A LOCAL VARIABLE!**
5411 * `minetest.global_exists(name)`
5412 * Checks if a global variable has been set, without triggering a warning.
5417 * `minetest.env`: `EnvRef` of the server environment and world.
5418 * Any function in the minetest namespace can be called using the syntax
5419 `minetest.env:somefunction(somearguments)`
5420 instead of `minetest.somefunction(somearguments)`
5421 * Deprecated, but support is not to be dropped soon
5426 ### Registered definition tables
5428 * `minetest.registered_items`
5429 * Map of registered items, indexed by name
5430 * `minetest.registered_nodes`
5431 * Map of registered node definitions, indexed by name
5432 * `minetest.registered_craftitems`
5433 * Map of registered craft item definitions, indexed by name
5434 * `minetest.registered_tools`
5435 * Map of registered tool definitions, indexed by name
5436 * `minetest.registered_entities`
5437 * Map of registered entity prototypes, indexed by name
5438 * `minetest.object_refs`
5439 * Map of object references, indexed by active object id
5440 * `minetest.luaentities`
5441 * Map of Lua entities, indexed by active object id
5442 * `minetest.registered_abms`
5443 * List of ABM definitions
5444 * `minetest.registered_lbms`
5445 * List of LBM definitions
5446 * `minetest.registered_aliases`
5447 * Map of registered aliases, indexed by name
5448 * `minetest.registered_ores`
5449 * Map of registered ore definitions, indexed by the `name` field.
5450 * If `name` is nil, the key is the object handle returned by
5451 `minetest.register_ore`.
5452 * `minetest.registered_biomes`
5453 * Map of registered biome definitions, indexed by the `name` field.
5454 * If `name` is nil, the key is the object handle returned by
5455 `minetest.register_biome`.
5456 * `minetest.registered_decorations`
5457 * Map of registered decoration definitions, indexed by the `name` field.
5458 * If `name` is nil, the key is the object handle returned by
5459 `minetest.register_decoration`.
5460 * `minetest.registered_schematics`
5461 * Map of registered schematic definitions, indexed by the `name` field.
5462 * If `name` is nil, the key is the object handle returned by
5463 `minetest.register_schematic`.
5464 * `minetest.registered_chatcommands`
5465 * Map of registered chat command definitions, indexed by name
5466 * `minetest.registered_privileges`
5467 * Map of registered privilege definitions, indexed by name
5469 ### Registered callback tables
5471 All callbacks registered with [Global callback registration functions] are added
5472 to corresponding `minetest.registered_*` tables.
5480 Sorted alphabetically.
5485 A fast access data structure to store areas, and find areas near a given
5487 Every area has a `data` string attribute to store additional information.
5488 You can create an empty `AreaStore` by calling `AreaStore()`, or
5489 `AreaStore(type_name)`. The mod decides where to save and load AreaStore.
5490 If you chose the parameter-less constructor, a fast implementation will be
5491 automatically chosen for you.
5495 * `get_area(id, include_borders, include_data)`
5496 * Returns the area information about the specified ID.
5497 * Returned values are either of these:
5499 nil -- Area not found
5500 true -- Without `include_borders` and `include_data`
5502 min = pos, max = pos -- `include_borders == true`
5503 data = string -- `include_data == true`
5506 * `get_areas_for_pos(pos, include_borders, include_data)`
5507 * Returns all areas as table, indexed by the area ID.
5508 * Table values: see `get_area`.
5509 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`
5510 * Returns all areas that contain all nodes inside the area specified by `edge1`
5511 and `edge2` (inclusive).
5512 * `accept_overlap`: if `true`, areas are returned that have nodes in
5513 common (intersect) with the specified area.
5514 * Returns the same values as `get_areas_for_pos`.
5515 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store.
5516 * Returns the new area's ID, or nil if the insertion failed.
5517 * The (inclusive) positions `edge1` and `edge2` describe the area.
5518 * `data` is a string stored with the area.
5519 * `id` (optional): will be used as the internal area ID if it is an unique
5520 number between 0 and 2^32-2.
5521 * `reserve(count)`: reserves resources for at most `count` many contained
5523 Only needed for efficiency, and only some implementations profit.
5524 * `remove_area(id)`: removes the area with the given id from the store, returns
5526 * `set_cache_params(params)`: sets params for the included prefiltering cache.
5527 Calling invalidates the cache, so that its elements have to be newly
5529 * `params` is a table with the following fields:
5531 enabled = boolean, -- Whether to enable, default true
5532 block_radius = int, -- The radius (in nodes) of the areas the cache
5533 -- generates prefiltered lists for, minimum 16,
5535 limit = int, -- The cache size, minimum 20, default 1000
5536 * `to_string()`: Experimental. Returns area store serialized as a (binary)
5538 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to
5540 * `from_string(str)`: Experimental. Deserializes string and loads it into the
5542 Returns success and, optionally, an error message.
5543 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data
5549 An `InvRef` is a reference to an inventory.
5553 * `is_empty(listname)`: return `true` if list is empty
5554 * `get_size(listname)`: get size of a list
5555 * `set_size(listname, size)`: set size of a list
5556 * returns `false` on error (e.g. invalid `listname` or `size`)
5557 * `get_width(listname)`: get width of a list
5558 * `set_width(listname, width)`: set width of list; currently used for crafting
5559 * `get_stack(listname, i)`: get a copy of stack index `i` in list
5560 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
5561 * `get_list(listname)`: return full list
5562 * `set_list(listname, list)`: set full list (size will not change)
5563 * `get_lists()`: returns list of inventory lists
5564 * `set_lists(lists)`: sets inventory lists (size will not change)
5565 * `add_item(listname, stack)`: add item somewhere in list, returns leftover
5567 * `room_for_item(listname, stack):` returns `true` if the stack of items
5568 can be fully added to the list
5569 * `contains_item(listname, stack, [match_meta])`: returns `true` if
5570 the stack of items can be fully taken from the list.
5571 If `match_meta` is false, only the items' names are compared
5573 * `remove_item(listname, stack)`: take as many items as specified from the
5574 list, returns the items that were actually removed (as an `ItemStack`)
5575 -- note that any item metadata is ignored, so attempting to remove a specific
5576 unique item this way will likely remove the wrong one -- to do that use
5577 `set_stack` with an empty `ItemStack`.
5578 * `get_location()`: returns a location compatible to
5579 `minetest.get_inventory(location)`.
5580 * returns `{type="undefined"}` in case location is not known
5585 An `ItemStack` is a stack of items.
5587 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
5588 an itemstring, a table or `nil`.
5592 * `is_empty()`: returns `true` if stack is empty.
5593 * `get_name()`: returns item name (e.g. `"default:stone"`).
5594 * `set_name(item_name)`: returns a boolean indicating whether the item was
5596 * `get_count()`: Returns number of items on the stack.
5597 * `set_count(count)`: returns a boolean indicating whether the item was cleared
5598 * `count`: number, unsigned 16 bit integer
5599 * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
5600 * `set_wear(wear)`: returns boolean indicating whether item was cleared
5601 * `wear`: number, unsigned 16 bit integer
5602 * `get_meta()`: returns ItemStackMetaRef. See section for more details
5603 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
5605 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
5606 * `get_description()`: returns the description shown in inventory list tooltips.
5607 * `clear()`: removes all items from the stack, making it empty.
5608 * `replace(item)`: replace the contents of this stack.
5609 * `item` can also be an itemstring or table.
5610 * `to_string()`: returns the stack in itemstring form.
5611 * `to_table()`: returns the stack in Lua table form.
5612 * `get_stack_max()`: returns the maximum size of the stack (depends on the
5614 * `get_free_space()`: returns `get_stack_max() - get_count()`.
5615 * `is_known()`: returns `true` if the item name refers to a defined item type.
5616 * `get_definition()`: returns the item definition table.
5617 * `get_tool_capabilities()`: returns the digging properties of the item,
5618 or those of the hand if none are defined for this item type
5619 * `add_wear(amount)`
5620 * Increases wear by `amount` if the item is a tool
5621 * `amount`: number, integer
5622 * `add_item(item)`: returns leftover `ItemStack`
5623 * Put some item or stack onto this stack
5624 * `item_fits(item)`: returns `true` if item or stack can be fully added to
5626 * `take_item(n)`: returns taken `ItemStack`
5627 * Take (and remove) up to `n` items from this stack
5628 * `n`: number, default: `1`
5629 * `peek_item(n)`: returns taken `ItemStack`
5630 * Copy (don't remove) up to `n` items from this stack
5631 * `n`: number, default: `1`
5636 ItemStack metadata: reference extra data and functionality stored in a stack.
5637 Can be obtained via `item:get_meta()`.
5641 * All methods in MetaDataRef
5642 * `set_tool_capabilities([tool_capabilities])`
5643 * Overrides the item's tool capabilities
5644 * A nil value will clear the override data and restore the original
5650 Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],
5651 and [`PlayerMetaRef`].
5655 * `contains(key)`: Returns true if key present, otherwise false.
5656 * Returns `nil` when the MetaData is inexistent.
5657 * `get(key)`: Returns `nil` if key not present, else the stored string.
5658 * `set_string(key, value)`: Value of `""` will delete the key.
5659 * `get_string(key)`: Returns `""` if key not present.
5660 * `set_int(key, value)`
5661 * `get_int(key)`: Returns `0` if key not present.
5662 * `set_float(key, value)`
5663 * `get_float(key)`: Returns `0` if key not present.
5664 * `to_table()`: returns `nil` or a table with keys:
5665 * `fields`: key-value storage
5666 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
5667 * `from_table(nil or {})`
5668 * Any non-table value will clear the metadata
5669 * See [Node Metadata] for an example
5670 * returns `true` on success
5672 * returns `true` if this metadata has the same key-value pairs as `other`
5677 An interface to use mod channels on client and server
5681 * `leave()`: leave the mod channel.
5682 * Server leaves channel `channel_name`.
5683 * No more incoming or outgoing messages can be sent to this channel from
5685 * This invalidate all future object usage.
5686 * Ensure you set mod_channel to nil after that to free Lua resources.
5687 * `is_writeable()`: returns true if channel is writeable and mod can send over
5689 * `send_all(message)`: Send `message` though the mod channel.
5690 * If mod channel is not writeable or invalid, message will be dropped.
5691 * Message size is limited to 65535 characters by protocol.
5696 Node metadata: reference extra data and functionality stored in a node.
5697 Can be obtained via `minetest.get_meta(pos)`.
5701 * All methods in MetaDataRef
5702 * `get_inventory()`: returns `InvRef`
5703 * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
5704 This will prevent them from being sent to the client. Note that the "private"
5705 status will only be remembered if an associated key-value pair exists,
5706 meaning it's best to call this when initializing all other meta (e.g.
5712 Node Timers: a high resolution persistent per-node timer.
5713 Can be gotten via `minetest.get_node_timer(pos)`.
5717 * `set(timeout,elapsed)`
5718 * set a timer's state
5719 * `timeout` is in seconds, and supports fractional values (0.1 etc)
5720 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
5721 * will trigger the node's `on_timer` function after `(timeout - elapsed)`
5725 * equivalent to `set(timeout,0)`
5728 * `get_timeout()`: returns current timeout in seconds
5729 * if `timeout` equals `0`, timer is inactive
5730 * `get_elapsed()`: returns current elapsed time in seconds
5731 * the node's `on_timer` function will be called after `(timeout - elapsed)`
5733 * `is_started()`: returns boolean state of timer
5734 * returns `true` if timer is started, otherwise `false`
5739 Moving things in the game are generally these.
5740 This is basically a reference to a C++ `ServerActiveObject`.
5742 ### Advice on handling `ObjectRefs`
5744 When you receive an `ObjectRef` as a callback argument or from another API
5745 function, it is possible to store the reference somewhere and keep it around.
5746 It will keep functioning until the object is unloaded or removed.
5748 However, doing this is **NOT** recommended as there is (intentionally) no method
5749 to test if a previously acquired `ObjectRef` is still valid.
5750 Instead, `ObjectRefs` should be "let go" of as soon as control is returned from
5751 Lua back to the engine.
5752 Doing so is much less error-prone and you will never need to wonder if the
5753 object you are working with still exists.
5758 * `get_pos()`: returns `{x=num, y=num, z=num}`
5759 * `set_pos(pos)`: `pos`=`{x=num, y=num, z=num}`
5760 * `move_to(pos, continuous=false)`
5761 * Does an interpolated move for Lua entities for visually smooth transitions.
5762 * If `continuous` is true, the Lua entity will not be moved to the current
5763 position before starting the interpolated move.
5764 * For players this does the same as `set_pos`,`continuous` is ignored.
5765 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
5766 * `puncher` = another `ObjectRef`,
5767 * `time_from_last_punch` = time since last punch action of the puncher
5768 * `direction`: can be `nil`
5769 * `right_click(clicker)`; `clicker` is another `ObjectRef`
5770 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
5771 * `set_hp(hp, reason)`: set number of hitpoints (2 * number of hearts).
5772 * See reason in register_on_player_hpchange
5773 * Is limited to the range of 0 ... 65535 (2^16 - 1)
5774 * For players: HP are also limited by `hp_max` specified in the player's
5776 * `get_inventory()`: returns an `InvRef` for players, otherwise returns `nil`
5777 * `get_wield_list()`: returns the name of the inventory list the wielded item
5779 * `get_wield_index()`: returns the index of the wielded item
5780 * `get_wielded_item()`: returns an `ItemStack`
5781 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if
5783 * `set_armor_groups({group1=rating, group2=rating, ...})`
5784 * `get_armor_groups()`: returns a table with the armor group ratings
5785 * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
5786 * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
5787 * `frame_speed`: number, default: `15.0`
5788 * `frame_blend`: number, default: `0.0`
5789 * `frame_loop`: boolean, default: `true`
5790 * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and
5792 * `set_animation_frame_speed(frame_speed)`
5793 * `frame_speed`: number, default: `15.0`
5794 * `set_attach(parent, bone, position, rotation)`
5796 * `position`: `{x=num, y=num, z=num}` (relative)
5797 * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees
5798 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't
5801 * `set_bone_position(bone, position, rotation)`
5803 * `position`: `{x=num, y=num, z=num}` (relative)
5804 * `rotation`: `{x=num, y=num, z=num}`
5805 * `get_bone_position(bone)`: returns position and rotation of the bone
5806 * `set_properties(object property table)`
5807 * `get_properties()`: returns object property table
5808 * `is_player()`: returns true for players, false otherwise
5809 * `get_nametag_attributes()`
5810 * returns a table with the attributes of the nametag of an object
5812 color = {a=0..255, r=0..255, g=0..255, b=0..255},
5815 * `set_nametag_attributes(attributes)`
5816 * sets the attributes of the nametag of an object
5820 text = "My Nametag",
5823 #### Lua entity only (no-op for other objects)
5825 * `remove()`: remove object
5826 * The object is removed after returning from Lua. However the `ObjectRef`
5827 itself instantly becomes unusable with all further method calls having
5828 no effect and returning `nil`.
5829 * `set_velocity(vel)`
5830 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
5831 * `add_velocity(vel)`
5832 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
5833 * In comparison to using get_velocity, adding the velocity and then using
5834 set_velocity, add_velocity is supposed to avoid synchronization problems.
5835 * `get_velocity()`: returns the velocity, a vector
5836 * `set_acceleration(acc)`
5838 * `get_acceleration()`: returns the acceleration, a vector
5839 * `set_rotation(rot)`
5840 * `rot` is a vector (radians). X is pitch (elevation), Y is yaw (heading)
5841 and Z is roll (bank).
5842 * `get_rotation()`: returns the rotation, a vector (radians)
5843 * `set_yaw(radians)`: sets the yaw (heading).
5844 * `get_yaw()`: returns number in radians
5845 * `set_texture_mod(mod)`
5846 * `get_texture_mod()` returns current texture modifier
5847 * `set_sprite(p, num_frames, framelength, select_horiz_by_yawpitch)`
5848 * Select sprite from spritesheet with optional animation and Dungeon Master
5849 style texture selection based on yaw relative to camera
5850 * `p`: {x=number, y=number}, the coordinate of the first frame
5851 (x: column, y: row), default: `{x=0, y=0}`
5852 * `num_frames`: number, default: `1`
5853 * `framelength`: number, default: `0.2`
5854 * `select_horiz_by_yawpitch`: boolean, this was once used for the Dungeon
5855 Master mob, default: `false`
5856 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
5859 #### Player only (no-op for other objects)
5861 * `get_player_name()`: returns `""` if is not a player
5862 * `get_player_velocity()`: returns `nil` if is not a player, otherwise a
5863 table {x, y, z} representing the player's instantaneous velocity in nodes/s
5864 * `add_player_velocity(vel)`
5865 * Adds to player velocity, this happens client-side and only once.
5866 * Does not apply during free_move.
5867 * Note that since the player speed is normalized at each move step,
5868 increasing e.g. Y velocity beyond what would usually be achieved
5869 (see: physics overrides) will cause existing X/Z velocity to be reduced.
5870 * Example: `add_player_velocity({x=0, y=6.5, z=0})` is equivalent to
5871 pressing the jump key (assuming default settings)
5872 * `get_look_dir()`: get camera direction as a unit vector
5873 * `get_look_vertical()`: pitch in radians
5874 * Angle ranges between -pi/2 and pi/2, which are straight up and down
5876 * `get_look_horizontal()`: yaw in radians
5877 * Angle is counter-clockwise from the +z direction.
5878 * `set_look_vertical(radians)`: sets look pitch
5879 * radians: Angle from looking forward, where positive is downwards.
5880 * `set_look_horizontal(radians)`: sets look yaw
5881 * radians: Angle from the +z direction, where positive is counter-clockwise.
5882 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use
5883 `get_look_vertical`.
5884 * Angle ranges between -pi/2 and pi/2, which are straight down and up
5886 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use
5887 `get_look_horizontal`.
5888 * Angle is counter-clockwise from the +x direction.
5889 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use
5890 `set_look_vertical`.
5891 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use
5892 `set_look_horizontal`.
5893 * `get_breath()`: returns player's breath
5894 * `set_breath(value)`: sets player's breath
5896 * `0`: player is drowning
5897 * max: bubbles bar is not shown
5898 * See [Object properties] for more information
5899 * Is limited to range 0 ... 65535 (2^16 - 1)
5900 * `set_fov(fov, is_multiplier)`: Sets player's FOV
5902 * `is_multiplier`: Set to `true` if the FOV value is a multiplier.
5903 Defaults to `false`.
5904 * Set to 0 to clear FOV override.
5906 * Returns player's FOV override in degrees, and a boolean depending on whether
5907 the value is a multiplier.
5908 * Returns 0 as first value if player's FOV hasn't been overridden.
5909 * `set_attribute(attribute, value)`: DEPRECATED, use get_meta() instead
5910 * Sets an extra attribute with value on player.
5911 * `value` must be a string, or a number which will be converted to a
5913 * If `value` is `nil`, remove attribute from player.
5914 * `get_attribute(attribute)`: DEPRECATED, use get_meta() instead
5915 * Returns value (a string) for extra attribute.
5916 * Returns `nil` if no attribute found.
5917 * `get_meta()`: Returns a PlayerMetaRef.
5918 * `set_inventory_formspec(formspec)`
5919 * Redefine player's inventory form
5920 * Should usually be called in `on_joinplayer`
5921 * `get_inventory_formspec()`: returns a formspec string
5922 * `set_formspec_prepend(formspec)`:
5923 * the formspec string will be added to every formspec shown to the user,
5924 except for those with a no_prepend[] tag.
5925 * This should be used to set style elements such as background[] and
5926 bgcolor[], any non-style elements (eg: label) may result in weird behaviour.
5927 * Only affects formspecs shown after this is called.
5928 * `get_formspec_prepend(formspec)`: returns a formspec string.
5929 * `get_player_control()`: returns table with player pressed keys
5930 * The table consists of fields with boolean value representing the pressed
5931 keys, the fields are jump, right, left, LMB, RMB, sneak, aux1, down, up.
5932 * example: `{jump=false, right=true, left=false, LMB=false, RMB=false,
5933 sneak=true, aux1=false, down=false, up=false}`
5934 * `get_player_control_bits()`: returns integer with bit packed player pressed
5936 * bit nr/meaning: 0/up, 1/down, 2/left, 3/right, 4/jump, 5/aux1, 6/sneak,
5938 * `set_physics_override(override_table)`
5939 * `override_table` is a table with the following fields:
5940 * `speed`: multiplier to default walking speed value (default: `1`)
5941 * `jump`: multiplier to default jump value (default: `1`)
5942 * `gravity`: multiplier to default gravity value (default: `1`)
5943 * `sneak`: whether player can sneak (default: `true`)
5944 * `sneak_glitch`: whether player can use the new move code replications
5945 of the old sneak side-effects: sneak ladders and 2 node sneak jump
5947 * `new_move`: use new move/sneak code. When `false` the exact old code
5948 is used for the specific old sneak behaviour (default: `true`)
5949 * `get_physics_override()`: returns the table given to `set_physics_override`
5950 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
5952 * `hud_remove(id)`: remove the HUD element of the specified id
5953 * `hud_change(id, stat, value)`: change a value of a previously added HUD
5955 * element `stat` values:
5956 `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
5957 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
5958 * `hud_set_flags(flags)`: sets specified HUD flags of player.
5959 * `flags`: A table with the following fields set to boolean values
5967 * If a flag equals `nil`, the flag is not modified
5968 * `minimap`: Modifies the client's permission to view the minimap.
5969 The client may locally elect to not view the minimap.
5970 * `minimap_radar` is only usable when `minimap` is true
5971 * `hud_get_flags()`: returns a table of player HUD flags with boolean values.
5972 * See `hud_set_flags` for a list of flags that can be toggled.
5973 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
5974 * `count`: number of items, must be between `1` and `32`
5975 * `hud_get_hotbar_itemcount`: returns number of visible items
5976 * `hud_set_hotbar_image(texturename)`
5977 * sets background image for hotbar
5978 * `hud_get_hotbar_image`: returns texturename
5979 * `hud_set_hotbar_selected_image(texturename)`
5980 * sets image for selected item of hotbar
5981 * `hud_get_hotbar_selected_image`: returns texturename
5982 * `set_sky(parameters)`
5983 * `parameters` is a table with the following optional fields:
5984 * `base_color`: ColorSpec, changes fog in "skybox" and "plain".
5985 * `type`: Available types:
5986 * `"regular"`: Uses 0 textures, `base_color` ignored
5987 * `"skybox"`: Uses 6 textures, `base_color` used as fog.
5988 * `"plain"`: Uses 0 textures, `base_color` used as both fog and sky.
5989 * `textures`: A table containing up to six textures in the following
5990 order: Y+ (top), Y- (bottom), X- (west), X+ (east), Z+ (north), Z- (south).
5991 * `clouds`: Boolean for whether clouds appear. (default: `true`)
5992 * `sky_color`: A table containing the following values, alpha is ignored:
5993 * `day_sky`: ColorSpec, for the top half of the `"regular"`
5994 sky during the day. (default: `#8cbafa`)
5995 * `day_horizon`: ColorSpec, for the bottom half of the
5996 `"regular"` sky during the day. (default: `#9bc1f0`)
5997 * `dawn_sky`: ColorSpec, for the top half of the `"regular"`
5998 sky during dawn/sunset. (default: `#b4bafa`)
5999 The resulting sky color will be a darkened version of the ColorSpec.
6000 Warning: The darkening of the ColorSpec is subject to change.
6001 * `dawn_horizon`: ColorSpec, for the bottom half of the `"regular"`
6002 sky during dawn/sunset. (default: `#bac1f0`)
6003 The resulting sky color will be a darkened version of the ColorSpec.
6004 Warning: The darkening of the ColorSpec is subject to change.
6005 * `night_sky`: ColorSpec, for the top half of the `"regular"`
6006 sky during the night. (default: `#006aff`)
6007 The resulting sky color will be a dark version of the ColorSpec.
6008 Warning: The darkening of the ColorSpec is subject to change.
6009 * `night_horizon`: ColorSpec, for the bottom half of the `"regular"`
6010 sky during the night. (default: `#4090ff`)
6011 The resulting sky color will be a dark version of the ColorSpec.
6012 Warning: The darkening of the ColorSpec is subject to change.
6013 * `indoors`: ColorSpec, for when you're either indoors or
6014 underground. Only applies to the `"regular"` sky.
6015 (default: `#646464`)
6016 * `fog_sun_tint`: ColorSpec, changes the fog tinting for the sun
6017 at sunrise and sunset.
6018 * `fog_moon_tint`: ColorSpec, changes the fog tinting for the moon
6019 at sunrise and sunset.
6020 * `fog_tint_type`: string, changes which mode the directional fog
6021 abides by, `"custom"` uses `sun_tint` and `moon_tint`, while
6022 `"default"` uses the classic Minetest sun and moon tinting.
6023 Will use tonemaps, if set to `"default"`. (default: `"default"`)
6024 * `get_sky()`: returns base_color, type, table of textures, clouds.
6025 * `get_sky_color()`: returns a table with the `sky_color` parameters as in
6027 * `set_sun(parameters)`:
6028 * `parameters` is a table with the following optional fields:
6029 * `visible`: Boolean for whether the sun is visible.
6031 * `texture`: A regular texture for the sun. Setting to `""`
6032 will re-enable the mesh sun. (default: `"sun.png"`)
6033 * `tonemap`: A 512x1 texture containing the tonemap for the sun
6034 (default: `"sun_tonemap.png"`)
6035 * `sunrise`: A regular texture for the sunrise texture.
6036 (default: `"sunrisebg.png"`)
6037 * `sunrise_visible`: Boolean for whether the sunrise texture is visible.
6039 * `scale`: Float controlling the overall size of the sun. (default: `1`)
6040 * `get_sun()`: returns a table with the current sun parameters as in
6042 * `set_moon(parameters)`:
6043 * `parameters` is a table with the following optional fields:
6044 * `visible`: Boolean for whether the moon is visible.
6046 * `texture`: A regular texture for the moon. Setting to `""`
6047 will re-enable the mesh moon. (default: `"moon.png"`)
6048 * `tonemap`: A 512x1 texture containing the tonemap for the moon
6049 (default: `"moon_tonemap.png"`)
6050 * `scale`: Float controlling the overall size of the moon (default: `1`)
6051 * `get_moon()`: returns a table with the current moon parameters as in
6053 * `set_stars(parameters)`:
6054 * `parameters` is a table with the following optional fields:
6055 * `visible`: Boolean for whether the stars are visible.
6057 * `count`: Integer number to set the number of stars in
6058 the skybox. Only applies to `"skybox"` and `"regular"` sky types.
6060 * `star_color`: ColorSpec, sets the colors of the stars,
6061 alpha channel is used to set overall star brightness.
6062 (default: `#ebebff69`)
6063 * `scale`: Float controlling the overall size of the stars (default: `1`)
6064 * `get_stars()`: returns a table with the current stars parameters as in
6066 * `set_clouds(parameters)`: set cloud parameters
6067 * `parameters` is a table with the following optional fields:
6068 * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
6069 * `color`: basic cloud color with alpha channel, ColorSpec
6070 (default `#fff0f0e5`).
6071 * `ambient`: cloud color lower bound, use for a "glow at night" effect.
6072 ColorSpec (alpha ignored, default `#000000`)
6073 * `height`: cloud height, i.e. y of cloud base (default per conf,
6075 * `thickness`: cloud thickness in nodes (default `16`)
6076 * `speed`: 2D cloud speed + direction in nodes per second
6077 (default `{x=0, z=-2}`).
6078 * `get_clouds()`: returns a table with the current cloud parameters as in
6080 * `override_day_night_ratio(ratio or nil)`
6081 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific
6083 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
6084 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
6085 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`:
6086 set animation for player model in third person view
6088 set_local_animation({x=0, y=79}, -- stand/idle animation key frames
6089 {x=168, y=187}, -- walk animation key frames
6090 {x=189, y=198}, -- dig animation key frames
6091 {x=200, y=219}, -- walk+dig animation key frames
6092 frame_speed=30) -- animation frame speed
6093 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and
6095 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for
6097 * in first person view
6098 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
6099 * `get_eye_offset()`: returns `offset_first` and `offset_third`
6100 * `send_mapblock(blockpos)`:
6101 * Sends a server-side loaded mapblock to the player.
6102 * Returns `false` if failed.
6103 * Resource intensive - use sparsely
6104 * To get blockpos, integer divide pos by 16
6109 A 32-bit pseudorandom number generator.
6110 Uses PCG32, an algorithm of the permuted congruential generator family,
6111 offering very strong randomness.
6113 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
6117 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
6118 * `next(min, max)`: return next integer random number [`min`...`max`]
6119 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed
6120 random number [`min`...`max`].
6121 * This is only a rough approximation of a normal distribution with:
6122 * `mean = (max - min) / 2`, and
6123 * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
6124 * Increasing `num_trials` improves accuracy of the approximation
6129 A perlin noise generator.
6130 It can be created via `PerlinNoise(seed, octaves, persistence, spread)`
6131 or `PerlinNoise(noiseparams)`.
6132 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
6133 or `minetest.get_perlin(noiseparams)`.
6137 * `get_2d(pos)`: returns 2D noise value at `pos={x=,y=}`
6138 * `get_3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
6143 A fast, bulk perlin noise generator.
6145 It can be created via `PerlinNoiseMap(noiseparams, size)` or
6146 `minetest.get_perlin_map(noiseparams, size)`.
6148 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
6149 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
6152 For each of the functions with an optional `buffer` parameter: If `buffer` is
6153 not nil, this table will be used to store the result instead of creating a new
6158 * `get_2d_map(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
6159 with values starting at `pos={x=,y=}`
6160 * `get_3d_map(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>`
6161 3D array of 3D noise with values starting at `pos={x=,y=,z=}`.
6162 * `get_2d_map_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element
6163 array of 2D noise with values starting at `pos={x=,y=}`
6164 * `get_3d_map_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
6165 * `calc_2d_map(pos)`: Calculates the 2d noise map starting at `pos`. The result
6166 is stored internally.
6167 * `calc_3d_map(pos)`: Calculates the 3d noise map starting at `pos`. The result
6168 is stored internally.
6169 * `get_map_slice(slice_offset, slice_size, buffer)`: In the form of an array,
6170 returns a slice of the most recently computed noise results. The result slice
6171 begins at coordinates `slice_offset` and takes a chunk of `slice_size`.
6172 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer
6174 `noisevals = noise:get_map_slice({y=20}, {y=2})`
6175 It is important to note that `slice_offset` offset coordinates begin at 1,
6176 and are relative to the starting position of the most recently calculated
6178 To grab a single vertical column of noise starting at map coordinates
6179 x = 1023, y=1000, z = 1000:
6180 `noise:calc_3d_map({x=1000, y=1000, z=1000})`
6181 `noisevals = noise:get_map_slice({x=24, z=1}, {x=1, z=1})`
6187 Uses the same method of storage as the deprecated player attribute API, so
6188 data there will also be in player meta.
6189 Can be obtained using `player:get_meta()`.
6193 * All methods in MetaDataRef
6198 A 16-bit pseudorandom number generator.
6199 Uses a well-known LCG algorithm introduced by K&R.
6201 It can be created via `PseudoRandom(seed)`.
6205 * `next()`: return next integer random number [`0`...`32767`]
6206 * `next(min, max)`: return next integer random number [`min`...`max`]
6207 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
6208 due to the simple implementation making bad distribution otherwise.
6213 A raycast on the map. It works with selection boxes.
6214 Can be used as an iterator in a for loop as:
6216 local ray = Raycast(...)
6217 for pointed_thing in ray do
6221 The map is loaded as the ray advances. If the map is modified after the
6222 `Raycast` is created, the changes may or may not have an effect on the object.
6224 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
6225 `minetest.raycast(pos1, pos2, objects, liquids)` where:
6227 * `pos1`: start of the ray
6228 * `pos2`: end of the ray
6229 * `objects`: if false, only nodes will be returned. Default is true.
6230 * `liquids`: if false, liquid nodes won't be returned. Default is false.
6234 * `next()`: returns a `pointed_thing` with exact pointing location
6235 * Returns the next thing pointed by the ray or nil.
6240 Interface for the operating system's crypto-secure PRNG.
6242 It can be created via `SecureRandom()`. The constructor returns nil if a
6243 secure random device cannot be found on the system.
6247 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many
6248 random bytes, as a string.
6253 An interface to read config files in the format of `minetest.conf`.
6255 It can be created via `Settings(filename)`.
6259 * `get(key)`: returns a value
6260 * `get_bool(key, [default])`: returns a boolean
6261 * `default` is the value returned if `key` is not found.
6262 * Returns `nil` if `key` is not found and `default` not specified.
6263 * `get_np_group(key)`: returns a NoiseParams table
6265 * Returns `{flag = true/false, ...}` according to the set flags.
6266 * Is currently limited to mapgen flags `mg_flags` and mapgen-specific
6267 flags like `mgv5_spflags`.
6269 * Setting names can't contain whitespace or any of `="{}#`.
6270 * Setting values can't contain the sequence `\n"""`.
6271 * Setting names starting with "secure." can't be set on the main settings
6272 object (`minetest.settings`).
6273 * `set_bool(key, value)`
6274 * See documentation for set() above.
6275 * `set_np_group(key, value)`
6276 * `value` is a NoiseParams table.
6277 * Also, see documentation for set() above.
6278 * `remove(key)`: returns a boolean (`true` for success)
6279 * `get_names()`: returns `{key1,...}`
6280 * `write()`: returns a boolean (`true` for success)
6281 * Writes changes to file.
6282 * `to_table()`: returns `{[key1]=value1,...}`
6286 The settings have the format `key = value`. Example:
6298 Mod metadata: per mod metadata, saved automatically.
6299 Can be obtained via `minetest.get_mod_storage()` during load time.
6301 WARNING: This storage backend is incaptable to save raw binary data due
6302 to restrictions of JSON.
6306 * All methods in MetaDataRef
6317 Used by `ObjectRef` methods. Part of an Entity definition.
6318 These properties are not persistent, but are applied automatically to the
6319 corresponding Lua entity using the given registration fields.
6320 Player properties need to be saved manually.
6324 -- For players only. Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`.
6327 -- For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`.
6330 -- For players only. Zoom FOV in degrees.
6331 -- Note that zoom loads and/or generates world beyond the server's
6332 -- maximum send and generate distances, so acts like a telescope.
6333 -- Smaller zoom_fov values increase the distance loaded/generated.
6334 -- Defaults to 15 in creative mode, 0 in survival mode.
6335 -- zoom_fov = 0 disables zooming for the player.
6338 -- For players only. Camera height above feet position in nodes.
6339 -- Defaults to 1.625.
6342 -- Collide with `walkable` nodes.
6344 collide_with_objects = true,
6345 -- Collide with other objects if physical = true
6347 collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5}, -- Default
6348 selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
6349 -- Selection box uses collision box dimensions when not set.
6350 -- For both boxes: {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from
6354 -- Overrides selection box when false
6356 visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem" / "item",
6357 -- "cube" is a node-sized cube.
6358 -- "sprite" is a flat texture always facing the player.
6359 -- "upright_sprite" is a vertical flat texture.
6360 -- "mesh" uses the defined mesh model.
6361 -- "wielditem" is used for dropped items.
6362 -- (see builtin/game/item_entity.lua).
6363 -- For this use 'wield_item = itemname' (Deprecated: 'textures = {itemname}').
6364 -- If the item has a 'wield_image' the object will be an extrusion of
6366 -- If 'itemname' is a cubic node or nodebox the object will appear
6367 -- identical to 'itemname'.
6368 -- If 'itemname' is a plantlike node the object will be an extrusion
6370 -- Otherwise for non-node items, the object will be an extrusion of
6371 -- 'inventory_image'.
6372 -- If 'itemname' contains a ColorString or palette index (e.g. from
6373 -- `minetest.itemstring_with_palette()`), the entity will inherit the color.
6374 -- "item" is similar to "wielditem" but ignores the 'wield_image' parameter.
6376 visual_size = {x = 1, y = 1, z = 1},
6377 -- Multipliers for the visual size. If `z` is not specified, `x` will be used
6378 -- to scale the entity along both horizontal axes.
6381 -- File name of mesh when using "mesh" visual
6384 -- Number of required textures depends on visual.
6385 -- "cube" uses 6 textures just like a node, but all 6 must be defined.
6386 -- "sprite" uses 1 texture.
6387 -- "upright_sprite" uses 2 textures: {front, back}.
6388 -- "wielditem" expects 'textures = {itemname}' (see 'visual' above).
6391 -- Number of required colors depends on visual
6393 use_texture_alpha = false,
6394 -- Use texture's alpha channel.
6395 -- Excludes "upright_sprite" and "wielditem".
6396 -- Note: currently causes visual issues when viewed through other
6397 -- semi-transparent materials such as water.
6399 spritediv = {x = 1, y = 1},
6400 -- Used with spritesheet textures for animation and/or frame selection
6401 -- according to position relative to player.
6402 -- Defines the number of columns and rows in the spritesheet:
6405 initial_sprite_basepos = {x = 0, y = 0},
6406 -- Used with spritesheet textures.
6407 -- Defines the {column, row} position of the initially used frame in the
6411 -- If false, object is invisible and can't be pointed.
6413 makes_footstep_sound = false,
6414 -- If true, is able to make footstep sounds of nodes
6415 -- (see node sound definition for details).
6417 automatic_rotate = 0,
6418 -- Set constant rotation in radians per second, positive or negative.
6419 -- Set to 0 to disable constant rotation.
6422 -- If positive number, object will climb upwards when it moves
6423 -- horizontally against a `walkable` node, if the height difference
6424 -- is within `stepheight`.
6426 automatic_face_movement_dir = 0.0,
6427 -- Automatically set yaw to movement direction, offset in degrees.
6428 -- 'false' to disable.
6430 automatic_face_movement_max_rotation_per_sec = -1,
6431 -- Limit automatic rotation to this value in degrees per second.
6432 -- No limit if value <= 0.
6434 backface_culling = true,
6435 -- Set to false to disable backface_culling for model
6438 -- Add this much extra lighting when calculating texture color.
6439 -- Value < 0 disables light's effect on texture color.
6440 -- For faking self-lighting, UI style entities, or programmatic coloring
6444 -- By default empty, for players their name is shown if empty
6446 nametag_color = <ColorSpec>,
6447 -- Sets color of nametag
6450 -- By default empty, text to be shown when pointed at object
6453 -- If false, never save this object statically. It will simply be
6454 -- deleted when the block gets unloaded.
6455 -- The get_staticdata() callback is never called then.
6456 -- Defaults to 'true'.
6462 Used by `minetest.register_entity`.
6465 initial_properties = {
6467 mesh = "boats_boat.obj",
6470 -- A table of object properties, see the `Object properties` section.
6471 -- Object properties being read directly from the entity definition
6472 -- table is deprecated. Define object properties in this
6473 -- `initial_properties` table instead.
6475 on_activate = function(self, staticdata, dtime_s),
6477 on_step = function(self, dtime),
6479 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
6481 on_rightclick = function(self, clicker),
6483 get_staticdata = function(self),
6484 -- Called sometimes; the string returned is passed to on_activate when
6485 -- the entity is re-activated from static state
6487 _custom_field = whatever,
6488 -- You can define arbitrary member variables here (see Item definition
6489 -- for more info) by using a '_' prefix
6492 ABM (ActiveBlockModifier) definition
6493 ------------------------------------
6495 Used by `minetest.register_abm`.
6498 label = "Lava cooling",
6499 -- Descriptive label for profiling purposes (optional).
6500 -- Definitions with identical labels will be listed as one.
6502 nodenames = {"default:lava_source"},
6503 -- Apply `action` function to these nodes.
6504 -- `group:groupname` can also be used here.
6506 neighbors = {"default:water_source", "default:water_flowing"},
6507 -- Only apply `action` to nodes that have one of, or any
6508 -- combination of, these neighbors.
6509 -- If left out or empty, any neighbor will do.
6510 -- `group:groupname` can also be used here.
6513 -- Operation interval in seconds
6516 -- Chance of triggering `action` per-node per-interval is 1.0 / this
6520 -- If true, catch-up behaviour is enabled: The `chance` value is
6521 -- temporarily reduced when returning to an area to simulate time lost
6522 -- by the area being unattended. Note that the `chance` value can often
6525 action = function(pos, node, active_object_count, active_object_count_wider),
6526 -- Function triggered for each qualifying node.
6527 -- `active_object_count` is number of active objects in the node's
6529 -- `active_object_count_wider` is number of active objects in the node's
6530 -- mapblock plus all 26 neighboring mapblocks. If any neighboring
6531 -- mapblocks are unloaded an estmate is calculated for them based on
6532 -- loaded mapblocks.
6535 LBM (LoadingBlockModifier) definition
6536 -------------------------------------
6538 Used by `minetest.register_lbm`.
6540 A loading block modifier (LBM) is used to define a function that is called for
6541 specific nodes (defined by `nodenames`) when a mapblock which contains such nodes
6545 label = "Upgrade legacy doors",
6546 -- Descriptive label for profiling purposes (optional).
6547 -- Definitions with identical labels will be listed as one.
6549 name = "modname:replace_legacy_door",
6551 nodenames = {"default:lava_source"},
6552 -- List of node names to trigger the LBM on.
6553 -- Also non-registered nodes will work.
6554 -- Groups (as of group:groupname) will work as well.
6556 run_at_every_load = false,
6557 -- Whether to run the LBM's action every time a block gets loaded,
6558 -- and not only the first time the block gets loaded after the LBM
6561 action = function(pos, node),
6568 * `{name="image.png", animation={Tile Animation definition}}`
6569 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
6570 tileable_horizontal=bool, align_style="node"/"world"/"user", scale=int}`
6571 * backface culling enabled by default for most nodes
6572 * tileable flags are info for shaders, how they should treat texture
6573 when displacement mapping is used.
6574 Directions are from the point of view of the tile texture,
6575 not the node it's on.
6576 * align style determines whether the texture will be rotated with the node
6577 or kept aligned with its surroundings. "user" means that client
6578 setting will be used, similar to `glasslike_framed_optional`.
6579 Note: supported by solid nodes and nodeboxes only.
6580 * scale is used to make texture span several (exactly `scale`) nodes,
6581 instead of just one, in each direction. Works for world-aligned
6583 Note that as the effect is applied on per-mapblock basis, `16` should
6584 be equally divisible by `scale` or you may get wrong results.
6585 * `{name="image.png", color=ColorSpec}`
6586 * the texture's color will be multiplied with this color.
6587 * the tile's color overrides the owning node's color in all cases.
6588 * deprecated, yet still supported field names:
6591 Tile animation definition
6592 -------------------------
6595 type = "vertical_frames",
6598 -- Width of a frame in pixels
6601 -- Height of a frame in pixels
6611 -- Width in number of frames
6614 -- Height in number of frames
6617 -- Length of a single frame
6623 Used by `minetest.register_node`, `minetest.register_craftitem`, and
6624 `minetest.register_tool`.
6627 description = "Steel Axe",
6630 -- key = name, value = rating; rating = 1..3.
6631 -- If rating not applicable, use 1.
6632 -- e.g. {wool = 1, fluffy = 3}
6633 -- {soil = 2, outerspace = 1, crumbly = 1}
6634 -- {bendy = 2, snappy = 1},
6635 -- {hard = 1, metal = 1, spikes = 1}
6637 inventory_image = "default_tool_steelaxe.png",
6639 inventory_overlay = "overlay.png",
6640 -- An overlay which does not get colorized
6647 -- An image file containing the palette of a node.
6648 -- You can set the currently used color as the "palette_index" field of
6649 -- the item stack metadata.
6650 -- The palette is always stretched to fit indices between 0 and 255, to
6651 -- ensure compatibility with "colorfacedir" and "colorwallmounted" nodes.
6653 color = "0xFFFFFFFF",
6654 -- The color of the item. The palette overrides this.
6656 wield_scale = {x = 1, y = 1, z = 1},
6662 liquids_pointable = false,
6664 -- See "Tools" section for an example including explanation
6665 tool_capabilities = {
6666 full_punch_interval = 1.0,
6670 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00},
6671 uses = 20, maxlevel = 2},
6673 damage_groups = {groupname = damage},
6674 -- Damage values must be between -32768 and 32767 (2^15)
6676 punch_attack_uses = nil,
6677 -- Amount of uses this tool has for attacking players and entities
6678 -- by punching them (0 = infinite uses).
6679 -- For compatibility, this is automatically set from the first
6680 -- suitable groupcap using the forumla "uses * 3^(maxlevel - 1)".
6681 -- It is recommend to set this explicitly instead of relying on the
6682 -- fallback behavior.
6685 node_placement_prediction = nil,
6686 -- If nil and item is node, prediction is made automatically.
6687 -- If nil and item is not a node, no prediction is made.
6688 -- If "" and item is anything, no prediction is made.
6689 -- Otherwise should be name of node which the client immediately places
6690 -- on ground when the player places the item. Server will always update
6691 -- actual result to client in a short moment.
6693 node_dig_prediction = "air",
6694 -- if "", no prediction is made.
6695 -- if "air", node is removed.
6696 -- Otherwise should be name of node which the client immediately places
6697 -- upon digging. Server will always update actual result shortly.
6700 -- Definition of items sounds to be played at various events.
6701 -- All fields in this table are optional.
6703 breaks = <SimpleSoundSpec>,
6704 -- When tool breaks due to wear. Ignored for non-tools
6706 eat = <SimpleSoundSpec>,
6707 -- When item is eaten with `minetest.do_item_eat`
6710 on_place = function(itemstack, placer, pointed_thing),
6711 -- Shall place item and return the leftover itemstack.
6712 -- The placer may be any ObjectRef or nil.
6713 -- default: minetest.item_place
6715 on_secondary_use = function(itemstack, user, pointed_thing),
6716 -- Same as on_place but called when not pointing at a node.
6717 -- The user may be any ObjectRef or nil.
6720 on_drop = function(itemstack, dropper, pos),
6721 -- Shall drop item and return the leftover itemstack.
6722 -- The dropper may be any ObjectRef or nil.
6723 -- default: minetest.item_drop
6725 on_use = function(itemstack, user, pointed_thing),
6727 -- Function must return either nil if no item shall be removed from
6728 -- inventory, or an itemstack to replace the original itemstack.
6729 -- e.g. itemstack:take_item(); return itemstack
6730 -- Otherwise, the function is free to do what it wants.
6731 -- The user may be any ObjectRef or nil.
6732 -- The default functions handle regular use cases.
6734 after_use = function(itemstack, user, node, digparams),
6736 -- If defined, should return an itemstack and will be called instead of
6737 -- wearing out the tool. If returns nil, does nothing.
6738 -- If after_use doesn't exist, it is the same as:
6739 -- function(itemstack, user, node, digparams)
6740 -- itemstack:add_wear(digparams.wear)
6743 -- The user may be any ObjectRef or nil.
6745 _custom_field = whatever,
6746 -- Add your own custom fields. By convention, all custom field names
6747 -- should start with `_` to avoid naming collisions with future engine
6754 Used by `minetest.register_node`.
6757 -- <all fields allowed in item definitions>,
6759 drawtype = "normal", -- See "Node drawtypes"
6762 -- Supported for drawtypes "plantlike", "signlike", "torchlike",
6763 -- "firelike", "mesh".
6764 -- For plantlike and firelike, the image will start at the bottom of the
6765 -- node. For torchlike, the image will start at the surface to which the
6766 -- node "attaches". For the other drawtypes the image will be centered
6769 tiles = {tile definition 1, def2, def3, def4, def5, def6},
6770 -- Textures of node; +Y, -Y, +X, -X, +Z, -Z
6771 -- Old field name was 'tile_images'.
6772 -- List can be shortened to needed length.
6774 overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6},
6775 -- Same as `tiles`, but these textures are drawn on top of the base
6776 -- tiles. You can use this to colorize only specific parts of your
6777 -- texture. If the texture name is an empty string, that overlay is not
6778 -- drawn. Since such tiles are drawn twice, it is not recommended to use
6779 -- overlays on very common nodes.
6781 special_tiles = {tile definition 1, Tile definition 2},
6782 -- Special textures of node; used rarely.
6783 -- Old field name was 'special_materials'.
6784 -- List can be shortened to needed length.
6787 -- The node's original color will be multiplied with this color.
6788 -- If the node has a palette, then this setting only has an effect in
6789 -- the inventory and on the wield item.
6791 use_texture_alpha = false,
6792 -- Use texture's alpha channel
6794 palette = "palette.png",
6795 -- The node's `param2` is used to select a pixel from the image.
6796 -- Pixels are arranged from left to right and from top to bottom.
6797 -- The node's color will be multiplied with the selected pixel's color.
6798 -- Tiles can override this behavior.
6799 -- Only when `paramtype2` supports palettes.
6801 post_effect_color = "green#0F",
6802 -- Screen tint if player is inside node, see "ColorSpec"
6804 paramtype = "none", -- See "Nodes"
6806 paramtype2 = "none", -- See "Nodes"
6808 place_param2 = nil, -- Force value for param2 when player places node
6810 is_ground_content = true,
6811 -- If false, the cave generator and dungeon generator will not carve
6812 -- through this node.
6813 -- Specifically, this stops mod-added nodes being removed by caves and
6814 -- dungeons when those generate in a neighbor mapchunk and extend out
6815 -- beyond the edge of that mapchunk.
6817 sunlight_propagates = false,
6818 -- If true, sunlight will go infinitely through this node
6820 walkable = true, -- If true, objects collide with node
6822 pointable = true, -- If true, can be pointed at
6824 diggable = true, -- If false, can never be dug
6826 climbable = false, -- If true, can be climbed on (ladder)
6828 buildable_to = false, -- If true, placed nodes can replace this node
6831 -- If true, liquids flow into and replace this node.
6832 -- Warning: making a liquid node 'floodable' will cause problems.
6834 liquidtype = "none", -- "none" / "source" / "flowing"
6836 liquid_alternative_flowing = "", -- Flowing version of source liquid
6838 liquid_alternative_source = "", -- Source version of flowing liquid
6840 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
6842 liquid_renewable = true,
6843 -- If true, a new liquid source can be created by placing two or more
6847 -- Only valid for "nodebox" drawtype with 'type = "leveled"'.
6848 -- Allows defining the nodebox height without using param2.
6849 -- The nodebox height is 'leveled' / 64 nodes.
6850 -- The maximum value of 'leveled' is 127.
6852 liquid_range = 8, -- Number of flowing nodes around source (max. 8)
6855 -- Player will take this amount of damage if no bubbles are left
6858 -- Amount of light emitted by node.
6859 -- To set the maximum (14), use the value 'minetest.LIGHT_MAX'.
6860 -- A value outside the range 0 to minetest.LIGHT_MAX causes undefined
6863 damage_per_second = 0,
6864 -- If player is inside node, this damage is caused
6866 node_box = {type="regular"}, -- See "Node boxes"
6868 connects_to = nodenames,
6869 -- Used for nodebox nodes with the type == "connected".
6870 -- Specifies to what neighboring nodes connections will be drawn.
6871 -- e.g. `{"group:fence", "default:wood"}` or `"default:stone"`
6873 connect_sides = { "top", "bottom", "front", "left", "back", "right" },
6874 -- Tells connected nodebox nodes to connect only to these sides of this
6878 -- File name of mesh when using "mesh" drawtype
6883 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
6886 -- Custom selection box definition. Multiple boxes can be defined.
6887 -- If "nodebox" drawtype is used and selection_box is nil, then node_box
6888 -- definition is used for the selection box.
6893 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
6896 -- Custom collision box definition. Multiple boxes can be defined.
6897 -- If "nodebox" drawtype is used and collision_box is nil, then node_box
6898 -- definition is used for the collision box.
6899 -- Both of the boxes above are defined as:
6900 -- {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from node center.
6902 -- Support maps made in and before January 2012
6903 legacy_facedir_simple = false,
6904 legacy_wallmounted = false,
6907 -- Valid for drawtypes:
6908 -- mesh, nodebox, plantlike, allfaces_optional, liquid, flowingliquid.
6909 -- 1 - wave node like plants (node top moves side-to-side, bottom is fixed)
6910 -- 2 - wave node like leaves (whole node moves side-to-side)
6911 -- 3 - wave node like liquids (whole node moves up and down)
6912 -- Not all models will properly wave.
6913 -- plantlike drawtype can only wave like plants.
6914 -- allfaces_optional drawtype can only wave like leaves.
6915 -- liquid, flowingliquid drawtypes can only wave like liquids.
6918 -- Definition of node sounds to be played at various events.
6919 -- All fields in this table are optional.
6921 footstep = <SimpleSoundSpec>,
6922 -- If walkable, played when object walks on it. If node is
6923 -- climbable or a liquid, played when object moves through it
6925 dig = <SimpleSoundSpec> or "__group",
6926 -- While digging node.
6927 -- If `"__group"`, then the sound will be
6928 -- `default_dig_<groupname>`, where `<groupname>` is the
6929 -- name of the tool's digging group with the fastest digging time.
6930 -- In case of a tie, one of the sounds will be played (but we
6931 -- cannot predict which one)
6932 -- Default value: `"__group"`
6934 dug = <SimpleSoundSpec>,
6937 place = <SimpleSoundSpec>,
6938 -- Node was placed. Also played after falling
6940 place_failed = <SimpleSoundSpec>,
6941 -- When node placement failed
6943 fall = <SimpleSoundSpec>,
6944 -- When node starts to fall
6948 -- Name of dropped item when dug.
6949 -- Default dropped item is the node itself.
6950 -- Using a table allows multiple items, drop chances and tool filtering.
6951 -- Tool filtering was undocumented until recently, tool filtering by string
6952 -- matching is deprecated.
6955 -- Maximum number of item lists to drop.
6956 -- The entries in 'items' are processed in order. For each:
6957 -- Tool filtering is applied, chance of drop is applied, if both are
6958 -- successful the entire item list is dropped.
6959 -- Entry processing continues until the number of dropped item lists
6960 -- equals 'max_items'.
6961 -- Therefore, entries should progress from low to high drop chance.
6965 -- 1 in 1000 chance of dropping a diamond.
6966 -- Default rarity is '1'.
6968 items = {"default:diamond"},
6971 -- Only drop if using a tool whose name is identical to one
6973 tools = {"default:shovel_mese", "default:shovel_diamond"},
6975 items = {"default:dirt"},
6976 -- Whether all items in the dropped item list inherit the
6977 -- hardware coloring palette color from the dug node.
6978 -- Default is 'false'.
6979 inherit_color = true,
6982 -- Only drop if using a tool whose name contains
6983 -- "default:shovel_" (this tool filtering by string matching
6985 tools = {"~default:shovel_"},
6987 -- The item list dropped.
6988 items = {"default:sand", "default:desert_sand"},
6993 on_construct = function(pos),
6994 -- Node constructor; called after adding node.
6995 -- Can set up metadata and stuff like that.
6996 -- Not called for bulk node placement (i.e. schematics and VoxelManip).
6999 on_destruct = function(pos),
7000 -- Node destructor; called before removing node.
7001 -- Not called for bulk node placement.
7004 after_destruct = function(pos, oldnode),
7005 -- Node destructor; called after removing node.
7006 -- Not called for bulk node placement.
7009 on_flood = function(pos, oldnode, newnode),
7010 -- Called when a liquid (newnode) is about to flood oldnode, if it has
7011 -- `floodable = true` in the nodedef. Not called for bulk node placement
7012 -- (i.e. schematics and VoxelManip) or air nodes. If return true the
7013 -- node is not flooded, but on_flood callback will most likely be called
7014 -- over and over again every liquid update interval.
7016 -- Warning: making a liquid node 'floodable' will cause problems.
7018 preserve_metadata = function(pos, oldnode, oldmeta, drops),
7019 -- Called when oldnode is about be converted to an item, but before the
7020 -- node is deleted from the world or the drops are added. This is
7021 -- generally the result of either the node being dug or an attached node
7022 -- becoming detached.
7023 -- drops is a table of ItemStacks, so any metadata to be preserved can
7024 -- be added directly to one or more of the dropped items. See
7025 -- "ItemStackMetaRef".
7028 after_place_node = function(pos, placer, itemstack, pointed_thing),
7029 -- Called after constructing node when node was placed using
7030 -- minetest.item_place_node / minetest.place_node.
7031 -- If return true no item is taken from itemstack.
7032 -- `placer` may be any valid ObjectRef or nil.
7035 after_dig_node = function(pos, oldnode, oldmetadata, digger),
7036 -- oldmetadata is in table format.
7037 -- Called after destructing node when node was dug using
7038 -- minetest.node_dig / minetest.dig_node.
7041 can_dig = function(pos, [player]),
7042 -- Returns true if node can be dug, or false if not.
7045 on_punch = function(pos, node, puncher, pointed_thing),
7046 -- default: minetest.node_punch
7047 -- By default calls minetest.register_on_punchnode callbacks.
7049 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing),
7051 -- itemstack will hold clicker's wielded item.
7052 -- Shall return the leftover itemstack.
7053 -- Note: pointed_thing can be nil, if a mod calls this function.
7054 -- This function does not get triggered by clients <=0.4.16 if the
7055 -- "formspec" node metadata field is set.
7057 on_dig = function(pos, node, digger),
7058 -- default: minetest.node_dig
7059 -- By default checks privileges, wears out tool and removes node.
7061 on_timer = function(pos, elapsed),
7063 -- called by NodeTimers, see minetest.get_node_timer and NodeTimerRef.
7064 -- elapsed is the total time passed since the timer was started.
7065 -- return true to run the timer for another cycle with the same timeout
7068 on_receive_fields = function(pos, formname, fields, sender),
7069 -- fields = {name1 = value1, name2 = value2, ...}
7070 -- Called when an UI form (e.g. sign text input) returns data.
7071 -- See minetest.register_on_player_receive_fields for more info.
7074 allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7075 -- Called when a player wants to move items inside the inventory.
7076 -- Return value: number of items allowed to move.
7078 allow_metadata_inventory_put = function(pos, listname, index, stack, player),
7079 -- Called when a player wants to put something into the inventory.
7080 -- Return value: number of items allowed to put.
7081 -- Return value -1: Allow and don't modify item count in inventory.
7083 allow_metadata_inventory_take = function(pos, listname, index, stack, player),
7084 -- Called when a player wants to take something out of the inventory.
7085 -- Return value: number of items allowed to take.
7086 -- Return value -1: Allow and don't modify item count in inventory.
7088 on_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7089 on_metadata_inventory_put = function(pos, listname, index, stack, player),
7090 on_metadata_inventory_take = function(pos, listname, index, stack, player),
7091 -- Called after the actual action has happened, according to what was
7095 on_blast = function(pos, intensity),
7096 -- intensity: 1.0 = mid range of regular TNT.
7097 -- If defined, called when an explosion touches the node, instead of
7098 -- removing the node.
7104 Used by `minetest.register_craft`.
7109 output = 'default:pick_stone',
7111 {'default:cobble', 'default:cobble', 'default:cobble'},
7112 {'', 'default:stick', ''},
7113 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
7115 replacements = <list of item pairs>,
7116 -- replacements: replace one input item with another item on crafting
7124 output = 'mushrooms:mushroom_stew',
7127 "mushrooms:mushroom_brown",
7128 "mushrooms:mushroom_red",
7130 replacements = <list of item pairs>,
7136 type = "toolrepair",
7137 additional_wear = -0.02,
7140 Note: Tools with group `disable_repair=1` will not repairable by this recipe.
7146 output = "default:glass",
7147 recipe = "default:sand",
7155 recipe = "bucket:bucket_lava",
7157 replacements = {{"bucket:bucket_lava", "bucket:bucket_empty"}},
7163 Used by `minetest.register_ore`.
7165 See [Ores] section above for essential information.
7168 ore_type = "scatter",
7170 ore = "default:stone_with_coal",
7173 -- Facedir rotation. Default is 0 (unchanged rotation)
7175 wherein = "default:stone",
7176 -- A list of nodenames is supported too
7178 clust_scarcity = 8 * 8 * 8,
7179 -- Ore has a 1 out of clust_scarcity chance of spawning in a node.
7180 -- If the desired average distance between ores is 'd', set this to
7184 -- Number of ores in a cluster
7187 -- Size of the bounding box of the cluster.
7188 -- In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27
7189 -- nodes are coal ore.
7193 -- Lower and upper limits for ore
7196 -- Attributes for the ore generation, see 'Ore attributes' section above
7198 noise_threshold = 0.5,
7199 -- If noise is above this threshold, ore is placed. Not needed for a
7200 -- uniform distribution.
7205 spread = {x = 100, y = 100, z = 100},
7210 -- NoiseParams structure describing one of the perlin noises used for
7211 -- ore distribution.
7212 -- Needed by "sheet", "puff", "blob" and "vein" ores.
7213 -- Omit from "scatter" ore for a uniform ore distribution.
7214 -- Omit from "stratum" ore for a simple horizontal strata from y_min to
7217 biomes = {"desert", "rainforest"},
7218 -- List of biomes in which this ore occurs.
7219 -- Occurs in all biomes if this is omitted, and ignored if the Mapgen
7220 -- being used does not support biomes.
7221 -- Can be a list of (or a single) biome names, IDs, or definitions.
7223 -- Type-specific parameters
7226 column_height_min = 1,
7227 column_height_max = 16,
7228 column_midpoint_factor = 0.5,
7234 spread = {x = 100, y = 100, z = 100},
7242 spread = {x = 100, y = 100, z = 100},
7249 random_factor = 1.0,
7252 np_stratum_thickness = {
7255 spread = {x = 100, y = 100, z = 100},
7260 stratum_thickness = 8,
7266 Used by `minetest.register_biome`.
7271 node_dust = "default:snow",
7272 -- Node dropped onto upper surface after all else is generated
7274 node_top = "default:dirt_with_snow",
7276 -- Node forming surface layer of biome and thickness of this layer
7278 node_filler = "default:permafrost",
7280 -- Node forming lower layer of biome and thickness of this layer
7282 node_stone = "default:bluestone",
7283 -- Node that replaces all stone nodes between roughly y_min and y_max.
7285 node_water_top = "default:ice",
7286 depth_water_top = 10,
7287 -- Node forming a surface layer in seawater with the defined thickness
7290 -- Node that replaces all seawater nodes not in the surface layer
7292 node_river_water = "default:ice",
7293 -- Node that replaces river water in mapgens that use
7294 -- default:river_water
7296 node_riverbed = "default:gravel",
7298 -- Node placed under river water and thickness of this layer
7300 node_cave_liquid = "default:lava_source",
7301 node_cave_liquid = {"default:water_source", "default:lava_source"},
7302 -- Nodes placed inside 50% of the medium size caves.
7303 -- Multiple nodes can be specified, each cave will use a randomly
7304 -- chosen node from the list.
7305 -- If this field is left out or 'nil', cave liquids fall back to
7306 -- classic behaviour of lava and water distributed using 3D noise.
7307 -- For no cave liquid, specify "air".
7309 node_dungeon = "default:cobble",
7310 -- Node used for primary dungeon structure.
7311 -- If absent, dungeon nodes fall back to the 'mapgen_cobble' mapgen
7312 -- alias, if that is also absent, dungeon nodes fall back to the biome
7314 -- If present, the following two nodes are also used.
7316 node_dungeon_alt = "default:mossycobble",
7317 -- Node used for randomly-distributed alternative structure nodes.
7318 -- If alternative structure nodes are not wanted leave this absent for
7319 -- performance reasons.
7321 node_dungeon_stair = "stairs:stair_cobble",
7322 -- Node used for dungeon stairs.
7323 -- If absent, stairs fall back to 'node_dungeon'.
7327 -- Upper and lower limits for biome.
7328 -- Alternatively you can use xyz limits as shown below.
7330 max_pos = {x = 31000, y = 128, z = 31000},
7331 min_pos = {x = -31000, y = 9, z = -31000},
7332 -- xyz limits for biome, an alternative to using 'y_min' and 'y_max'.
7333 -- Biome is limited to a cuboid defined by these positions.
7334 -- Any x, y or z field left undefined defaults to -31000 in 'min_pos' or
7335 -- 31000 in 'max_pos'.
7338 -- Vertical distance in nodes above 'y_max' over which the biome will
7339 -- blend with the biome above.
7340 -- Set to 0 for no vertical blend. Defaults to 0.
7343 humidity_point = 50,
7344 -- Characteristic temperature and humidity for the biome.
7345 -- These values create 'biome points' on a voronoi diagram with heat and
7346 -- humidity as axes. The resulting voronoi cells determine the
7347 -- distribution of the biomes.
7348 -- Heat and humidity have average values of 50, vary mostly between
7349 -- 0 and 100 but can exceed these values.
7352 Decoration definition
7353 ---------------------
7355 See [Decoration types]. Used by `minetest.register_decoration`.
7358 deco_type = "simple",
7360 place_on = "default:dirt_with_grass",
7361 -- Node (or list of nodes) that the decoration can be placed on
7364 -- Size of the square divisions of the mapchunk being generated.
7365 -- Determines the resolution of noise variation if used.
7366 -- If the chunk size is not evenly divisible by sidelen, sidelen is made
7367 -- equal to the chunk size.
7370 -- The value determines 'decorations per surface node'.
7371 -- Used only if noise_params is not specified.
7372 -- If >= 10.0 complete coverage is enabled and decoration placement uses
7373 -- a different and much faster method.
7378 spread = {x = 100, y = 100, z = 100},
7385 -- NoiseParams structure describing the perlin noise used for decoration
7387 -- A noise value is calculated for each square division and determines
7388 -- 'decorations per surface node' within each division.
7389 -- If the noise value >= 10.0 complete coverage is enabled and
7390 -- decoration placement uses a different and much faster method.
7392 biomes = {"Oceanside", "Hills", "Plains"},
7393 -- List of biomes in which this decoration occurs. Occurs in all biomes
7394 -- if this is omitted, and ignored if the Mapgen being used does not
7396 -- Can be a list of (or a single) biome names, IDs, or definitions.
7400 -- Lower and upper limits for decoration.
7401 -- These parameters refer to the Y co-ordinate of the 'place_on' node.
7403 spawn_by = "default:water",
7404 -- Node (or list of nodes) that the decoration only spawns next to.
7405 -- Checks two horizontal planes of 8 neighbouring nodes (including
7406 -- diagonal neighbours), one plane level with the 'place_on' node and a
7407 -- plane one node above that.
7410 -- Number of spawn_by nodes that must be surrounding the decoration
7411 -- position to occur.
7412 -- If absent or -1, decorations occur next to any nodes.
7414 flags = "liquid_surface, force_placement, all_floors, all_ceilings",
7415 -- Flags for all decoration types.
7416 -- "liquid_surface": Instead of placement on the highest solid surface
7417 -- in a mapchunk column, placement is on the highest liquid surface.
7418 -- Placement is disabled if solid nodes are found above the liquid
7420 -- "force_placement": Nodes other than "air" and "ignore" are replaced
7421 -- by the decoration.
7422 -- "all_floors", "all_ceilings": Instead of placement on the highest
7423 -- surface in a mapchunk the decoration is placed on all floor and/or
7424 -- ceiling surfaces, for example in caves and dungeons.
7425 -- Ceiling decorations act as an inversion of floor decorations so the
7426 -- effect of 'place_offset_y' is inverted.
7427 -- Y-slice probabilities do not function correctly for ceiling
7428 -- schematic decorations as the behaviour is unchanged.
7429 -- If a single decoration registration has both flags the floor and
7430 -- ceiling decorations will be aligned vertically.
7432 ----- Simple-type parameters
7434 decoration = "default:grass",
7435 -- The node name used as the decoration.
7436 -- If instead a list of strings, a randomly selected node from the list
7437 -- is placed as the decoration.
7440 -- Decoration height in nodes.
7441 -- If height_max is not 0, this is the lower limit of a randomly
7445 -- Upper limit of the randomly selected height.
7446 -- If absent, the parameter 'height' is used as a constant.
7449 -- Param2 value of decoration nodes.
7450 -- If param2_max is not 0, this is the lower limit of a randomly
7454 -- Upper limit of the randomly selected param2.
7455 -- If absent, the parameter 'param2' is used as a constant.
7458 -- Y offset of the decoration base node relative to the standard base
7460 -- Can be positive or negative. Default is 0.
7461 -- Effect is inverted for "all_ceilings" decorations.
7462 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
7463 -- to the 'place_on' node.
7465 ----- Schematic-type parameters
7467 schematic = "foobar.mts",
7468 -- If schematic is a string, it is the filepath relative to the current
7469 -- working directory of the specified Minetest schematic file.
7470 -- Could also be the ID of a previously registered schematic.
7473 size = {x = 4, y = 6, z = 4},
7475 {name = "default:cobble", param1 = 255, param2 = 0},
7476 {name = "default:dirt_with_grass", param1 = 255, param2 = 0},
7477 {name = "air", param1 = 255, param2 = 0},
7481 {ypos = 2, prob = 128},
7482 {ypos = 5, prob = 64},
7486 -- Alternative schematic specification by supplying a table. The fields
7487 -- size and data are mandatory whereas yslice_prob is optional.
7488 -- See 'Schematic specifier' for details.
7490 replacements = {["oldname"] = "convert_to", ...},
7492 flags = "place_center_x, place_center_y, place_center_z",
7493 -- Flags for schematic decorations. See 'Schematic attributes'.
7496 -- Rotation can be "0", "90", "180", "270", or "random"
7499 -- If the flag 'place_center_y' is set this parameter is ignored.
7500 -- Y offset of the schematic base node layer relative to the 'place_on'
7502 -- Can be positive or negative. Default is 0.
7503 -- Effect is inverted for "all_ceilings" decorations.
7504 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
7505 -- to the 'place_on' node.
7508 Chat command definition
7509 -----------------------
7511 Used by `minetest.register_chatcommand`.
7514 params = "<name> <privilege>", -- Short parameter description
7516 description = "Remove privilege from player", -- Full description
7518 privs = {privs=true}, -- Require the "privs" privilege to run
7520 func = function(name, param),
7521 -- Called when command is run. Returns boolean success and text output.
7524 Note that in params, use of symbols is as follows:
7526 * `<>` signifies a placeholder to be replaced when the command is used. For
7527 example, when a player name is needed: `<name>`
7528 * `[]` signifies param is optional and not required when the command is used.
7529 For example, if you require param1 but param2 is optional:
7530 `<param1> [<param2>]`
7531 * `|` signifies exclusive or. The command requires one param from the options
7532 provided. For example: `<param1> | <param2>`
7533 * `()` signifies grouping. For example, when param1 and param2 are both
7534 required, or only param3 is required: `(<param1> <param2>) | <param3>`
7536 Privilege definition
7537 --------------------
7539 Used by `minetest.register_privilege`.
7543 -- Privilege description
7545 give_to_singleplayer = true,
7546 -- Whether to grant the privilege to singleplayer.
7548 give_to_admin = true,
7549 -- Whether to grant the privilege to the server admin.
7550 -- Uses value of 'give_to_singleplayer' by default.
7552 on_grant = function(name, granter_name),
7553 -- Called when given to player 'name' by 'granter_name'.
7554 -- 'granter_name' will be nil if the priv was granted by a mod.
7556 on_revoke = function(name, revoker_name),
7557 -- Called when taken from player 'name' by 'revoker_name'.
7558 -- 'revoker_name' will be nil if the priv was revoked by a mod.
7560 -- Note that the above two callbacks will be called twice if a player is
7561 -- responsible, once with the player name, and then with a nil player
7563 -- Return true in the above callbacks to stop register_on_priv_grant or
7564 -- revoke being called.
7567 Detached inventory callbacks
7568 ----------------------------
7570 Used by `minetest.create_detached_inventory`.
7573 allow_move = function(inv, from_list, from_index, to_list, to_index, count, player),
7574 -- Called when a player wants to move items inside the inventory.
7575 -- Return value: number of items allowed to move.
7577 allow_put = function(inv, listname, index, stack, player),
7578 -- Called when a player wants to put something into the inventory.
7579 -- Return value: number of items allowed to put.
7580 -- Return value -1: Allow and don't modify item count in inventory.
7582 allow_take = function(inv, listname, index, stack, player),
7583 -- Called when a player wants to take something out of the inventory.
7584 -- Return value: number of items allowed to take.
7585 -- Return value -1: Allow and don't modify item count in inventory.
7587 on_move = function(inv, from_list, from_index, to_list, to_index, count, player),
7588 on_put = function(inv, listname, index, stack, player),
7589 on_take = function(inv, listname, index, stack, player),
7590 -- Called after the actual action has happened, according to what was
7600 Used by `Player:hud_add`. Returned by `Player:hud_get`.
7603 hud_elem_type = "image", -- See HUD element types
7604 -- Type of element, can be "image", "text", "statbar", or "inventory"
7606 position = {x=0.5, y=0.5},
7607 -- Left corner position of element
7611 scale = {x = 2, y = 2},
7618 -- Selected item in inventory. 0 for no item selected.
7621 -- Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
7623 alignment = {x=0, y=0},
7625 offset = {x=0, y=0},
7627 size = { x=100, y=100 },
7628 -- Size of element in pixels
7631 -- Z index : lower z-index HUDs are displayed behind higher z-index HUDs
7637 Used by `minetest.add_particle`.
7640 pos = {x=0, y=0, z=0},
7641 velocity = {x=0, y=0, z=0},
7642 acceleration = {x=0, y=0, z=0},
7643 -- Spawn particle at pos with velocity and acceleration
7646 -- Disappears after expirationtime seconds
7649 -- Scales the visual size of the particle texture.
7651 collisiondetection = false,
7652 -- If true collides with `walkable` nodes and, depending on the
7653 -- `object_collision` field, objects too.
7655 collision_removal = false,
7656 -- If true particle is removed when it collides.
7657 -- Requires collisiondetection = true to have any effect.
7659 object_collision = false,
7660 -- If true particle collides with objects that are defined as
7661 -- `physical = true,` and `collide_with_objects = true,`.
7662 -- Requires collisiondetection = true to have any effect.
7665 -- If true faces player using y axis only
7667 texture = "image.png",
7669 playername = "singleplayer",
7670 -- Optional, if specified spawns particle only on the player's client
7672 animation = {Tile Animation definition},
7673 -- Optional, specifies how to animate the particle texture
7676 -- Optional, specify particle self-luminescence in darkness.
7681 `ParticleSpawner` definition
7682 ----------------------------
7684 Used by `minetest.add_particlespawner`.
7688 -- Number of particles spawned over the time period `time`.
7691 -- Lifespan of spawner in seconds.
7692 -- If time is 0 spawner has infinite lifespan and spawns the `amount` on
7693 -- a per-second basis.
7695 minpos = {x=0, y=0, z=0},
7696 maxpos = {x=0, y=0, z=0},
7697 minvel = {x=0, y=0, z=0},
7698 maxvel = {x=0, y=0, z=0},
7699 minacc = {x=0, y=0, z=0},
7700 maxacc = {x=0, y=0, z=0},
7705 -- The particles' properties are random values between the min and max
7707 -- pos, velocity, acceleration, expirationtime, size
7709 collisiondetection = false,
7710 -- If true collide with `walkable` nodes and, depending on the
7711 -- `object_collision` field, objects too.
7713 collision_removal = false,
7714 -- If true particles are removed when they collide.
7715 -- Requires collisiondetection = true to have any effect.
7717 object_collision = false,
7718 -- If true particles collide with objects that are defined as
7719 -- `physical = true,` and `collide_with_objects = true,`.
7720 -- Requires collisiondetection = true to have any effect.
7722 attached = ObjectRef,
7723 -- If defined, particle positions, velocities and accelerations are
7724 -- relative to this object's position and yaw
7727 -- If true face player using y axis only
7729 texture = "image.png",
7731 playername = "singleplayer",
7732 -- Optional, if specified spawns particles only on the player's client
7734 animation = {Tile Animation definition},
7735 -- Optional, specifies how to animate the particles' texture
7738 -- Optional, specify particle self-luminescence in darkness.
7742 `HTTPRequest` definition
7743 ------------------------
7745 Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
7748 url = "http://example.org",
7751 -- Timeout for connection in seconds. Default is 3 seconds.
7753 post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
7754 -- Optional, if specified a POST request with post_data is performed.
7755 -- Accepts both a string and a table. If a table is specified, encodes
7756 -- table as x-www-form-urlencoded key-value pairs.
7757 -- If post_data is not specified, a GET request is performed instead.
7759 user_agent = "ExampleUserAgent",
7760 -- Optional, if specified replaces the default minetest user agent with
7763 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
7764 -- Optional, if specified adds additional headers to the HTTP request.
7765 -- You must make sure that the header strings follow HTTP specification
7769 -- Optional, if true performs a multipart HTTP request.
7770 -- Default is false.
7773 `HTTPRequestResult` definition
7774 ------------------------------
7776 Passed to `HTTPApiTable.fetch` callback. Returned by
7777 `HTTPApiTable.fetch_async_get`.
7781 -- If true, the request has finished (either succeeded, failed or timed
7785 -- If true, the request was successful
7788 -- If true, the request timed out
7796 Authentication handler definition
7797 ---------------------------------
7799 Used by `minetest.register_authentication_handler`.
7802 get_auth = function(name),
7803 -- Get authentication data for existing player `name` (`nil` if player
7805 -- Returns following structure:
7806 -- `{password=<string>, privileges=<table>, last_login=<number or nil>}`
7808 create_auth = function(name, password),
7809 -- Create new auth data for player `name`.
7810 -- Note that `password` is not plain-text but an arbitrary
7811 -- representation decided by the engine.
7813 delete_auth = function(name),
7814 -- Delete auth data of player `name`.
7815 -- Returns boolean indicating success (false if player is nonexistent).
7817 set_password = function(name, password),
7818 -- Set password of player `name` to `password`.
7819 -- Auth data should be created if not present.
7821 set_privileges = function(name, privileges),
7822 -- Set privileges of player `name`.
7823 -- `privileges` is in table form, auth data should be created if not
7826 reload = function(),
7827 -- Reload authentication data from the storage location.
7828 -- Returns boolean indicating success.
7830 record_login = function(name),
7831 -- Called when player joins, used for keeping track of last_login
7833 iterate = function(),
7834 -- Returns an iterator (use with `for` loops) for all player names
7835 -- currently in the auth database