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 in 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
843 Looped sounds must either be connected to an object or played locationless to
844 one player using `to_player = name,`.
846 A positional sound will only be heard by players that are within
847 `max_hear_distance` of the sound position, at the start of the sound.
852 Specifies a sound name, gain (=volume) and pitch.
853 This is either a string or a table.
855 In string form, you just specify the sound name or
856 the empty string for no sound.
858 Table form has the following fields:
861 * `gain`: Volume (`1.0` = 100%)
862 * `pitch`: Pitch (`1.0` = 100%)
864 `gain` and `pitch` are optional and default to `1.0`.
870 * `"default_place_node"`: Play e.g. `default_place_node.ogg`
871 * `{name = "default_place_node"}`: Same as above
872 * `{name = "default_place_node", gain = 0.5}`: 50% volume
873 * `{name = "default_place_node", gain = 0.9, pitch = 1.1}`: 90% volume, 110% pitch
878 These sound files are played back by the engine if provided.
880 * `player_damage`: Played when the local player takes damage (gain = 0.5)
881 * `player_falling_damage`: Played when the local player takes
882 damage by falling (gain = 0.5)
883 * `default_dig_<groupname>`: Default node digging sound
884 (see node sound definition for details)
886 Registered definitions
887 ======================
889 Anything added using certain [Registration functions] gets added to one or more
890 of the global [Registered definition tables].
892 Note that in some cases you will stumble upon things that are not contained
893 in these tables (e.g. when a mod has been removed). Always check for
894 existence before trying to access the fields.
898 All nodes register with `minetest.register_node` get added to the table
899 `minetest.registered_nodes`.
901 If you want to check the drawtype of a node, you could do:
903 local function get_nodedef_field(nodename, fieldname)
904 if not minetest.registered_nodes[nodename] then
907 return minetest.registered_nodes[nodename][fieldname]
909 local drawtype = get_nodedef_field(nodename, "drawtype")
917 Nodes are the bulk data of the world: cubes and other things that take the
918 space of a cube. Huge amounts of them are handled efficiently, but they
921 The definition of a node is stored and can be accessed by using
923 minetest.registered_nodes[node.name]
925 See [Registered definitions].
927 Nodes are passed by value between Lua and the engine.
928 They are represented by a table:
930 {name="name", param1=num, param2=num}
932 `param1` and `param2` are 8-bit integers ranging from 0 to 255. The engine uses
933 them for certain automated functions. If you don't use these functions, you can
934 use them to store arbitrary values.
939 The functions of `param1` and `param2` are determined by certain fields in the
942 `param1` is reserved for the engine when `paramtype != "none"`:
944 * `paramtype = "light"`
945 * The value stores light with and without sun in its upper and lower 4 bits
947 * Required by a light source node to enable spreading its light.
948 * Required by the following drawtypes as they determine their visual
949 brightness from their internal light value:
960 `param2` is reserved for the engine when any of these are used:
962 * `liquidtype = "flowing"`
963 * The level and some flags of the liquid is stored in `param2`
964 * `drawtype = "flowingliquid"`
965 * The drawn liquid level is read from `param2`
966 * `drawtype = "torchlike"`
967 * `drawtype = "signlike"`
968 * `paramtype2 = "wallmounted"`
969 * The rotation of the node is stored in `param2`. You can make this value
970 by using `minetest.dir_to_wallmounted()`.
971 * `paramtype2 = "facedir"`
972 * The rotation of the node is stored in `param2`. Furnaces and chests are
973 rotated this way. Can be made by using `minetest.dir_to_facedir()`.
974 * Values range 0 - 23
975 * facedir / 4 = axis direction:
976 0 = y+, 1 = z+, 2 = z-, 3 = x+, 4 = x-, 5 = y-
977 * facedir modulo 4 = rotation around that axis
978 * `paramtype2 = "leveled"`
979 * Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
981 * The level of the top face of the nodebox is stored in `param2`.
982 * The other faces are defined by 'fixed = {}' like 'type = "fixed"'
984 * The nodebox height is (`param2` / 64) nodes.
985 * The maximum accepted value of `param2` is 127.
987 * The height of the 'plantlike' section is stored in `param2`.
988 * The height is (`param2` / 16) nodes.
989 * `paramtype2 = "degrotate"`
990 * Only valid for "plantlike". The rotation of the node is stored in
992 * Values range 0 - 179. The value stored in `param2` is multiplied by two to
993 get the actual rotation in degrees of the node.
994 * `paramtype2 = "meshoptions"`
995 * Only valid for "plantlike". The value of `param2` becomes a bitfield which
996 can be used to change how the client draws plantlike nodes.
997 * Bits 0, 1 and 2 form a mesh selector.
998 Currently the following meshes are choosable:
999 * 0 = a "x" shaped plant (ordinary plant)
1000 * 1 = a "+" shaped plant (just rotated 45 degrees)
1001 * 2 = a "*" shaped plant with 3 faces instead of 2
1002 * 3 = a "#" shaped plant with 4 faces instead of 2
1003 * 4 = a "#" shaped plant with 4 faces that lean outwards
1004 * 5-7 are unused and reserved for future meshes.
1005 * Bits 3 through 7 are optional flags that can be combined and give these
1007 * bit 3 (0x08) - Makes the plant slightly vary placement horizontally
1008 * bit 4 (0x10) - Makes the plant mesh 1.4x larger
1009 * bit 5 (0x20) - Moves each face randomly a small bit down (1/8 max)
1010 * bits 6-7 are reserved for future use.
1011 * `paramtype2 = "color"`
1012 * `param2` tells which color is picked from the palette.
1013 The palette should have 256 pixels.
1014 * `paramtype2 = "colorfacedir"`
1015 * Same as `facedir`, but with colors.
1016 * The first three bits of `param2` tells which color is picked from the
1017 palette. The palette should have 8 pixels.
1018 * `paramtype2 = "colorwallmounted"`
1019 * Same as `wallmounted`, but with colors.
1020 * The first five bits of `param2` tells which color is picked from the
1021 palette. The palette should have 32 pixels.
1022 * `paramtype2 = "glasslikeliquidlevel"`
1023 * Only valid for "glasslike_framed" or "glasslike_framed_optional"
1025 * `param2` values 0-63 define 64 levels of internal liquid, 0 being empty
1027 * Liquid texture is defined using `special_tiles = {"modname_tilename.png"}`
1029 Nodes can also contain extra data. See [Node Metadata].
1034 There are a bunch of different looking node types.
1036 Look for examples in `games/minimal` or `games/minetest_game`.
1039 * A node-sized cube.
1041 * Invisible, uses no texture.
1043 * The cubic source node for a liquid.
1045 * The flowing version of a liquid, appears with various heights and slopes.
1047 * Often used for partially-transparent nodes.
1048 * Only external sides of textures are visible.
1049 * `glasslike_framed`
1050 * All face-connected nodes are drawn as one volume within a surrounding
1052 * The frame appearance is generated from the edges of the first texture
1053 specified in `tiles`. The width of the edges used are 1/16th of texture
1054 size: 1 pixel for 16x16, 2 pixels for 32x32 etc.
1055 * The glass 'shine' (or other desired detail) on each node face is supplied
1056 by the second texture specified in `tiles`.
1057 * `glasslike_framed_optional`
1058 * This switches between the above 2 drawtypes according to the menu setting
1061 * Often used for partially-transparent nodes.
1062 * External and internal sides of textures are visible.
1063 * `allfaces_optional`
1064 * Often used for leaves nodes.
1065 * This switches between `normal`, `glasslike` and `allfaces` according to
1066 the menu setting: Opaque Leaves / Simple Leaves / Fancy Leaves.
1067 * With 'Simple Leaves' selected, the texture specified in `special_tiles`
1068 is used instead, if present. This allows a visually thicker texture to be
1069 used to compensate for how `glasslike` reduces visual thickness.
1071 * A single vertical texture.
1072 * If placed on top of a node, uses the first texture specified in `tiles`.
1073 * If placed against the underside of a node, uses the second texture
1074 specified in `tiles`.
1075 * If placed on the side of a node, uses the third texture specified in
1076 `tiles` and is perpendicular to that node.
1078 * A single texture parallel to, and mounted against, the top, underside or
1081 * Two vertical and diagonal textures at right-angles to each other.
1082 * See `paramtype2 = "meshoptions"` above for other options.
1084 * When above a flat surface, appears as 6 textures, the central 2 as
1085 `plantlike` plus 4 more surrounding those.
1086 * If not above a surface the central 2 do not appear, but the texture
1087 appears against the faces of surrounding nodes if they are present.
1089 * A 3D model suitable for a wooden fence.
1090 * One placed node appears as a single vertical post.
1091 * Adjacently-placed nodes cause horizontal bars to appear between them.
1093 * Often used for tracks for mining carts.
1094 * Requires 4 textures to be specified in `tiles`, in order: Straight,
1095 curved, t-junction, crossing.
1096 * Each placed node automatically switches to a suitable rotated texture
1097 determined by the adjacent `raillike` nodes, in order to create a
1098 continuous track network.
1099 * Becomes a sloping node if placed against stepped nodes.
1101 * Often used for stairs and slabs.
1102 * Allows defining nodes consisting of an arbitrary number of boxes.
1103 * See [Node boxes] below for more information.
1105 * Uses models for nodes.
1106 * Tiles should hold model materials textures.
1107 * Only static meshes are implemented.
1108 * For supported model formats see Irrlicht engine documentation.
1109 * `plantlike_rooted`
1110 * Enables underwater `plantlike` without air bubbles around the nodes.
1111 * Consists of a base cube at the co-ordinates of the node plus a
1112 `plantlike` extension above with a height of `param2 / 16` nodes.
1113 * The `plantlike` extension visually passes through any nodes above the
1114 base cube without affecting them.
1115 * The base cube texture tiles are defined as normal, the `plantlike`
1116 extension uses the defined special tile, for example:
1117 `special_tiles = {{name = "default_papyrus.png", tileable_vertical = true}},`
1119 `*_optional` drawtypes need less rendering time if deactivated
1120 (always client-side).
1125 Node selection boxes are defined using "node boxes".
1127 A nodebox is defined as any of:
1130 -- A normal cube; the default in most things
1134 -- A fixed box (or boxes) (facedir param2 is used, if applicable)
1136 fixed = box OR {box1, box2, ...}
1139 -- A variable height box (or boxes) with the top face position defined
1140 -- by the node parameter 'leveled = ', or if 'paramtype2 == "leveled"'
1142 -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
1144 fixed = box OR {box1, box2, ...}
1147 -- A box like the selection box for torches
1148 -- (wallmounted param2 is used, if applicable)
1149 type = "wallmounted",
1155 -- A node that has optional boxes depending on neighbouring nodes'
1156 -- presence and type. See also `connects_to`.
1158 fixed = box OR {box1, box2, ...}
1159 connect_top = box OR {box1, box2, ...}
1160 connect_bottom = box OR {box1, box2, ...}
1161 connect_front = box OR {box1, box2, ...}
1162 connect_left = box OR {box1, box2, ...}
1163 connect_back = box OR {box1, box2, ...}
1164 connect_right = box OR {box1, box2, ...}
1165 -- The following `disconnected_*` boxes are the opposites of the
1166 -- `connect_*` ones above, i.e. when a node has no suitable neighbour
1167 -- on the respective side, the corresponding disconnected box is drawn.
1168 disconnected_top = box OR {box1, box2, ...}
1169 disconnected_bottom = box OR {box1, box2, ...}
1170 disconnected_front = box OR {box1, box2, ...}
1171 disconnected_left = box OR {box1, box2, ...}
1172 disconnected_back = box OR {box1, box2, ...}
1173 disconnected_right = box OR {box1, box2, ...}
1174 disconnected = box OR {box1, box2, ...} -- when there is *no* neighbour
1175 disconnected_sides = box OR {box1, box2, ...} -- when there are *no*
1176 -- neighbours to the sides
1179 A `box` is defined as:
1181 {x1, y1, z1, x2, y2, z2}
1183 A box of a regular node would look like:
1185 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
1190 Map terminology and coordinates
1191 ===============================
1193 Nodes, mapblocks, mapchunks
1194 ---------------------------
1196 A 'node' is the fundamental cubic unit of a world and appears to a player as
1197 roughly 1x1x1 meters in size.
1199 A 'mapblock' (often abbreviated to 'block') is 16x16x16 nodes and is the
1200 fundamental region of a world that is stored in the world database, sent to
1201 clients and handled by many parts of the engine.
1202 'mapblock' is preferred terminology to 'block' to help avoid confusion with
1203 'node', however 'block' often appears in the API.
1205 A 'mapchunk' (sometimes abbreviated to 'chunk') is usually 5x5x5 mapblocks
1206 (80x80x80 nodes) and is the volume of world generated in one operation by
1208 The size in mapblocks has been chosen to optimise map generation.
1213 ### Orientation of axes
1215 For node and mapblock coordinates, +X is East, +Y is up, +Z is North.
1217 ### Node coordinates
1219 Almost all positions used in the API use node coordinates.
1221 ### Mapblock coordinates
1223 Occasionally the API uses 'blockpos' which refers to mapblock coordinates that
1224 specify a particular mapblock.
1225 For example blockpos (0,0,0) specifies the mapblock that extends from
1226 node position (0,0,0) to node position (15,15,15).
1228 #### Converting node position to the containing blockpos
1230 To calculate the blockpos of the mapblock that contains the node at 'nodepos',
1233 * blockpos = math.floor(nodepos / 16)
1235 #### Converting blockpos to min/max node positions
1237 To calculate the min/max node positions contained in the mapblock at 'blockpos',
1241 nodepos = blockpos * 16
1243 nodepos = blockpos * 16 + 15
1254 The position field is used for all element types.
1256 To account for differing resolutions, the position coordinates are the
1257 percentage of the screen, ranging in value from `0` to `1`.
1259 The name field is not yet used, but should contain a description of what the
1260 HUD element represents. The direction field is the direction in which something
1263 `0` draws from left to right, `1` draws from right to left, `2` draws from
1264 top to bottom, and `3` draws from bottom to top.
1266 The `alignment` field specifies how the item will be aligned. It is a table
1267 where `x` and `y` range from `-1` to `1`, with `0` being central. `-1` is
1268 moved to the left/up, and `1` is to the right/down. Fractional values can be
1271 The `offset` field specifies a pixel offset from the position. Contrary to
1272 position, the offset is not scaled to screen size. This allows for some
1273 precisely positioned items in the HUD.
1275 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
1278 The `z_index` field specifies the order of HUD elements from back to front.
1279 Lower z-index elements are displayed behind higher z-index elements. Elements
1280 with same z-index are displayed in an arbitrary order. Default 0.
1281 Supports negative values.
1283 Below are the specific uses for fields in each type; fields not listed for that
1288 Displays an image on the HUD.
1290 * `scale`: The scale of the image, with 1 being the original texture size.
1291 Only the X coordinate scale is used (positive values).
1292 Negative values represent that percentage of the screen it
1293 should take; e.g. `x=-100` means 100% (width).
1294 * `text`: The name of the texture that is displayed.
1295 * `alignment`: The alignment of the image.
1296 * `offset`: offset in pixels from position.
1300 Displays text on the HUD.
1302 * `scale`: Defines the bounding rectangle of the text.
1303 A value such as `{x=100, y=100}` should work.
1304 * `text`: The text to be displayed in the HUD element.
1305 * `number`: An integer containing the RGB value of the color used to draw the
1306 text. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1307 * `alignment`: The alignment of the text.
1308 * `offset`: offset in pixels from position.
1312 Displays a horizontal bar made up of half-images.
1314 * `text`: The name of the texture that is used.
1315 * `number`: The number of half-textures that are displayed.
1316 If odd, will end with a vertically center-split texture.
1318 * `offset`: offset in pixels from position.
1319 * `size`: If used, will force full-image size to this value (override texture
1324 * `text`: The name of the inventory list to be displayed.
1325 * `number`: Number of items in the inventory to be displayed.
1326 * `item`: Position of item that is selected.
1328 * `offset`: offset in pixels from position.
1332 Displays distance to selected world position.
1334 * `name`: The name of the waypoint.
1335 * `text`: Distance suffix. Can be blank.
1336 * `number:` An integer containing the RGB value of the color used to draw the
1338 * `world_pos`: World position of the waypoint.
1343 Representations of simple things
1344 ================================
1349 {x=num, y=num, z=num}
1351 For helper functions see [Spatial Vectors].
1356 * `{type="nothing"}`
1357 * `{type="node", under=pos, above=pos}`
1358 * Indicates a pointed node selection box.
1359 * `under` refers to the node position behind the pointed face.
1360 * `above` refers to the node position in front of the pointed face.
1361 * `{type="object", ref=ObjectRef}`
1363 Exact pointing location (currently only `Raycast` supports these fields):
1365 * `pointed_thing.intersection_point`: The absolute world coordinates of the
1366 point on the selection box which is pointed at. May be in the selection box
1367 if the pointer is in the box too.
1368 * `pointed_thing.box_id`: The ID of the pointed selection box (counting starts
1370 * `pointed_thing.intersection_normal`: Unit vector, points outwards of the
1371 selected selection box. This specifies which face is pointed at.
1372 Is a null vector `{x = 0, y = 0, z = 0}` when the pointer is inside the
1378 Flag Specifier Format
1379 =====================
1381 Flags using the standardized flag specifier format can be specified in either
1382 of two ways, by string or table.
1384 The string format is a comma-delimited set of flag names; whitespace and
1385 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1386 flag, and specifying a flag prefixed by the string `"no"` explicitly
1387 clears the flag from whatever the default may be.
1389 In addition to the standard string flag format, the schematic flags field can
1390 also be a table of flag names to boolean values representing whether or not the
1391 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1392 is present, mapped to a boolean of any value, the specified flag is unset.
1394 E.g. A flag field of value
1396 {place_center_x = true, place_center_y=false, place_center_z=true}
1400 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1402 which is equivalent to
1404 "place_center_x, noplace_center_y, place_center_z"
1408 "place_center_x, place_center_z"
1410 since, by default, no schematic attributes are set.
1421 There are three kinds of items: nodes, tools and craftitems.
1423 * Node: Can be placed in the world's voxel grid
1424 * Tool: Has a wear property but cannot be stacked. The default use action is to
1425 dig nodes or hit objects according to its tool capabilities.
1426 * Craftitem: Cannot dig nodes or be placed
1431 All item stacks have an amount between 0 and 65535. It is 1 by
1432 default. Tool item stacks can not have an amount greater than 1.
1434 Tools use a wear (damage) value ranging from 0 to 65535. The
1435 value 0 is the default and is used for unworn tools. The values
1436 1 to 65535 are used for worn tools, where a higher value stands for
1437 a higher wear. Non-tools always have a wear value of 0.
1442 Items and item stacks can exist in three formats: Serializes, table format
1445 When an item must be passed to a function, it can usually be in any of
1450 This is called "stackstring" or "itemstring". It is a simple string with
1451 1-3 components: the full item identifier, an optional amount and an optional
1454 <identifier> [<amount>[ <wear>]]
1458 * `'default:apple'`: 1 apple
1459 * `'default:dirt 5'`: 5 dirt
1460 * `'default:pick_stone'`: a new stone pickaxe
1461 * `'default:pick_wood 1 21323'`: a wooden pickaxe, ca. 1/3 worn out
1469 {name="default:dirt", count=5, wear=0, metadata=""}
1471 A wooden pick about 1/3 worn out:
1473 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1477 {name="default:apple", count=1, wear=0, metadata=""}
1481 A native C++ format with many helper methods. Useful for converting
1482 between formats. See the [Class reference] section for details.
1490 In a number of places, there is a group table. Groups define the
1491 properties of a thing (item, node, armor of entity, capabilities of
1492 tool) in such a way that the engine and other mods can can interact with
1493 the thing without actually knowing what the thing is.
1498 Groups are stored in a table, having the group names with keys and the
1499 group ratings as values. Group ratings are integer values within the
1500 range [-32767, 32767]. For example:
1503 groups = {crumbly=3, soil=1}
1505 -- A more special dirt-kind of thing
1506 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1508 Groups always have a rating associated with them. If there is no
1509 useful meaning for a rating for an enabled group, it shall be `1`.
1511 When not defined, the rating of a group defaults to `0`. Thus when you
1512 read groups, you must interpret `nil` and `0` as the same value, `0`.
1514 You can read the rating of a group for an item or a node by using
1516 minetest.get_item_group(itemname, groupname)
1521 Groups of items can define what kind of an item it is (e.g. wool).
1526 In addition to the general item things, groups are used to define whether
1527 a node is destroyable and how long it takes to destroy by a tool.
1532 For entities, groups are, as of now, used only for calculating damage.
1533 The rating is the percentage of damage caused by tools with this damage group.
1534 See [Entity damage mechanism].
1536 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1537 object.set_armor_groups({fleshy=30, cracky=80})
1542 Groups in tools define which groups of nodes and entities they are
1545 Groups in crafting recipes
1546 --------------------------
1548 An example: Make meat soup from any meat, any water and any bowl:
1551 output = 'food:meat_soup_raw',
1557 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1560 Another example: Make red wool from white wool and red dye:
1564 output = 'wool:red',
1565 recipe = {'wool:white', 'group:dye,basecolor_red'},
1571 The asterisk `(*)` after a group name describes that there is no engine
1572 functionality bound to it, and implementation is left up as a suggestion
1575 ### Node, item and tool groups
1577 * `not_in_creative_inventory`: (*) Special group for inventory mods to indicate
1578 that the item should be hidden in item lists.
1581 ### Node-only groups
1583 * `attached_node`: if the node under it is not a walkable block the node will be
1584 dropped as an item. If the node is wallmounted the wallmounted direction is
1586 * `bouncy`: value is bounce speed in percent
1587 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1588 connect to each other
1589 * `dig_immediate`: Player can always pick up node without reducing tool wear
1590 * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
1591 * `3`: the node always gets the digging time 0 seconds (torch)
1592 * `disable_jump`: Player (and possibly other things) cannot jump from node
1593 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1594 * `falling_node`: if there is no walkable block under the node it will fall
1595 * `float`: the node will not fall through liquids
1596 * `level`: Can be used to give an additional sense of progression in the game.
1597 * A larger level will cause e.g. a weapon of a lower level make much less
1598 damage, and get worn out much faster, or not be able to get drops
1599 from destroyed nodes.
1600 * `0` is something that is directly accessible at the start of gameplay
1601 * There is no upper limit
1602 * See also: `leveldiff` in [Tools]
1603 * `slippery`: Players and items will slide on the node.
1604 Slipperiness rises steadily with `slippery` value, starting at 1.
1607 ### Tool-only groups
1609 * `disable_repair`: If set to 1 for a tool, it cannot be repaired using the
1610 `"toolrepair"` crafting recipe
1613 ### `ObjectRef` groups
1615 * `immortal`: Skips all damage and breath handling for an object. This group
1616 will also hide the integrated HUD status bars for players, and is
1617 automatically set to all players when damage is disabled on the server.
1618 * `punch_operable`: For entities; disables the regular damage mechanism for
1619 players punching it by hand or a non-tool item, so that it can do something
1620 else than take damage.
1624 Known damage and digging time defining groups
1625 ---------------------------------------------
1627 * `crumbly`: dirt, sand
1628 * `cracky`: tough but crackable stuff like stone.
1629 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1630 plants, wire, sheets of metal
1631 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1632 * `fleshy`: Living things like animals and the player. This could imply
1633 some blood effects when hitting.
1634 * `explody`: Especially prone to explosions
1635 * `oddly_breakable_by_hand`:
1636 Can be added to nodes that shouldn't logically be breakable by the
1637 hand but are. Somewhat similar to `dig_immediate`, but times are more
1638 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1639 speed of a tool if the tool can dig at a faster speed than this
1640 suggests for the hand.
1642 Examples of custom groups
1643 -------------------------
1645 Item groups are often used for defining, well, _groups of items_.
1647 * `meat`: any meat-kind of a thing (rating might define the size or healing
1648 ability or be irrelevant -- it is not defined as of yet)
1649 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1651 * `flammable`: can be set on fire. Rating might define the intensity of the
1652 fire, affecting e.g. the speed of the spreading of an open fire.
1653 * `wool`: any wool (any origin, any color)
1654 * `metal`: any metal
1655 * `weapon`: any weapon
1656 * `heavy`: anything considerably heavy
1658 Digging time calculation specifics
1659 ----------------------------------
1661 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1662 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1663 faster digging time.
1665 The `level` group is used to limit the toughness of nodes a tool can dig
1666 and to scale the digging times / damage to a greater extent.
1668 **Please do understand this**, otherwise you cannot use the system to it's
1671 Tools define their properties by a list of parameters for groups. They
1672 cannot dig other groups; thus it is important to use a standard bunch of
1673 groups to enable interaction with tools.
1686 * Full punch interval
1687 * Maximum drop level
1688 * For an arbitrary list of groups:
1689 * Uses (until the tool breaks)
1690 * Maximum level (usually `0`, `1`, `2` or `3`)
1694 ### Full punch interval
1696 When used as a weapon, the tool will do full damage if this time is spent
1697 between punches. If e.g. half the time is spent, the tool will do half
1700 ### Maximum drop level
1702 Suggests the maximum level of node, when dug with the tool, that will drop
1703 it's useful item. (e.g. iron ore to drop a lump of iron).
1705 This is not automated; it is the responsibility of the node definition
1710 Determines how many uses the tool has when it is used for digging a node,
1711 of this group, of the maximum level. For lower leveled nodes, the use count
1712 is multiplied by `3^leveldiff`.
1713 `leveldiff` is the difference of the tool's `maxlevel` `groupcaps` and the
1714 node's `level` group. The node cannot be dug if `leveldiff` is less than zero.
1716 * `uses=10, leveldiff=0`: actual uses: 10
1717 * `uses=10, leveldiff=1`: actual uses: 30
1718 * `uses=10, leveldiff=2`: actual uses: 90
1722 Tells what is the maximum level of a node of this group that the tool will
1727 List of digging times for different ratings of the group, for nodes of the
1730 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1731 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1732 for this group, and unable to dig the rating `1`, which is the toughest.
1733 Unless there is a matching group that enables digging otherwise.
1735 If the result digging time is 0, a delay of 0.15 seconds is added between
1736 digging nodes; If the player releases LMB after digging, this delay is set to 0,
1737 i.e. players can more quickly click the nodes away instead of holding LMB.
1741 List of damage for groups of entities. See [Entity damage mechanism].
1743 Example definition of the capabilities of a tool
1744 ------------------------------------------------
1746 tool_capabilities = {
1747 full_punch_interval=1.5,
1750 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1752 damage_groups = {fleshy=2},
1755 This makes the tool be able to dig nodes that fulfil both of these:
1757 * Have the `crumbly` group
1758 * Have a `level` group less or equal to `2`
1760 Table of resulting digging times:
1762 crumbly 0 1 2 3 4 <- level
1764 1 0.80 1.60 1.60 - -
1765 2 0.60 1.20 1.20 - -
1766 3 0.40 0.80 0.80 - -
1768 level diff: 2 1 0 -1 -2
1770 Table of resulting tool uses:
1779 * At `crumbly==0`, the node is not diggable.
1780 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1781 easy nodes to be quickly breakable.
1782 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1787 Entity damage mechanism
1788 =======================
1793 foreach group in cap.damage_groups:
1794 damage += cap.damage_groups[group]
1795 * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
1796 * (object.armor_groups[group] / 100.0)
1797 -- Where object.armor_groups[group] is 0 for inexistent values
1800 Client predicts damage based on damage groups. Because of this, it is able to
1801 give an immediate response when an entity is damaged or dies; the response is
1802 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1804 Currently a smoke puff will appear when an entity dies.
1806 The group `immortal` completely disables normal damage.
1808 Entities can define a special armor group, which is `punch_operable`. This
1809 group disables the regular damage mechanism for players punching it by hand or
1810 a non-tool item, so that it can do something else than take damage.
1812 On the Lua side, every punch calls:
1814 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction,
1817 This should never be called directly, because damage is usually not handled by
1820 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1821 accessed unless absolutely required, to encourage interoperability.
1822 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1823 * `tool_capabilities` can be `nil`.
1824 * `direction` is a unit vector, pointing from the source of the punch to
1826 * `damage` damage that will be done to entity
1827 Return value of this function will determine if damage is done by this function
1828 (retval true) or shall be done by engine (retval false)
1830 To punch an entity/object in Lua, call:
1832 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1834 * Return value is tool wear.
1835 * Parameters are equal to the above callback.
1836 * If `direction` equals `nil` and `puncher` does not equal `nil`, `direction`
1837 will be automatically filled in based on the location of `puncher`.
1848 The instance of a node in the world normally only contains the three values
1849 mentioned in [Nodes]. However, it is possible to insert extra data into a node.
1850 It is called "node metadata"; See `NodeMetaRef`.
1852 Node metadata contains two things:
1857 Some of the values in the key-value store are handled specially:
1859 * `formspec`: Defines a right-click inventory menu. See [Formspec].
1860 * `infotext`: Text shown on the screen when the node is pointed at
1864 local meta = minetest.get_meta(pos)
1865 meta:set_string("formspec",
1867 "list[context;main;0,0;8,4;]"..
1868 "list[current_player;main;0,5;8,4;]")
1869 meta:set_string("infotext", "Chest");
1870 local inv = meta:get_inventory()
1871 inv:set_size("main", 8*4)
1872 print(dump(meta:to_table()))
1875 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1876 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1877 [10] = "", [11] = "", [12] = "", [13] = "",
1878 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1879 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1880 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1881 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1885 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1893 Item stacks can store metadata too. See [`ItemStackMetaRef`].
1895 Item metadata only contains a key-value store.
1897 Some of the values in the key-value store are handled specially:
1899 * `description`: Set the item stack's description. Defaults to
1901 * `color`: A `ColorString`, which sets the stack's color.
1902 * `palette_index`: If the item has a palette, this is used to get the
1903 current color from the palette.
1907 local meta = stack:get_meta()
1908 meta:set_string("key", "value")
1909 print(dump(meta:to_table()))
1917 Formspec defines a menu. This supports inventories and some of the
1918 typical widgets like buttons, checkboxes, text input fields, etc.
1919 It is a string, with a somewhat strange format.
1921 A formspec is made out of formspec elements, which includes widgets
1922 like buttons but also can be used to set stuff like background color.
1924 Many formspec elements have a `name`, which is a unique identifier which
1925 is used when the server receives user input. You must not use the name
1926 "quit" for formspec elements.
1928 Spaces and newlines can be inserted between the blocks, as is used in the
1931 Position and size units are inventory slots unless the new coordinate system
1932 is enabled. `X` and `Y` position the formspec element relative to the top left
1933 of the menu or container. `W` and `H` are its width and height values.
1935 If the new system is enabled, all elements have unified coordinates for all
1936 elements with no padding or spacing in between. This is highly recommended
1937 for new forms. See `real_coordinates[<bool>]` and `Migrating to Real
1940 Inventories with a `player:<name>` inventory location are only sent to the
1941 player named `<name>`.
1943 When displaying text which can contain formspec code, e.g. text set by a player,
1944 use `minetest.formspec_escape`.
1945 For coloured text you can use `minetest.colorize`.
1947 Since formspec version 3, elements drawn in the order they are defined. All
1948 background elements are drawn before all other elements.
1949 `list` elements are an exception here. They are drawn last. This, however, might
1950 be changed at any time.
1952 **WARNING**: do _not_ use a element name starting with `key_`; those names are
1953 reserved to pass key press events to formspec!
1955 **WARNING**: Minetest allows you to add elements to every single formspec instance
1956 using `player:set_formspec_prepend()`, which may be the reason backgrounds are
1957 appearing when you don't expect them to, or why things are styled differently
1958 to normal. See [`no_prepend[]`] and [Styling Formspecs].
1966 list[context;main;0,0;8,4;]
1967 list[current_player;main;0,5;8,4;]
1972 list[context;fuel;2,3;1,1;]
1973 list[context;src;2,1;1,1;]
1974 list[context;dst;5,1;2,2;]
1975 list[current_player;main;0,5;8,4;]
1977 ### Minecraft-like player inventory
1980 image[1,0.6;1,2;player.png]
1981 list[current_player;main;0,3.5;8,4;]
1982 list[current_player;craft;3,0;3,3;]
1983 list[current_player;craftpreview;7,1;1,1;]
1988 ### `formspec_version[<version>]`
1990 * Set the formspec version to a certain number. If not specified,
1991 version 1 is assumed.
1992 * Must be specified before `size` element.
1993 * Clients older than this version can neither show newer elements nor display
1994 elements with new arguments correctly.
1995 * Available since feature `formspec_version_element`.
1997 ### `size[<W>,<H>,<fixed_size>]`
1999 * Define the size of the menu in inventory slots
2000 * `fixed_size`: `true`/`false` (optional)
2001 * deprecated: `invsize[<W>,<H>;]`
2003 ### `position[<X>,<Y>]`
2005 * Must be used after `size` element.
2006 * Defines the position on the game window of the formspec's `anchor` point.
2007 * For X and Y, 0.0 and 1.0 represent opposite edges of the game window,
2009 * [0.0, 0.0] sets the position to the top left corner of the game window.
2010 * [1.0, 1.0] sets the position to the bottom right of the game window.
2011 * Defaults to the center of the game window [0.5, 0.5].
2013 ### `anchor[<X>,<Y>]`
2015 * Must be used after both `size` and `position` (if present) elements.
2016 * Defines the location of the anchor point within the formspec.
2017 * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec,
2019 * [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
2020 * [1.0, 0.0] sets the anchor to the top right of the formspec.
2021 * Defaults to the center of the formspec [0.5, 0.5].
2023 * `position` and `anchor` elements need suitable values to avoid a formspec
2024 extending off the game window due to particular game window sizes.
2028 * Must be used after the `size`, `position`, and `anchor` elements (if present).
2029 * Disables player:set_formspec_prepend() from applying to this formspec.
2031 ### `real_coordinates[<bool>]`
2033 * INFORMATION: Enable it automatically using `formspec_version` version 2 or newer.
2034 * When set to true, all following formspec elements will use the new coordinate system.
2035 * If used immediately after `size`, `position`, `anchor`, and `no_prepend` elements
2036 (if present), the form size will use the new coordinate system.
2037 * **Note**: Formspec prepends are not affected by the coordinates in the main form.
2038 They must enable it explicitly.
2039 * For information on converting forms to the new coordinate system, see `Migrating
2040 to Real Coordinates`.
2042 ### `container[<X>,<Y>]`
2044 * Start of a container block, moves all physical elements in the container by
2046 * Must have matching `container_end`
2047 * Containers can be nested, in which case the offsets are added
2048 (child containers are relative to parent containers)
2050 ### `container_end[]`
2052 * End of a container, following elements are no longer relative to this
2055 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
2057 * Show an inventory list if it has been sent to the client. Nothing will
2058 be shown if the inventory list is of size 0.
2059 * **Note**: With the new coordinate system, the spacing between inventory
2060 slots is one-fourth the size of an inventory slot.
2061 * **Note**: Lists are drawn after every other element. This might change at any time.
2063 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
2065 * Show an inventory list if it has been sent to the client. Nothing will
2066 be shown if the inventory list is of size 0.
2067 * **Note**: With the new coordinate system, the spacing between inventory
2068 slots is one-fourth the size of an inventory slot.
2069 * **Note**: Lists are drawn after every other element. This might change at any time.
2071 ### `listring[<inventory location>;<list name>]`
2073 * Allows to create a ring of inventory lists
2074 * Shift-clicking on items in one element of the ring
2075 will send them to the next inventory list inside the ring
2076 * The first occurrence of an element inside the ring will
2077 determine the inventory where items will be sent to
2081 * Shorthand for doing `listring[<inventory location>;<list name>]`
2082 for the last two inventory lists added by list[...]
2084 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
2086 * Sets background color of slots as `ColorString`
2087 * Sets background color of slots on mouse hovering
2089 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
2091 * Sets background color of slots as `ColorString`
2092 * Sets background color of slots on mouse hovering
2093 * Sets color of slots border
2095 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
2097 * Sets background color of slots as `ColorString`
2098 * Sets background color of slots on mouse hovering
2099 * Sets color of slots border
2100 * Sets default background color of tooltips
2101 * Sets default font color of tooltips
2103 ### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2105 * Adds tooltip for an element
2106 * `<bgcolor>` tooltip background color as `ColorString` (optional)
2107 * `<fontcolor>` tooltip font color as `ColorString` (optional)
2109 ### `tooltip[<X>,<Y>;<W>,<H>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2111 * Adds tooltip for an area. Other tooltips will take priority when present.
2112 * `<bgcolor>` tooltip background color as `ColorString` (optional)
2113 * `<fontcolor>` tooltip font color as `ColorString` (optional)
2115 ### `image[<X>,<Y>;<W>,<H>;<texture name>]`
2119 ### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
2121 * Show an inventory image of registered item/node
2123 ### `bgcolor[<bgcolor>;<fullscreen>;<fbgcolor>]`
2125 * Sets background color of formspec.
2126 * `bgcolor` and `fbgcolor` (optional) are `ColorString`s, they define the color
2127 of the non-fullscreen and the fullscreen background.
2128 * `fullscreen` (optional) can be one of the following:
2129 * `false`: Only the non-fullscreen background color is drawn. (default)
2130 * `true`: Only the fullscreen background color is drawn.
2131 * `both`: The non-fullscreen and the fullscreen background color are drawn.
2132 * `neither`: No background color is drawn.
2133 * Note: Leave a parameter empty to not modify the value.
2134 * Note: `fbgcolor`, leaving parameters empty and values for `fullscreen` that
2135 are not bools are only available since formspec version 3.
2137 ### `background[<X>,<Y>;<W>,<H>;<texture name>]`
2139 * Example for formspec 8x4 in 16x resolution: image shall be sized
2140 8 times 16px times 4 times 16px.
2142 ### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
2144 * Example for formspec 8x4 in 16x resolution:
2145 image shall be sized 8 times 16px times 4 times 16px
2146 * If `auto_clip` is `true`, the background is clipped to the formspec size
2147 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2149 ### `background9[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>;<middle>]`
2151 * 9-sliced background. See https://en.wikipedia.org/wiki/9-slice_scaling
2152 * Middle is a rect which defines the middle of the 9-slice.
2153 * `x` - The middle will be x pixels from all sides.
2154 * `x,y` - The middle will be x pixels from the horizontal and y from the vertical.
2155 * `x,y,x2,y2` - The middle will start at x,y, and end at x2, y2. Negative x2 and y2 values
2156 will be added to the width and height of the texture, allowing it to be used as the
2157 distance from the far end.
2158 * All numbers in middle are integers.
2159 * Example for formspec 8x4 in 16x resolution:
2160 image shall be sized 8 times 16px times 4 times 16px
2161 * If `auto_clip` is `true`, the background is clipped to the formspec size
2162 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2163 * Available since formspec version 2
2165 ### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
2167 * Textual password style field; will be sent to server when a button is clicked
2168 * When enter is pressed in field, fields.key_enter_field will be sent with the
2170 * With the old coordinate system, fields are a set height, but will be vertically
2171 centred on `H`. With the new coordinate system, `H` will modify the height.
2172 * `name` is the name of the field as returned in fields to `on_receive_fields`
2173 * `label`, if not blank, will be text printed on the top left above the field
2174 * See `field_close_on_enter` to stop enter closing the formspec
2176 ### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2178 * Textual field; will be sent to server when a button is clicked
2179 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2180 the name of this field.
2181 * With the old coordinate system, fields are a set height, but will be vertically
2182 centred on `H`. With the new coordinate system, `H` will modify the height.
2183 * `name` is the name of the field as returned in fields to `on_receive_fields`
2184 * `label`, if not blank, will be text printed on the top left above the field
2185 * `default` is the default value of the field
2186 * `default` may contain variable references such as `${text}` which
2187 will fill the value from the metadata value `text`
2188 * **Note**: no extra text or more than a single variable is supported ATM.
2189 * See `field_close_on_enter` to stop enter closing the formspec
2191 ### `field[<name>;<label>;<default>]`
2193 * As above, but without position/size units
2194 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2195 the name of this field.
2196 * Special field for creating simple forms, such as sign text input
2197 * Must be used without a `size[]` element
2198 * A "Proceed" button will be added automatically
2199 * See `field_close_on_enter` to stop enter closing the formspec
2201 ### `field_close_on_enter[<name>;<close_on_enter>]`
2203 * <name> is the name of the field
2204 * if <close_on_enter> is false, pressing enter in the field will submit the
2205 form but not close it.
2206 * defaults to true when not specified (ie: no tag for a field)
2208 ### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2210 * Same as fields above, but with multi-line input
2211 * If the text overflows, a vertical scrollbar is added.
2212 * If the name is empty, the textarea is read-only and
2213 the background is not shown, which corresponds to a multi-line label.
2215 ### `label[<X>,<Y>;<label>]`
2217 * The label formspec element displays the text set in `label`
2218 at the specified position.
2219 * **Note**: If the new coordinate system is enabled, labels are
2220 positioned from the center of the text, not the top.
2221 * The text is displayed directly without automatic line breaking,
2222 so label should not be used for big text chunks. Newlines can be
2223 used to make labels multiline.
2224 * **Note**: With the new coordinate system, newlines are spaced with
2225 half a coordinate. With the old system, newlines are spaced 2/5 of
2228 ### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]`
2229 * Displays a static formated text with hyperlinks.
2230 * `x`, `y`, `w` and `h` work as per field
2231 * `name` is the name of the field as returned in fields to `on_receive_fields` in case of action in text.
2232 * `text` is the formatted text using `markup language` described below.
2234 ### `vertlabel[<X>,<Y>;<label>]`
2235 * Textual label drawn vertically
2236 * `label` is the text on the label
2237 * **Note**: If the new coordinate system is enabled, vertlabels are
2238 positioned from the center of the text, not the left.
2240 ### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
2242 * Clickable button. When clicked, fields will be sent.
2243 * With the old coordinate system, buttons are a set height, but will be vertically
2244 centred on `H`. With the new coordinate system, `H` will modify the height.
2245 * `label` is the text on the button
2247 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2249 * `texture name` is the filename of an image
2250 * **Note**: Height is supported on both the old and new coordinate systems
2253 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
2255 * `texture name` is the filename of an image
2256 * `noclip=true` means the image button doesn't need to be within specified
2258 * `drawborder`: draw button border or not
2259 * `pressed texture name` is the filename of an image on pressed state
2261 ### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
2263 * `item name` is the registered name of an item/node
2264 * The item description will be used as the tooltip. This can be overridden with
2267 ### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
2269 * When clicked, fields will be sent and the form will quit.
2270 * Same as `button` in all other respects.
2272 ### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2274 * When clicked, fields will be sent and the form will quit.
2275 * Same as `image_button` in all other respects.
2277 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
2279 * Scrollable item list showing arbitrary text elements
2280 * `name` fieldname sent to server on doubleclick value is current selected
2282 * `listelements` can be prepended by #color in hexadecimal format RRGGBB
2284 * if you want a listelement to start with "#" write "##".
2286 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
2288 * Scrollable itemlist showing arbitrary text elements
2289 * `name` fieldname sent to server on doubleclick value is current selected
2291 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
2292 * if you want a listelement to start with "#" write "##"
2293 * Index to be selected within textlist
2294 * `true`/`false`: draw transparent background
2295 * See also `minetest.explode_textlist_event`
2296 (main menu: `core.explode_textlist_event`).
2298 ### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2300 * Show a tab**header** at specific position (ignores formsize)
2301 * `X` and `Y`: position of the tabheader
2302 * *Note*: Width and height are automatically chosen with this syntax
2303 * `name` fieldname data is transferred to Lua
2304 * `caption 1`...: name shown on top of tab
2305 * `current_tab`: index of selected tab 1...
2306 * `transparent` (optional): show transparent
2307 * `draw_border` (optional): draw border
2309 ### `tabheader[<X>,<Y>;<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2311 * Show a tab**header** at specific position (ignores formsize)
2312 * **Important note**: This syntax for tabheaders can only be used with the
2313 new coordinate system.
2314 * `X` and `Y`: position of the tabheader
2315 * `H`: height of the tabheader. Width is automatically determined with this syntax.
2316 * `name` fieldname data is transferred to Lua
2317 * `caption 1`...: name shown on top of tab
2318 * `current_tab`: index of selected tab 1...
2319 * `transparent` (optional): show transparent
2320 * `draw_border` (optional): draw border
2322 ### `tabheader[<X>,<Y>;<W>,<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2324 * Show a tab**header** at specific position (ignores formsize)
2325 * **Important note**: This syntax for tabheaders can only be used with the
2326 new coordinate system.
2327 * `X` and `Y`: position of the tabheader
2328 * `W` and `H`: width and height of the tabheader
2329 * `name` fieldname data is transferred to Lua
2330 * `caption 1`...: name shown on top of tab
2331 * `current_tab`: index of selected tab 1...
2332 * `transparent` (optional): show transparent
2333 * `draw_border` (optional): draw border
2335 ### `box[<X>,<Y>;<W>,<H>;<color>]`
2337 * Simple colored box
2338 * `color` is color specified as a `ColorString`.
2339 If the alpha component is left blank, the box will be semitransparent.
2341 ### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
2343 * Show a dropdown field
2344 * **Important note**: There are two different operation modes:
2345 1. handle directly on change (only changed dropdown is submitted)
2346 2. read the value on pressing a button (all dropdown values are available)
2347 * `X` and `Y`: position of the dropdown
2348 * `W`: width of the dropdown. Height is automatically chosen with this syntax.
2349 * Fieldname data is transferred to Lua
2350 * Items to be shown in dropdown
2351 * Index of currently selected dropdown item
2353 ### `dropdown[<X>,<Y>;<W>,<H>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
2355 * Show a dropdown field
2356 * **Important note**: This syntax for dropdowns can only be used with the
2357 new coordinate system.
2358 * **Important note**: There are two different operation modes:
2359 1. handle directly on change (only changed dropdown is submitted)
2360 2. read the value on pressing a button (all dropdown values are available)
2361 * `X` and `Y`: position of the dropdown
2362 * `W` and `H`: width and height of the dropdown
2363 * Fieldname data is transferred to Lua
2364 * Items to be shown in dropdown
2365 * Index of currently selected dropdown item
2367 ### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
2370 * `name` fieldname data is transferred to Lua
2371 * `label` to be shown left of checkbox
2372 * `selected` (optional): `true`/`false`
2373 * **Note**: If the new coordinate system is enabled, checkboxes are
2374 positioned from the center of the checkbox, not the top.
2376 ### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
2378 * Show a scrollbar using options defined by the previous `scrollbaroptions[]`
2379 * There are two ways to use it:
2380 1. handle the changed event (only changed scrollbar is available)
2381 2. read the value on pressing a button (all scrollbars are available)
2382 * `orientation`: `vertical`/`horizontal`
2383 * Fieldname data is transferred to Lua
2384 * Value of this trackbar is set to (`0`-`1000`) by default
2385 * See also `minetest.explode_scrollbar_event`
2386 (main menu: `core.explode_scrollbar_event`).
2388 ### `scrollbaroptions[opt1;opt2;...]`
2389 * Sets options for all following `scrollbar[]` elements
2391 * Sets scrollbar minimum value, defaults to `0`.
2393 * Sets scrollbar maximum value, defaults to `1000`.
2394 If the max is equal to the min, the scrollbar will be disabled.
2396 * Sets scrollbar step value when the arrows are clicked or the mouse wheel is
2398 * If this is set to a negative number, the value will be reset to `10`.
2400 * Sets scrollbar step value used by page up and page down.
2401 * If this is set to a negative number, the value will be reset to `100`.
2403 * Sets size of the thumb on the scrollbar. Size is calculated in the number of
2404 units the thumb spans out of the range of the scrollbar values.
2405 * Example: If a scrollbar has a `min` of 1 and a `max` of 100, a thumbsize of 10
2406 would span a tenth of the scrollbar space.
2407 * If this is set to zero or less, the value will be reset to `1`.
2408 * `arrows=<show/hide/default>`
2409 * Whether to show the arrow buttons on the scrollbar. `default` hides the arrows
2410 when the scrollbar gets too small, but shows them otherwise.
2412 ### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
2414 * Show scrollable table using options defined by the previous `tableoptions[]`
2415 * Displays cells as defined by the previous `tablecolumns[]`
2416 * `name`: fieldname sent to server on row select or doubleclick
2417 * `cell 1`...`cell n`: cell contents given in row-major order
2418 * `selected idx`: index of row to be selected within table (first row = `1`)
2419 * See also `minetest.explode_table_event`
2420 (main menu: `core.explode_table_event`).
2422 ### `tableoptions[<opt 1>;<opt 2>;...]`
2424 * Sets options for `table[]`
2426 * default text color (`ColorString`), defaults to `#FFFFFF`
2427 * `background=#RRGGBB`
2428 * table background color (`ColorString`), defaults to `#000000`
2429 * `border=<true/false>`
2430 * should the table be drawn with a border? (default: `true`)
2431 * `highlight=#RRGGBB`
2432 * highlight background color (`ColorString`), defaults to `#466432`
2433 * `highlight_text=#RRGGBB`
2434 * highlight text color (`ColorString`), defaults to `#FFFFFF`
2435 * `opendepth=<value>`
2436 * all subtrees up to `depth < value` are open (default value = `0`)
2437 * only useful when there is a column of type "tree"
2439 ### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
2441 * Sets columns for `table[]`
2442 * Types: `text`, `image`, `color`, `indent`, `tree`
2443 * `text`: show cell contents as text
2444 * `image`: cell contents are an image index, use column options to define
2446 * `color`: cell contents are a ColorString and define color of following
2448 * `indent`: cell contents are a number and define indentation of following
2450 * `tree`: same as indent, but user can open and close subtrees
2454 * for `text` and `image`: content alignment within cells.
2455 Available values: `left` (default), `center`, `right`, `inline`
2457 * for `text` and `image`: minimum width in em (default: `0`)
2458 * for `indent` and `tree`: indent width in em (default: `1.5`)
2459 * `padding=<value>`: padding left of the column, in em (default `0.5`).
2460 Exception: defaults to 0 for indent columns
2461 * `tooltip=<value>`: tooltip text (default: empty)
2462 * `image` column options:
2463 * `0=<value>` sets image for image index 0
2464 * `1=<value>` sets image for image index 1
2465 * `2=<value>` sets image for image index 2
2466 * and so on; defined indices need not be contiguous empty or
2467 non-numeric cells are treated as `0`.
2468 * `color` column options:
2469 * `span=<value>`: number of following columns to affect
2470 (default: infinite).
2472 ### `style[<name>;<prop1>;<prop2>;...]`
2474 * Set the style for the named element `name`.
2475 * Note: this **must** be before the element is defined.
2476 * See [Styling Formspecs].
2479 ### `style_type[<type>;<prop1>;<prop2>;...]`
2481 * Sets the style for all elements of type `type` which appear after this element.
2482 * See [Styling Formspecs].
2484 Migrating to Real Coordinates
2485 -----------------------------
2487 In the old system, positions included padding and spacing. Padding is a gap between
2488 the formspec window edges and content, and spacing is the gaps between items. For
2489 example, two `1x1` elements at `0,0` and `1,1` would have a spacing of `5/4` between them,
2490 and a padding of `3/8` from the formspec edge. It may be easiest to recreate old layouts
2491 in the new coordinate system from scratch.
2493 To recreate an old layout with padding, you'll need to pass the positions and sizes
2494 through the following formula to re-introduce padding:
2497 pos = (oldpos + 1)*spacing + padding
2503 You'll need to change the `size[]` tag like this:
2506 size = (oldsize-1)*spacing + padding*2 + 1
2509 A few elements had random offsets in the old system. Here is a table which shows these
2510 offsets when migrating:
2512 | Element | Position | Size | Notes
2513 |---------|------------|---------|-------
2514 | box | +0.3, +0.1 | 0, -0.4 |
2515 | button | | | Buttons now support height, so set h = 2 * 15/13 * 0.35, and reposition if h ~= 15/13 * 0.35 before
2516 | list | | | Spacing is now 0.25 for both directions, meaning lists will be taller in height
2517 | label | 0, +0.3 | | The first line of text is now positioned centered exactly at the position specified
2522 Formspec elements can be themed using the style elements:
2524 style[<name>;<prop1>;<prop2>;...]
2525 style_type[<type>;<prop1>;<prop2>;...]
2529 property_name=property_value
2533 style_type[button;bgcolor=#006699]
2534 style[world_delete;bgcolor=red;textcolor=yellow]
2535 button[4,3.95;2.6,1;world_delete;Delete]
2537 Setting a property to nothing will reset it to the default value. For example:
2539 style_type[button;bgimg=button.png;bgimg_pressed=button_pressed.png;border=false]
2540 style[btn_exit;bgimg=;bgimg_pressed=;border=;bgcolor=red]
2543 ### Supported Element Types
2545 Some types may inherit styles from parent types.
2548 * button_exit, inherits from button
2555 * pwdfield, inherits from field
2558 * vertlabel, inherits from field
2564 ### Valid Properties
2567 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2568 * Default to false in formspec_version version 3 or higher
2569 * button, button_exit, image_button, item_image_button
2570 * alpha - boolean, whether to draw alpha in bgimg. Default true.
2571 * bgcolor - color, sets button tint.
2572 * bgcolor_hovered - color when hovered. Defaults to a lighter bgcolor when not provided.
2573 * bgcolor_pressed - color when pressed. Defaults to a darker bgcolor when not provided.
2574 * bgimg - standard background image. Defaults to none.
2575 * bgimg_hovered - background image when hovered. Defaults to bgimg when not provided.
2576 * bgimg_pressed - background image when pressed. Defaults to bgimg when not provided.
2577 * border - boolean, draw border. Set to false to hide the bevelled button pane. Default true.
2578 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2579 * textcolor - color, default white.
2581 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2583 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2585 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2587 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2588 * field, pwdfield, textarea
2589 * border - set to false to hide the textbox background and border. Default true.
2590 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2591 * textcolor - color. Default white.
2593 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2594 * Default to false in formspec_version version 3 or higher
2596 * noclip - boolean, set to true to allow the element to exceed formspec bounds. Default to false.
2598 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2599 * image_button (additional properties)
2600 * fgimg - standard image. Defaults to none.
2601 * fgimg_hovered - image when hovered. Defaults to fgimg when not provided.
2602 * fgimg_pressed - image when pressed. Defaults to fgimg when not provided.
2603 * NOTE: The parameters of any given image_button will take precedence over fgimg/fgimg_pressed
2605 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2606 * textcolor - color. Default white.
2611 Markup language used in `hypertext[]` elements uses tag that look like HTML tags. Some
2612 tags can enclose text, they open with `<tagname>` and close with `</tagname>`.
2613 Tags can have attributes, in that case, attributes are in the opening tag in
2614 form of a key/value separated with equal signs. Attribute values should not be quoted.
2616 These are the technically basic tags but see below for usual tags. Base tags are:
2618 `<style color=... font=... size=...>...</style>`
2620 Changes the style of the text.
2622 * `color`: Text color. Given color is a `colorspec`.
2623 * `size`: Text size.
2624 * `font`: Text font (`mono` or `normal`).
2626 `<global background=... margin=... valign=... color=... hovercolor=... size=... font=... halign=... >`
2631 * `background`: Text background, a `colorspec` or `none`.
2632 * `margin`: Page margins in pixel.
2633 * `valign`: Text vertical alignment (`top`, `middle`, `bottom`).
2635 Inheriting styles (affects child elements):
2636 * `color`: Default text color. Given color is a `colorspec`.
2637 * `hovercolor`: Color of <action> tags when mouse is over.
2638 * `size`: Default text size.
2639 * `font`: Default text font (`mono` or `normal`).
2640 * `halign`: Default text horizontal alignment (`left`, `right`, `center`, `justify`).
2642 This tag needs to be placed only once as it changes the global settings of the
2643 text. Anyway, if several tags are placed, each changed will be made in the order
2646 `<tag name=... color=... hovercolor=... font=... size=...>`
2648 Defines or redefines tag style. This can be used to define new tags.
2649 * `name`: Name of the tag to define or change.
2650 * `color`: Text color. Given color is a `colorspec`.
2651 * `hovercolor`: Text color when element hovered (only for `action` tags). Given color is a `colorspec`.
2652 * `size`: Text size.
2653 * `font`: Text font (`mono` or `normal`).
2655 Following tags are the usual tags for text layout. They are defined by default.
2656 Other tags can be added using `<tag ...>` tag.
2658 `<normal>...</normal>`: Normal size text
2660 `<big>...</big>`: Big text
2662 `<bigger>...</bigger>`: Bigger text
2664 `<center>...</center>`: Centered text
2666 `<left>...</left>`: Left-aligned text
2668 `<right>...</right>`: Right-aligned text
2670 `<justify>...</justify>`: Justified text
2672 `<mono>...</mono>`: Monospaced font
2674 `<b>...</b>`, `<i>...</i>`, `<u>...</u>`: Bold, italic, underline styles.
2676 `<action name=...>...</action>`
2678 Make that text a clickable text triggering an action.
2680 * `name`: Name of the action (mandatory).
2682 When clicked, the formspec is send to the server. The value of the text field
2683 sent to `on_player_receive_fields` will be "action:" concatenated to the action
2686 `<img name=... float=... width=... height=...>`
2688 Draws an image which is present in the client media cache.
2690 * `name`: Name of the texture (mandatory).
2691 * `float`: If present, makes the image floating (`left` or `right`).
2692 * `width`: Force image width instead of taking texture width.
2693 * `height`: Force image height instead of taking texture height.
2695 If only width or height given, texture aspect is kept.
2697 `<item name=... float=... width=... height=... rotate=...>`
2699 Draws an item image.
2701 * `name`: Item string of the item to draw (mandatory).
2702 * `float`: If present, makes the image floating (`left` or `right`).
2703 * `width`: Item image width.
2704 * `height`: Item image height.
2705 * `rotate`: Rotate item image if set to `yes` or `X,Y,Z`. X, Y and Z being
2706 rotation speeds in percent of standard speed (-1000 to 1000). Works only if
2707 `inventory_items_animations` is set to true.
2708 * `angle`: Angle in which the item image is shown. Value has `X,Y,Z` form.
2709 X, Y and Z being angles around each three axes. Works only if
2710 `inventory_items_animations` is set to true.
2718 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
2719 * `"current_player"`: Player to whom the menu is shown
2720 * `"player:<name>"`: Any player
2721 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
2722 * `"detached:<name>"`: A detached inventory
2724 Player Inventory lists
2725 ----------------------
2727 * `main`: list containing the default inventory
2728 * `craft`: list containing the craft input
2729 * `craftpreview`: list containing the craft prediction
2730 * `craftresult`: list containing the crafted output
2731 * `hand`: list containing an override for the empty hand
2732 * Is not created automatically, use `InvRef:set_size`
2733 * Is only used to enhance the empty hand's tool capabilities
2741 `#RGB` defines a color in hexadecimal format.
2743 `#RGBA` defines a color in hexadecimal format and alpha channel.
2745 `#RRGGBB` defines a color in hexadecimal format.
2747 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
2749 Named colors are also supported and are equivalent to
2750 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
2751 To specify the value of the alpha channel, append `#AA` to the end of the color
2752 name (e.g. `colorname#08`). For named colors the hexadecimal string
2753 representing the alpha value must (always) be two hexadecimal digits.
2758 A ColorSpec specifies a 32-bit color. It can be written in any of the following
2761 * table form: Each element ranging from 0..255 (a, if absent, defaults to 255):
2762 * `colorspec = {a=255, r=0, g=255, b=0}`
2763 * numerical form: The raw integer value of an ARGB8 quad:
2764 * `colorspec = 0xFF00FF00`
2765 * string form: A ColorString (defined above):
2766 * `colorspec = "green"`
2774 Most text can contain escape sequences, that can for example color the text.
2775 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
2776 The following functions provide escape sequences:
2778 * `minetest.get_color_escape_sequence(color)`:
2779 * `color` is a ColorString
2780 * The escape sequence sets the text color to `color`
2781 * `minetest.colorize(color, message)`:
2783 `minetest.get_color_escape_sequence(color) ..
2785 minetest.get_color_escape_sequence("#ffffff")`
2786 * `minetest.get_background_escape_sequence(color)`
2787 * `color` is a ColorString
2788 * The escape sequence sets the background of the whole text element to
2789 `color`. Only defined for item descriptions and tooltips.
2790 * `minetest.strip_foreground_colors(str)`
2791 * Removes foreground colors added by `get_color_escape_sequence`.
2792 * `minetest.strip_background_colors(str)`
2793 * Removes background colors added by `get_background_escape_sequence`.
2794 * `minetest.strip_colors(str)`
2795 * Removes all color escape sequences.
2802 A spatial vector is similar to a position, but instead using
2803 absolute world coordinates, it uses *relative* coordinates, relative to
2804 no particular point.
2806 Internally, it is implemented as a table with the 3 fields
2807 `x`, `y` and `z`. Example: `{x = 0, y = 1, z = 0}`.
2809 For the following functions, `v`, `v1`, `v2` are vectors,
2810 `p1`, `p2` are positions:
2812 * `vector.new(a[, b, c])`:
2814 * A copy of `a` if `a` is a vector.
2815 * `{x = a, y = b, z = c}`, if all of `a`, `b`, `c` are defined numbers.
2816 * `vector.direction(p1, p2)`:
2817 * Returns a vector of length 1 with direction `p1` to `p2`.
2818 * If `p1` and `p2` are identical, returns `{x = 0, y = 0, z = 0}`.
2819 * `vector.distance(p1, p2)`:
2820 * Returns zero or a positive number, the distance between `p1` and `p2`.
2821 * `vector.length(v)`:
2822 * Returns zero or a positive number, the length of vector `v`.
2823 * `vector.normalize(v)`:
2824 * Returns a vector of length 1 with direction of vector `v`.
2825 * If `v` has zero length, returns `{x = 0, y = 0, z = 0}`.
2826 * `vector.floor(v)`:
2827 * Returns a vector, each dimension rounded down.
2828 * `vector.round(v)`:
2829 * Returns a vector, each dimension rounded to nearest integer.
2830 * `vector.apply(v, func)`:
2831 * Returns a vector where the function `func` has been applied to each
2833 * `vector.equals(v1, v2)`:
2834 * Returns a boolean, `true` if the vectors are identical.
2835 * `vector.sort(v1, v2)`:
2836 * Returns in order minp, maxp vectors of the cuboid defined by `v1`, `v2`.
2837 * `vector.angle(v1, v2)`:
2838 * Returns the angle between `v1` and `v2` in radians.
2839 * `vector.dot(v1, v2)`
2840 * Returns the dot product of `v1` and `v2`
2841 * `vector.cross(v1, v2)`
2842 * Returns the cross product of `v1` and `v2`
2844 For the following functions `x` can be either a vector or a number:
2846 * `vector.add(v, x)`:
2848 * If `x` is a vector: Returns the sum of `v` and `x`.
2849 * If `x` is a number: Adds `x` to each component of `v`.
2850 * `vector.subtract(v, x)`:
2852 * If `x` is a vector: Returns the difference of `v` subtracted by `x`.
2853 * If `x` is a number: Subtracts `x` from each component of `v`.
2854 * `vector.multiply(v, x)`:
2855 * Returns a scaled vector or Schur product.
2856 * `vector.divide(v, x)`:
2857 * Returns a scaled vector or Schur quotient.
2865 * `dump2(obj, name, dumped)`: returns a string which makes `obj`
2866 human-readable, handles reference loops.
2867 * `obj`: arbitrary variable
2868 * `name`: string, default: `"_"`
2869 * `dumped`: table, default: `{}`
2870 * `dump(obj, dumped)`: returns a string which makes `obj` human-readable
2871 * `obj`: arbitrary variable
2872 * `dumped`: table, default: `{}`
2873 * `math.hypot(x, y)`
2874 * Get the hypotenuse of a triangle with legs x and y.
2875 Useful for distance calculation.
2876 * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
2877 * Get the sign of a number.
2878 * tolerance: number, default: `0.0`
2879 * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
2881 * `math.factorial(x)`: returns the factorial of `x`
2882 * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
2883 * `separator`: string, default: `","`
2884 * `include_empty`: boolean, default: `false`
2885 * `max_splits`: number, if it's negative, splits aren't limited,
2887 * `sep_is_pattern`: boolean, it specifies whether separator is a plain
2888 string or a pattern (regex), default: `false`
2889 * e.g. `"a,b":split","` returns `{"a","b"}`
2890 * `string:trim()`: returns the string without whitespace pre- and suffixes
2891 * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
2892 * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
2893 * Adds newlines to the string to keep it within the specified character
2895 * Note that the returned lines may be longer than the limit since it only
2896 splits at word borders.
2897 * `limit`: number, maximal amount of characters in one line
2898 * `as_table`: boolean, if set to true, a table of lines instead of a string
2899 is returned, default: `false`
2900 * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
2901 * `pos`: table {x=X, y=Y, z=Z}
2902 * Converts the position `pos` to a human-readable, printable string
2903 * `decimal_places`: number, if specified, the x, y and z values of
2904 the position are rounded to the given decimal place.
2905 * `minetest.string_to_pos(string)`: returns a position or `nil`
2906 * Same but in reverse.
2907 * If the string can't be parsed to a position, nothing is returned.
2908 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
2909 * Converts a string representing an area box into two positions
2910 * `minetest.formspec_escape(string)`: returns a string
2911 * escapes the characters "[", "]", "\", "," and ";", which can not be used
2913 * `minetest.is_yes(arg)`
2914 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
2915 * `minetest.is_nan(arg)`
2916 * returns true when the passed number represents NaN.
2917 * `minetest.get_us_time()`
2918 * returns time with microsecond precision. May not return wall time.
2919 * `table.copy(table)`: returns a table
2920 * returns a deep copy of `table`
2921 * `table.indexof(list, val)`: returns the smallest numerical index containing
2922 the value `val` in the table `list`. Non-numerical indices are ignored.
2923 If `val` could not be found, `-1` is returned. `list` must not have
2925 * `table.insert_all(table, other_table)`:
2926 * Appends all values in `other_table` to `table` - uses `#table + 1` to
2928 * `table.key_value_swap(t)`: returns a table with keys and values swapped
2929 * If multiple keys in `t` map to the same value, the result is undefined.
2930 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
2932 * returns the exact position on the surface of a pointed node
2933 * `minetest.get_dig_params(groups, tool_capabilities)`: Simulates a tool
2935 Returns a table with the following fields:
2936 * `diggable`: `true` if node can be dug, `false` otherwise.
2937 * `time`: Time it would take to dig the node.
2938 * `wear`: How much wear would be added to the tool.
2939 `time` and `wear` are meaningless if node's not diggable
2941 * `groups`: Table of the node groups of the node that would be dug
2942 * `tool_capabilities`: Tool capabilities table of the tool
2943 * `minetest.get_hit_params(groups, tool_capabilities [, time_from_last_punch])`:
2944 Simulates an item that punches an object.
2945 Returns a table with the following fields:
2946 * `hp`: How much damage the punch would cause.
2947 * `wear`: How much wear would be added to the tool.
2949 * `groups`: Damage groups of the object
2950 * `tool_capabilities`: Tool capabilities table of the item
2951 * `time_from_last_punch`: time in seconds since last punch action
2959 Texts can be translated client-side with the help of `minetest.translate` and
2962 Translating a string
2963 --------------------
2965 Two functions are provided to translate strings: `minetest.translate` and
2966 `minetest.get_translator`.
2968 * `minetest.get_translator(textdomain)` is a simple wrapper around
2969 `minetest.translate`, and `minetest.get_translator(textdomain)(str, ...)` is
2970 equivalent to `minetest.translate(textdomain, str, ...)`.
2971 It is intended to be used in the following way, so that it avoids verbose
2972 repetitions of `minetest.translate`:
2974 local S = minetest.get_translator(textdomain)
2977 As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
2979 * `minetest.translate(textdomain, str, ...)` translates the string `str` with
2980 the given `textdomain` for disambiguation. The textdomain must match the
2981 textdomain specified in the translation file in order to get the string
2982 translated. This can be used so that a string is translated differently in
2984 It is advised to use the name of the mod as textdomain whenever possible, to
2985 avoid clashes with other mods.
2986 This function must be given a number of arguments equal to the number of
2987 arguments the translated string expects.
2988 Arguments are literal strings -- they will not be translated, so if you want
2989 them to be, they need to come as outputs of `minetest.translate` as well.
2991 For instance, suppose we want to translate "@1 Wool" with "@1" being replaced
2992 by the translation of "Red". We can do the following:
2994 local S = minetest.get_translator()
2995 S("@1 Wool", S("Red"))
2997 This will be displayed as "Red Wool" on old clients and on clients that do
2998 not have localization enabled. However, if we have for instance a translation
2999 file named `wool.fr.tr` containing the following:
3004 this will be displayed as "Laine Rouge" on clients with a French locale.
3006 Operations on translated strings
3007 --------------------------------
3009 The output of `minetest.translate` is a string, with escape sequences adding
3010 additional information to that string so that it can be translated on the
3011 different clients. In particular, you can't expect operations like string.length
3012 to work on them like you would expect them to, or string.gsub to work in the
3013 expected manner. However, string concatenation will still work as expected
3014 (note that you should only use this for things like formspecs; do not translate
3015 sentences by breaking them into parts; arguments should be used instead), and
3016 operations such as `minetest.colorize` which are also concatenation.
3018 Translation file format
3019 -----------------------
3021 A translation file has the suffix `.[lang].tr`, where `[lang]` is the language
3022 it corresponds to. It must be put into the `locale` subdirectory of the mod.
3023 The file should be a text file, with the following format:
3025 * Lines beginning with `# textdomain:` (the space is significant) can be used
3026 to specify the text domain of all following translations in the file.
3027 * All other empty lines or lines beginning with `#` are ignored.
3028 * Other lines should be in the format `original=translated`. Both `original`
3029 and `translated` can contain escape sequences beginning with `@` to insert
3030 arguments, literal `@`, `=` or newline (See [Escapes] below).
3031 There must be no extraneous whitespace around the `=` or at the beginning or
3032 the end of the line.
3037 Strings that need to be translated can contain several escapes, preceded by `@`.
3039 * `@@` acts as a literal `@`.
3040 * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated
3041 string that will be inlined when translated. Due to how translations are
3042 implemented, the original translation string **must** have its arguments in
3043 increasing order, without gaps or repetitions, starting from 1.
3044 * `@=` acts as a literal `=`. It is not required in strings given to
3045 `minetest.translate`, but is in translation files to avoid being confused
3046 with the `=` separating the original from the translation.
3047 * `@\n` (where the `\n` is a literal newline) acts as a literal newline.
3048 As with `@=`, this escape is not required in strings given to
3049 `minetest.translate`, but is in translation files.
3050 * `@n` acts as a literal newline as well.
3058 Perlin noise creates a continuously-varying value depending on the input values.
3059 Usually in Minetest the input values are either 2D or 3D co-ordinates in nodes.
3060 The result is used during map generation to create the terrain shape, vary heat
3061 and humidity to distribute biomes, vary the density of decorations or vary the
3064 Structure of perlin noise
3065 -------------------------
3067 An 'octave' is a simple noise generator that outputs a value between -1 and 1.
3068 The smooth wavy noise it generates has a single characteristic scale, almost
3069 like a 'wavelength', so on its own does not create fine detail.
3070 Due to this perlin noise combines several octaves to create variation on
3071 multiple scales. Each additional octave has a smaller 'wavelength' than the
3074 This combination results in noise varying very roughly between -2.0 and 2.0 and
3075 with an average value of 0.0, so `scale` and `offset` are then used to multiply
3076 and offset the noise variation.
3078 The final perlin noise variation is created as follows:
3080 noise = offset + scale * (octave1 +
3081 octave2 * persistence +
3082 octave3 * persistence ^ 2 +
3083 octave4 * persistence ^ 3 +
3089 Noise Parameters are commonly called `NoiseParams`.
3093 After the multiplication by `scale` this is added to the result and is the final
3094 step in creating the noise value.
3095 Can be positive or negative.
3099 Once all octaves have been combined, the result is multiplied by this.
3100 Can be positive or negative.
3104 For octave1, this is roughly the change of input value needed for a very large
3105 variation in the noise value generated by octave1. It is almost like a
3106 'wavelength' for the wavy noise variation.
3107 Each additional octave has a 'wavelength' that is smaller than the previous
3108 octave, to create finer detail. `spread` will therefore roughly be the typical
3109 size of the largest structures in the final noise variation.
3111 `spread` is a vector with values for x, y, z to allow the noise variation to be
3112 stretched or compressed in the desired axes.
3113 Values are positive numbers.
3117 This is a whole number that determines the entire pattern of the noise
3118 variation. Altering it enables different noise patterns to be created.
3119 With other parameters equal, different seeds produce different noise patterns
3120 and identical seeds produce identical noise patterns.
3122 For this parameter you can randomly choose any whole number. Usually it is
3123 preferable for this to be different from other seeds, but sometimes it is useful
3124 to be able to create identical noise patterns.
3126 When used in mapgen this is actually a 'seed offset', it is added to the
3127 'world seed' to create the seed used by the noise, to ensure the noise has a
3128 different pattern in different worlds.
3132 The number of simple noise generators that are combined.
3133 A whole number, 1 or more.
3134 Each additional octave adds finer detail to the noise but also increases the
3135 noise calculation load.
3136 3 is a typical minimum for a high quality, complex and natural-looking noise
3137 variation. 1 octave has a slight 'gridlike' appearence.
3139 Choose the number of octaves according to the `spread` and `lacunarity`, and the
3140 size of the finest detail you require. For example:
3141 if `spread` is 512 nodes, `lacunarity` is 2.0 and finest detail required is 16
3142 nodes, octaves will be 6 because the 'wavelengths' of the octaves will be
3143 512, 256, 128, 64, 32, 16 nodes.
3144 Warning: If the 'wavelength' of any octave falls below 1 an error will occur.
3148 Each additional octave has an amplitude that is the amplitude of the previous
3149 octave multiplied by `persistence`, to reduce the amplitude of finer details,
3150 as is often helpful and natural to do so.
3151 Since this controls the balance of fine detail to large-scale detail
3152 `persistence` can be thought of as the 'roughness' of the noise.
3154 A positive or negative non-zero number, often between 0.3 and 1.0.
3155 A common medium value is 0.5, such that each octave has half the amplitude of
3156 the previous octave.
3157 This may need to be tuned when altering `lacunarity`; when doing so consider
3158 that a common medium value is 1 / lacunarity.
3162 Each additional octave has a 'wavelength' that is the 'wavelength' of the
3163 previous octave multiplied by 1 / lacunarity, to create finer detail.
3164 'lacunarity' is often 2.0 so 'wavelength' often halves per octave.
3166 A positive number no smaller than 1.0.
3167 Values below 2.0 create higher quality noise at the expense of requiring more
3168 octaves to cover a paticular range of 'wavelengths'.
3172 Leave this field unset for no special handling.
3173 Currently supported are `defaults`, `eased` and `absvalue`:
3177 Specify this if you would like to keep auto-selection of eased/not-eased while
3178 specifying some other flags.
3182 Maps noise gradient values onto a quintic S-curve before performing
3183 interpolation. This results in smooth, rolling noise.
3184 Disable this (`noeased`) for sharp-looking noise with a slightly gridded
3186 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is
3188 Easing a 3D noise significantly increases the noise calculation load, so use
3193 The absolute value of each octave's noise variation is used when combining the
3194 octaves. The final perlin noise variation is created as follows:
3196 noise = offset + scale * (abs(octave1) +
3197 abs(octave2) * persistence +
3198 abs(octave3) * persistence ^ 2 +
3199 abs(octave4) * persistence ^ 3 +
3204 For 2D or 3D perlin noise or perlin noise maps:
3209 spread = {x = 500, y = 500, z = 500},
3214 flags = "defaults, absvalue",
3217 For 2D noise the Z component of `spread` is still defined but is ignored.
3218 A single noise parameter table can be used for 2D or 3D noise.
3229 These tell in what manner the ore is generated.
3231 All default ores are of the uniformly-distributed scatter type.
3235 Randomly chooses a location and generates a cluster of ore.
3237 If `noise_params` is specified, the ore will be placed if the 3D perlin noise
3238 at that point is greater than the `noise_threshold`, giving the ability to
3239 create a non-equal distribution of ore.
3243 Creates a sheet of ore in a blob shape according to the 2D perlin noise
3244 described by `noise_params` and `noise_threshold`. This is essentially an
3245 improved version of the so-called "stratus" ore seen in some unofficial mods.
3247 This sheet consists of vertical columns of uniform randomly distributed height,
3248 varying between the inclusive range `column_height_min` and `column_height_max`.
3249 If `column_height_min` is not specified, this parameter defaults to 1.
3250 If `column_height_max` is not specified, this parameter defaults to `clust_size`
3251 for reverse compatibility. New code should prefer `column_height_max`.
3253 The `column_midpoint_factor` parameter controls the position of the column at
3254 which ore emanates from.
3255 If 1, columns grow upward. If 0, columns grow downward. If 0.5, columns grow
3256 equally starting from each direction.
3257 `column_midpoint_factor` is a decimal number ranging in value from 0 to 1. If
3258 this parameter is not specified, the default is 0.5.
3260 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this
3265 Creates a sheet of ore in a cloud-like puff shape.
3267 As with the `sheet` ore type, the size and shape of puffs are described by
3268 `noise_params` and `noise_threshold` and are placed at random vertical
3269 positions within the currently generated chunk.
3271 The vertical top and bottom displacement of each puff are determined by the
3272 noise parameters `np_puff_top` and `np_puff_bottom`, respectively.
3276 Creates a deformed sphere of ore according to 3d perlin noise described by
3277 `noise_params`. The maximum size of the blob is `clust_size`, and
3278 `clust_scarcity` has the same meaning as with the `scatter` type.
3282 Creates veins of ore varying in density by according to the intersection of two
3283 instances of 3d perlin noise with different seeds, both described by
3286 `random_factor` varies the influence random chance has on placement of an ore
3287 inside the vein, which is `1` by default. Note that modifying this parameter
3288 may require adjusting `noise_threshold`.
3290 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
3293 This ore type is difficult to control since it is sensitive to small changes.
3294 The following is a decent set of parameters to work from:
3299 spread = {x=200, y=200, z=200},
3306 noise_threshold = 1.6
3308 **WARNING**: Use this ore type *very* sparingly since it is ~200x more
3309 computationally expensive than any other ore.
3313 Creates a single undulating ore stratum that is continuous across mapchunk
3314 borders and horizontally spans the world.
3316 The 2D perlin noise described by `noise_params` defines the Y co-ordinate of
3317 the stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
3318 defines the stratum's vertical thickness (in units of nodes). Due to being
3319 continuous across mapchunk borders the stratum's vertical thickness is
3322 If the noise parameter `noise_params` is omitted the ore will occur from y_min
3323 to y_max in a simple horizontal stratum.
3325 A parameter `stratum_thickness` can be provided instead of the noise parameter
3326 `np_stratum_thickness`, to create a constant thickness.
3328 Leaving out one or both noise parameters makes the ore generation less
3329 intensive, useful when adding multiple strata.
3331 `y_min` and `y_max` define the limits of the ore generation and for performance
3332 reasons should be set as close together as possible but without clipping the
3333 stratum's Y variation.
3335 Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
3336 solid-ore stratum would require a `clust_scarcity` of 1.
3338 The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
3339 `random_factor` are ignored by this ore type.
3344 See section [Flag Specifier Format].
3346 Currently supported flags:
3347 `puff_cliffs`, `puff_additive_composition`.
3351 If set, puff ore generation will not taper down large differences in
3352 displacement when approaching the edge of a puff. This flag has no effect for
3353 ore types other than `puff`.
3355 ### `puff_additive_composition`
3357 By default, when noise described by `np_puff_top` or `np_puff_bottom` results
3358 in a negative displacement, the sub-column at that point is not generated. With
3359 this attribute set, puff ore generation will instead generate the absolute
3360 difference in noise displacement values. This flag has no effect for ore types
3369 The varying types of decorations that can be placed.
3374 Creates a 1 times `H` times 1 column of a specified node (or a random node from
3375 a list, if a decoration list is specified). Can specify a certain node it must
3376 spawn next to, such as water or lava, for example. Can also generate a
3377 decoration of random height between a specified lower and upper bound.
3378 This type of decoration is intended for placement of grass, flowers, cacti,
3379 papyri, waterlilies and so on.
3384 Copies a box of `MapNodes` from a specified schematic file (or raw description).
3385 Can specify a probability of a node randomly appearing when placed.
3386 This decoration type is intended to be used for multi-node sized discrete
3387 structures, such as trees, cave spikes, rocks, and so on.
3396 --------------------
3398 A schematic specifier identifies a schematic by either a filename to a
3399 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
3400 in the form of a table. This table specifies the following fields:
3402 * The `size` field is a 3D vector containing the dimensions of the provided
3403 schematic. (required field)
3404 * The `yslice_prob` field is a table of {ypos, prob} slice tables. A slice table
3405 sets the probability of a particular horizontal slice of the schematic being
3406 placed. (optional field)
3407 `ypos` = 0 for the lowest horizontal slice of a schematic.
3408 The default of `prob` is 255.
3409 * The `data` field is a flat table of MapNode tables making up the schematic,
3410 in the order of `[z [y [x]]]`. (required field)
3411 Each MapNode table contains:
3412 * `name`: the name of the map node to place (required)
3413 * `prob` (alias `param1`): the probability of this node being placed
3415 * `param2`: the raw param2 value of the node being placed onto the map
3417 * `force_place`: boolean representing if the node should forcibly overwrite
3418 any previous contents (default: false)
3420 About probability values:
3422 * A probability value of `0` or `1` means that node will never appear
3424 * A probability value of `254` or `255` means the node will always appear
3426 * If the probability value `p` is greater than `1`, then there is a
3427 `(p / 256 * 100)` percent chance that node will appear when the schematic is
3430 Schematic attributes
3431 --------------------
3433 See section [Flag Specifier Format].
3435 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
3438 * `place_center_x`: Placement of this decoration is centered along the X axis.
3439 * `place_center_y`: Placement of this decoration is centered along the Y axis.
3440 * `place_center_z`: Placement of this decoration is centered along the Z axis.
3441 * `force_placement`: Schematic nodes other than "ignore" will replace existing
3447 Lua Voxel Manipulator
3448 =====================
3453 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator'
3454 facility. The purpose of this object is for fast, low-level, bulk access to
3455 reading and writing Map content. As such, setting map nodes through VoxelManip
3456 will lack many of the higher level features and concepts you may be used to
3457 with other methods of setting nodes. For example, nodes will not have their
3458 construction and destruction callbacks run, and no rollback information is
3461 It is important to note that VoxelManip is designed for speed, and *not* ease
3462 of use or flexibility. If your mod requires a map manipulation facility that
3463 will handle 100% of all edge cases, or the use of high level node placement
3464 features, perhaps `minetest.set_node()` is better suited for the job.
3466 In addition, VoxelManip might not be faster, or could even be slower, for your
3467 specific use case. VoxelManip is most effective when setting large areas of map
3468 at once - for example, if only setting a 3x3x3 node area, a
3469 `minetest.set_node()` loop may be more optimal. Always profile code using both
3470 methods of map manipulation to determine which is most appropriate for your
3473 A recent simple test of setting cubic areas showed that `minetest.set_node()`
3474 is faster than a VoxelManip for a 3x3x3 node cube or smaller.
3479 A VoxelManip object can be created any time using either:
3480 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
3482 If the optional position parameters are present for either of these routines,
3483 the specified region will be pre-loaded into the VoxelManip object on creation.
3484 Otherwise, the area of map you wish to manipulate must first be loaded into the
3485 VoxelManip object using `VoxelManip:read_from_map()`.
3487 Note that `VoxelManip:read_from_map()` returns two position vectors. The region
3488 formed by these positions indicate the minimum and maximum (respectively)
3489 positions of the area actually loaded in the VoxelManip, which may be larger
3490 than the area requested. For convenience, the loaded area coordinates can also
3491 be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
3493 Now that the VoxelManip object is populated with map data, your mod can fetch a
3494 copy of this data using either of two methods. `VoxelManip:get_node_at()`,
3495 which retrieves an individual node in a MapNode formatted table at the position
3496 requested is the simplest method to use, but also the slowest.
3498 Nodes in a VoxelManip object may also be read in bulk to a flat array table
3501 * `VoxelManip:get_data()` for node content (in Content ID form, see section
3503 * `VoxelManip:get_light_data()` for node light levels, and
3504 * `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
3506 See section [Flat array format] for more details.
3508 It is very important to understand that the tables returned by any of the above
3509 three functions represent a snapshot of the VoxelManip's internal state at the
3510 time of the call. This copy of the data will not magically update itself if
3511 another function modifies the internal VoxelManip state.
3512 Any functions that modify a VoxelManip's contents work on the VoxelManip's
3513 internal state unless otherwise explicitly stated.
3515 Once the bulk data has been edited to your liking, the internal VoxelManip
3516 state can be set using:
3518 * `VoxelManip:set_data()` for node content (in Content ID form, see section
3520 * `VoxelManip:set_light_data()` for node light levels, and
3521 * `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
3523 The parameter to each of the above three functions can use any table at all in
3524 the same flat array format as produced by `get_data()` etc. and is not required
3525 to be a table retrieved from `get_data()`.
3527 Once the internal VoxelManip state has been modified to your liking, the
3528 changes can be committed back to the map by calling `VoxelManip:write_to_map()`
3530 ### Flat array format
3533 `Nx = p2.X - p1.X + 1`,
3534 `Ny = p2.Y - p1.Y + 1`, and
3535 `Nz = p2.Z - p1.Z + 1`.
3537 Then, for a loaded region of p1..p2, this array ranges from `1` up to and
3538 including the value of the expression `Nx * Ny * Nz`.
3540 Positions offset from p1 are present in the array with the format of:
3543 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
3544 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
3546 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
3547 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
3549 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
3551 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
3554 and the array index for a position p contained completely in p1..p2 is:
3556 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
3558 Note that this is the same "flat 3D array" format as
3559 `PerlinNoiseMap:get3dMap_flat()`.
3560 VoxelArea objects (see section [`VoxelArea`]) can be used to simplify calculation
3561 of the index for a single point in a flat VoxelManip array.
3565 A Content ID is a unique integer identifier for a specific node type.
3566 These IDs are used by VoxelManip in place of the node name string for
3567 `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
3568 `minetest.get_content_id()` to look up the Content ID for the specified node
3569 name, and `minetest.get_name_from_content_id()` to look up the node name string
3570 for a given Content ID.
3571 After registration of a node, its Content ID will remain the same throughout
3572 execution of the mod.
3573 Note that the node being queried needs to have already been been registered.
3575 The following builtin node types have their Content IDs defined as constants:
3577 * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
3578 * `minetest.CONTENT_AIR`: ID for "air" nodes
3579 * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
3581 ### Mapgen VoxelManip objects
3583 Inside of `on_generated()` callbacks, it is possible to retrieve the same
3584 VoxelManip object used by the core's Map Generator (commonly abbreviated
3585 Mapgen). Most of the rules previously described still apply but with a few
3588 * The Mapgen VoxelManip object is retrieved using:
3589 `minetest.get_mapgen_object("voxelmanip")`
3590 * This VoxelManip object already has the region of map just generated loaded
3591 into it; it's not necessary to call `VoxelManip:read_from_map()` before using
3592 a Mapgen VoxelManip.
3593 * The `on_generated()` callbacks of some mods may place individual nodes in the
3594 generated area using non-VoxelManip map modification methods. Because the
3595 same Mapgen VoxelManip object is passed through each `on_generated()`
3596 callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3597 consistency with the current map state. For this reason, calling any of the
3598 following functions:
3599 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3600 will also update the Mapgen VoxelManip object's internal state active on the
3602 * After modifying the Mapgen VoxelManip object's internal buffer, it may be
3603 necessary to update lighting information using either:
3604 `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3606 ### Other API functions operating on a VoxelManip
3608 If any VoxelManip contents were set to a liquid node,
3609 `VoxelManip:update_liquids()` must be called for these liquid nodes to begin
3610 flowing. It is recommended to call this function only after having written all
3611 buffered data back to the VoxelManip object, save for special situations where
3612 the modder desires to only have certain liquid nodes begin flowing.
3614 The functions `minetest.generate_ores()` and `minetest.generate_decorations()`
3615 will generate all registered decorations and ores throughout the full area
3616 inside of the specified VoxelManip object.
3618 `minetest.place_schematic_on_vmanip()` is otherwise identical to
3619 `minetest.place_schematic()`, except instead of placing the specified schematic
3620 directly on the map at the specified position, it will place the schematic
3621 inside the VoxelManip.
3625 * Attempting to read data from a VoxelManip object before map is read will
3626 result in a zero-length array table for `VoxelManip:get_data()`, and an
3627 "ignore" node at any position for `VoxelManip:get_node_at()`.
3628 * If either a region of map has not yet been generated or is out-of-bounds of
3629 the map, that region is filled with "ignore" nodes.
3630 * Other mods, or the core itself, could possibly modify the area of map
3631 currently loaded into a VoxelManip object. With the exception of Mapgen
3632 VoxelManips (see above section), the internal buffers are not updated. For
3633 this reason, it is strongly encouraged to complete the usage of a particular
3634 VoxelManip object in the same callback it had been created.
3635 * If a VoxelManip object will be used often, such as in an `on_generated()`
3636 callback, consider passing a file-scoped table as the optional parameter to
3637 `VoxelManip:get_data()`, which serves as a static buffer the function can use
3638 to write map data to instead of returning a new table each call. This greatly
3639 enhances performance by avoiding unnecessary memory allocations.
3644 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object
3645 containing the region formed by `p1` and `p2`.
3646 * returns actual emerged `pmin`, actual emerged `pmax`
3647 * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to
3649 * **important**: data must be set using `VoxelManip:set_data()` before
3651 * if `light` is true, then lighting is automatically recalculated.
3652 The default value is true.
3653 If `light` is false, no light calculations happen, and you should correct
3654 all modified blocks with `minetest.fix_light()` as soon as possible.
3655 Keep in mind that modifying the map where light is incorrect can cause
3657 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
3658 the `VoxelManip` at that position
3659 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
3661 * `get_data([buffer])`: Retrieves the node content data loaded into the
3662 `VoxelManip` object.
3663 * returns raw node data in the form of an array of node content IDs
3664 * if the param `buffer` is present, this table will be used to store the
3666 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
3667 * `update_map()`: Does nothing, kept for compatibility.
3668 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to
3670 * `light` is a table, `{day=<0...15>, night=<0...15>}`
3671 * To be used only by a `VoxelManip` object from
3672 `minetest.get_mapgen_object`.
3673 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
3675 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
3676 * Returns an array (indices 1 to volume) of integers ranging from `0` to
3678 * Each value is the bitwise combination of day and night light values
3680 * `light = day + (night * 16)`
3681 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
3682 in the `VoxelManip`.
3683 * expects lighting data in the same format that `get_light_data()` returns
3684 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the
3685 `VoxelManip` object.
3686 * Returns an array (indices 1 to volume) of integers ranging from `0` to
3688 * If the param `buffer` is present, this table will be used to store the
3690 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in
3692 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the
3694 * To be used only by a `VoxelManip` object from
3695 `minetest.get_mapgen_object`.
3696 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
3697 area if left out or nil. For almost all uses these should be left out
3698 or nil to use the default.
3699 * `propagate_shadow` is an optional boolean deciding whether shadows in a
3700 generated mapchunk above are propagated down into the mapchunk, defaults
3701 to `true` if left out.
3702 * `update_liquids()`: Update liquid flow
3703 * `was_modified()`: Returns `true` or `false` if the data in the voxel
3704 manipulator had been modified since the last read from map, due to a call to
3705 `minetest.set_data()` on the loaded area elsewhere.
3706 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
3711 A helper class for voxel areas.
3712 It can be created via `VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}`.
3713 The coordinates are *inclusive*, like most other things in Minetest.
3717 * `getExtent()`: returns a 3D vector containing the size of the area formed by
3718 `MinEdge` and `MaxEdge`.
3719 * `getVolume()`: returns the volume of the area formed by `MinEdge` and
3721 * `index(x, y, z)`: returns the index of an absolute position in a flat array
3723 * `x`, `y` and `z` must be integers to avoid an incorrect index result.
3724 * The position (x, y, z) is not checked for being inside the area volume,
3725 being outside can cause an incorrect index result.
3726 * Useful for things like `VoxelManip`, raw Schematic specifiers,
3727 `PerlinNoiseMap:get2d`/`3dMap`, and so on.
3728 * `indexp(p)`: same functionality as `index(x, y, z)` but takes a vector.
3729 * As with `index(x, y, z)`, the components of `p` must be integers, and `p`
3730 is not checked for being inside the area volume.
3731 * `position(i)`: returns the absolute position vector corresponding to index
3733 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by
3734 `MinEdge` and `MaxEdge`.
3735 * `containsp(p)`: same as above, except takes a vector
3736 * `containsi(i)`: same as above, except takes an index `i`
3737 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns
3739 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of
3741 * `iterp(minp, maxp)`: same as above, except takes a vector
3749 A mapgen object is a construct used in map generation. Mapgen objects can be
3750 used by an `on_generate` callback to speed up operations by avoiding
3751 unnecessary recalculations, these can be retrieved using the
3752 `minetest.get_mapgen_object()` function. If the requested Mapgen object is
3753 unavailable, or `get_mapgen_object()` was called outside of an `on_generate()`
3754 callback, `nil` is returned.
3756 The following Mapgen objects are currently available:
3760 This returns three values; the `VoxelManip` object to be used, minimum and
3761 maximum emerged position, in that order. All mapgens support this object.
3765 Returns an array containing the y coordinates of the ground levels of nodes in
3766 the most recently generated chunk by the current mapgen.
3770 Returns an array containing the biome IDs of nodes in the most recently
3771 generated chunk by the current mapgen.
3775 Returns an array containing the temperature values of nodes in the most
3776 recently generated chunk by the current mapgen.
3780 Returns an array containing the humidity values of nodes in the most recently
3781 generated chunk by the current mapgen.
3785 Returns a table mapping requested generation notification types to arrays of
3786 positions at which the corresponding generated structures are located within
3787 the current chunk. To set the capture of positions of interest to be recorded
3788 on generate, use `minetest.set_gen_notify()`.
3789 For decorations, the returned positions are the ground surface 'place_on'
3790 nodes, not the decorations themselves. A 'simple' type decoration is often 1
3791 node above the returned position and possibly displaced by 'place_offset_y'.
3793 Possible fields of the table returned are:
3799 * `large_cave_begin`
3803 Decorations have a key in the format of `"decoration#id"`, where `id` is the
3804 numeric unique decoration ID as returned by `minetest.get_decoration_id`.
3812 Functions receive a "luaentity" as `self`:
3814 * It has the member `.name`, which is the registered name `("mod:thing")`
3815 * It has the member `.object`, which is an `ObjectRef` pointing to the object
3816 * The original prototype stuff is visible directly via a metatable
3820 * `on_activate(self, staticdata, dtime_s)`
3821 * Called when the object is instantiated.
3822 * `dtime_s` is the time passed since the object was unloaded, which can be
3823 used for updating the entity state.
3824 * `on_step(self, dtime)`
3825 * Called on every server tick, after movement and collision processing.
3826 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
3828 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)`
3829 * Called when somebody punches the object.
3830 * Note that you probably want to handle most punches using the automatic
3832 * `puncher`: an `ObjectRef` (can be `nil`)
3833 * `time_from_last_punch`: Meant for disallowing spamming of clicks
3835 * `tool_capabilities`: capability table of used tool (can be `nil`)
3836 * `dir`: unit vector of direction of punch. Always defined. Points from the
3837 puncher to the punched.
3838 * `damage`: damage that will be done to entity.
3839 * `on_death(self, killer)`
3840 * Called when the object dies.
3841 * `killer`: an `ObjectRef` (can be `nil`)
3842 * `on_rightclick(self, clicker)`
3843 * `on_attach_child(self, child)`
3844 * `child`: an `ObjectRef` of the child that attaches
3845 * `on_detach_child(self, child)`
3846 * `child`: an `ObjectRef` of the child that detaches
3847 * `on_detach(self, parent)`
3848 * `parent`: an `ObjectRef` (can be `nil`) from where it got detached
3849 * This happens before the parent object is removed from the world
3850 * `get_staticdata(self)`
3851 * Should return a string that will be passed to `on_activate` when the
3852 object is instantiated the next time.
3864 axiom, --string initial tree axiom
3865 rules_a, --string rules set A
3866 rules_b, --string rules set B
3867 rules_c, --string rules set C
3868 rules_d, --string rules set D
3869 trunk, --string trunk node name
3870 leaves, --string leaves node name
3871 leaves2, --string secondary leaves node name
3872 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
3873 angle, --num angle in deg
3874 iterations, --num max # of iterations, usually 2 -5
3875 random_level, --num factor to lower nr of iterations, usually 0 - 3
3876 trunk_type, --string single/double/crossed) type of trunk: 1 node,
3877 -- 2x2 nodes or 3x3 in cross shape
3878 thin_branches, --boolean true -> use thin (1 node) branches
3879 fruit, --string fruit node name
3880 fruit_chance, --num chance (0-100) to replace leaves with fruit node
3881 seed, --num random seed, if no seed is provided, the engine
3885 Key for special L-System symbols used in axioms
3886 -----------------------------------------------
3888 * `G`: move forward one unit with the pen up
3889 * `F`: move forward one unit with the pen down drawing trunks and branches
3890 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
3891 * `T`: move forward one unit with the pen down drawing trunks only
3892 * `R`: move forward one unit with the pen down placing fruit
3893 * `A`: replace with rules set A
3894 * `B`: replace with rules set B
3895 * `C`: replace with rules set C
3896 * `D`: replace with rules set D
3897 * `a`: replace with rules set A, chance 90%
3898 * `b`: replace with rules set B, chance 80%
3899 * `c`: replace with rules set C, chance 70%
3900 * `d`: replace with rules set D, chance 60%
3901 * `+`: yaw the turtle right by `angle` parameter
3902 * `-`: yaw the turtle left by `angle` parameter
3903 * `&`: pitch the turtle down by `angle` parameter
3904 * `^`: pitch the turtle up by `angle` parameter
3905 * `/`: roll the turtle to the right by `angle` parameter
3906 * `*`: roll the turtle to the left by `angle` parameter
3907 * `[`: save in stack current state info
3908 * `]`: recover from stack state info
3913 Spawn a small apple tree:
3915 pos = {x=230,y=20,z=4}
3918 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
3919 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
3920 trunk="default:tree",
3921 leaves="default:leaves",
3925 trunk_type="single",
3928 fruit="default:apple"
3930 minetest.spawn_tree(pos,apple_tree)
3935 'minetest' namespace reference
3936 ==============================
3941 * `minetest.get_current_modname()`: returns the currently loading mod's name,
3943 * `minetest.get_modpath(modname)`: returns e.g.
3944 `"/home/user/.minetest/usermods/modname"`.
3945 * Useful for loading additional `.lua` modules or static data from mod
3946 * `minetest.get_modnames()`: returns a list of installed mods
3947 * Return a list of installed mods, sorted alphabetically
3948 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
3949 * Useful for storing custom data
3950 * `minetest.is_singleplayer()`
3951 * `minetest.features`: Table containing API feature flags
3954 glasslike_framed = true, -- 0.4.7
3955 nodebox_as_selectionbox = true, -- 0.4.7
3956 get_all_craft_recipes_works = true, -- 0.4.7
3957 -- The transparency channel of textures can optionally be used on
3959 use_texture_alpha = true,
3960 -- Tree and grass ABMs are no longer done from C++ (0.4.8)
3961 no_legacy_abms = true,
3962 -- Texture grouping is possible using parentheses (0.4.11)
3963 texture_names_parens = true,
3964 -- Unique Area ID for AreaStore:insert_area (0.4.14)
3965 area_store_custom_ids = true,
3966 -- add_entity supports passing initial staticdata to on_activate
3968 add_entity_with_staticdata = true,
3969 -- Chat messages are no longer predicted (0.4.16)
3970 no_chat_message_prediction = true,
3971 -- The transparency channel of textures can optionally be used on
3972 -- objects (ie: players and lua entities) (5.0.0)
3973 object_use_texture_alpha = true,
3974 -- Object selectionbox is settable independently from collisionbox
3976 object_independent_selectionbox = true,
3977 -- Specifies whether binary data can be uploaded or downloaded using
3978 -- the HTTP API (5.1.0)
3979 httpfetch_binary_data = true,
3980 -- Whether formspec_version[<version>] may be used (5.1.0)
3981 formspec_version_element = true,
3982 -- Whether AreaStore's IDs are kept on save/load (5.1.0)
3983 area_store_persistent_ids = true,
3986 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
3987 * `arg`: string or table in format `{foo=true, bar=true}`
3988 * `missing_features`: `{foo=true, bar=true}`
3989 * `minetest.get_player_information(player_name)`: Table containing information
3990 about a player. Example return value:
3993 address = "127.0.0.1", -- IP address of client
3994 ip_version = 4, -- IPv4 / IPv6
3995 min_rtt = 0.01, -- minimum round trip time
3996 max_rtt = 0.2, -- maximum round trip time
3997 avg_rtt = 0.02, -- average round trip time
3998 min_jitter = 0.01, -- minimum packet time jitter
3999 max_jitter = 0.5, -- maximum packet time jitter
4000 avg_jitter = 0.03, -- average packet time jitter
4001 connection_uptime = 200, -- seconds since client connected
4002 protocol_version = 32, -- protocol version used by client
4003 formspec_version = 2, -- supported formspec version
4004 -- following information is available on debug build only!!!
4005 -- DO NOT USE IN MODS
4006 --ser_vers = 26, -- serialization version used by client
4007 --major = 0, -- major version number
4008 --minor = 4, -- minor version number
4009 --patch = 10, -- patch version number
4010 --vers_string = "0.4.9-git", -- full version string
4011 --state = "Active" -- current client state
4014 * `minetest.mkdir(path)`: returns success.
4015 * Creates a directory specified by `path`, creating parent directories
4016 if they don't exist.
4017 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
4019 * nil: return all entries,
4020 * true: return only subdirectory names, or
4021 * false: return only file names.
4022 * `minetest.safe_file_write(path, content)`: returns boolean indicating success
4023 * Replaces contents of file at path with new contents in a safe (atomic)
4024 way. Use this instead of below code when writing e.g. database files:
4025 `local f = io.open(path, "wb"); f:write(content); f:close()`
4026 * `minetest.get_version()`: returns a table containing components of the
4027 engine version. Components:
4028 * `project`: Name of the project, eg, "Minetest"
4029 * `string`: Simple version, eg, "1.2.3-dev"
4030 * `hash`: Full git version (only set if available),
4031 eg, "1.2.3-dev-01234567-dirty".
4032 Use this for informational purposes only. The information in the returned
4033 table does not represent the capabilities of the engine, nor is it
4034 reliable or verifiable. Compatible forks will have a different name and
4035 version entirely. To check for the presence of engine features, test
4036 whether the functions exported by the wanted features exist. For example:
4037 `if minetest.check_for_falling then ... end`.
4038 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
4039 * `data`: string of data to hash
4040 * `raw`: return raw bytes instead of hex digits, default: false
4045 * `minetest.debug(...)`
4046 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
4047 * `minetest.log([level,] text)`
4048 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
4049 `"info"`, or `"verbose"`. Default is `"none"`.
4051 Registration functions
4052 ----------------------
4054 Call these functions only at load time!
4058 * `minetest.register_node(name, node definition)`
4059 * `minetest.register_craftitem(name, item definition)`
4060 * `minetest.register_tool(name, item definition)`
4061 * `minetest.override_item(name, redefinition)`
4062 * Overrides fields of an item registered with register_node/tool/craftitem.
4063 * Note: Item must already be defined, (opt)depend on the mod defining it.
4064 * Example: `minetest.override_item("default:mese",
4065 {light_source=minetest.LIGHT_MAX})`
4066 * `minetest.unregister_item(name)`
4067 * Unregisters the item from the engine, and deletes the entry with key
4068 `name` from `minetest.registered_items` and from the associated item table
4069 according to its nature: `minetest.registered_nodes`, etc.
4070 * `minetest.register_entity(name, entity definition)`
4071 * `minetest.register_abm(abm definition)`
4072 * `minetest.register_lbm(lbm definition)`
4073 * `minetest.register_alias(alias, original_name)`
4074 * Also use this to set the 'mapgen aliases' needed in a game for the core
4075 mapgens. See [Mapgen aliases] section above.
4076 * `minetest.register_alias_force(alias, original_name)`
4077 * `minetest.register_ore(ore definition)`
4078 * Returns an integer object handle uniquely identifying the registered
4080 * The order of ore registrations determines the order of ore generation.
4081 * `minetest.register_biome(biome definition)`
4082 * Returns an integer object handle uniquely identifying the registered
4083 biome on success. To get the biome ID, use `minetest.get_biome_id`.
4084 * `minetest.unregister_biome(name)`
4085 * Unregisters the biome from the engine, and deletes the entry with key
4086 `name` from `minetest.registered_biomes`.
4087 * `minetest.register_decoration(decoration definition)`
4088 * Returns an integer object handle uniquely identifying the registered
4089 decoration on success. To get the decoration ID, use
4090 `minetest.get_decoration_id`.
4091 * The order of decoration registrations determines the order of decoration
4093 * `minetest.register_schematic(schematic definition)`
4094 * Returns an integer object handle uniquely identifying the registered
4095 schematic on success.
4096 * If the schematic is loaded from a file, the `name` field is set to the
4098 * If the function is called when loading the mod, and `name` is a relative
4099 path, then the current mod path will be prepended to the schematic
4101 * `minetest.clear_registered_ores()`
4102 * Clears all ores currently registered.
4103 * `minetest.clear_registered_biomes()`
4104 * Clears all biomes currently registered.
4105 * `minetest.clear_registered_decorations()`
4106 * Clears all decorations currently registered.
4107 * `minetest.clear_registered_schematics()`
4108 * Clears all schematics currently registered.
4112 * `minetest.register_craft(recipe)`
4113 * Check recipe table syntax for different types below.
4114 * `minetest.clear_craft(recipe)`
4115 * Will erase existing craft based either on output item or on input recipe.
4116 * Specify either output or input only. If you specify both, input will be
4117 ignored. For input use the same recipe table syntax as for
4118 `minetest.register_craft(recipe)`. For output specify only the item,
4120 * Returns false if no erase candidate could be found, otherwise returns true.
4121 * **Warning**! The type field ("shaped", "cooking" or any other) will be
4122 ignored if the recipe contains output. Erasing is then done independently
4123 from the crafting method.
4124 * `minetest.register_chatcommand(cmd, chatcommand definition)`
4125 * `minetest.override_chatcommand(name, redefinition)`
4126 * Overrides fields of a chatcommand registered with `register_chatcommand`.
4127 * `minetest.unregister_chatcommand(name)`
4128 * Unregisters a chatcommands registered with `register_chatcommand`.
4129 * `minetest.register_privilege(name, definition)`
4130 * `definition` can be a description or a definition table (see [Privilege
4132 * If it is a description, the priv will be granted to singleplayer and admin
4134 * To allow players with `basic_privs` to grant, see the `basic_privs`
4135 minetest.conf setting.
4136 * `minetest.register_authentication_handler(authentication handler definition)`
4137 * Registers an auth handler that overrides the builtin one.
4138 * This function can be called by a single mod once only.
4140 Global callback registration functions
4141 --------------------------------------
4143 Call these functions only at load time!
4145 * `minetest.register_globalstep(function(dtime))`
4146 * Called every server step, usually interval of 0.1s
4147 * `minetest.register_on_mods_loaded(function())`
4148 * Called after mods have finished loading and before the media is cached or the
4150 * `minetest.register_on_shutdown(function())`
4151 * Called before server shutdown
4152 * **Warning**: If the server terminates abnormally (i.e. crashes), the
4153 registered callbacks **will likely not be run**. Data should be saved at
4154 semi-frequent intervals as well as on server shutdown.
4155 * `minetest.register_on_placenode(function(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
4156 * Called when a node has been placed
4157 * If return `true` no item is taken from `itemstack`
4158 * `placer` may be any valid ObjectRef or nil.
4159 * **Not recommended**; use `on_construct` or `after_place_node` in node
4160 definition whenever possible.
4161 * `minetest.register_on_dignode(function(pos, oldnode, digger))`
4162 * Called when a node has been dug.
4163 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node
4164 definition whenever possible.
4165 * `minetest.register_on_punchnode(function(pos, node, puncher, pointed_thing))`
4166 * Called when a node is punched
4167 * `minetest.register_on_generated(function(minp, maxp, blockseed))`
4168 * Called after generating a piece of world. Modifying nodes inside the area
4169 is a bit faster than usually.
4170 * `minetest.register_on_newplayer(function(ObjectRef))`
4171 * Called after a new player has been created
4172 * `minetest.register_on_punchplayer(function(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
4173 * Called when a player is punched
4174 * Note: This callback is invoked even if the punched player is dead.
4175 * `player`: ObjectRef - Player that was punched
4176 * `hitter`: ObjectRef - Player that hit
4177 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4179 * `tool_capabilities`: Capability table of used tool (can be nil)
4180 * `dir`: Unit vector of direction of punch. Always defined. Points from
4181 the puncher to the punched.
4182 * `damage`: Number that represents the damage calculated by the engine
4183 * should return `true` to prevent the default damage mechanism
4184 * `minetest.register_on_player_hpchange(function(player, hp_change, reason), modifier)`
4185 * Called when the player gets damaged or healed
4186 * `player`: ObjectRef of the player
4187 * `hp_change`: the amount of change. Negative when it is damage.
4188 * `reason`: a PlayerHPChangeReason table.
4189 * The `type` field will have one of the following values:
4190 * `set_hp`: A mod or the engine called `set_hp` without
4191 giving a type - use this for custom damage types.
4192 * `punch`: Was punched. `reason.object` will hold the puncher, or nil if none.
4194 * `node_damage`: `damage_per_second` from a neighbouring node.
4195 `reason.node` will hold the node name or nil.
4198 * Any of the above types may have additional fields from mods.
4199 * `reason.from` will be `mod` or `engine`.
4200 * `modifier`: when true, the function should return the actual `hp_change`.
4201 Note: modifiers only get a temporary `hp_change` that can be modified by later modifiers.
4202 Modifiers can return true as a second argument to stop the execution of further functions.
4203 Non-modifiers receive the final HP change calculated by the modifiers.
4204 * `minetest.register_on_dieplayer(function(ObjectRef, reason))`
4205 * Called when a player dies
4206 * `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
4207 * `minetest.register_on_respawnplayer(function(ObjectRef))`
4208 * Called when player is to be respawned
4209 * Called _before_ repositioning of player occurs
4210 * return true in func to disable regular player placement
4211 * `minetest.register_on_prejoinplayer(function(name, ip))`
4212 * Called before a player joins the game
4213 * If it returns a string, the player is disconnected with that string as
4215 * `minetest.register_on_joinplayer(function(ObjectRef))`
4216 * Called when a player joins the game
4217 * `minetest.register_on_leaveplayer(function(ObjectRef, timed_out))`
4218 * Called when a player leaves the game
4219 * `timed_out`: True for timeout, false for other reasons.
4220 * `minetest.register_on_auth_fail(function(name, ip))`
4221 * Called when a client attempts to log into an account but supplies the
4223 * `ip`: The IP address of the client.
4224 * `name`: The account the client attempted to log into.
4225 * `minetest.register_on_cheat(function(ObjectRef, cheat))`
4226 * Called when a player cheats
4227 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
4229 * `interacted_too_far`
4230 * `interacted_while_dead`
4231 * `finished_unknown_dig`
4234 * `minetest.register_on_chat_message(function(name, message))`
4235 * Called always when a player says something
4236 * Return `true` to mark the message as handled, which means that it will
4237 not be sent to other players.
4238 * `minetest.register_on_player_receive_fields(function(player, formname, fields))`
4239 * Called when the server received input from `player` in a formspec with
4240 the given `formname`. Specifically, this is called on any of the
4242 * a button was pressed,
4243 * Enter was pressed while the focus was on a text field
4244 * a checkbox was toggled,
4245 * something was selecteed in a drop-down list,
4246 * a different tab was selected,
4247 * selection was changed in a textlist or table,
4248 * an entry was double-clicked in a textlist or table,
4249 * a scrollbar was moved, or
4250 * the form was actively closed by the player.
4251 * Fields are sent for formspec elements which define a field. `fields`
4252 is a table containing each formspecs element value (as string), with
4253 the `name` parameter as index for each. The value depends on the
4254 formspec element type:
4255 * `button` and variants: If pressed, contains the user-facing button
4256 text as value. If not pressed, is `nil`
4257 * `field`, `textarea` and variants: Text in the field
4258 * `dropdown`: Text of selected item
4259 * `tabheader`: Tab index, starting with `"1"` (only if tab changed)
4260 * `checkbox`: `"true"` if checked, `"false"` if unchecked
4261 * `textlist`: See `minetest.explode_textlist_event`
4262 * `table`: See `minetest.explode_table_event`
4263 * `scrollbar`: See `minetest.explode_scrollbar_event`
4264 * Special case: `["quit"]="true"` is sent when the user actively
4265 closed the form by mouse click, keypress or through a button_exit[]
4267 * Special case: `["key_enter"]="true"` is sent when the user pressed
4268 the Enter key and the focus was either nowhere (causing the formspec
4269 to be closed) or on a button. If the focus was on a text field,
4270 additionally, the index `key_enter_field` contains the name of the
4271 text field. See also: `field_close_on_enter`.
4272 * Newest functions are called first
4273 * If function returns `true`, remaining functions are not called
4274 * `minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv))`
4275 * Called when `player` crafts something
4276 * `itemstack` is the output
4277 * `old_craft_grid` contains the recipe (Note: the one in the inventory is
4279 * `craft_inv` is the inventory with the crafting grid
4280 * Return either an `ItemStack`, to replace the output, or `nil`, to not
4282 * `minetest.register_craft_predict(function(itemstack, player, old_craft_grid, craft_inv))`
4283 * The same as before, except that it is called before the player crafts, to
4284 make craft prediction, and it should not change anything.
4285 * `minetest.register_allow_player_inventory_action(function(player, action, inventory, inventory_info))`
4286 * Determinates how much of a stack may be taken, put or moved to a
4288 * `player` (type `ObjectRef`) is the player who modified the inventory
4289 `inventory` (type `InvRef`).
4290 * List of possible `action` (string) values and their
4291 `inventory_info` (table) contents:
4292 * `move`: `{from_list=string, to_list=string, from_index=number, to_index=number, count=number}`
4293 * `put`: `{listname=string, index=number, stack=ItemStack}`
4294 * `take`: Same as `put`
4295 * Return a numeric value to limit the amount of items to be taken, put or
4296 moved. A value of `-1` for `take` will make the source stack infinite.
4297 * `minetest.register_on_player_inventory_action(function(player, action, inventory, inventory_info))`
4298 * Called after a take, put or move event from/to/in a player inventory
4299 * Function arguments: see `minetest.register_allow_player_inventory_action`
4300 * Does not accept or handle any return value.
4301 * `minetest.register_on_protection_violation(function(pos, name))`
4302 * Called by `builtin` and mods when a player violates protection at a
4303 position (eg, digs a node or punches a protected entity).
4304 * The registered functions can be called using
4305 `minetest.record_protection_violation`.
4306 * The provided function should check that the position is protected by the
4307 mod calling this function before it prints a message, if it does, to
4308 allow for multiple protection mods.
4309 * `minetest.register_on_item_eat(function(hp_change, replace_with_item, itemstack, user, pointed_thing))`
4310 * Called when an item is eaten, by `minetest.item_eat`
4311 * Return `itemstack` to cancel the default item eat response (i.e.: hp increase).
4312 * `minetest.register_on_priv_grant(function(name, granter, priv))`
4313 * Called when `granter` grants the priv `priv` to `name`.
4314 * Note that the callback will be called twice if it's done by a player,
4315 once with granter being the player name, and again with granter being nil.
4316 * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
4317 * Called when `revoker` revokes the priv `priv` from `name`.
4318 * Note that the callback will be called twice if it's done by a player,
4319 once with revoker being the player name, and again with revoker being nil.
4320 * `minetest.register_can_bypass_userlimit(function(name, ip))`
4321 * Called when `name` user connects with `ip`.
4322 * Return `true` to by pass the player limit
4323 * `minetest.register_on_modchannel_message(function(channel_name, sender, message))`
4324 * Called when an incoming mod channel message is received
4325 * You should have joined some channels to receive events.
4326 * If message comes from a server mod, `sender` field is an empty string.
4331 * `minetest.settings`: Settings object containing all of the settings from the
4332 main config file (`minetest.conf`).
4333 * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
4334 parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
4339 * `minetest.string_to_privs(str[, delim])`:
4340 * Converts string representation of privs into table form
4341 * `delim`: String separating the privs. Defaults to `","`.
4342 * Returns `{ priv1 = true, ... }`
4343 * `minetest.privs_to_string(privs[, delim])`:
4344 * Returns the string representation of `privs`
4345 * `delim`: String to delimit privs. Defaults to `","`.
4346 * `minetest.get_player_privs(name) -> {priv1=true,...}`
4347 * `minetest.check_player_privs(player_or_name, ...)`:
4348 returns `bool, missing_privs`
4349 * A quickhand for checking privileges.
4350 * `player_or_name`: Either a Player object or the name of a player.
4351 * `...` is either a list of strings, e.g. `"priva", "privb"` or
4352 a table, e.g. `{ priva = true, privb = true }`.
4354 * `minetest.check_password_entry(name, entry, password)`
4355 * Returns true if the "password entry" for a player with name matches given
4356 password, false otherwise.
4357 * The "password entry" is the password representation generated by the
4358 engine as returned as part of a `get_auth()` call on the auth handler.
4359 * Only use this function for making it possible to log in via password from
4360 external protocols such as IRC, other uses are frowned upon.
4361 * `minetest.get_password_hash(name, raw_password)`
4362 * Convert a name-password pair to a password hash that Minetest can use.
4363 * The returned value alone is not a good basis for password checks based
4364 on comparing the password hash in the database with the password hash
4365 from the function, with an externally provided password, as the hash
4366 in the db might use the new SRP verifier format.
4367 * For this purpose, use `minetest.check_password_entry` instead.
4368 * `minetest.get_player_ip(name)`: returns an IP address string for the player
4370 * The player needs to be online for this to be successful.
4372 * `minetest.get_auth_handler()`: Return the currently active auth handler
4373 * See the [Authentication handler definition]
4374 * Use this to e.g. get the authentication data for a player:
4375 `local auth_data = minetest.get_auth_handler().get_auth(playername)`
4376 * `minetest.notify_authentication_modified(name)`
4377 * Must be called by the authentication handler for privilege changes.
4378 * `name`: string; if omitted, all auth data should be considered modified
4379 * `minetest.set_player_password(name, password_hash)`: Set password hash of
4381 * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player
4383 * `minetest.auth_reload()`
4384 * See `reload()` in authentication handler definition
4386 `minetest.set_player_password`, `minetest_set_player_privs`,
4387 `minetest_get_player_privs` and `minetest.auth_reload` call the authentication
4393 * `minetest.chat_send_all(text)`
4394 * `minetest.chat_send_player(name, text)`
4395 * `minetest.format_chat_message(name, message)`
4396 * Used by the server to format a chat message, based on the setting `chat_message_format`.
4397 Refer to the documentation of the setting for a list of valid placeholders.
4398 * Takes player name and message, and returns the formatted string to be sent to players.
4399 * Can be redefined by mods if required, for things like colored names or messages.
4400 * **Only** the first occurrence of each placeholder will be replaced.
4405 * `minetest.set_node(pos, node)`
4406 * `minetest.add_node(pos, node)`: alias to `minetest.set_node`
4407 * Set node at position `pos`
4408 * `node`: table `{name=string, param1=number, param2=number}`
4409 * If param1 or param2 is omitted, it's set to `0`.
4410 * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
4411 * `minetest.bulk_set_node({pos1, pos2, pos3, ...}, node)`
4412 * Set node on all positions set in the first argument.
4413 * e.g. `minetest.bulk_set_node({{x=0, y=1, z=1}, {x=1, y=2, z=2}}, {name="default:stone"})`
4414 * For node specification or position syntax see `minetest.set_node` call
4415 * Faster than set_node due to single call, but still considerably slower
4416 than Lua Voxel Manipulators (LVM) for large numbers of nodes.
4417 Unlike LVMs, this will call node callbacks. It also allows setting nodes
4418 in spread out positions which would cause LVMs to waste memory.
4419 For setting a cube, this is 1.3x faster than set_node whereas LVM is 20
4421 * `minetest.swap_node(pos, node)`
4422 * Set node at position, but don't remove metadata
4423 * `minetest.remove_node(pos)`
4424 * By default it does the same as `minetest.set_node(pos, {name="air"})`
4425 * `minetest.get_node(pos)`
4426 * Returns the node at the given position as table in the format
4427 `{name="node_name", param1=0, param2=0}`,
4428 returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
4429 * `minetest.get_node_or_nil(pos)`
4430 * Same as `get_node` but returns `nil` for unloaded areas.
4431 * `minetest.get_node_light(pos, timeofday)`
4432 * Gets the light value at the given position. Note that the light value
4433 "inside" the node at the given position is returned, so you usually want
4434 to get the light value of a neighbor.
4435 * `pos`: The position where to measure the light.
4436 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
4437 * Returns a number between `0` and `15` or `nil`
4438 * `minetest.place_node(pos, node)`
4439 * Place node with the same effects that a player would cause
4440 * `minetest.dig_node(pos)`
4441 * Dig node with the same effects that a player would cause
4442 * Returns `true` if successful, `false` on failure (e.g. protected location)
4443 * `minetest.punch_node(pos)`
4444 * Punch node with the same effects that a player would cause
4445 * `minetest.spawn_falling_node(pos)`
4446 * Change node into falling node
4447 * Returns `true` if successful, `false` on failure
4449 * `minetest.find_nodes_with_meta(pos1, pos2)`
4450 * Get a table of positions of nodes that have metadata within a region
4452 * `minetest.get_meta(pos)`
4453 * Get a `NodeMetaRef` at that position
4454 * `minetest.get_node_timer(pos)`
4455 * Get `NodeTimerRef`
4457 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at
4459 * Returns `ObjectRef`, or `nil` if failed
4460 * `minetest.add_item(pos, item)`: Spawn item
4461 * Returns `ObjectRef`, or `nil` if failed
4462 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
4463 * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of
4465 * `radius`: using an euclidean metric
4466 * `minetest.set_timeofday(val)`
4467 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
4468 * `minetest.get_timeofday()`
4469 * `minetest.get_gametime()`: returns the time, in seconds, since the world was
4471 * `minetest.get_day_count()`: returns number days elapsed since world was
4473 * accounts for time changes.
4474 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns
4476 * `radius`: using a maximum metric
4477 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4478 * `search_center` is an optional boolean (default: `false`)
4479 If true `pos` is also checked for the nodes
4480 * `minetest.find_nodes_in_area(pos1, pos2, nodenames)`: returns a list of
4482 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4483 * First return value: Table with all node positions
4484 * Second return value: Table with the count of each node with the node name
4486 * Area volume is limited to 4,096,000 nodes
4487 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
4489 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4490 * Return value: Table with all node positions with a node air above
4491 * Area volume is limited to 4,096,000 nodes
4492 * `minetest.get_perlin(noiseparams)`
4493 * `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
4494 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
4495 * `minetest.get_voxel_manip([pos1, pos2])`
4496 * Return voxel manipulator object.
4497 * Loads the manipulator from the map if positions are passed.
4498 * `minetest.set_gen_notify(flags, {deco_ids})`
4499 * Set the types of on-generate notifications that should be collected.
4500 * `flags` is a flag field with the available flags:
4508 * The second parameter is a list of IDs of decorations which notification
4510 * `minetest.get_gen_notify()`
4511 * Returns a flagstring and a table with the `deco_id`s.
4512 * `minetest.get_decoration_id(decoration_name)`
4513 * Returns the decoration ID number for the provided decoration name string,
4514 or `nil` on failure.
4515 * `minetest.get_mapgen_object(objectname)`
4516 * Return requested mapgen object if available (see [Mapgen objects])
4517 * `minetest.get_heat(pos)`
4518 * Returns the heat at the position, or `nil` on failure.
4519 * `minetest.get_humidity(pos)`
4520 * Returns the humidity at the position, or `nil` on failure.
4521 * `minetest.get_biome_data(pos)`
4522 * Returns a table containing:
4523 * `biome` the biome id of the biome at that position
4524 * `heat` the heat at the position
4525 * `humidity` the humidity at the position
4526 * Or returns `nil` on failure.
4527 * `minetest.get_biome_id(biome_name)`
4528 * Returns the biome id, as used in the biomemap Mapgen object and returned
4529 by `minetest.get_biome_data(pos)`, for a given biome_name string.
4530 * `minetest.get_biome_name(biome_id)`
4531 * Returns the biome name string for the provided biome id, or `nil` on
4533 * If no biomes have been registered, such as in mgv6, returns `default`.
4534 * `minetest.get_mapgen_params()`
4535 * Deprecated: use `minetest.get_mapgen_setting(name)` instead.
4536 * Returns a table containing:
4542 * `minetest.set_mapgen_params(MapgenParams)`
4543 * Deprecated: use `minetest.set_mapgen_setting(name, value, override)`
4545 * Set map generation parameters.
4546 * Function cannot be called after the registration period; only
4547 initialization and `on_mapgen_init`.
4548 * Takes a table as an argument with the fields:
4554 * Leave field unset to leave that parameter unchanged.
4555 * `flags` contains a comma-delimited string of flags to set, or if the
4556 prefix `"no"` is attached, clears instead.
4557 * `flags` is in the same format and has the same options as `mg_flags` in
4559 * `minetest.get_mapgen_setting(name)`
4560 * Gets the *active* mapgen setting (or nil if none exists) in string
4561 format with the following order of precedence:
4562 1) Settings loaded from map_meta.txt or overrides set during mod
4564 2) Settings set by mods without a metafile override
4565 3) Settings explicitly set in the user config file, minetest.conf
4566 4) Settings set as the user config default
4567 * `minetest.get_mapgen_setting_noiseparams(name)`
4568 * Same as above, but returns the value as a NoiseParams table if the
4569 setting `name` exists and is a valid NoiseParams.
4570 * `minetest.set_mapgen_setting(name, value, [override_meta])`
4571 * Sets a mapgen param to `value`, and will take effect if the corresponding
4572 mapgen setting is not already present in map_meta.txt.
4573 * `override_meta` is an optional boolean (default: `false`). If this is set
4574 to true, the setting will become the active setting regardless of the map
4576 * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`.
4577 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
4578 * Same as above, except value is a NoiseParams table.
4579 * `minetest.set_noiseparams(name, noiseparams, set_default)`
4580 * Sets the noiseparams setting of `name` to the noiseparams table specified
4582 * `set_default` is an optional boolean (default: `true`) that specifies
4583 whether the setting should be applied to the default config or current
4585 * `minetest.get_noiseparams(name)`
4586 * Returns a table of the noiseparams for name.
4587 * `minetest.generate_ores(vm, pos1, pos2)`
4588 * Generate all registered ores within the VoxelManip `vm` and in the area
4589 from `pos1` to `pos2`.
4590 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
4591 * `minetest.generate_decorations(vm, pos1, pos2)`
4592 * Generate all registered decorations within the VoxelManip `vm` and in the
4593 area from `pos1` to `pos2`.
4594 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
4595 * `minetest.clear_objects([options])`
4596 * Clear all objects in the environment
4597 * Takes an optional table as an argument with the field `mode`.
4598 * mode = `"full"` : Load and go through every mapblock, clearing
4600 * mode = `"quick"`: Clear objects immediately in loaded mapblocks,
4601 clear objects in unloaded mapblocks only when the
4602 mapblocks are next activated.
4603 * `minetest.load_area(pos1[, pos2])`
4604 * Load the mapblocks containing the area from `pos1` to `pos2`.
4605 `pos2` defaults to `pos1` if not specified.
4606 * This function does not trigger map generation.
4607 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
4608 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be
4609 asynchronously fetched from memory, loaded from disk, or if inexistent,
4611 * If `callback` is a valid Lua function, this will be called for each block
4613 * The function signature of callback is:
4614 `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
4615 * `blockpos` is the *block* coordinates of the block that had been
4617 * `action` could be one of the following constant values:
4618 * `minetest.EMERGE_CANCELLED`
4619 * `minetest.EMERGE_ERRORED`
4620 * `minetest.EMERGE_FROM_MEMORY`
4621 * `minetest.EMERGE_FROM_DISK`
4622 * `minetest.EMERGE_GENERATED`
4623 * `calls_remaining` is the number of callbacks to be expected after
4625 * `param` is the user-defined parameter passed to emerge_area (or
4626 nil if the parameter was absent).
4627 * `minetest.delete_area(pos1, pos2)`
4628 * delete all mapblocks in the area from pos1 to pos2, inclusive
4629 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
4630 * Checks if there is anything other than air between pos1 and pos2.
4631 * Returns false if something is blocking the sight.
4632 * Returns the position of the blocking node when `false`
4633 * `pos1`: First position
4634 * `pos2`: Second position
4635 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
4636 * Creates a `Raycast` object.
4637 * `pos1`: start of the ray
4638 * `pos2`: end of the ray
4639 * `objects`: if false, only nodes will be returned. Default is `true`.
4640 * `liquids`: if false, liquid nodes won't be returned. Default is `false`.
4641 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
4642 * returns table containing path
4643 * returns a table of 3D points representing a path from `pos1` to `pos2` or
4645 * `pos1`: start position
4646 * `pos2`: end position
4647 * `searchdistance`: number of blocks to search in each direction using a
4649 * `max_jump`: maximum height difference to consider walkable
4650 * `max_drop`: maximum height difference to consider droppable
4651 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
4652 * `minetest.spawn_tree (pos, {treedef})`
4653 * spawns L-system tree at given `pos` with definition in `treedef` table
4654 * `minetest.transforming_liquid_add(pos)`
4655 * add node to liquid update queue
4656 * `minetest.get_node_max_level(pos)`
4657 * get max available level for leveled node
4658 * `minetest.get_node_level(pos)`
4659 * get level of leveled node (water, snow)
4660 * `minetest.set_node_level(pos, level)`
4661 * set level of leveled node, default `level` equals `1`
4662 * if `totallevel > maxlevel`, returns rest (`total-max`).
4663 * `minetest.add_node_level(pos, level)`
4664 * increase level of leveled node by level, default `level` equals `1`
4665 * if `totallevel > maxlevel`, returns rest (`total-max`)
4666 * can be negative for decreasing
4667 * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
4668 * resets the light in a cuboid-shaped part of
4669 the map and removes lighting bugs.
4670 * Loads the area if it is not loaded.
4671 * `pos1` is the corner of the cuboid with the least coordinates
4672 (in node coordinates), inclusive.
4673 * `pos2` is the opposite corner of the cuboid, inclusive.
4674 * The actual updated cuboid might be larger than the specified one,
4675 because only whole map blocks can be updated.
4676 The actual updated area consists of those map blocks that intersect
4677 with the given cuboid.
4678 * However, the neighborhood of the updated area might change
4679 as well, as light can spread out of the cuboid, also light
4681 * returns `false` if the area is not fully generated,
4683 * `minetest.check_single_for_falling(pos)`
4684 * causes an unsupported `group:falling_node` node to fall and causes an
4685 unattached `group:attached_node` node to fall.
4686 * does not spread these updates to neighbours.
4687 * `minetest.check_for_falling(pos)`
4688 * causes an unsupported `group:falling_node` node to fall and causes an
4689 unattached `group:attached_node` node to fall.
4690 * spread these updates to neighbours and can cause a cascade
4692 * `minetest.get_spawn_level(x, z)`
4693 * Returns a player spawn y co-ordinate for the provided (x, z)
4694 co-ordinates, or `nil` for an unsuitable spawn point.
4695 * For most mapgens a 'suitable spawn point' is one with y between
4696 `water_level` and `water_level + 16`, and in mgv7 well away from rivers,
4697 so `nil` will be returned for many (x, z) co-ordinates.
4698 * The spawn level returned is for a player spawn in unmodified terrain.
4699 * The spawn level is intentionally above terrain level to cope with
4700 full-node biome 'dust' nodes.
4705 You can find mod channels communication scheme in `doc/mod_channels.png`.
4707 * `minetest.mod_channel_join(channel_name)`
4708 * Server joins channel `channel_name`, and creates it if necessary. You
4709 should listen for incoming messages with
4710 `minetest.register_on_modchannel_message`
4715 `minetest.get_inventory(location)`: returns an `InvRef`
4718 * `{type="player", name="celeron55"}`
4719 * `{type="node", pos={x=, y=, z=}}`
4720 * `{type="detached", name="creative"}`
4721 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns
4723 * `callbacks`: See [Detached inventory callbacks]
4724 * `player_name`: Make detached inventory available to one player
4725 exclusively, by default they will be sent to every player (even if not
4727 Note that this parameter is mostly just a workaround and will be removed
4729 * Creates a detached inventory. If it already exists, it is cleared.
4730 * `minetest.remove_detached_inventory(name)`
4731 * Returns a `boolean` indicating whether the removal succeeded.
4732 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
4733 returns left over ItemStack.
4734 * See `minetest.item_eat` and `minetest.register_on_item_eat`
4739 * `minetest.show_formspec(playername, formname, formspec)`
4740 * `playername`: name of player to show formspec
4741 * `formname`: name passed to `on_player_receive_fields` callbacks.
4742 It should follow the `"modname:<whatever>"` naming convention
4743 * `formspec`: formspec to display
4744 * `minetest.close_formspec(playername, formname)`
4745 * `playername`: name of player to close formspec
4746 * `formname`: has to exactly match the one given in `show_formspec`, or the
4747 formspec will not close.
4748 * calling `show_formspec(playername, formname, "")` is equal to this
4750 * to close a formspec regardless of the formname, call
4751 `minetest.close_formspec(playername, "")`.
4752 **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
4753 * `minetest.formspec_escape(string)`: returns a string
4754 * escapes the characters "[", "]", "\", "," and ";", which can not be used
4756 * `minetest.explode_table_event(string)`: returns a table
4757 * returns e.g. `{type="CHG", row=1, column=2}`
4759 * `"INV"`: no row selected
4761 * `"DCL"`: double-click
4762 * `minetest.explode_textlist_event(string)`: returns a table
4763 * returns e.g. `{type="CHG", index=1}`
4765 * `"INV"`: no row selected
4767 * `"DCL"`: double-click
4768 * `minetest.explode_scrollbar_event(string)`: returns a table
4769 * returns e.g. `{type="CHG", value=500}`
4771 * `"INV"`: something failed
4772 * `"CHG"`: has been changed
4773 * `"VAL"`: not changed
4778 * `minetest.inventorycube(img1, img2, img3)`
4779 * Returns a string for making an image of a cube (useful as an item image)
4780 * `minetest.get_pointed_thing_position(pointed_thing, above)`
4781 * Returns the position of a `pointed_thing` or `nil` if the `pointed_thing`
4782 does not refer to a node or entity.
4783 * If the optional `above` parameter is true and the `pointed_thing` refers
4784 to a node, then it will return the `above` position of the `pointed_thing`.
4785 * `minetest.dir_to_facedir(dir, is6d)`
4786 * Convert a vector to a facedir value, used in `param2` for
4787 `paramtype2="facedir"`.
4788 * passing something non-`nil`/`false` for the optional second parameter
4789 causes it to take the y component into account.
4790 * `minetest.facedir_to_dir(facedir)`
4791 * Convert a facedir back into a vector aimed directly out the "back" of a
4793 * `minetest.dir_to_wallmounted(dir)`
4794 * Convert a vector to a wallmounted value, used for
4795 `paramtype2="wallmounted"`.
4796 * `minetest.wallmounted_to_dir(wallmounted)`
4797 * Convert a wallmounted value back into a vector aimed directly out the
4799 * `minetest.dir_to_yaw(dir)`
4800 * Convert a vector into a yaw (angle)
4801 * `minetest.yaw_to_dir(yaw)`
4802 * Convert yaw (angle) to a vector
4803 * `minetest.is_colored_paramtype(ptype)`
4804 * Returns a boolean. Returns `true` if the given `paramtype2` contains
4805 color information (`color`, `colorwallmounted` or `colorfacedir`).
4806 * `minetest.strip_param2_color(param2, paramtype2)`
4807 * Removes everything but the color information from the
4808 given `param2` value.
4809 * Returns `nil` if the given `paramtype2` does not contain color
4811 * `minetest.get_node_drops(nodename, toolname)`
4812 * Returns list of item names.
4813 * **Note**: This will be removed or modified in a future version.
4814 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
4815 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
4816 * `input.width` = for example `3`
4817 * `input.items` = for example
4818 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
4819 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
4820 * `output.time` = a number, if unsuccessful: `0`
4821 * `output.replacements` = List of replacement `ItemStack`s that couldn't be
4822 placed in `decremented_input.items`. Replacements can be placed in
4823 `decremented_input` if the stack of the replaced item has a count of 1.
4824 * `decremented_input` = like `input`
4825 * `minetest.get_craft_recipe(output)`: returns input
4826 * returns last registered recipe for output item (node)
4827 * `output` is a node or item type such as `"default:torch"`
4828 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
4829 * `input.width` = for example `3`
4830 * `input.items` = for example
4831 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
4832 * `input.items` = `nil` if no recipe found
4833 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
4834 * returns indexed table with all registered recipes for query item (node)
4835 or `nil` if no recipe was found.
4836 * recipe entry table:
4837 * `method`: 'normal' or 'cooking' or 'fuel'
4838 * `width`: 0-3, 0 means shapeless recipe
4839 * `items`: indexed [1-9] table with recipe items
4840 * `output`: string with item name and quantity
4841 * Example query for `"default:gold_ingot"` will return table:
4844 [1]={method = "cooking", width = 3, output = "default:gold_ingot",
4845 items = {1 = "default:gold_lump"}},
4846 [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
4847 items = {1 = "default:goldblock"}}
4849 * `minetest.handle_node_drops(pos, drops, digger)`
4850 * `drops`: list of itemstrings
4851 * Handles drops from nodes after digging: Default action is to put them
4852 into digger's inventory.
4853 * Can be overridden to get different functionality (e.g. dropping items on
4855 * `minetest.itemstring_with_palette(item, palette_index)`: returns an item
4857 * Creates an item string which contains palette index information
4858 for hardware colorization. You can use the returned string
4859 as an output in a craft recipe.
4860 * `item`: the item stack which becomes colored. Can be in string,
4861 table and native form.
4862 * `palette_index`: this index is added to the item stack
4863 * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
4864 * Creates an item string which contains static color information
4865 for hardware colorization. Use this method if you wish to colorize
4866 an item that does not own a palette. You can use the returned string
4867 as an output in a craft recipe.
4868 * `item`: the item stack which becomes colored. Can be in string,
4869 table and native form.
4870 * `colorstring`: the new color of the item stack
4875 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
4876 returns `{{actor, pos, time, oldnode, newnode}, ...}`
4877 * Find who has done something to a node, or near a node
4878 * `actor`: `"player:<name>"`, also `"liquid"`.
4879 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns
4880 `boolean, log_messages`.
4881 * Revert latest actions of someone
4882 * `actor`: `"player:<name>"`, also `"liquid"`.
4884 Defaults for the `on_place` and `on_drop` item definition functions
4885 -------------------------------------------------------------------
4887 * `minetest.item_place_node(itemstack, placer, pointed_thing[, param2, prevent_after_place])`
4888 * Place item as a node
4889 * `param2` overrides `facedir` and wallmounted `param2`
4890 * `prevent_after_place`: if set to `true`, `after_place_node` is not called
4891 for the newly placed node to prevent a callback and placement loop
4892 * returns `itemstack, position`
4893 * `position`: the location the node was placed to. `nil` if nothing was placed.
4894 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
4896 * returns the leftover itemstack
4897 * **Note**: This function is deprecated and will never be called.
4898 * `minetest.item_place(itemstack, placer, pointed_thing[, param2])`
4899 * Wrapper that calls `minetest.item_place_node` if appropriate
4900 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
4901 * **Note**: is not called when wielded item overrides `on_place`
4902 * `param2` overrides facedir and wallmounted `param2`
4903 * returns `itemstack, position`
4904 * `position`: the location the node was placed to. `nil` if nothing was placed.
4905 * `minetest.item_drop(itemstack, dropper, pos)`
4907 * returns the leftover itemstack
4908 * `minetest.item_eat(hp_change[, replace_with_item])`
4909 * Returns `function(itemstack, user, pointed_thing)` as a
4910 function wrapper for `minetest.do_item_eat`.
4911 * `replace_with_item` is the itemstring which is added to the inventory.
4912 If the player is eating a stack, then replace_with_item goes to a
4915 Defaults for the `on_punch` and `on_dig` node definition callbacks
4916 ------------------------------------------------------------------
4918 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
4919 * Calls functions registered by `minetest.register_on_punchnode()`
4920 * `minetest.node_dig(pos, node, digger)`
4921 * Checks if node can be dug, puts item into inventory, removes node
4922 * Calls functions registered by `minetest.registered_on_dignodes()`
4927 * `minetest.sound_play(spec, parameters)`: returns a handle
4928 * `spec` is a `SimpleSoundSpec`
4929 * `parameters` is a sound parameter table
4930 * `minetest.sound_stop(handle)`
4931 * `minetest.sound_fade(handle, step, gain)`
4932 * `handle` is a handle returned by `minetest.sound_play`
4933 * `step` determines how fast a sound will fade.
4934 Negative step will lower the sound volume, positive step will increase
4936 * `gain` the target gain for the fade.
4941 * `minetest.after(time, func, ...)`
4942 * Call the function `func` after `time` seconds, may be fractional
4943 * Optional: Variable number of arguments that are passed to `func`
4948 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for
4949 server shutdown. Will display `message` to clients.
4950 * `reconnect` == true displays a reconnect button
4951 * `delay` adds an optional delay (in seconds) before shutdown.
4952 Negative delay cancels the current active shutdown.
4953 Zero delay triggers an immediate shutdown.
4954 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
4955 * `minetest.get_server_status(name, joined)`
4956 * Returns the server status string when a player joins or when the command
4957 `/status` is called. Returns `nil` or an empty string when the message is
4959 * `joined`: Boolean value, indicates whether the function was called when
4961 * This function may be overwritten by mods to customize the status message.
4962 * `minetest.get_server_uptime()`: returns the server uptime in seconds
4963 * `minetest.remove_player(name)`: remove player from database (if they are not
4965 * As auth data is not removed, minetest.player_exists will continue to
4966 return true. Call the below method as well if you want to remove auth
4968 * Returns a code (0: successful, 1: no such player, 2: player is connected)
4969 * `minetest.remove_player_auth(name)`: remove player authentication data
4970 * Returns boolean indicating success (false if player nonexistant)
4975 * `minetest.get_ban_list()`: returns a list of all bans formatted as string
4976 * `minetest.get_ban_description(ip_or_name)`: returns list of bans matching
4977 IP address or name formatted as string
4978 * `minetest.ban_player(name)`: ban the IP of a currently connected player
4979 * Returns boolean indicating success
4980 * `minetest.unban_player_or_ip(ip_or_name)`: remove ban record matching
4982 * `minetest.kick_player(name, [reason])`: disconnect a player with an optional
4984 * Returns boolean indicating success (false if player nonexistant)
4989 * `minetest.add_particle(particle definition)`
4990 * Deprecated: `minetest.add_particle(pos, velocity, acceleration,
4991 expirationtime, size, collisiondetection, texture, playername)`
4993 * `minetest.add_particlespawner(particlespawner definition)`
4994 * Add a `ParticleSpawner`, an object that spawns an amount of particles
4995 over `time` seconds.
4996 * Returns an `id`, and -1 if adding didn't succeed
4997 * Deprecated: `minetest.add_particlespawner(amount, time,
5001 minexptime, maxexptime,
5003 collisiondetection, texture, playername)`
5005 * `minetest.delete_particlespawner(id, player)`
5006 * Delete `ParticleSpawner` with `id` (return value from
5007 `minetest.add_particlespawner`).
5008 * If playername is specified, only deletes on the player's client,
5009 otherwise on all clients.
5014 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
5015 * Create a schematic from the volume of map specified by the box formed by
5017 * Apply the specified probability and per-node force-place to the specified
5018 nodes according to the `probability_list`.
5019 * `probability_list` is an array of tables containing two fields, `pos`
5021 * `pos` is the 3D vector specifying the absolute coordinates of the
5022 node being modified,
5023 * `prob` is an integer value from `0` to `255` that encodes
5024 probability and per-node force-place. Probability has levels
5025 0-127, then 128 may be added to encode per-node force-place.
5026 For probability stated as 0-255, divide by 2 and round down to
5027 get values 0-127, then add 128 to apply per-node force-place.
5028 * If there are two or more entries with the same pos value, the
5030 * If `pos` is not inside the box formed by `p1` and `p2`, it is
5032 * If `probability_list` equals `nil`, no probabilities are applied.
5033 * Apply the specified probability to the specified horizontal slices
5034 according to the `slice_prob_list`.
5035 * `slice_prob_list` is an array of tables containing two fields, `ypos`
5037 * `ypos` indicates the y position of the slice with a probability
5038 applied, the lowest slice being `ypos = 0`.
5039 * If slice probability list equals `nil`, no slice probabilities
5041 * Saves schematic in the Minetest Schematic format to filename.
5043 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement, flags)`
5044 * Place the schematic specified by schematic (see [Schematic specifier]) at
5046 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
5047 * If the `rotation` parameter is omitted, the schematic is not rotated.
5048 * `replacements` = `{["old_name"] = "convert_to", ...}`
5049 * `force_placement` is a boolean indicating whether nodes other than `air`
5050 and `ignore` are replaced by the schematic.
5051 * Returns nil if the schematic could not be loaded.
5052 * **Warning**: Once you have loaded a schematic from a file, it will be
5053 cached. Future calls will always use the cached version and the
5054 replacement list defined for it, regardless of whether the file or the
5055 replacement list parameter have changed. The only way to load the file
5056 anew is to restart the server.
5057 * `flags` is a flag field with the available flags:
5062 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement, flags)`:
5063 * This function is analogous to minetest.place_schematic, but places a
5064 schematic onto the specified VoxelManip object `vmanip` instead of the
5066 * Returns false if any part of the schematic was cut-off due to the
5067 VoxelManip not containing the full area required, and true if the whole
5068 schematic was able to fit.
5069 * Returns nil if the schematic could not be loaded.
5070 * After execution, any external copies of the VoxelManip contents are
5072 * `flags` is a flag field with the available flags:
5077 * `minetest.serialize_schematic(schematic, format, options)`
5078 * Return the serialized schematic specified by schematic
5079 (see [Schematic specifier])
5080 * in the `format` of either "mts" or "lua".
5081 * "mts" - a string containing the binary MTS data used in the MTS file
5083 * "lua" - a string containing Lua code representing the schematic in table
5085 * `options` is a table containing the following optional parameters:
5086 * If `lua_use_comments` is true and `format` is "lua", the Lua code
5087 generated will have (X, Z) position comments for every X row
5088 generated in the schematic data for easier reading.
5089 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua",
5090 the Lua code generated will use that number of spaces as indentation
5091 instead of a tab character.
5093 * `minetest.read_schematic(schematic, options)`
5094 * Returns a Lua table representing the schematic (see: [Schematic specifier])
5095 * `schematic` is the schematic to read (see: [Schematic specifier])
5096 * `options` is a table containing the following optional parameters:
5097 * `write_yslice_prob`: string value:
5098 * `none`: no `write_yslice_prob` table is inserted,
5099 * `low`: only probabilities that are not 254 or 255 are written in
5100 the `write_ylisce_prob` table,
5101 * `all`: write all probabilities to the `write_yslice_prob` table.
5102 * The default for this option is `all`.
5103 * Any invalid value will be interpreted as `all`.
5108 * `minetest.request_http_api()`:
5109 * returns `HTTPApiTable` containing http functions if the calling mod has
5110 been granted access by being listed in the `secure.http_mods` or
5111 `secure.trusted_mods` setting, otherwise returns `nil`.
5112 * The returned table contains the functions `fetch`, `fetch_async` and
5113 `fetch_async_get` described below.
5114 * Only works at init time and must be called from the mod's main scope
5115 (not from a function).
5116 * Function only exists if minetest server was built with cURL support.
5117 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
5119 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
5120 * Performs given request asynchronously and calls callback upon completion
5121 * callback: `function(HTTPRequestResult res)`
5122 * Use this HTTP function if you are unsure, the others are for advanced use
5123 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
5124 * Performs given request asynchronously and returns handle for
5125 `HTTPApiTable.fetch_async_get`
5126 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
5127 * Return response data for given asynchronous HTTP request
5132 * `minetest.get_mod_storage()`:
5133 * returns reference to mod private `StorageRef`
5134 * must be called during mod load time
5139 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
5140 * `minetest.is_player(obj)`: boolean, whether `obj` is a player
5141 * `minetest.player_exists(name)`: boolean, whether player exists
5142 (regardless of online status)
5143 * `minetest.hud_replace_builtin(name, hud_definition)`
5144 * Replaces definition of a builtin hud element
5145 * `name`: `"breath"` or `"health"`
5146 * `hud_definition`: definition to replace builtin definition
5147 * `minetest.send_join_message(player_name)`
5148 * This function can be overridden by mods to change the join message.
5149 * `minetest.send_leave_message(player_name, timed_out)`
5150 * This function can be overridden by mods to change the leave message.
5151 * `minetest.hash_node_position(pos)`: returns an 48-bit integer
5152 * `pos`: table {x=number, y=number, z=number},
5153 * Gives a unique hash number for a node position (16+16+16=48bit)
5154 * `minetest.get_position_from_hash(hash)`: returns a position
5155 * Inverse transform of `minetest.hash_node_position`
5156 * `minetest.get_item_group(name, group)`: returns a rating
5157 * Get rating of a group of an item. (`0` means: not in group)
5158 * `minetest.get_node_group(name, group)`: returns a rating
5159 * Deprecated: An alias for the former.
5160 * `minetest.raillike_group(name)`: returns a rating
5161 * Returns rating of the connect_to_raillike group corresponding to name
5162 * If name is not yet the name of a connect_to_raillike group, a new group
5163 id is created, with that name.
5164 * `minetest.get_content_id(name)`: returns an integer
5165 * Gets the internal content ID of `name`
5166 * `minetest.get_name_from_content_id(content_id)`: returns a string
5167 * Gets the name of the content with that content ID
5168 * `minetest.parse_json(string[, nullvalue])`: returns something
5169 * Convert a string containing JSON data into the Lua equivalent
5170 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
5171 * On success returns a table, a string, a number, a boolean or `nullvalue`
5172 * On failure outputs an error message and returns `nil`
5173 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
5174 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error
5176 * Convert a Lua table into a JSON string
5177 * styled: Outputs in a human-readable format if this is set, defaults to
5179 * Unserializable things like functions and userdata will cause an error.
5180 * **Warning**: JSON is more strict than the Lua table format.
5181 1. You can only use strings and positive integers of at least one as
5183 2. You can not mix string and integer keys.
5184 This is due to the fact that JSON has two distinct array and object
5186 * Example: `write_json({10, {a = false}})`,
5187 returns `"[10, {\"a\": false}]"`
5188 * `minetest.serialize(table)`: returns a string
5189 * Convert a table containing tables, strings, numbers, booleans and `nil`s
5190 into string form readable by `minetest.deserialize`
5191 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
5192 * `minetest.deserialize(string)`: returns a table
5193 * Convert a string returned by `minetest.deserialize` into a table
5194 * `string` is loaded in an empty sandbox environment.
5195 * Will load functions, but they cannot access the global environment.
5196 * Example: `deserialize('return { ["foo"] = "bar" }')`,
5197 returns `{foo='bar'}`
5198 * Example: `deserialize('print("foo")')`, returns `nil`
5199 (function call fails), returns
5200 `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
5201 * `minetest.compress(data, method, ...)`: returns `compressed_data`
5202 * Compress a string of data.
5203 * `method` is a string identifying the compression method to be used.
5204 * Supported compression methods:
5205 * Deflate (zlib): `"deflate"`
5206 * `...` indicates method-specific arguments. Currently defined arguments
5208 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
5209 * `minetest.decompress(compressed_data, method, ...)`: returns data
5210 * Decompress a string of data (using ZLib).
5211 * See documentation on `minetest.compress()` for supported compression
5213 * `...` indicates method-specific arguments. Currently, no methods use this
5214 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
5215 * Each argument is a 8 Bit unsigned integer
5216 * Returns the ColorString from rgb or rgba values
5217 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
5218 * `minetest.encode_base64(string)`: returns string encoded in base64
5219 * Encodes a string in base64.
5220 * `minetest.decode_base64(string)`: returns string
5221 * Decodes a string encoded in base64.
5222 * `minetest.is_protected(pos, name)`: returns boolean
5223 * Returning `true` restricts the player `name` from modifying (i.e. digging,
5224 placing) the node at position `pos`.
5225 * `name` will be `""` for non-players or unknown players.
5226 * This function should be overridden by protection mods. It is highly
5227 recommended to grant access to players with the `protection_bypass` privilege.
5228 * Cache and call the old version of this function if the position is
5229 not protected by the mod. This will allow using multiple protection mods.
5232 local old_is_protected = minetest.is_protected
5233 function minetest.is_protected(pos, name)
5234 if mymod:position_protected_from(pos, name) then
5237 return old_is_protected(pos, name)
5239 * `minetest.record_protection_violation(pos, name)`
5240 * This function calls functions registered with
5241 `minetest.register_on_protection_violation`.
5242 * `minetest.is_area_protected(pos1, pos2, player_name, interval)`
5243 * Returns the position of the first node that `player_name` may not modify
5244 in the specified cuboid between `pos1` and `pos2`.
5245 * Returns `false` if no protections were found.
5246 * Applies `is_protected()` to a 3D lattice of points in the defined volume.
5247 The points are spaced evenly throughout the volume and have a spacing
5248 similar to, but no larger than, `interval`.
5249 * All corners and edges of the defined volume are checked.
5250 * `interval` defaults to 4.
5251 * `interval` should be carefully chosen and maximised to avoid an excessive
5252 number of points being checked.
5253 * Like `minetest.is_protected`, this function may be extended or
5254 overwritten by mods to provide a faster implementation to check the
5255 cuboid for intersections.
5256 * `minetest.rotate_and_place(itemstack, placer, pointed_thing[, infinitestacks,
5257 orient_flags, prevent_after_place])`
5258 * Attempt to predict the desired orientation of the facedir-capable node
5259 defined by `itemstack`, and place it accordingly (on-wall, on the floor,
5260 or hanging from the ceiling).
5261 * `infinitestacks`: if `true`, the itemstack is not changed. Otherwise the
5262 stacks are handled normally.
5263 * `orient_flags`: Optional table containing extra tweaks to the placement code:
5264 * `invert_wall`: if `true`, place wall-orientation on the ground and
5265 ground-orientation on the wall.
5266 * `force_wall` : if `true`, always place the node in wall orientation.
5267 * `force_ceiling`: if `true`, always place on the ceiling.
5268 * `force_floor`: if `true`, always place the node on the floor.
5269 * `force_facedir`: if `true`, forcefully reset the facedir to north
5270 when placing on the floor or ceiling.
5271 * The first four options are mutually-exclusive; the last in the list
5272 takes precedence over the first.
5273 * `prevent_after_place` is directly passed to `minetest.item_place_node`
5274 * Returns the new itemstack after placement
5275 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
5276 * calls `rotate_and_place()` with `infinitestacks` set according to the state
5277 of the creative mode setting, checks for "sneak" to set the `invert_wall`
5278 parameter and `prevent_after_place` set to `true`.
5280 * `minetest.calculate_knockback(player, hitter, time_from_last_punch,
5281 tool_capabilities, dir, distance, damage)`
5282 * Returns the amount of knockback applied on the punched player.
5283 * Arguments are equivalent to `register_on_punchplayer`, except the following:
5284 * `distance`: distance between puncher and punched player
5285 * This function can be overriden by mods that wish to modify this behaviour.
5286 * You may want to cache and call the old function to allow multiple mods to
5287 change knockback behaviour.
5289 * `minetest.forceload_block(pos[, transient])`
5290 * forceloads the position `pos`.
5291 * returns `true` if area could be forceloaded
5292 * If `transient` is `false` or absent, the forceload will be persistent
5293 (saved between server runs). If `true`, the forceload will be transient
5294 (not saved between server runs).
5296 * `minetest.forceload_free_block(pos[, transient])`
5297 * stops forceloading the position `pos`
5298 * If `transient` is `false` or absent, frees a persistent forceload.
5299 If `true`, frees a transient forceload.
5301 * `minetest.request_insecure_environment()`: returns an environment containing
5302 insecure functions if the calling mod has been listed as trusted in the
5303 `secure.trusted_mods` setting or security is disabled, otherwise returns
5305 * Only works at init time and must be called from the mod's main scope (not
5307 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE
5308 IT IN A LOCAL VARIABLE!**
5310 * `minetest.global_exists(name)`
5311 * Checks if a global variable has been set, without triggering a warning.
5316 * `minetest.env`: `EnvRef` of the server environment and world.
5317 * Any function in the minetest namespace can be called using the syntax
5318 `minetest.env:somefunction(somearguments)`
5319 instead of `minetest.somefunction(somearguments)`
5320 * Deprecated, but support is not to be dropped soon
5325 ### Registered definition tables
5327 * `minetest.registered_items`
5328 * Map of registered items, indexed by name
5329 * `minetest.registered_nodes`
5330 * Map of registered node definitions, indexed by name
5331 * `minetest.registered_craftitems`
5332 * Map of registered craft item definitions, indexed by name
5333 * `minetest.registered_tools`
5334 * Map of registered tool definitions, indexed by name
5335 * `minetest.registered_entities`
5336 * Map of registered entity prototypes, indexed by name
5337 * `minetest.object_refs`
5338 * Map of object references, indexed by active object id
5339 * `minetest.luaentities`
5340 * Map of Lua entities, indexed by active object id
5341 * `minetest.registered_abms`
5342 * List of ABM definitions
5343 * `minetest.registered_lbms`
5344 * List of LBM definitions
5345 * `minetest.registered_aliases`
5346 * Map of registered aliases, indexed by name
5347 * `minetest.registered_ores`
5348 * Map of registered ore definitions, indexed by the `name` field.
5349 * If `name` is nil, the key is the object handle returned by
5350 `minetest.register_ore`.
5351 * `minetest.registered_biomes`
5352 * Map of registered biome definitions, indexed by the `name` field.
5353 * If `name` is nil, the key is the object handle returned by
5354 `minetest.register_biome`.
5355 * `minetest.registered_decorations`
5356 * Map of registered decoration definitions, indexed by the `name` field.
5357 * If `name` is nil, the key is the object handle returned by
5358 `minetest.register_decoration`.
5359 * `minetest.registered_schematics`
5360 * Map of registered schematic definitions, indexed by the `name` field.
5361 * If `name` is nil, the key is the object handle returned by
5362 `minetest.register_schematic`.
5363 * `minetest.registered_chatcommands`
5364 * Map of registered chat command definitions, indexed by name
5365 * `minetest.registered_privileges`
5366 * Map of registered privilege definitions, indexed by name
5368 ### Registered callback tables
5370 All callbacks registered with [Global callback registration functions] are added
5371 to corresponding `minetest.registered_*` tables.
5379 Sorted alphabetically.
5384 A fast access data structure to store areas, and find areas near a given
5386 Every area has a `data` string attribute to store additional information.
5387 You can create an empty `AreaStore` by calling `AreaStore()`, or
5388 `AreaStore(type_name)`. The mod decides where to save and load AreaStore.
5389 If you chose the parameter-less constructor, a fast implementation will be
5390 automatically chosen for you.
5394 * `get_area(id, include_borders, include_data)`
5395 * Returns the area information about the specified ID.
5396 * Returned values are either of these:
5398 nil -- Area not found
5399 true -- Without `include_borders` and `include_data`
5401 min = pos, max = pos -- `include_borders == true`
5402 data = string -- `include_data == true`
5405 * `get_areas_for_pos(pos, include_borders, include_data)`
5406 * Returns all areas as table, indexed by the area ID.
5407 * Table values: see `get_area`.
5408 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`
5409 * Returns all areas that contain all nodes inside the area specified by `edge1`
5410 and `edge2` (inclusive).
5411 * `accept_overlap`: if `true`, areas are returned that have nodes in
5412 common (intersect) with the specified area.
5413 * Returns the same values as `get_areas_for_pos`.
5414 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store.
5415 * Returns the new area's ID, or nil if the insertion failed.
5416 * The (inclusive) positions `edge1` and `edge2` describe the area.
5417 * `data` is a string stored with the area.
5418 * `id` (optional): will be used as the internal area ID if it is an unique
5419 number between 0 and 2^32-2.
5420 * `reserve(count)`: reserves resources for at most `count` many contained
5422 Only needed for efficiency, and only some implementations profit.
5423 * `remove_area(id)`: removes the area with the given id from the store, returns
5425 * `set_cache_params(params)`: sets params for the included prefiltering cache.
5426 Calling invalidates the cache, so that its elements have to be newly
5428 * `params` is a table with the following fields:
5430 enabled = boolean, -- Whether to enable, default true
5431 block_radius = int, -- The radius (in nodes) of the areas the cache
5432 -- generates prefiltered lists for, minimum 16,
5434 limit = int, -- The cache size, minimum 20, default 1000
5435 * `to_string()`: Experimental. Returns area store serialized as a (binary)
5437 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to
5439 * `from_string(str)`: Experimental. Deserializes string and loads it into the
5441 Returns success and, optionally, an error message.
5442 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data
5448 An `InvRef` is a reference to an inventory.
5452 * `is_empty(listname)`: return `true` if list is empty
5453 * `get_size(listname)`: get size of a list
5454 * `set_size(listname, size)`: set size of a list
5455 * returns `false` on error (e.g. invalid `listname` or `size`)
5456 * `get_width(listname)`: get width of a list
5457 * `set_width(listname, width)`: set width of list; currently used for crafting
5458 * `get_stack(listname, i)`: get a copy of stack index `i` in list
5459 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
5460 * `get_list(listname)`: return full list
5461 * `set_list(listname, list)`: set full list (size will not change)
5462 * `get_lists()`: returns list of inventory lists
5463 * `set_lists(lists)`: sets inventory lists (size will not change)
5464 * `add_item(listname, stack)`: add item somewhere in list, returns leftover
5466 * `room_for_item(listname, stack):` returns `true` if the stack of items
5467 can be fully added to the list
5468 * `contains_item(listname, stack, [match_meta])`: returns `true` if
5469 the stack of items can be fully taken from the list.
5470 If `match_meta` is false, only the items' names are compared
5472 * `remove_item(listname, stack)`: take as many items as specified from the
5473 list, returns the items that were actually removed (as an `ItemStack`)
5474 -- note that any item metadata is ignored, so attempting to remove a specific
5475 unique item this way will likely remove the wrong one -- to do that use
5476 `set_stack` with an empty `ItemStack`.
5477 * `get_location()`: returns a location compatible to
5478 `minetest.get_inventory(location)`.
5479 * returns `{type="undefined"}` in case location is not known
5484 An `ItemStack` is a stack of items.
5486 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
5487 an itemstring, a table or `nil`.
5491 * `is_empty()`: returns `true` if stack is empty.
5492 * `get_name()`: returns item name (e.g. `"default:stone"`).
5493 * `set_name(item_name)`: returns a boolean indicating whether the item was
5495 * `get_count()`: Returns number of items on the stack.
5496 * `set_count(count)`: returns a boolean indicating whether the item was cleared
5497 * `count`: number, unsigned 16 bit integer
5498 * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
5499 * `set_wear(wear)`: returns boolean indicating whether item was cleared
5500 * `wear`: number, unsigned 16 bit integer
5501 * `get_meta()`: returns ItemStackMetaRef. See section for more details
5502 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
5504 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
5505 * `get_description()`: returns the description shown in inventory list tooltips.
5506 * `clear()`: removes all items from the stack, making it empty.
5507 * `replace(item)`: replace the contents of this stack.
5508 * `item` can also be an itemstring or table.
5509 * `to_string()`: returns the stack in itemstring form.
5510 * `to_table()`: returns the stack in Lua table form.
5511 * `get_stack_max()`: returns the maximum size of the stack (depends on the
5513 * `get_free_space()`: returns `get_stack_max() - get_count()`.
5514 * `is_known()`: returns `true` if the item name refers to a defined item type.
5515 * `get_definition()`: returns the item definition table.
5516 * `get_tool_capabilities()`: returns the digging properties of the item,
5517 or those of the hand if none are defined for this item type
5518 * `add_wear(amount)`
5519 * Increases wear by `amount` if the item is a tool
5520 * `amount`: number, integer
5521 * `add_item(item)`: returns leftover `ItemStack`
5522 * Put some item or stack onto this stack
5523 * `item_fits(item)`: returns `true` if item or stack can be fully added to
5525 * `take_item(n)`: returns taken `ItemStack`
5526 * Take (and remove) up to `n` items from this stack
5527 * `n`: number, default: `1`
5528 * `peek_item(n)`: returns taken `ItemStack`
5529 * Copy (don't remove) up to `n` items from this stack
5530 * `n`: number, default: `1`
5535 ItemStack metadata: reference extra data and functionality stored in a stack.
5536 Can be obtained via `item:get_meta()`.
5540 * All methods in MetaDataRef
5541 * `set_tool_capabilities([tool_capabilities])`
5542 * Overrides the item's tool capabilities
5543 * A nil value will clear the override data and restore the original
5549 Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],
5550 and [`PlayerMetaRef`].
5554 * `contains(key)`: Returns true if key present, otherwise false.
5555 * Returns `nil` when the MetaData is inexistent.
5556 * `get(key)`: Returns `nil` if key not present, else the stored string.
5557 * `set_string(key, value)`: Value of `""` will delete the key.
5558 * `get_string(key)`: Returns `""` if key not present.
5559 * `set_int(key, value)`
5560 * `get_int(key)`: Returns `0` if key not present.
5561 * `set_float(key, value)`
5562 * `get_float(key)`: Returns `0` if key not present.
5563 * `to_table()`: returns `nil` or a table with keys:
5564 * `fields`: key-value storage
5565 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
5566 * `from_table(nil or {})`
5567 * Any non-table value will clear the metadata
5568 * See [Node Metadata] for an example
5569 * returns `true` on success
5571 * returns `true` if this metadata has the same key-value pairs as `other`
5576 An interface to use mod channels on client and server
5580 * `leave()`: leave the mod channel.
5581 * Server leaves channel `channel_name`.
5582 * No more incoming or outgoing messages can be sent to this channel from
5584 * This invalidate all future object usage.
5585 * Ensure you set mod_channel to nil after that to free Lua resources.
5586 * `is_writeable()`: returns true if channel is writeable and mod can send over
5588 * `send_all(message)`: Send `message` though the mod channel.
5589 * If mod channel is not writeable or invalid, message will be dropped.
5590 * Message size is limited to 65535 characters by protocol.
5595 Node metadata: reference extra data and functionality stored in a node.
5596 Can be obtained via `minetest.get_meta(pos)`.
5600 * All methods in MetaDataRef
5601 * `get_inventory()`: returns `InvRef`
5602 * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
5603 This will prevent them from being sent to the client. Note that the "private"
5604 status will only be remembered if an associated key-value pair exists,
5605 meaning it's best to call this when initializing all other meta (e.g.
5611 Node Timers: a high resolution persistent per-node timer.
5612 Can be gotten via `minetest.get_node_timer(pos)`.
5616 * `set(timeout,elapsed)`
5617 * set a timer's state
5618 * `timeout` is in seconds, and supports fractional values (0.1 etc)
5619 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
5620 * will trigger the node's `on_timer` function after `(timeout - elapsed)`
5624 * equivalent to `set(timeout,0)`
5627 * `get_timeout()`: returns current timeout in seconds
5628 * if `timeout` equals `0`, timer is inactive
5629 * `get_elapsed()`: returns current elapsed time in seconds
5630 * the node's `on_timer` function will be called after `(timeout - elapsed)`
5632 * `is_started()`: returns boolean state of timer
5633 * returns `true` if timer is started, otherwise `false`
5638 Moving things in the game are generally these.
5640 This is basically a reference to a C++ `ServerActiveObject`
5644 * `get_pos()`: returns `{x=num, y=num, z=num}`
5645 * `set_pos(pos)`: `pos`=`{x=num, y=num, z=num}`
5646 * `move_to(pos, continuous=false)`
5647 * Does an interpolated move for Lua entities for visually smooth transitions.
5648 * If `continuous` is true, the Lua entity will not be moved to the current
5649 position before starting the interpolated move.
5650 * For players this does the same as `set_pos`,`continuous` is ignored.
5651 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
5652 * `puncher` = another `ObjectRef`,
5653 * `time_from_last_punch` = time since last punch action of the puncher
5654 * `direction`: can be `nil`
5655 * `right_click(clicker)`; `clicker` is another `ObjectRef`
5656 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
5657 * `set_hp(hp, reason)`: set number of hitpoints (2 * number of hearts).
5658 * See reason in register_on_player_hpchange
5659 * Is limited to the range of 0 ... 65535 (2^16 - 1)
5660 * For players: HP are also limited by `hp_max` specified in the player's
5662 * `get_inventory()`: returns an `InvRef` for players, otherwise returns `nil`
5663 * `get_wield_list()`: returns the name of the inventory list the wielded item
5665 * `get_wield_index()`: returns the index of the wielded item
5666 * `get_wielded_item()`: returns an `ItemStack`
5667 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if
5669 * `set_armor_groups({group1=rating, group2=rating, ...})`
5670 * `get_armor_groups()`: returns a table with the armor group ratings
5671 * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
5672 * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
5673 * `frame_speed`: number, default: `15.0`
5674 * `frame_blend`: number, default: `0.0`
5675 * `frame_loop`: boolean, default: `true`
5676 * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and
5678 * `set_animation_frame_speed(frame_speed)`
5679 * `frame_speed`: number, default: `15.0`
5680 * `set_attach(parent, bone, position, rotation)`
5682 * `position`: `{x=num, y=num, z=num}` (relative)
5683 * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees
5684 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't
5687 * `set_bone_position(bone, position, rotation)`
5689 * `position`: `{x=num, y=num, z=num}` (relative)
5690 * `rotation`: `{x=num, y=num, z=num}`
5691 * `get_bone_position(bone)`: returns position and rotation of the bone
5692 * `set_properties(object property table)`
5693 * `get_properties()`: returns object property table
5694 * `is_player()`: returns true for players, false otherwise
5695 * `get_nametag_attributes()`
5696 * returns a table with the attributes of the nametag of an object
5698 color = {a=0..255, r=0..255, g=0..255, b=0..255},
5701 * `set_nametag_attributes(attributes)`
5702 * sets the attributes of the nametag of an object
5706 text = "My Nametag",
5709 #### Lua entity only (no-op for other objects)
5711 * `remove()`: remove object (after returning from Lua)
5712 * `set_velocity(vel)`
5713 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
5714 * `add_velocity(vel)`
5715 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
5716 * In comparison to using get_velocity, adding the velocity and then using
5717 set_velocity, add_velocity is supposed to avoid synchronization problems.
5718 * `get_velocity()`: returns the velocity, a vector
5719 * `set_acceleration(acc)`
5721 * `get_acceleration()`: returns the acceleration, a vector
5722 * `set_rotation(rot)`
5723 * `rot` is a vector (radians). X is pitch (elevation), Y is yaw (heading)
5724 and Z is roll (bank).
5725 * `get_rotation()`: returns the rotation, a vector (radians)
5726 * `set_yaw(radians)`: sets the yaw (heading).
5727 * `get_yaw()`: returns number in radians
5728 * `set_texture_mod(mod)`
5729 * `get_texture_mod()` returns current texture modifier
5730 * `set_sprite(p, num_frames, framelength, select_horiz_by_yawpitch)`
5731 * Select sprite from spritesheet with optional animation and Dungeon Master
5732 style texture selection based on yaw relative to camera
5733 * `p`: {x=number, y=number}, the coordinate of the first frame
5734 (x: column, y: row), default: `{x=0, y=0}`
5735 * `num_frames`: number, default: `1`
5736 * `framelength`: number, default: `0.2`
5737 * `select_horiz_by_yawpitch`: boolean, this was once used for the Dungeon
5738 Master mob, default: `false`
5739 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
5742 #### Player only (no-op for other objects)
5744 * `get_player_name()`: returns `""` if is not a player
5745 * `get_player_velocity()`: returns `nil` if is not a player, otherwise a
5746 table {x, y, z} representing the player's instantaneous velocity in nodes/s
5747 * `add_player_velocity(vel)`
5748 * Adds to player velocity, this happens client-side and only once.
5749 * Does not apply during free_move.
5750 * Note that since the player speed is normalized at each move step,
5751 increasing e.g. Y velocity beyond what would usually be achieved
5752 (see: physics overrides) will cause existing X/Z velocity to be reduced.
5753 * Example: `add_player_velocity({x=0, y=6.5, z=0})` is equivalent to
5754 pressing the jump key (assuming default settings)
5755 * `get_look_dir()`: get camera direction as a unit vector
5756 * `get_look_vertical()`: pitch in radians
5757 * Angle ranges between -pi/2 and pi/2, which are straight up and down
5759 * `get_look_horizontal()`: yaw in radians
5760 * Angle is counter-clockwise from the +z direction.
5761 * `set_look_vertical(radians)`: sets look pitch
5762 * radians: Angle from looking forward, where positive is downwards.
5763 * `set_look_horizontal(radians)`: sets look yaw
5764 * radians: Angle from the +z direction, where positive is counter-clockwise.
5765 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use
5766 `get_look_vertical`.
5767 * Angle ranges between -pi/2 and pi/2, which are straight down and up
5769 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use
5770 `get_look_horizontal`.
5771 * Angle is counter-clockwise from the +x direction.
5772 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use
5773 `set_look_vertical`.
5774 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use
5775 `set_look_horizontal`.
5776 * `get_breath()`: returns player's breath
5777 * `set_breath(value)`: sets player's breath
5779 * `0`: player is drowning
5780 * max: bubbles bar is not shown
5781 * See [Object properties] for more information
5782 * Is limited to range 0 ... 65535 (2^16 - 1)
5783 * `set_fov(fov, is_multiplier)`: Sets player's FOV
5785 * `is_multiplier`: Set to `true` if the FOV value is a multiplier.
5786 Defaults to `false`.
5787 * Set to 0 to clear FOV override.
5789 * Returns player's FOV override in degrees, and a boolean depending on whether
5790 the value is a multiplier.
5791 * Returns 0 as first value if player's FOV hasn't been overridden.
5792 * `set_attribute(attribute, value)`: DEPRECATED, use get_meta() instead
5793 * Sets an extra attribute with value on player.
5794 * `value` must be a string, or a number which will be converted to a
5796 * If `value` is `nil`, remove attribute from player.
5797 * `get_attribute(attribute)`: DEPRECATED, use get_meta() instead
5798 * Returns value (a string) for extra attribute.
5799 * Returns `nil` if no attribute found.
5800 * `get_meta()`: Returns a PlayerMetaRef.
5801 * `set_inventory_formspec(formspec)`
5802 * Redefine player's inventory form
5803 * Should usually be called in `on_joinplayer`
5804 * `get_inventory_formspec()`: returns a formspec string
5805 * `set_formspec_prepend(formspec)`:
5806 * the formspec string will be added to every formspec shown to the user,
5807 except for those with a no_prepend[] tag.
5808 * This should be used to set style elements such as background[] and
5809 bgcolor[], any non-style elements (eg: label) may result in weird behaviour.
5810 * Only affects formspecs shown after this is called.
5811 * `get_formspec_prepend(formspec)`: returns a formspec string.
5812 * `get_player_control()`: returns table with player pressed keys
5813 * The table consists of fields with boolean value representing the pressed
5814 keys, the fields are jump, right, left, LMB, RMB, sneak, aux1, down, up.
5815 * example: `{jump=false, right=true, left=false, LMB=false, RMB=false,
5816 sneak=true, aux1=false, down=false, up=false}`
5817 * `get_player_control_bits()`: returns integer with bit packed player pressed
5819 * bit nr/meaning: 0/up, 1/down, 2/left, 3/right, 4/jump, 5/aux1, 6/sneak,
5821 * `set_physics_override(override_table)`
5822 * `override_table` is a table with the following fields:
5823 * `speed`: multiplier to default walking speed value (default: `1`)
5824 * `jump`: multiplier to default jump value (default: `1`)
5825 * `gravity`: multiplier to default gravity value (default: `1`)
5826 * `sneak`: whether player can sneak (default: `true`)
5827 * `sneak_glitch`: whether player can use the new move code replications
5828 of the old sneak side-effects: sneak ladders and 2 node sneak jump
5830 * `new_move`: use new move/sneak code. When `false` the exact old code
5831 is used for the specific old sneak behaviour (default: `true`)
5832 * `get_physics_override()`: returns the table given to `set_physics_override`
5833 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
5835 * `hud_remove(id)`: remove the HUD element of the specified id
5836 * `hud_change(id, stat, value)`: change a value of a previously added HUD
5838 * element `stat` values:
5839 `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
5840 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
5841 * `hud_set_flags(flags)`: sets specified HUD flags of player.
5842 * `flags`: A table with the following fields set to boolean values
5850 * If a flag equals `nil`, the flag is not modified
5851 * `minimap`: Modifies the client's permission to view the minimap.
5852 The client may locally elect to not view the minimap.
5853 * `minimap_radar` is only usable when `minimap` is true
5854 * `hud_get_flags()`: returns a table of player HUD flags with boolean values.
5855 * See `hud_set_flags` for a list of flags that can be toggled.
5856 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
5857 * `count`: number of items, must be between `1` and `32`
5858 * `hud_get_hotbar_itemcount`: returns number of visible items
5859 * `hud_set_hotbar_image(texturename)`
5860 * sets background image for hotbar
5861 * `hud_get_hotbar_image`: returns texturename
5862 * `hud_set_hotbar_selected_image(texturename)`
5863 * sets image for selected item of hotbar
5864 * `hud_get_hotbar_selected_image`: returns texturename
5865 * `set_sky(bgcolor, type, {texture names}, clouds)`
5866 * `bgcolor`: ColorSpec, defaults to white
5867 * `type`: Available types:
5868 * `"regular"`: Uses 0 textures, `bgcolor` ignored
5869 * `"skybox"`: Uses 6 textures, `bgcolor` used
5870 * `"plain"`: Uses 0 textures, `bgcolor` used
5871 * `clouds`: Boolean for whether clouds appear in front of `"skybox"` or
5872 `"plain"` custom skyboxes (default: `true`)
5873 * `get_sky()`: returns bgcolor, type, table of textures, clouds
5874 * `set_clouds(parameters)`: set cloud parameters
5875 * `parameters` is a table with the following optional fields:
5876 * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
5877 * `color`: basic cloud color with alpha channel, ColorSpec
5878 (default `#fff0f0e5`).
5879 * `ambient`: cloud color lower bound, use for a "glow at night" effect.
5880 ColorSpec (alpha ignored, default `#000000`)
5881 * `height`: cloud height, i.e. y of cloud base (default per conf,
5883 * `thickness`: cloud thickness in nodes (default `16`)
5884 * `speed`: 2D cloud speed + direction in nodes per second
5885 (default `{x=0, z=-2}`).
5886 * `get_clouds()`: returns a table with the current cloud parameters as in
5888 * `override_day_night_ratio(ratio or nil)`
5889 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific
5891 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
5892 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
5893 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`:
5894 set animation for player model in third person view
5896 set_local_animation({x=0, y=79}, -- stand/idle animation key frames
5897 {x=168, y=187}, -- walk animation key frames
5898 {x=189, y=198}, -- dig animation key frames
5899 {x=200, y=219}, -- walk+dig animation key frames
5900 frame_speed=30) -- animation frame speed
5901 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and
5903 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for
5905 * in first person view
5906 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
5907 * `get_eye_offset()`: returns `offset_first` and `offset_third`
5908 * `send_mapblock(blockpos)`:
5909 * Sends a server-side loaded mapblock to the player.
5910 * Returns `false` if failed.
5911 * Resource intensive - use sparsely
5912 * To get blockpos, integer divide pos by 16
5917 A 32-bit pseudorandom number generator.
5918 Uses PCG32, an algorithm of the permuted congruential generator family,
5919 offering very strong randomness.
5921 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
5925 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
5926 * `next(min, max)`: return next integer random number [`min`...`max`]
5927 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed
5928 random number [`min`...`max`].
5929 * This is only a rough approximation of a normal distribution with:
5930 * `mean = (max - min) / 2`, and
5931 * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
5932 * Increasing `num_trials` improves accuracy of the approximation
5937 A perlin noise generator.
5938 It can be created via `PerlinNoise(seed, octaves, persistence, spread)`
5939 or `PerlinNoise(noiseparams)`.
5940 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
5941 or `minetest.get_perlin(noiseparams)`.
5945 * `get_2d(pos)`: returns 2D noise value at `pos={x=,y=}`
5946 * `get_3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
5951 A fast, bulk perlin noise generator.
5953 It can be created via `PerlinNoiseMap(noiseparams, size)` or
5954 `minetest.get_perlin_map(noiseparams, size)`.
5956 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
5957 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
5960 For each of the functions with an optional `buffer` parameter: If `buffer` is
5961 not nil, this table will be used to store the result instead of creating a new
5966 * `get_2d_map(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
5967 with values starting at `pos={x=,y=}`
5968 * `get_3d_map(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>`
5969 3D array of 3D noise with values starting at `pos={x=,y=,z=}`.
5970 * `get_2d_map_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element
5971 array of 2D noise with values starting at `pos={x=,y=}`
5972 * `get_3d_map_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
5973 * `calc_2d_map(pos)`: Calculates the 2d noise map starting at `pos`. The result
5974 is stored internally.
5975 * `calc_3d_map(pos)`: Calculates the 3d noise map starting at `pos`. The result
5976 is stored internally.
5977 * `get_map_slice(slice_offset, slice_size, buffer)`: In the form of an array,
5978 returns a slice of the most recently computed noise results. The result slice
5979 begins at coordinates `slice_offset` and takes a chunk of `slice_size`.
5980 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer
5982 `noisevals = noise:get_map_slice({y=20}, {y=2})`
5983 It is important to note that `slice_offset` offset coordinates begin at 1,
5984 and are relative to the starting position of the most recently calculated
5986 To grab a single vertical column of noise starting at map coordinates
5987 x = 1023, y=1000, z = 1000:
5988 `noise:calc_3d_map({x=1000, y=1000, z=1000})`
5989 `noisevals = noise:get_map_slice({x=24, z=1}, {x=1, z=1})`
5995 Uses the same method of storage as the deprecated player attribute API, so
5996 data there will also be in player meta.
5997 Can be obtained using `player:get_meta()`.
6001 * All methods in MetaDataRef
6006 A 16-bit pseudorandom number generator.
6007 Uses a well-known LCG algorithm introduced by K&R.
6009 It can be created via `PseudoRandom(seed)`.
6013 * `next()`: return next integer random number [`0`...`32767`]
6014 * `next(min, max)`: return next integer random number [`min`...`max`]
6015 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
6016 due to the simple implementation making bad distribution otherwise.
6021 A raycast on the map. It works with selection boxes.
6022 Can be used as an iterator in a for loop as:
6024 local ray = Raycast(...)
6025 for pointed_thing in ray do
6029 The map is loaded as the ray advances. If the map is modified after the
6030 `Raycast` is created, the changes may or may not have an effect on the object.
6032 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
6033 `minetest.raycast(pos1, pos2, objects, liquids)` where:
6035 * `pos1`: start of the ray
6036 * `pos2`: end of the ray
6037 * `objects`: if false, only nodes will be returned. Default is true.
6038 * `liquids`: if false, liquid nodes won't be returned. Default is false.
6042 * `next()`: returns a `pointed_thing` with exact pointing location
6043 * Returns the next thing pointed by the ray or nil.
6048 Interface for the operating system's crypto-secure PRNG.
6050 It can be created via `SecureRandom()`. The constructor returns nil if a
6051 secure random device cannot be found on the system.
6055 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many
6056 random bytes, as a string.
6061 An interface to read config files in the format of `minetest.conf`.
6063 It can be created via `Settings(filename)`.
6067 * `get(key)`: returns a value
6068 * `get_bool(key, [default])`: returns a boolean
6069 * `default` is the value returned if `key` is not found.
6070 * Returns `nil` if `key` is not found and `default` not specified.
6071 * `get_np_group(key)`: returns a NoiseParams table
6073 * Setting names can't contain whitespace or any of `="{}#`.
6074 * Setting values can't contain the sequence `\n"""`.
6075 * Setting names starting with "secure." can't be set on the main settings
6076 object (`minetest.settings`).
6077 * `set_bool(key, value)`
6078 * See documentation for set() above.
6079 * `set_np_group(key, value)`
6080 * `value` is a NoiseParams table.
6081 * Also, see documentation for set() above.
6082 * `remove(key)`: returns a boolean (`true` for success)
6083 * `get_names()`: returns `{key1,...}`
6084 * `write()`: returns a boolean (`true` for success)
6085 * Writes changes to file.
6086 * `to_table()`: returns `{[key1]=value1,...}`
6090 The settings have the format `key = value`. Example:
6102 Mod metadata: per mod metadata, saved automatically.
6103 Can be obtained via `minetest.get_mod_storage()` during load time.
6105 WARNING: This storage backend is incaptable to save raw binary data due
6106 to restrictions of JSON.
6110 * All methods in MetaDataRef
6121 Used by `ObjectRef` methods. Part of an Entity definition.
6122 These properties are not persistent, but are applied automatically to the
6123 corresponding Lua entity using the given registration fields.
6124 Player properties need to be saved manually.
6128 -- For players only. Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`.
6131 -- For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`.
6134 -- For players only. Zoom FOV in degrees.
6135 -- Note that zoom loads and/or generates world beyond the server's
6136 -- maximum send and generate distances, so acts like a telescope.
6137 -- Smaller zoom_fov values increase the distance loaded/generated.
6138 -- Defaults to 15 in creative mode, 0 in survival mode.
6139 -- zoom_fov = 0 disables zooming for the player.
6142 -- For players only. Camera height above feet position in nodes.
6143 -- Defaults to 1.625.
6146 -- Collide with `walkable` nodes.
6148 collide_with_objects = true,
6149 -- Collide with other objects if physical = true
6151 collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5}, -- Default
6152 selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
6153 -- Selection box uses collision box dimensions when not set.
6154 -- For both boxes: {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from
6158 -- Overrides selection box when false
6160 visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem" / "item",
6161 -- "cube" is a node-sized cube.
6162 -- "sprite" is a flat texture always facing the player.
6163 -- "upright_sprite" is a vertical flat texture.
6164 -- "mesh" uses the defined mesh model.
6165 -- "wielditem" is used for dropped items.
6166 -- (see builtin/game/item_entity.lua).
6167 -- For this use 'wield_item = itemname' (Deprecated: 'textures = {itemname}').
6168 -- If the item has a 'wield_image' the object will be an extrusion of
6170 -- If 'itemname' is a cubic node or nodebox the object will appear
6171 -- identical to 'itemname'.
6172 -- If 'itemname' is a plantlike node the object will be an extrusion
6174 -- Otherwise for non-node items, the object will be an extrusion of
6175 -- 'inventory_image'.
6176 -- If 'itemname' contains a ColorString or palette index (e.g. from
6177 -- `minetest.itemstring_with_palette()`), the entity will inherit the color.
6178 -- "item" is similar to "wielditem" but ignores the 'wield_image' parameter.
6180 visual_size = {x = 1, y = 1, z = 1},
6181 -- Multipliers for the visual size. If `z` is not specified, `x` will be used
6182 -- to scale the entity along both horizontal axes.
6185 -- File name of mesh when using "mesh" visual
6188 -- Number of required textures depends on visual.
6189 -- "cube" uses 6 textures just like a node, but all 6 must be defined.
6190 -- "sprite" uses 1 texture.
6191 -- "upright_sprite" uses 2 textures: {front, back}.
6192 -- "wielditem" expects 'textures = {itemname}' (see 'visual' above).
6195 -- Number of required colors depends on visual
6197 use_texture_alpha = false,
6198 -- Use texture's alpha channel.
6199 -- Excludes "upright_sprite" and "wielditem".
6200 -- Note: currently causes visual issues when viewed through other
6201 -- semi-transparent materials such as water.
6203 spritediv = {x = 1, y = 1},
6204 -- Used with spritesheet textures for animation and/or frame selection
6205 -- according to position relative to player.
6206 -- Defines the number of columns and rows in the spritesheet:
6209 initial_sprite_basepos = {x = 0, y = 0},
6210 -- Used with spritesheet textures.
6211 -- Defines the {column, row} position of the initially used frame in the
6215 -- If false, object is invisible and can't be pointed.
6217 makes_footstep_sound = false,
6218 -- If true, is able to make footstep sounds of nodes
6219 -- (see node sound definition for details).
6221 automatic_rotate = 0,
6222 -- Set constant rotation in radians per second, positive or negative.
6223 -- Set to 0 to disable constant rotation.
6226 -- If positive number, object will climb upwards when it moves
6227 -- horizontally against a `walkable` node, if the height difference
6228 -- is within `stepheight`.
6230 automatic_face_movement_dir = 0.0,
6231 -- Automatically set yaw to movement direction, offset in degrees.
6232 -- 'false' to disable.
6234 automatic_face_movement_max_rotation_per_sec = -1,
6235 -- Limit automatic rotation to this value in degrees per second.
6236 -- No limit if value <= 0.
6238 backface_culling = true,
6239 -- Set to false to disable backface_culling for model
6242 -- Add this much extra lighting when calculating texture color.
6243 -- Value < 0 disables light's effect on texture color.
6244 -- For faking self-lighting, UI style entities, or programmatic coloring
6248 -- By default empty, for players their name is shown if empty
6250 nametag_color = <ColorSpec>,
6251 -- Sets color of nametag
6254 -- By default empty, text to be shown when pointed at object
6257 -- If false, never save this object statically. It will simply be
6258 -- deleted when the block gets unloaded.
6259 -- The get_staticdata() callback is never called then.
6260 -- Defaults to 'true'.
6266 Used by `minetest.register_entity`.
6269 initial_properties = {
6271 mesh = "boats_boat.obj",
6274 -- A table of object properties, see the `Object properties` section.
6275 -- Object properties being read directly from the entity definition
6276 -- table is deprecated. Define object properties in this
6277 -- `initial_properties` table instead.
6279 on_activate = function(self, staticdata, dtime_s),
6281 on_step = function(self, dtime),
6283 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
6285 on_rightclick = function(self, clicker),
6287 get_staticdata = function(self),
6288 -- Called sometimes; the string returned is passed to on_activate when
6289 -- the entity is re-activated from static state
6291 _custom_field = whatever,
6292 -- You can define arbitrary member variables here (see Item definition
6293 -- for more info) by using a '_' prefix
6296 ABM (ActiveBlockModifier) definition
6297 ------------------------------------
6299 Used by `minetest.register_abm`.
6302 label = "Lava cooling",
6303 -- Descriptive label for profiling purposes (optional).
6304 -- Definitions with identical labels will be listed as one.
6306 nodenames = {"default:lava_source"},
6307 -- Apply `action` function to these nodes.
6308 -- `group:groupname` can also be used here.
6310 neighbors = {"default:water_source", "default:water_flowing"},
6311 -- Only apply `action` to nodes that have one of, or any
6312 -- combination of, these neighbors.
6313 -- If left out or empty, any neighbor will do.
6314 -- `group:groupname` can also be used here.
6317 -- Operation interval in seconds
6320 -- Chance of triggering `action` per-node per-interval is 1.0 / this
6324 -- If true, catch-up behaviour is enabled: The `chance` value is
6325 -- temporarily reduced when returning to an area to simulate time lost
6326 -- by the area being unattended. Note that the `chance` value can often
6329 action = function(pos, node, active_object_count, active_object_count_wider),
6330 -- Function triggered for each qualifying node.
6331 -- `active_object_count` is number of active objects in the node's
6333 -- `active_object_count_wider` is number of active objects in the node's
6334 -- mapblock plus all 26 neighboring mapblocks. If any neighboring
6335 -- mapblocks are unloaded an estmate is calculated for them based on
6336 -- loaded mapblocks.
6339 LBM (LoadingBlockModifier) definition
6340 -------------------------------------
6342 Used by `minetest.register_lbm`.
6344 A loading block modifier (LBM) is used to define a function that is called for
6345 specific nodes (defined by `nodenames`) when a mapblock which contains such nodes
6349 label = "Upgrade legacy doors",
6350 -- Descriptive label for profiling purposes (optional).
6351 -- Definitions with identical labels will be listed as one.
6353 name = "modname:replace_legacy_door",
6355 nodenames = {"default:lava_source"},
6356 -- List of node names to trigger the LBM on.
6357 -- Also non-registered nodes will work.
6358 -- Groups (as of group:groupname) will work as well.
6360 run_at_every_load = false,
6361 -- Whether to run the LBM's action every time a block gets loaded,
6362 -- and not only the first time the block gets loaded after the LBM
6365 action = function(pos, node),
6372 * `{name="image.png", animation={Tile Animation definition}}`
6373 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
6374 tileable_horizontal=bool, align_style="node"/"world"/"user", scale=int}`
6375 * backface culling enabled by default for most nodes
6376 * tileable flags are info for shaders, how they should treat texture
6377 when displacement mapping is used.
6378 Directions are from the point of view of the tile texture,
6379 not the node it's on.
6380 * align style determines whether the texture will be rotated with the node
6381 or kept aligned with its surroundings. "user" means that client
6382 setting will be used, similar to `glasslike_framed_optional`.
6383 Note: supported by solid nodes and nodeboxes only.
6384 * scale is used to make texture span several (exactly `scale`) nodes,
6385 instead of just one, in each direction. Works for world-aligned
6387 Note that as the effect is applied on per-mapblock basis, `16` should
6388 be equally divisible by `scale` or you may get wrong results.
6389 * `{name="image.png", color=ColorSpec}`
6390 * the texture's color will be multiplied with this color.
6391 * the tile's color overrides the owning node's color in all cases.
6392 * deprecated, yet still supported field names:
6395 Tile animation definition
6396 -------------------------
6399 type = "vertical_frames",
6402 -- Width of a frame in pixels
6405 -- Height of a frame in pixels
6415 -- Width in number of frames
6418 -- Height in number of frames
6421 -- Length of a single frame
6427 Used by `minetest.register_node`, `minetest.register_craftitem`, and
6428 `minetest.register_tool`.
6431 description = "Steel Axe",
6434 -- key = name, value = rating; rating = 1..3.
6435 -- If rating not applicable, use 1.
6436 -- e.g. {wool = 1, fluffy = 3}
6437 -- {soil = 2, outerspace = 1, crumbly = 1}
6438 -- {bendy = 2, snappy = 1},
6439 -- {hard = 1, metal = 1, spikes = 1}
6441 inventory_image = "default_tool_steelaxe.png",
6443 inventory_overlay = "overlay.png",
6444 -- An overlay which does not get colorized
6451 -- An image file containing the palette of a node.
6452 -- You can set the currently used color as the "palette_index" field of
6453 -- the item stack metadata.
6454 -- The palette is always stretched to fit indices between 0 and 255, to
6455 -- ensure compatibility with "colorfacedir" and "colorwallmounted" nodes.
6457 color = "0xFFFFFFFF",
6458 -- The color of the item. The palette overrides this.
6460 wield_scale = {x = 1, y = 1, z = 1},
6466 liquids_pointable = false,
6468 -- See "Tools" section for an example including explanation
6469 tool_capabilities = {
6470 full_punch_interval = 1.0,
6474 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00},
6475 uses = 20, maxlevel = 2},
6477 damage_groups = {groupname = damage},
6478 -- Damage values must be between -32768 and 32767 (2^15)
6480 punch_attack_uses = nil,
6481 -- Amount of uses this tool has for attacking players and entities
6482 -- by punching them (0 = infinite uses).
6483 -- For compatibility, this is automatically set from the first
6484 -- suitable groupcap using the forumla "uses * 3^(maxlevel - 1)".
6485 -- It is recommend to set this explicitly instead of relying on the
6486 -- fallback behavior.
6489 node_placement_prediction = nil,
6490 -- If nil and item is node, prediction is made automatically.
6491 -- If nil and item is not a node, no prediction is made.
6492 -- If "" and item is anything, no prediction is made.
6493 -- Otherwise should be name of node which the client immediately places
6494 -- on ground when the player places the item. Server will always update
6495 -- actual result to client in a short moment.
6497 node_dig_prediction = "air",
6498 -- if "", no prediction is made.
6499 -- if "air", node is removed.
6500 -- Otherwise should be name of node which the client immediately places
6501 -- upon digging. Server will always update actual result shortly.
6504 -- Definition of items sounds to be played at various events.
6505 -- All fields in this table are optional.
6507 breaks = <SimpleSoundSpec>,
6508 -- When tool breaks due to wear. Ignored for non-tools
6510 eat = <SimpleSoundSpec>,
6511 -- When item is eaten with `minetest.do_item_eat`
6514 on_place = function(itemstack, placer, pointed_thing),
6515 -- Shall place item and return the leftover itemstack.
6516 -- The placer may be any ObjectRef or nil.
6517 -- default: minetest.item_place
6519 on_secondary_use = function(itemstack, user, pointed_thing),
6520 -- Same as on_place but called when not pointing at a node.
6521 -- The user may be any ObjectRef or nil.
6524 on_drop = function(itemstack, dropper, pos),
6525 -- Shall drop item and return the leftover itemstack.
6526 -- The dropper may be any ObjectRef or nil.
6527 -- default: minetest.item_drop
6529 on_use = function(itemstack, user, pointed_thing),
6531 -- Function must return either nil if no item shall be removed from
6532 -- inventory, or an itemstack to replace the original itemstack.
6533 -- e.g. itemstack:take_item(); return itemstack
6534 -- Otherwise, the function is free to do what it wants.
6535 -- The user may be any ObjectRef or nil.
6536 -- The default functions handle regular use cases.
6538 after_use = function(itemstack, user, node, digparams),
6540 -- If defined, should return an itemstack and will be called instead of
6541 -- wearing out the tool. If returns nil, does nothing.
6542 -- If after_use doesn't exist, it is the same as:
6543 -- function(itemstack, user, node, digparams)
6544 -- itemstack:add_wear(digparams.wear)
6547 -- The user may be any ObjectRef or nil.
6549 _custom_field = whatever,
6550 -- Add your own custom fields. By convention, all custom field names
6551 -- should start with `_` to avoid naming collisions with future engine
6558 Used by `minetest.register_node`.
6561 -- <all fields allowed in item definitions>,
6563 drawtype = "normal", -- See "Node drawtypes"
6566 -- Supported for drawtypes "plantlike", "signlike", "torchlike",
6567 -- "firelike", "mesh".
6568 -- For plantlike and firelike, the image will start at the bottom of the
6569 -- node. For torchlike, the image will start at the surface to which the
6570 -- node "attaches". For the other drawtypes the image will be centered
6573 tiles = {tile definition 1, def2, def3, def4, def5, def6},
6574 -- Textures of node; +Y, -Y, +X, -X, +Z, -Z
6575 -- Old field name was 'tile_images'.
6576 -- List can be shortened to needed length.
6578 overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6},
6579 -- Same as `tiles`, but these textures are drawn on top of the base
6580 -- tiles. You can use this to colorize only specific parts of your
6581 -- texture. If the texture name is an empty string, that overlay is not
6582 -- drawn. Since such tiles are drawn twice, it is not recommended to use
6583 -- overlays on very common nodes.
6585 special_tiles = {tile definition 1, Tile definition 2},
6586 -- Special textures of node; used rarely.
6587 -- Old field name was 'special_materials'.
6588 -- List can be shortened to needed length.
6591 -- The node's original color will be multiplied with this color.
6592 -- If the node has a palette, then this setting only has an effect in
6593 -- the inventory and on the wield item.
6595 use_texture_alpha = false,
6596 -- Use texture's alpha channel
6598 palette = "palette.png",
6599 -- The node's `param2` is used to select a pixel from the image.
6600 -- Pixels are arranged from left to right and from top to bottom.
6601 -- The node's color will be multiplied with the selected pixel's color.
6602 -- Tiles can override this behavior.
6603 -- Only when `paramtype2` supports palettes.
6605 post_effect_color = "green#0F",
6606 -- Screen tint if player is inside node, see "ColorSpec"
6608 paramtype = "none", -- See "Nodes"
6610 paramtype2 = "none", -- See "Nodes"
6612 place_param2 = nil, -- Force value for param2 when player places node
6614 is_ground_content = true,
6615 -- If false, the cave generator and dungeon generator will not carve
6616 -- through this node.
6617 -- Specifically, this stops mod-added nodes being removed by caves and
6618 -- dungeons when those generate in a neighbor mapchunk and extend out
6619 -- beyond the edge of that mapchunk.
6621 sunlight_propagates = false,
6622 -- If true, sunlight will go infinitely through this node
6624 walkable = true, -- If true, objects collide with node
6626 pointable = true, -- If true, can be pointed at
6628 diggable = true, -- If false, can never be dug
6630 climbable = false, -- If true, can be climbed on (ladder)
6632 buildable_to = false, -- If true, placed nodes can replace this node
6635 -- If true, liquids flow into and replace this node.
6636 -- Warning: making a liquid node 'floodable' will cause problems.
6638 liquidtype = "none", -- "none" / "source" / "flowing"
6640 liquid_alternative_flowing = "", -- Flowing version of source liquid
6642 liquid_alternative_source = "", -- Source version of flowing liquid
6644 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
6646 liquid_renewable = true,
6647 -- If true, a new liquid source can be created by placing two or more
6651 -- Only valid for "nodebox" drawtype with 'type = "leveled"'.
6652 -- Allows defining the nodebox height without using param2.
6653 -- The nodebox height is 'leveled' / 64 nodes.
6654 -- The maximum value of 'leveled' is 127.
6656 liquid_range = 8, -- Number of flowing nodes around source (max. 8)
6659 -- Player will take this amount of damage if no bubbles are left
6662 -- Amount of light emitted by node.
6663 -- To set the maximum (14), use the value 'minetest.LIGHT_MAX'.
6664 -- A value outside the range 0 to minetest.LIGHT_MAX causes undefined
6667 damage_per_second = 0,
6668 -- If player is inside node, this damage is caused
6670 node_box = {type="regular"}, -- See "Node boxes"
6672 connects_to = nodenames,
6673 -- Used for nodebox nodes with the type == "connected".
6674 -- Specifies to what neighboring nodes connections will be drawn.
6675 -- e.g. `{"group:fence", "default:wood"}` or `"default:stone"`
6677 connect_sides = { "top", "bottom", "front", "left", "back", "right" },
6678 -- Tells connected nodebox nodes to connect only to these sides of this
6682 -- File name of mesh when using "mesh" drawtype
6687 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
6690 -- Custom selection box definition. Multiple boxes can be defined.
6691 -- If "nodebox" drawtype is used and selection_box is nil, then node_box
6692 -- definition is used for the selection box.
6697 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
6700 -- Custom collision box definition. Multiple boxes can be defined.
6701 -- If "nodebox" drawtype is used and collision_box is nil, then node_box
6702 -- definition is used for the collision box.
6703 -- Both of the boxes above are defined as:
6704 -- {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from node center.
6706 -- Support maps made in and before January 2012
6707 legacy_facedir_simple = false,
6708 legacy_wallmounted = false,
6711 -- Valid for drawtypes:
6712 -- mesh, nodebox, plantlike, allfaces_optional, liquid, flowingliquid.
6713 -- 1 - wave node like plants (node top moves side-to-side, bottom is fixed)
6714 -- 2 - wave node like leaves (whole node moves side-to-side)
6715 -- 3 - wave node like liquids (whole node moves up and down)
6716 -- Not all models will properly wave.
6717 -- plantlike drawtype can only wave like plants.
6718 -- allfaces_optional drawtype can only wave like leaves.
6719 -- liquid, flowingliquid drawtypes can only wave like liquids.
6722 -- Definition of node sounds to be played at various events.
6723 -- All fields in this table are optional.
6725 footstep = <SimpleSoundSpec>,
6726 -- If walkable, played when object walks on it. If node is
6727 -- climbable or a liquid, played when object moves through it
6729 dig = <SimpleSoundSpec> or "__group",
6730 -- While digging node.
6731 -- If `"__group"`, then the sound will be
6732 -- `default_dig_<groupname>`, where `<groupname>` is the
6733 -- name of the tool's digging group with the fastest digging time.
6734 -- In case of a tie, one of the sounds will be played (but we
6735 -- cannot predict which one)
6736 -- Default value: `"__group"`
6738 dug = <SimpleSoundSpec>,
6741 place = <SimpleSoundSpec>,
6742 -- Node was placed. Also played after falling
6744 place_failed = <SimpleSoundSpec>,
6745 -- When node placement failed
6747 fall = <SimpleSoundSpec>,
6748 -- When node starts to fall
6752 -- Name of dropped item when dug.
6753 -- Default dropped item is the node itself.
6754 -- Using a table allows multiple items, drop chances and tool filtering.
6755 -- Tool filtering was undocumented until recently, tool filtering by string
6756 -- matching is deprecated.
6759 -- Maximum number of item lists to drop.
6760 -- The entries in 'items' are processed in order. For each:
6761 -- Tool filtering is applied, chance of drop is applied, if both are
6762 -- successful the entire item list is dropped.
6763 -- Entry processing continues until the number of dropped item lists
6764 -- equals 'max_items'.
6765 -- Therefore, entries should progress from low to high drop chance.
6769 -- 1 in 1000 chance of dropping a diamond.
6770 -- Default rarity is '1'.
6772 items = {"default:diamond"},
6775 -- Only drop if using a tool whose name is identical to one
6777 tools = {"default:shovel_mese", "default:shovel_diamond"},
6779 items = {"default:dirt"},
6780 -- Whether all items in the dropped item list inherit the
6781 -- hardware coloring palette color from the dug node.
6782 -- Default is 'false'.
6783 inherit_color = true,
6786 -- Only drop if using a tool whose name contains
6787 -- "default:shovel_" (this tool filtering by string matching
6789 tools = {"~default:shovel_"},
6791 -- The item list dropped.
6792 items = {"default:sand", "default:desert_sand"},
6797 on_construct = function(pos),
6798 -- Node constructor; called after adding node.
6799 -- Can set up metadata and stuff like that.
6800 -- Not called for bulk node placement (i.e. schematics and VoxelManip).
6803 on_destruct = function(pos),
6804 -- Node destructor; called before removing node.
6805 -- Not called for bulk node placement.
6808 after_destruct = function(pos, oldnode),
6809 -- Node destructor; called after removing node.
6810 -- Not called for bulk node placement.
6813 on_flood = function(pos, oldnode, newnode),
6814 -- Called when a liquid (newnode) is about to flood oldnode, if it has
6815 -- `floodable = true` in the nodedef. Not called for bulk node placement
6816 -- (i.e. schematics and VoxelManip) or air nodes. If return true the
6817 -- node is not flooded, but on_flood callback will most likely be called
6818 -- over and over again every liquid update interval.
6820 -- Warning: making a liquid node 'floodable' will cause problems.
6822 preserve_metadata = function(pos, oldnode, oldmeta, drops),
6823 -- Called when oldnode is about be converted to an item, but before the
6824 -- node is deleted from the world or the drops are added. This is
6825 -- generally the result of either the node being dug or an attached node
6826 -- becoming detached.
6827 -- drops is a table of ItemStacks, so any metadata to be preserved can
6828 -- be added directly to one or more of the dropped items. See
6829 -- "ItemStackMetaRef".
6832 after_place_node = function(pos, placer, itemstack, pointed_thing),
6833 -- Called after constructing node when node was placed using
6834 -- minetest.item_place_node / minetest.place_node.
6835 -- If return true no item is taken from itemstack.
6836 -- `placer` may be any valid ObjectRef or nil.
6839 after_dig_node = function(pos, oldnode, oldmetadata, digger),
6840 -- oldmetadata is in table format.
6841 -- Called after destructing node when node was dug using
6842 -- minetest.node_dig / minetest.dig_node.
6845 can_dig = function(pos, [player]),
6846 -- Returns true if node can be dug, or false if not.
6849 on_punch = function(pos, node, puncher, pointed_thing),
6850 -- default: minetest.node_punch
6851 -- By default calls minetest.register_on_punchnode callbacks.
6853 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing),
6855 -- itemstack will hold clicker's wielded item.
6856 -- Shall return the leftover itemstack.
6857 -- Note: pointed_thing can be nil, if a mod calls this function.
6858 -- This function does not get triggered by clients <=0.4.16 if the
6859 -- "formspec" node metadata field is set.
6861 on_dig = function(pos, node, digger),
6862 -- default: minetest.node_dig
6863 -- By default checks privileges, wears out tool and removes node.
6865 on_timer = function(pos, elapsed),
6867 -- called by NodeTimers, see minetest.get_node_timer and NodeTimerRef.
6868 -- elapsed is the total time passed since the timer was started.
6869 -- return true to run the timer for another cycle with the same timeout
6872 on_receive_fields = function(pos, formname, fields, sender),
6873 -- fields = {name1 = value1, name2 = value2, ...}
6874 -- Called when an UI form (e.g. sign text input) returns data.
6875 -- See minetest.register_on_player_receive_fields for more info.
6878 allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
6879 -- Called when a player wants to move items inside the inventory.
6880 -- Return value: number of items allowed to move.
6882 allow_metadata_inventory_put = function(pos, listname, index, stack, player),
6883 -- Called when a player wants to put something into the inventory.
6884 -- Return value: number of items allowed to put.
6885 -- Return value -1: Allow and don't modify item count in inventory.
6887 allow_metadata_inventory_take = function(pos, listname, index, stack, player),
6888 -- Called when a player wants to take something out of the inventory.
6889 -- Return value: number of items allowed to take.
6890 -- Return value -1: Allow and don't modify item count in inventory.
6892 on_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
6893 on_metadata_inventory_put = function(pos, listname, index, stack, player),
6894 on_metadata_inventory_take = function(pos, listname, index, stack, player),
6895 -- Called after the actual action has happened, according to what was
6899 on_blast = function(pos, intensity),
6900 -- intensity: 1.0 = mid range of regular TNT.
6901 -- If defined, called when an explosion touches the node, instead of
6902 -- removing the node.
6908 Used by `minetest.register_craft`.
6913 output = 'default:pick_stone',
6915 {'default:cobble', 'default:cobble', 'default:cobble'},
6916 {'', 'default:stick', ''},
6917 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
6919 replacements = <list of item pairs>,
6920 -- replacements: replace one input item with another item on crafting
6928 output = 'mushrooms:mushroom_stew',
6931 "mushrooms:mushroom_brown",
6932 "mushrooms:mushroom_red",
6934 replacements = <list of item pairs>,
6940 type = "toolrepair",
6941 additional_wear = -0.02,
6944 Note: Tools with group `disable_repair=1` will not repairable by this recipe.
6950 output = "default:glass",
6951 recipe = "default:sand",
6959 recipe = "bucket:bucket_lava",
6961 replacements = {{"bucket:bucket_lava", "bucket:bucket_empty"}},
6967 Used by `minetest.register_ore`.
6969 See [Ores] section above for essential information.
6972 ore_type = "scatter",
6974 ore = "default:stone_with_coal",
6977 -- Facedir rotation. Default is 0 (unchanged rotation)
6979 wherein = "default:stone",
6980 -- A list of nodenames is supported too
6982 clust_scarcity = 8 * 8 * 8,
6983 -- Ore has a 1 out of clust_scarcity chance of spawning in a node.
6984 -- If the desired average distance between ores is 'd', set this to
6988 -- Number of ores in a cluster
6991 -- Size of the bounding box of the cluster.
6992 -- In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27
6993 -- nodes are coal ore.
6997 -- Lower and upper limits for ore
7000 -- Attributes for the ore generation, see 'Ore attributes' section above
7002 noise_threshold = 0.5,
7003 -- If noise is above this threshold, ore is placed. Not needed for a
7004 -- uniform distribution.
7009 spread = {x = 100, y = 100, z = 100},
7014 -- NoiseParams structure describing one of the perlin noises used for
7015 -- ore distribution.
7016 -- Needed by "sheet", "puff", "blob" and "vein" ores.
7017 -- Omit from "scatter" ore for a uniform ore distribution.
7018 -- Omit from "stratum" ore for a simple horizontal strata from y_min to
7021 biomes = {"desert", "rainforest"},
7022 -- List of biomes in which this ore occurs.
7023 -- Occurs in all biomes if this is omitted, and ignored if the Mapgen
7024 -- being used does not support biomes.
7025 -- Can be a list of (or a single) biome names, IDs, or definitions.
7027 -- Type-specific parameters
7030 column_height_min = 1,
7031 column_height_max = 16,
7032 column_midpoint_factor = 0.5,
7038 spread = {x = 100, y = 100, z = 100},
7046 spread = {x = 100, y = 100, z = 100},
7053 random_factor = 1.0,
7056 np_stratum_thickness = {
7059 spread = {x = 100, y = 100, z = 100},
7064 stratum_thickness = 8,
7070 Used by `minetest.register_biome`.
7075 node_dust = "default:snow",
7076 -- Node dropped onto upper surface after all else is generated
7078 node_top = "default:dirt_with_snow",
7080 -- Node forming surface layer of biome and thickness of this layer
7082 node_filler = "default:permafrost",
7084 -- Node forming lower layer of biome and thickness of this layer
7086 node_stone = "default:bluestone",
7087 -- Node that replaces all stone nodes between roughly y_min and y_max.
7089 node_water_top = "default:ice",
7090 depth_water_top = 10,
7091 -- Node forming a surface layer in seawater with the defined thickness
7094 -- Node that replaces all seawater nodes not in the surface layer
7096 node_river_water = "default:ice",
7097 -- Node that replaces river water in mapgens that use
7098 -- default:river_water
7100 node_riverbed = "default:gravel",
7102 -- Node placed under river water and thickness of this layer
7104 node_cave_liquid = "default:lava_source",
7105 node_cave_liquid = {"default:water_source", "default:lava_source"},
7106 -- Nodes placed inside 50% of the medium size caves.
7107 -- Multiple nodes can be specified, each cave will use a randomly
7108 -- chosen node from the list.
7109 -- If this field is left out or 'nil', cave liquids fall back to
7110 -- classic behaviour of lava and water distributed using 3D noise.
7111 -- For no cave liquid, specify "air".
7113 node_dungeon = "default:cobble",
7114 -- Node used for primary dungeon structure.
7115 -- If absent, dungeon nodes fall back to the 'mapgen_cobble' mapgen
7116 -- alias, if that is also absent, dungeon nodes fall back to the biome
7118 -- If present, the following two nodes are also used.
7120 node_dungeon_alt = "default:mossycobble",
7121 -- Node used for randomly-distributed alternative structure nodes.
7122 -- If alternative structure nodes are not wanted leave this absent for
7123 -- performance reasons.
7125 node_dungeon_stair = "stairs:stair_cobble",
7126 -- Node used for dungeon stairs.
7127 -- If absent, stairs fall back to 'node_dungeon'.
7131 -- Upper and lower limits for biome.
7132 -- Alternatively you can use xyz limits as shown below.
7134 max_pos = {x = 31000, y = 128, z = 31000},
7135 min_pos = {x = -31000, y = 9, z = -31000},
7136 -- xyz limits for biome, an alternative to using 'y_min' and 'y_max'.
7137 -- Biome is limited to a cuboid defined by these positions.
7138 -- Any x, y or z field left undefined defaults to -31000 in 'min_pos' or
7139 -- 31000 in 'max_pos'.
7142 -- Vertical distance in nodes above 'y_max' over which the biome will
7143 -- blend with the biome above.
7144 -- Set to 0 for no vertical blend. Defaults to 0.
7147 humidity_point = 50,
7148 -- Characteristic temperature and humidity for the biome.
7149 -- These values create 'biome points' on a voronoi diagram with heat and
7150 -- humidity as axes. The resulting voronoi cells determine the
7151 -- distribution of the biomes.
7152 -- Heat and humidity have average values of 50, vary mostly between
7153 -- 0 and 100 but can exceed these values.
7156 Decoration definition
7157 ---------------------
7159 See [Decoration types]. Used by `minetest.register_decoration`.
7162 deco_type = "simple",
7164 place_on = "default:dirt_with_grass",
7165 -- Node (or list of nodes) that the decoration can be placed on
7168 -- Size of the square divisions of the mapchunk being generated.
7169 -- Determines the resolution of noise variation if used.
7170 -- If the chunk size is not evenly divisible by sidelen, sidelen is made
7171 -- equal to the chunk size.
7174 -- The value determines 'decorations per surface node'.
7175 -- Used only if noise_params is not specified.
7176 -- If >= 10.0 complete coverage is enabled and decoration placement uses
7177 -- a different and much faster method.
7182 spread = {x = 100, y = 100, z = 100},
7189 -- NoiseParams structure describing the perlin noise used for decoration
7191 -- A noise value is calculated for each square division and determines
7192 -- 'decorations per surface node' within each division.
7193 -- If the noise value >= 10.0 complete coverage is enabled and
7194 -- decoration placement uses a different and much faster method.
7196 biomes = {"Oceanside", "Hills", "Plains"},
7197 -- List of biomes in which this decoration occurs. Occurs in all biomes
7198 -- if this is omitted, and ignored if the Mapgen being used does not
7200 -- Can be a list of (or a single) biome names, IDs, or definitions.
7204 -- Lower and upper limits for decoration.
7205 -- These parameters refer to the Y co-ordinate of the 'place_on' node.
7207 spawn_by = "default:water",
7208 -- Node (or list of nodes) that the decoration only spawns next to.
7209 -- Checks two horizontal planes of 8 neighbouring nodes (including
7210 -- diagonal neighbours), one plane level with the 'place_on' node and a
7211 -- plane one node above that.
7214 -- Number of spawn_by nodes that must be surrounding the decoration
7215 -- position to occur.
7216 -- If absent or -1, decorations occur next to any nodes.
7218 flags = "liquid_surface, force_placement, all_floors, all_ceilings",
7219 -- Flags for all decoration types.
7220 -- "liquid_surface": Instead of placement on the highest solid surface
7221 -- in a mapchunk column, placement is on the highest liquid surface.
7222 -- Placement is disabled if solid nodes are found above the liquid
7224 -- "force_placement": Nodes other than "air" and "ignore" are replaced
7225 -- by the decoration.
7226 -- "all_floors", "all_ceilings": Instead of placement on the highest
7227 -- surface in a mapchunk the decoration is placed on all floor and/or
7228 -- ceiling surfaces, for example in caves and dungeons.
7229 -- Ceiling decorations act as an inversion of floor decorations so the
7230 -- effect of 'place_offset_y' is inverted.
7231 -- Y-slice probabilities do not function correctly for ceiling
7232 -- schematic decorations as the behaviour is unchanged.
7233 -- If a single decoration registration has both flags the floor and
7234 -- ceiling decorations will be aligned vertically.
7236 ----- Simple-type parameters
7238 decoration = "default:grass",
7239 -- The node name used as the decoration.
7240 -- If instead a list of strings, a randomly selected node from the list
7241 -- is placed as the decoration.
7244 -- Decoration height in nodes.
7245 -- If height_max is not 0, this is the lower limit of a randomly
7249 -- Upper limit of the randomly selected height.
7250 -- If absent, the parameter 'height' is used as a constant.
7253 -- Param2 value of decoration nodes.
7254 -- If param2_max is not 0, this is the lower limit of a randomly
7258 -- Upper limit of the randomly selected param2.
7259 -- If absent, the parameter 'param2' is used as a constant.
7262 -- Y offset of the decoration base node relative to the standard base
7264 -- Can be positive or negative. Default is 0.
7265 -- Effect is inverted for "all_ceilings" decorations.
7266 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
7267 -- to the 'place_on' node.
7269 ----- Schematic-type parameters
7271 schematic = "foobar.mts",
7272 -- If schematic is a string, it is the filepath relative to the current
7273 -- working directory of the specified Minetest schematic file.
7274 -- Could also be the ID of a previously registered schematic.
7277 size = {x = 4, y = 6, z = 4},
7279 {name = "default:cobble", param1 = 255, param2 = 0},
7280 {name = "default:dirt_with_grass", param1 = 255, param2 = 0},
7281 {name = "air", param1 = 255, param2 = 0},
7285 {ypos = 2, prob = 128},
7286 {ypos = 5, prob = 64},
7290 -- Alternative schematic specification by supplying a table. The fields
7291 -- size and data are mandatory whereas yslice_prob is optional.
7292 -- See 'Schematic specifier' for details.
7294 replacements = {["oldname"] = "convert_to", ...},
7296 flags = "place_center_x, place_center_y, place_center_z",
7297 -- Flags for schematic decorations. See 'Schematic attributes'.
7300 -- Rotation can be "0", "90", "180", "270", or "random"
7303 -- If the flag 'place_center_y' is set this parameter is ignored.
7304 -- Y offset of the schematic base node layer relative to the 'place_on'
7306 -- Can be positive or negative. Default is 0.
7307 -- Effect is inverted for "all_ceilings" decorations.
7308 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
7309 -- to the 'place_on' node.
7312 Chat command definition
7313 -----------------------
7315 Used by `minetest.register_chatcommand`.
7318 params = "<name> <privilege>", -- Short parameter description
7320 description = "Remove privilege from player", -- Full description
7322 privs = {privs=true}, -- Require the "privs" privilege to run
7324 func = function(name, param),
7325 -- Called when command is run. Returns boolean success and text output.
7328 Note that in params, use of symbols is as follows:
7330 * `<>` signifies a placeholder to be replaced when the command is used. For
7331 example, when a player name is needed: `<name>`
7332 * `[]` signifies param is optional and not required when the command is used.
7333 For example, if you require param1 but param2 is optional:
7334 `<param1> [<param2>]`
7335 * `|` signifies exclusive or. The command requires one param from the options
7336 provided. For example: `<param1> | <param2>`
7337 * `()` signifies grouping. For example, when param1 and param2 are both
7338 required, or only param3 is required: `(<param1> <param2>) | <param3>`
7340 Privilege definition
7341 --------------------
7343 Used by `minetest.register_privilege`.
7347 -- Privilege description
7349 give_to_singleplayer = true,
7350 -- Whether to grant the privilege to singleplayer.
7352 give_to_admin = true,
7353 -- Whether to grant the privilege to the server admin.
7354 -- Uses value of 'give_to_singleplayer' by default.
7356 on_grant = function(name, granter_name),
7357 -- Called when given to player 'name' by 'granter_name'.
7358 -- 'granter_name' will be nil if the priv was granted by a mod.
7360 on_revoke = function(name, revoker_name),
7361 -- Called when taken from player 'name' by 'revoker_name'.
7362 -- 'revoker_name' will be nil if the priv was revoked by a mod.
7364 -- Note that the above two callbacks will be called twice if a player is
7365 -- responsible, once with the player name, and then with a nil player
7367 -- Return true in the above callbacks to stop register_on_priv_grant or
7368 -- revoke being called.
7371 Detached inventory callbacks
7372 ----------------------------
7374 Used by `minetest.create_detached_inventory`.
7377 allow_move = function(inv, from_list, from_index, to_list, to_index, count, player),
7378 -- Called when a player wants to move items inside the inventory.
7379 -- Return value: number of items allowed to move.
7381 allow_put = function(inv, listname, index, stack, player),
7382 -- Called when a player wants to put something into the inventory.
7383 -- Return value: number of items allowed to put.
7384 -- Return value -1: Allow and don't modify item count in inventory.
7386 allow_take = function(inv, listname, index, stack, player),
7387 -- Called when a player wants to take something out of the inventory.
7388 -- Return value: number of items allowed to take.
7389 -- Return value -1: Allow and don't modify item count in inventory.
7391 on_move = function(inv, from_list, from_index, to_list, to_index, count, player),
7392 on_put = function(inv, listname, index, stack, player),
7393 on_take = function(inv, listname, index, stack, player),
7394 -- Called after the actual action has happened, according to what was
7404 Used by `Player:hud_add`. Returned by `Player:hud_get`.
7407 hud_elem_type = "image", -- See HUD element types
7408 -- Type of element, can be "image", "text", "statbar", or "inventory"
7410 position = {x=0.5, y=0.5},
7411 -- Left corner position of element
7415 scale = {x = 2, y = 2},
7422 -- Selected item in inventory. 0 for no item selected.
7425 -- Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
7427 alignment = {x=0, y=0},
7429 offset = {x=0, y=0},
7431 size = { x=100, y=100 },
7432 -- Size of element in pixels
7435 -- Z index : lower z-index HUDs are displayed behind higher z-index HUDs
7441 Used by `minetest.add_particle`.
7444 pos = {x=0, y=0, z=0},
7445 velocity = {x=0, y=0, z=0},
7446 acceleration = {x=0, y=0, z=0},
7447 -- Spawn particle at pos with velocity and acceleration
7450 -- Disappears after expirationtime seconds
7453 -- Scales the visual size of the particle texture.
7455 collisiondetection = false,
7456 -- If true collides with `walkable` nodes and, depending on the
7457 -- `object_collision` field, objects too.
7459 collision_removal = false,
7460 -- If true particle is removed when it collides.
7461 -- Requires collisiondetection = true to have any effect.
7463 object_collision = false,
7464 -- If true particle collides with objects that are defined as
7465 -- `physical = true,` and `collide_with_objects = true,`.
7466 -- Requires collisiondetection = true to have any effect.
7469 -- If true faces player using y axis only
7471 texture = "image.png",
7473 playername = "singleplayer",
7474 -- Optional, if specified spawns particle only on the player's client
7476 animation = {Tile Animation definition},
7477 -- Optional, specifies how to animate the particle texture
7480 -- Optional, specify particle self-luminescence in darkness.
7485 `ParticleSpawner` definition
7486 ----------------------------
7488 Used by `minetest.add_particlespawner`.
7492 -- Number of particles spawned over the time period `time`.
7495 -- Lifespan of spawner in seconds.
7496 -- If time is 0 spawner has infinite lifespan and spawns the `amount` on
7497 -- a per-second basis.
7499 minpos = {x=0, y=0, z=0},
7500 maxpos = {x=0, y=0, z=0},
7501 minvel = {x=0, y=0, z=0},
7502 maxvel = {x=0, y=0, z=0},
7503 minacc = {x=0, y=0, z=0},
7504 maxacc = {x=0, y=0, z=0},
7509 -- The particles' properties are random values between the min and max
7511 -- pos, velocity, acceleration, expirationtime, size
7513 collisiondetection = false,
7514 -- If true collide with `walkable` nodes and, depending on the
7515 -- `object_collision` field, objects too.
7517 collision_removal = false,
7518 -- If true particles are removed when they collide.
7519 -- Requires collisiondetection = true to have any effect.
7521 object_collision = false,
7522 -- If true particles collide with objects that are defined as
7523 -- `physical = true,` and `collide_with_objects = true,`.
7524 -- Requires collisiondetection = true to have any effect.
7526 attached = ObjectRef,
7527 -- If defined, particle positions, velocities and accelerations are
7528 -- relative to this object's position and yaw
7531 -- If true face player using y axis only
7533 texture = "image.png",
7535 playername = "singleplayer",
7536 -- Optional, if specified spawns particles only on the player's client
7538 animation = {Tile Animation definition},
7539 -- Optional, specifies how to animate the particles' texture
7542 -- Optional, specify particle self-luminescence in darkness.
7546 `HTTPRequest` definition
7547 ------------------------
7549 Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
7552 url = "http://example.org",
7555 -- Timeout for connection in seconds. Default is 3 seconds.
7557 post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
7558 -- Optional, if specified a POST request with post_data is performed.
7559 -- Accepts both a string and a table. If a table is specified, encodes
7560 -- table as x-www-form-urlencoded key-value pairs.
7561 -- If post_data is not specified, a GET request is performed instead.
7563 user_agent = "ExampleUserAgent",
7564 -- Optional, if specified replaces the default minetest user agent with
7567 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
7568 -- Optional, if specified adds additional headers to the HTTP request.
7569 -- You must make sure that the header strings follow HTTP specification
7573 -- Optional, if true performs a multipart HTTP request.
7574 -- Default is false.
7577 `HTTPRequestResult` definition
7578 ------------------------------
7580 Passed to `HTTPApiTable.fetch` callback. Returned by
7581 `HTTPApiTable.fetch_async_get`.
7585 -- If true, the request has finished (either succeeded, failed or timed
7589 -- If true, the request was successful
7592 -- If true, the request timed out
7600 Authentication handler definition
7601 ---------------------------------
7603 Used by `minetest.register_authentication_handler`.
7606 get_auth = function(name),
7607 -- Get authentication data for existing player `name` (`nil` if player
7609 -- Returns following structure:
7610 -- `{password=<string>, privileges=<table>, last_login=<number or nil>}`
7612 create_auth = function(name, password),
7613 -- Create new auth data for player `name`.
7614 -- Note that `password` is not plain-text but an arbitrary
7615 -- representation decided by the engine.
7617 delete_auth = function(name),
7618 -- Delete auth data of player `name`.
7619 -- Returns boolean indicating success (false if player is nonexistent).
7621 set_password = function(name, password),
7622 -- Set password of player `name` to `password`.
7623 -- Auth data should be created if not present.
7625 set_privileges = function(name, privileges),
7626 -- Set privileges of player `name`.
7627 -- `privileges` is in table form, auth data should be created if not
7630 reload = function(),
7631 -- Reload authentication data from the storage location.
7632 -- Returns boolean indicating success.
7634 record_login = function(name),
7635 -- Called when player joins, used for keeping track of last_login
7637 iterate = function(),
7638 -- Returns an iterator (use with `for` loops) for all player names
7639 -- currently in the auth database