1 Minetest Lua Modding API Reference
2 ==================================
3 * More information at <http://www.minetest.net/>
4 * Developer Wiki: <http://dev.minetest.net/>
8 Content and functionality can be added to Minetest using Lua scripting
9 in run-time loaded mods.
11 A mod is a self-contained bunch of scripts, textures and other related
12 things, which is loaded by and interfaces with Minetest.
14 Mods are contained and ran solely on the server side. Definitions and media
15 files are automatically transferred to the client.
17 If you see a deficiency in the API, feel free to attempt to add the
18 functionality in the engine and API, and to document it here.
22 If you have any difficulty in understanding this, please read
23 [Programming in Lua](http://www.lua.org/pil/).
27 Mods are loaded during server startup from the mod load paths by running
28 the `init.lua` scripts in a shared environment.
32 * `RUN_IN_PLACE=1` (Windows release, local build)
34 * Linux: `<build directory>`
35 * Windows: `<build directory>`
37 * Linux: `<build directory>`
38 * Windows: `<build directory>`
39 * `RUN_IN_PLACE=0`: (Linux release)
41 * Linux: `/usr/share/minetest`
42 * Windows: `<install directory>/minetest-0.4.x`
44 * Linux: `$HOME/.minetest`
45 * Windows: `C:/users/<user>/AppData/minetest` (maybe)
49 Games are looked up from:
51 * `$path_share/games/gameid/`
52 * `$path_user/games/gameid/`
54 Where `gameid` is unique to each game.
56 The game directory can contain the following files:
58 * `game.conf`, which contains:
59 * `name = <Human-readable full name of the game>` e.g. `name = Minetest`
60 * Optionally, game.conf can also contain
61 `disallowed_mapgens = <comma-separated mapgens>`
62 e.g. `disallowed_mapgens = v5,v6,flat`
63 These mapgens are removed from the list of mapgens for the game.
65 Used to set default settings when running this game.
67 In the same format as the one in builtin.
68 This settingtypes.txt will be parsed by the menu and the settings will be
69 displayed in the "Games" category in the advanced settings tab.
70 * If the game contains a folder called `textures` the server will load it as a
71 texturepack, overriding mod textures.
72 Any server texturepack will override mod textures and the game texturepack.
76 Games can provide custom main menu images. They are put inside a `menu`
77 directory inside the game directory.
79 The images are named `$identifier.png`, where `$identifier` is one of
80 `overlay`, `background`, `footer`, `header`.
81 If you want to specify multiple images for one identifier, add additional
82 images named like `$identifier.$n.png`, with an ascending number $n starting
83 with 1, and a random image will be chosen from the provided ones.
89 * `$path_share/games/gameid/mods/`
91 * `$path_user/games/gameid/mods/`
92 * `$path_user/mods/` (User-installed mods)
93 * `$worldpath/worldmods/`
95 In a run-in-place version (e.g. the distributed windows version):
97 * `minetest-0.4.x/games/gameid/mods/`
98 * `minetest-0.4.x/mods/` (User-installed mods)
99 * `minetest-0.4.x/worlds/worldname/worldmods/`
101 On an installed version on Linux:
103 * `/usr/share/minetest/games/gameid/mods/`
104 * `$HOME/.minetest/mods/` (User-installed mods)
105 * `$HOME/.minetest/worlds/worldname/worldmods`
107 Mod load path for world-specific games
108 --------------------------------------
109 It is possible to include a game in a world; in this case, no mods or
110 games are loaded or checked from anywhere else.
112 This is useful for e.g. adventure worlds.
114 This happens if the following directory exists:
118 Mods should be then be placed in:
124 Mods can be put in a subdirectory, if the parent directory, which otherwise
125 should be a mod, contains a file named `modpack.txt`. This file shall be
126 empty, except for lines starting with `#`, which are comments.
128 Mod directory structure
129 ------------------------
135 | |-- settingtypes.txt
139 | | |-- modname_stuff.png
140 | | `-- modname_something_else.png
148 The location of this directory can be fetched by using
149 `minetest.get_modpath(modname)`.
152 A key-value store of mod details.
154 * `name` - the mod name. Allows Minetest to determine the mod name even if the
155 folder is wrongly named.
156 * `description` - Description of mod to be shown in the Mods tab of the mainmenu.
157 * `depends` - A comma separated list of dependencies. These are mods that must
158 be loaded before this mod.
159 * `optional_depends` - A comma separated list of optional dependencies.
160 Like a dependency, but no error if the mod doesn't exist.
162 Note: to support 0.4.x, please also provide depends.txt.
165 A screenshot shown in the mod manager within the main menu. It should
166 have an aspect ratio of 3:2 and a minimum size of 300×200 pixels.
169 **Deprecated:** you should use mod.conf instead.
171 This file is used if there are no dependencies in mod.conf.
173 List of mods that have to be loaded before loading this mod.
175 A single line contains a single modname.
177 Optional dependencies can be defined by appending a question mark
178 to a single modname. This means that if the specified mod
179 is missing, it does not prevent this mod from being loaded.
181 ### `description.txt`
182 **Deprecated:** you should use mod.conf instead.
184 This file is used if there is no description in mod.conf.
186 A file containing a description to be shown in the Mods tab of the mainmenu.
188 ### `settingtypes.txt`
189 A file in the same format as the one in builtin. It will be parsed by the
190 settings menu and the settings will be displayed in the "Mods" category.
193 The main Lua script. Running this script should register everything it
194 wants to register. Subsequent execution depends on minetest calling the
195 registered callbacks.
197 `minetest.settings` can be used to read custom or existing settings at load
198 time, if necessary. (See `Settings`)
201 Models for entities or meshnodes.
203 ### `textures`, `sounds`, `media`
204 Media files (textures, sounds, whatever) that will be transferred to the
205 client and will be available for use by the mod.
208 Translation files for the clients. (See `Translations`)
210 Naming convention for registered textual names
211 ----------------------------------------------
212 Registered names should generally be in this format:
216 `<whatever>` can have these characters:
220 This is to prevent conflicting names from corrupting maps and is
221 enforced by the mod loader.
224 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
225 So the name should be `experimental:tnt`.
227 Enforcement can be overridden by prefixing the name with `:`. This can
228 be used for overriding the registrations of some other mod.
230 Example: Any mod can redefine `experimental:tnt` by using the name
235 (also that mod is required to have `experimental` as a dependency)
237 The `:` prefix can also be used for maintaining backwards compatibility.
241 Aliases can be added by using `minetest.register_alias(name, convert_to)` or
242 `minetest.register_alias_force(name, convert_to)`.
244 This converts anything called `name` to `convert_to`.
246 The only difference between `minetest.register_alias` and
247 `minetest.register_alias_force` is that if an item called `name` exists,
248 `minetest.register_alias` will do nothing while
249 `minetest.register_alias_force` will unregister it.
251 This can be used for maintaining backwards compatibility.
253 This can also set quick access names for things, e.g. if
254 you have an item called `epiclylongmodname:stuff`, you could do
256 minetest.register_alias("stuff", "epiclylongmodname:stuff")
258 and be able to use `/giveme stuff`.
262 In a game, a certain number of these must be set to tell core mapgens which
263 of the game's nodes are to be used by the core mapgens. For example:
265 minetest.register_alias("mapgen_stone", "default:stone")
267 ### Aliases needed for all mapgens except Mapgen v6
272 "mapgen_water_source"
273 "mapgen_river_water_source"
281 Only needed for registered biomes where 'node_stone' is stone:
283 "mapgen_stair_cobble"
285 Only needed for registered biomes where 'node_stone' is desert stone:
286 "mapgen_desert_stone"
287 "mapgen_stair_desert_stone"
288 Only needed for registered biomes where 'node_stone' is sandstone:
290 "mapgen_sandstonebrick"
291 "mapgen_stair_sandstone_block"
293 ### Aliases needed for Mapgen v6
298 "mapgen_water_source"
301 "mapgen_dirt_with_grass"
304 "mapgen_desert_stone"
306 "mapgen_dirt_with_snow"
317 "mapgen_jungleleaves"
320 "mapgen_pine_needles"
325 "mapgen_stair_cobble"
327 "mapgen_stair_desert_stone"
331 Mods should generally prefix their textures with `modname_`, e.g. given
332 the mod name `foomod`, a texture could be called:
336 Textures are referred to by their complete name, or alternatively by
337 stripping out the file extension:
339 * e.g. `foomod_foothing.png`
340 * e.g. `foomod_foothing`
344 There are various texture modifiers that can be used
345 to generate textures on-the-fly.
347 ### Texture overlaying
348 Textures can be overlaid by putting a `^` between them.
352 default_dirt.png^default_grass_side.png
354 `default_grass_side.png` is overlaid over `default_dirt.png`.
355 The texture with the lower resolution will be automatically upscaled to
356 the higher resolution texture.
359 Textures can be grouped together by enclosing them in `(` and `)`.
361 Example: `cobble.png^(thing1.png^thing2.png)`
363 A texture for `thing1.png^thing2.png` is created and the resulting
364 texture is overlaid on top of `cobble.png`.
367 Modifiers that accept texture names (e.g. `[combine`) accept escaping to allow
368 passing complex texture names as arguments. Escaping is done with backslash and
369 is required for `^` and `:`.
371 Example: `cobble.png^[lowpart:50:color.png\^[mask\:trans.png`
373 The lower 50 percent of `color.png^[mask:trans.png` are overlaid
374 on top of `cobble.png`.
376 ### Advanced texture modifiers
381 * `[crack:<t>:<n>:<p>`
382 * `[cracko:<t>:<n>:<p>`
385 * `<t>` = tile count (in each direction)
386 * `<n>` = animation frame count
387 * `<p>` = current animation frame
389 Draw a step of the crack animation on the texture.
390 `crack` draws it normally, while `cracko` lays it over, keeping transparent
395 default_cobble.png^[crack:10:1
397 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
402 * `<file>` = texture to combine
404 Creates a texture of size `<w>` times `<h>` and blits the listed files to their
405 specified coordinates.
409 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
411 #### `[resize:<w>x<h>`
412 Resizes the texture to the given dimensions.
416 default_sandstone.png^[resize:16x16
419 Makes the base image transparent according to the given ratio.
421 `r` must be between 0 and 255.
422 0 means totally transparent. 255 means totally opaque.
426 default_sandstone.png^[opacity:127
428 #### `[invert:<mode>`
429 Inverts the given channels of the base image.
430 Mode may contain the characters "r", "g", "b", "a".
431 Only the channels that are mentioned in the mode string will be inverted.
435 default_apple.png^[invert:rgb
438 Brightens the texture.
442 tnt_tnt_side.png^[brighten
445 Makes the texture completely opaque.
449 default_leaves.png^[noalpha
451 #### `[makealpha:<r>,<g>,<b>`
452 Convert one color to transparency.
456 default_cobble.png^[makealpha:128,128,128
459 * `<t>` = transformation(s) to apply
461 Rotates and/or flips the image.
463 `<t>` can be a number (between 0 and 7) or a transform name.
464 Rotations are counter-clockwise.
467 1 R90 rotate by 90 degrees
468 2 R180 rotate by 180 degrees
469 3 R270 rotate by 270 degrees
471 5 FXR90 flip X then rotate by 90 degrees
473 7 FYR90 flip Y then rotate by 90 degrees
477 default_stone.png^[transformFXR90
479 #### `[inventorycube{<top>{<left>{<right>`
480 Escaping does not apply here and `^` is replaced by `&` in texture names
483 Create an inventory cube texture using the side textures.
487 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
489 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
490 `dirt.png^grass_side.png` textures
492 #### `[lowpart:<percent>:<file>`
493 Blit the lower `<percent>`% part of `<file>` on the texture.
497 base.png^[lowpart:25:overlay.png
499 #### `[verticalframe:<t>:<n>`
500 * `<t>` = animation frame count
501 * `<n>` = current animation frame
503 Crops the texture to a frame of a vertical animation.
507 default_torch_animated.png^[verticalframe:16:8
510 Apply a mask to the base image.
512 The mask is applied using binary AND.
514 #### `[sheet:<w>x<h>:<x>,<y>`
515 Retrieves a tile at position x,y from the base image
516 which it assumes to be a tilesheet with dimensions w,h.
519 #### `[colorize:<color>:<ratio>`
520 Colorize the textures with the given color.
521 `<color>` is specified as a `ColorString`.
522 `<ratio>` is an int ranging from 0 to 255 or the word "`alpha`". If
523 it is an int, then it specifies how far to interpolate between the
524 colors where 0 is only the texture color and 255 is only `<color>`. If
525 omitted, the alpha of `<color>` will be used as the ratio. If it is
526 the word "`alpha`", then each texture pixel will contain the RGB of
527 `<color>` and the alpha of `<color>` multiplied by the alpha of the
530 #### `[multiply:<color>`
531 Multiplies texture colors with the given color.
532 `<color>` is specified as a `ColorString`.
533 Result is more like what you'd expect if you put a color on top of another
534 color. Meaning white surfaces get a lot of your new color while black parts
535 don't change very much.
539 The goal of hardware coloring is to simplify the creation of
540 colorful nodes. If your textures use the same pattern, and they only
541 differ in their color (like colored wool blocks), you can use hardware
542 coloring instead of creating and managing many texture files.
543 All of these methods use color multiplication (so a white-black texture
544 with red coloring will result in red-black color).
547 This method is useful if you wish to create nodes/items with
548 the same texture, in different colors, each in a new node/item definition.
551 When you register an item or node, set its `color` field (which accepts a
552 `ColorSpec`) to the desired color.
554 An `ItemStack`s static color can be overwritten by the `color` metadata
555 field. If you set that field to a `ColorString`, that color will be used.
558 Each tile may have an individual static color, which overwrites every
559 other coloring methods. To disable the coloring of a face,
560 set its color to white (because multiplying with white does nothing).
561 You can set the `color` property of the tiles in the node's definition
562 if the tile is in table format.
565 For nodes and items which can have many colors, a palette is more
566 suitable. A palette is a texture, which can contain up to 256 pixels.
567 Each pixel is one possible color for the node/item.
568 You can register one node/item, which can have up to 256 colors.
570 #### Palette indexing
571 When using palettes, you always provide a pixel index for the given
572 node or `ItemStack`. The palette is read from left to right and from
573 top to bottom. If the palette has less than 256 pixels, then it is
574 stretched to contain exactly 256 pixels (after arranging the pixels
575 to one line). The indexing starts from 0.
579 * 16x16 palette, index = 0: the top left corner
580 * 16x16 palette, index = 4: the fifth pixel in the first row
581 * 16x16 palette, index = 16: the pixel below the top left corner
582 * 16x16 palette, index = 255: the bottom right corner
583 * 2 (width)x4 (height) palette, index=31: the top left corner.
584 The palette has 8 pixels, so each pixel is stretched to 32 pixels,
585 to ensure the total 256 pixels.
586 * 2x4 palette, index=32: the top right corner
587 * 2x4 palette, index=63: the top right corner
588 * 2x4 palette, index=64: the pixel below the top left corner
590 #### Using palettes with items
591 When registering an item, set the item definition's `palette` field to
592 a texture. You can also use texture modifiers.
594 The `ItemStack`'s color depends on the `palette_index` field of the
595 stack's metadata. `palette_index` is an integer, which specifies the
596 index of the pixel to use.
598 #### Linking palettes with nodes
599 When registering a node, set the item definition's `palette` field to
600 a texture. You can also use texture modifiers.
601 The node's color depends on its `param2`, so you also must set an
602 appropriate `paramtype2`:
604 * `paramtype2 = "color"` for nodes which use their full `param2` for
605 palette indexing. These nodes can have 256 different colors.
606 The palette should contain 256 pixels.
607 * `paramtype2 = "colorwallmounted"` for nodes which use the first
608 five bits (most significant) of `param2` for palette indexing.
609 The remaining three bits are describing rotation, as in `wallmounted`
610 paramtype2. Division by 8 yields the palette index (without stretching the
611 palette). These nodes can have 32 different colors, and the palette
612 should contain 32 pixels.
614 * `param2 = 17` is 2 * 8 + 1, so the rotation is 1 and the third (= 2 + 1)
615 pixel will be picked from the palette.
616 * `param2 = 35` is 4 * 8 + 3, so the rotation is 3 and the fifth (= 4 + 1)
617 pixel will be picked from the palette.
618 * `paramtype2 = "colorfacedir"` for nodes which use the first
619 three bits of `param2` for palette indexing. The remaining
620 five bits are describing rotation, as in `facedir` paramtype2.
621 Division by 32 yields the palette index (without stretching the
622 palette). These nodes can have 8 different colors, and the
623 palette should contain 8 pixels.
625 * `param2 = 17` is 0 * 32 + 17, so the rotation is 17 and the
626 first (= 0 + 1) pixel will be picked from the palette.
627 * `param2 = 35` is 1 * 32 + 3, so the rotation is 3 and the
628 second (= 1 + 1) pixel will be picked from the palette.
630 To colorize a node on the map, set its `param2` value (according
631 to the node's paramtype2).
633 ### Conversion between nodes in the inventory and the on the map
634 Static coloring is the same for both cases, there is no need
637 If the `ItemStack`'s metadata contains the `color` field, it will be
638 lost on placement, because nodes on the map can only use palettes.
640 If the `ItemStack`'s metadata contains the `palette_index` field, it is
641 automatically transferred between node and item forms by the engine,
642 when a player digs or places a colored node.
643 You can disable this feature by setting the `drop` field of the node
644 to itself (without metadata).
645 To transfer the color to a special drop, you need a drop table.
649 minetest.register_node("mod:stone", {
650 description = "Stone",
651 tiles = {"default_stone.png"},
652 paramtype2 = "color",
653 palette = "palette.png",
656 -- assume that mod:cobblestone also has the same palette
657 {items = {"mod:cobblestone"}, inherit_color = true },
662 ### Colored items in craft recipes
663 Craft recipes only support item strings, but fortunately item strings
664 can also contain metadata. Example craft recipe registration:
666 minetest.register_craft({
667 output = minetest.itemstring_with_palette("wool:block", 3),
675 To set the `color` field, you can use `minetest.itemstring_with_color`.
677 Metadata field filtering in the `recipe` field are not supported yet,
678 so the craft output is independent of the color of the ingredients.
682 Sometimes hardware coloring is not enough, because it affects the
683 whole tile. Soft texture overlays were added to Minetest to allow
684 the dynamic coloring of only specific parts of the node's texture.
685 For example a grass block may have colored grass, while keeping the
688 These overlays are 'soft', because unlike texture modifiers, the layers
689 are not merged in the memory, but they are simply drawn on top of each
690 other. This allows different hardware coloring, but also means that
691 tiles with overlays are drawn slower. Using too much overlays might
694 For inventory and wield images you can specify overlays which
695 hardware coloring does not modify. You have to set `inventory_overlay`
696 and `wield_overlay` fields to an image name.
698 To define a node overlay, simply set the `overlay_tiles` field of the node
699 definition. These tiles are defined in the same way as plain tiles:
700 they can have a texture name, color etc.
701 To skip one face, set that overlay tile to an empty string.
703 Example (colored grass block):
705 minetest.register_node("default:dirt_with_grass", {
706 description = "Dirt with Grass",
707 -- Regular tiles, as usual
708 -- The dirt tile disables palette coloring
709 tiles = {{name = "default_grass.png"},
710 {name = "default_dirt.png", color = "white"}},
711 -- Overlay tiles: define them in the same style
712 -- The top and bottom tile does not have overlay
713 overlay_tiles = {"", "",
714 {name = "default_grass_side.png", tileable_vertical = false}},
715 -- Global color, used in inventory
717 -- Palette in the world
718 paramtype2 = "color",
719 palette = "default_foilage.png",
724 Only Ogg Vorbis files are supported.
726 For positional playing of sounds, only single-channel (mono) files are
727 supported. Otherwise OpenAL will play them non-positionally.
729 Mods should generally prefix their sounds with `modname_`, e.g. given
730 the mod name "`foomod`", a sound could be called:
734 Sounds are referred to by their name with a dot, a single digit and the
735 file extension stripped out. When a sound is played, the actual sound file
736 is chosen randomly from the matching sounds.
738 When playing the sound `foomod_foosound`, the sound is chosen randomly
739 from the available ones of the following files:
741 * `foomod_foosound.ogg`
742 * `foomod_foosound.0.ogg`
743 * `foomod_foosound.1.ogg`
745 * `foomod_foosound.9.ogg`
747 Examples of sound parameter tables:
749 -- Play locationless on all clients
751 gain = 1.0, -- default
752 fade = 0.0, -- default, change to a value > 0 to fade the sound in
753 pitch = 1.0, -- default
755 -- Play locationless to one player
758 gain = 1.0, -- default
759 fade = 0.0, -- default, change to a value > 0 to fade the sound in
760 pitch = 1.0, -- default
762 -- Play locationless to one player, looped
765 gain = 1.0, -- default
768 -- Play in a location
770 pos = {x = 1, y = 2, z = 3},
771 gain = 1.0, -- default
772 max_hear_distance = 32, -- default, uses an euclidean metric
774 -- Play connected to an object, looped
776 object = <an ObjectRef>,
777 gain = 1.0, -- default
778 max_hear_distance = 32, -- default, uses an euclidean metric
782 Looped sounds must either be connected to an object or played locationless to
783 one player using `to_player = name,`
785 ### `SimpleSoundSpec`
787 * e.g. `"default_place_node"`
789 * e.g. `{name = "default_place_node"}`
790 * e.g. `{name = "default_place_node", gain = 1.0}`
791 * e.g. `{name = "default_place_node", gain = 1.0, pitch = 1.0}`
793 Registered definitions of stuff
794 -------------------------------
795 Anything added using certain `minetest.register_*` functions get added to
796 the global `minetest.registered_*` tables.
798 * `minetest.register_entity(name, prototype table)`
799 * added to `minetest.registered_entities[name]`
801 * `minetest.register_node(name, node definition)`
802 * added to `minetest.registered_items[name]`
803 * added to `minetest.registered_nodes[name]`
805 * `minetest.register_tool(name, item definition)`
806 * added to `minetest.registered_items[name]`
808 * `minetest.register_craftitem(name, item definition)`
809 * added to `minetest.registered_items[name]`
811 * `minetest.unregister_item(name)`
812 * Unregisters the item name from engine, and deletes the entry with key
813 * `name` from `minetest.registered_items` and from the associated item
814 * table according to its nature: `minetest.registered_nodes[]` etc
816 * `minetest.register_biome(biome definition)`
817 * returns an integer uniquely identifying the registered biome
818 * added to `minetest.registered_biome` with the key of `biome.name`
819 * if `biome.name` is nil, the key is the returned ID
821 * `minetest.unregister_biome(name)`
822 * Unregisters the biome name from engine, and deletes the entry with key
823 * `name` from `minetest.registered_biome`
825 * `minetest.register_ore(ore definition)`
826 * returns an integer uniquely identifying the registered ore
827 * added to `minetest.registered_ores` with the key of `ore.name`
828 * if `ore.name` is nil, the key is the returned ID
830 * `minetest.register_decoration(decoration definition)`
831 * returns an integer uniquely identifying the registered decoration
832 * added to `minetest.registered_decorations` with the key of
834 * if `decoration.name` is nil, the key is the returned ID
836 * `minetest.register_schematic(schematic definition)`
837 * returns an integer uniquely identifying the registered schematic
838 * added to `minetest.registered_schematic` with the key of `schematic.name`
839 * if `schematic.name` is nil, the key is the returned ID
840 * if the schematic is loaded from a file, schematic.name is set to the
842 * if the function is called when loading the mod, and schematic.name is a
843 relative path, then the current mod path will be prepended to the
846 * `minetest.clear_registered_biomes()`
847 * clears all biomes currently registered
849 * `minetest.clear_registered_ores()`
850 * clears all ores currently registered
852 * `minetest.clear_registered_decorations()`
853 * clears all decorations currently registered
855 * `minetest.clear_registered_schematics()`
856 * clears all schematics currently registered
858 Note that in some cases you will stumble upon things that are not contained
859 in these tables (e.g. when a mod has been removed). Always check for
860 existence before trying to access the fields.
862 Example: If you want to check the drawtype of a node, you could do:
864 local function get_nodedef_field(nodename, fieldname)
865 if not minetest.registered_nodes[nodename] then
868 return minetest.registered_nodes[nodename][fieldname]
870 local drawtype = get_nodedef_field(nodename, "drawtype")
872 Example: `minetest.get_item_group(name, group)` has been implemented as:
874 function minetest.get_item_group(name, group)
875 if not minetest.registered_items[name] or not
876 minetest.registered_items[name].groups[group] then
879 return minetest.registered_items[name].groups[group]
884 Nodes are the bulk data of the world: cubes and other things that take the
885 space of a cube. Huge amounts of them are handled efficiently, but they
888 The definition of a node is stored and can be accessed by name in
890 minetest.registered_nodes[node.name]
892 See "Registered definitions of stuff".
894 Nodes are passed by value between Lua and the engine.
895 They are represented by a table:
897 {name="name", param1=num, param2=num}
899 `param1` and `param2` are 8-bit integers ranging from 0 to 255. The engine uses
900 them for certain automated functions. If you don't use these functions, you can
901 use them to store arbitrary values.
903 The functions of `param1` and `param2` are determined by certain fields in the
906 `param1` is reserved for the engine when `paramtype != "none"`:
909 ^ The value stores light with and without sun in its upper and lower 4 bits
910 respectively. Allows light to propagate from or through the node with
911 light value falling by 1 per node. This is essential for a light source
912 node to spread its light.
914 `param2` is reserved for the engine when any of these are used:
916 liquidtype == "flowing"
917 ^ The level and some flags of the liquid is stored in param2
918 drawtype == "flowingliquid"
919 ^ The drawn liquid level is read from param2
920 drawtype == "torchlike"
921 drawtype == "signlike"
922 paramtype2 == "wallmounted"
923 ^ The rotation of the node is stored in param2. You can make this value
924 by using minetest.dir_to_wallmounted().
925 paramtype2 == "facedir"
926 ^ The rotation of the node is stored in param2. Furnaces and chests are
927 rotated this way. Can be made by using minetest.dir_to_facedir().
929 facedir / 4 = axis direction:
930 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
931 facedir modulo 4 = rotation around that axis
932 paramtype2 == "leveled"
933 ^ Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
935 The level of the top face of the nodebox is stored in param2.
936 The other faces are defined by 'fixed = {}' like 'type = "fixed"'
938 The nodebox height is (param2 / 64) nodes.
939 The maximum accepted value of param2 is 127.
941 The height of the 'plantlike' section is stored in param2.
942 The height is (param2 / 16) nodes.
943 paramtype2 == "degrotate"
944 ^ Only valid for "plantlike". The rotation of the node is stored in param2.
945 Values range 0 - 179. The value stored in param2 is multiplied by two to
946 get the actual rotation in degrees of the node.
947 paramtype2 == "meshoptions"
948 ^ Only valid for "plantlike". The value of param2 becomes a bitfield which
949 can be used to change how the client draws plantlike nodes.
950 Bits 0, 1 and 2 form a mesh selector.
951 Currently the following meshes are choosable:
952 0 = a "x" shaped plant (ordinary plant)
953 1 = a "+" shaped plant (just rotated 45 degrees)
954 2 = a "*" shaped plant with 3 faces instead of 2
955 3 = a "#" shaped plant with 4 faces instead of 2
956 4 = a "#" shaped plant with 4 faces that lean outwards
957 5-7 are unused and reserved for future meshes.
958 Bits 3 through 7 are optional flags that can be combined and give these
960 bit 3 (0x08) - Makes the plant slightly vary placement horizontally
961 bit 4 (0x10) - Makes the plant mesh 1.4x larger
962 bit 5 (0x20) - Moves each face randomly a small bit down (1/8 max)
963 bits 6-7 are reserved for future use.
964 paramtype2 == "color"
965 ^ `param2` tells which color is picked from the palette.
966 The palette should have 256 pixels.
967 paramtype2 == "colorfacedir"
968 ^ Same as `facedir`, but with colors.
969 The first three bits of `param2` tells which color
970 is picked from the palette.
971 The palette should have 8 pixels.
972 paramtype2 == "colorwallmounted"
973 ^ Same as `wallmounted`, but with colors.
974 The first five bits of `param2` tells which color
975 is picked from the palette.
976 The palette should have 32 pixels.
977 paramtype2 == "glasslikeliquidlevel"
978 ^ Only valid for "glasslike_framed" or "glasslike_framed_optional"
980 param2 values 0-63 define 64 levels of internal liquid, 0 being empty and
982 Liquid texture is defined using `special_tiles = {"modname_tilename.png"},`
984 Nodes can also contain extra data. See "Node Metadata".
988 There are a bunch of different looking node types.
990 Look for examples in `games/minimal` or `games/minetest_game`.
995 * Invisible, uses no texture.
997 * The cubic source node for a liquid.
999 * The flowing version of a liquid, appears with various heights and slopes.
1001 * Often used for partially-transparent nodes.
1002 * Only external sides of textures are visible.
1003 * `glasslike_framed`
1004 * All face-connected nodes are drawn as one volume within a surrounding
1006 * The frame appearence is generated from the edges of the first texture
1007 specified in `tiles`. The width of the edges used are 1/16th of texture
1008 size: 1 pixel for 16x16, 2 pixels for 32x32 etc.
1009 * The glass 'shine' (or other desired detail) on each node face is supplied
1010 by the second texture specified in `tiles`.
1011 * `glasslike_framed_optional`
1012 * This switches between the above 2 drawtypes according to the menu setting
1015 * Often used for partially-transparent nodes.
1016 * External and internal sides of textures are visible.
1017 * `allfaces_optional`
1018 * Often used for leaves nodes.
1019 * This switches between `normal`, `glasslike` and `allfaces` according to
1020 the menu setting: Opaque Leaves / Simple Leaves / Fancy Leaves.
1021 * With 'Simple Leaves' selected, the texture specified in `special_tiles`
1022 is used instead, if present. This allows a visually thicker texture to be
1023 used to compensate for how `glasslike` reduces visual thickness.
1025 * A single vertical texture.
1026 * If placed on top of a node, uses the first texture specified in `tiles`.
1027 * If placed against the underside of a node, uses the second texture
1028 specified in `tiles`.
1029 * If placed on the side of a node, uses the third texture specified in
1030 `tiles` and is perpendicular to that node.
1032 * A single texture parallel to, and mounted against, the top, underside or
1035 * Two vertical and diagonal textures at right-angles to each other.
1036 * See `paramtype2 == "meshoptions"` above for other options.
1038 * When above a flat surface, appears as 6 textures, the central 2 as
1039 `plantlike` plus 4 more surrounding those.
1040 * If not above a surface the central 2 do not appear, but the texture
1041 appears against the faces of surrounding nodes if they are present.
1043 * A 3D model suitable for a wooden fence.
1044 * One placed node appears as a single vertical post.
1045 * Adjacently-placed nodes cause horizontal bars to appear between them.
1047 * Often used for tracks for mining carts.
1048 * Requires 4 textures to be specified in `tiles`, in order: Straight,
1049 curved, t-junction, crossing.
1050 * Each placed node automatically switches to a suitable rotated texture
1051 determined by the adjacent `raillike` nodes, in order to create a
1052 continuous track network.
1053 * Becomes a sloping node if placed against stepped nodes.
1055 * Often used for stairs and slabs.
1056 * Allows defining nodes consisting of an arbitrary number of boxes.
1057 * See 'Node boxes' below for more information.
1059 * Uses models for nodes.
1060 * Tiles should hold model materials textures.
1061 * Only static meshes are implemented.
1062 * For supported model formats see Irrlicht engine documentation.
1063 * `plantlike_rooted`
1064 * Enables underwater `plantlike` without air bubbles around the nodes.
1065 * Consists of a base cube at the co-ordinates of the node plus a
1066 `plantlike` extension above with a height of `param2 / 16` nodes.
1067 * The `plantlike` extension visually passes through any nodes above the
1068 base cube without affecting them.
1069 * The base cube texture tiles are defined as normal, the `plantlike`
1070 extension uses the defined special tile, for example:
1071 `special_tiles = {{name = "default_papyrus.png", tileable_vertical = true}},`
1073 `*_optional` drawtypes need less rendering time if deactivated
1074 (always client-side).
1078 Node selection boxes are defined using "node boxes".
1080 A nodebox is defined as any of:
1083 -- A normal cube; the default in most things
1087 -- A fixed box (or boxes) (facedir param2 is used, if applicable)
1089 fixed = box OR {box1, box2, ...}
1092 -- A variable height box (or boxes) with the top face position defined
1093 -- by the node parameter 'leveled = ', or if 'paramtype2 == "leveled"'
1095 -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
1097 fixed = box OR {box1, box2, ...}
1100 -- A box like the selection box for torches
1101 -- (wallmounted param2 is used, if applicable)
1102 type = "wallmounted",
1108 -- A node that has optional boxes depending on neighbouring nodes'
1109 -- presence and type. See also `connects_to`.
1111 fixed = box OR {box1, box2, ...}
1112 connect_top = box OR {box1, box2, ...}
1113 connect_bottom = box OR {box1, box2, ...}
1114 connect_front = box OR {box1, box2, ...}
1115 connect_left = box OR {box1, box2, ...}
1116 connect_back = box OR {box1, box2, ...}
1117 connect_right = box OR {box1, box2, ...}
1118 -- The following `disconnected_*` boxes are the opposites of the
1119 -- `connect_*` ones above, i.e. when a node has no suitable neighbour
1120 -- on the respective side, the corresponding disconnected box is drawn.
1121 disconnected_top = box OR {box1, box2, ...}
1122 disconnected_bottom = box OR {box1, box2, ...}
1123 disconnected_front = box OR {box1, box2, ...}
1124 disconnected_left = box OR {box1, box2, ...}
1125 disconnected_back = box OR {box1, box2, ...}
1126 disconnected_right = box OR {box1, box2, ...}
1127 disconnected = box OR {box1, box2, ...} -- when there is *no* neighbour
1128 disconnected_sides = box OR {box1, box2, ...} -- when there are *no*
1129 neighbours to the sides
1132 A `box` is defined as:
1134 {x1, y1, z1, x2, y2, z2}
1136 A box of a regular node would look like:
1138 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
1142 Perlin noise creates a continuously-varying value depending on the input values.
1143 Usually in Minetest the input values are either 2D or 3D co-ordinates in nodes.
1144 The result is used during map generation to create the terrain shape, vary heat
1145 and humidity to distribute biomes, vary the density of decorations or vary the
1148 ### Structure of perlin noise
1149 An 'octave' is a simple noise generator that outputs a value between -1 and 1.
1150 The smooth wavy noise it generates has a single characteristic scale, almost
1151 like a 'wavelength', so on its own does not create fine detail.
1152 Due to this perlin noise combines several octaves to create variation on
1153 multiple scales. Each additional octave has a smaller 'wavelength' than the
1156 This combination results in noise varying very roughly between -2.0 and 2.0 and
1157 with an average value of 0.0, so `scale` and `offset` are then used to multiply
1158 and offset the noise variation.
1160 The final perlin noise variation is created as follows:
1162 noise = offset + scale * (octave1 +
1163 octave2 * persistence +
1164 octave3 * persistence ^ 2 +
1165 octave4 * persistence ^ 3 +
1170 Noise Parameters are commonly called `NoiseParams`.
1173 After the multiplication by `scale` this is added to the result and is the final
1174 step in creating the noise value.
1175 Can be positive or negative.
1178 Once all octaves have been combined, the result is multiplied by this.
1179 Can be positive or negative.
1182 For octave1, this is roughly the change of input value needed for a very large
1183 variation in the noise value generated by octave1. It is almost like a
1184 'wavelength' for the wavy noise variation.
1185 Each additional octave has a 'wavelength' that is smaller than the previous
1186 octave, to create finer detail. `spread` will therefore roughly be the typical
1187 size of the largest structures in the final noise variation.
1189 `spread` is a vector with values for x, y, z to allow the noise variation to be
1190 stretched or compressed in the desired axes.
1191 Values are positive numbers.
1194 This is a whole number that determines the entire pattern of the noise
1195 variation. Altering it enables different noise patterns to be created.
1196 With other parameters equal, different seeds produce different noise patterns
1197 and identical seeds produce identical noise patterns.
1199 For this parameter you can randomly choose any whole number. Usually it is
1200 preferable for this to be different from other seeds, but sometimes it is useful
1201 to be able to create identical noise patterns.
1203 When used in mapgen this is actually a 'seed offset', it is added to the
1204 'world seed' to create the seed used by the noise, to ensure the noise has a
1205 different pattern in different worlds.
1208 The number of simple noise generators that are combined.
1209 A whole number, 1 or more.
1210 Each additional octave adds finer detail to the noise but also increases the
1211 noise calculation load.
1212 3 is a typical minimum for a high quality, complex and natural-looking noise
1213 variation. 1 octave has a slight 'gridlike' appearence.
1215 Choose the number of octaves according to the `spread` and `lacunarity`, and the
1216 size of the finest detail you require. For example:
1217 if `spread` is 512 nodes, `lacunarity` is 2.0 and finest detail required is 16
1218 nodes, octaves will be 6 because the 'wavelengths' of the octaves will be
1219 512, 256, 128, 64, 32, 16 nodes.
1222 Each additional octave has an amplitude that is the amplitude of the previous
1223 octave multiplied by `persistence`, to reduce the amplitude of finer details,
1224 as is often helpful and natural to do so.
1225 Since this controls the balance of fine detail to large-scale detail
1226 `persistence` can be thought of as the 'roughness' of the noise.
1228 A positive or negative non-zero number, often between 0.3 and 1.0.
1229 A common medium value is 0.5, such that each octave has half the amplitude of
1230 the previous octave.
1231 This may need to be tuned when altering `lacunarity`; when doing so consider
1232 that a common medium value is 1 / lacunarity.
1235 Each additional octave has a 'wavelength' that is the 'wavelength' of the
1236 previous octave multiplied by 1 / lacunarity, to create finer detail.
1237 'lacunarity' is often 2.0 so 'wavelength' often halves per octave.
1239 A positive number no smaller than 1.0.
1240 Values below 2.0 create higher quality noise at the expense of requiring more
1241 octaves to cover a paticular range of 'wavelengths'.
1244 Leave this field unset for no special handling.
1245 Currently supported are `defaults`, `eased` and `absvalue`:
1248 Specify this if you would like to keep auto-selection of eased/not-eased while
1249 specifying some other flags.
1252 Maps noise gradient values onto a quintic S-curve before performing
1253 interpolation. This results in smooth, rolling noise.
1254 Disable this (`noeased`) for sharp-looking noise with a slightly gridded
1256 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is
1258 Easing a 3D noise significantly increases the noise calculation load, so use
1262 The absolute value of each octave's noise variation is used when combining the
1263 octaves. The final perlin noise variation is created as follows:
1265 noise = offset + scale * (abs(octave1) +
1266 abs(octave2) * persistence +
1267 abs(octave3) * persistence ^ 2 +
1268 abs(octave4) * persistence ^ 3 +
1272 For 2D or 3D perlin noise or perlin noise maps:
1277 spread = {x = 500, y = 500, z = 500},
1282 flags = "defaults, absvalue",
1285 For 2D noise the Z component of `spread` is still defined but is ignored.
1286 A single noise parameter table can be used for 2D or 3D noise.
1290 These tell in what manner the ore is generated.
1292 All default ores are of the uniformly-distributed scatter type.
1295 Randomly chooses a location and generates a cluster of ore.
1297 If `noise_params` is specified, the ore will be placed if the 3D perlin noise
1298 at that point is greater than the `noise_threshold`, giving the ability to
1299 create a non-equal distribution of ore.
1302 Creates a sheet of ore in a blob shape according to the 2D perlin noise
1303 described by `noise_params` and `noise_threshold`. This is essentially an
1304 improved version of the so-called "stratus" ore seen in some unofficial mods.
1306 This sheet consists of vertical columns of uniform randomly distributed height,
1307 varying between the inclusive range `column_height_min` and `column_height_max`.
1308 If `column_height_min` is not specified, this parameter defaults to 1.
1309 If `column_height_max` is not specified, this parameter defaults to `clust_size`
1310 for reverse compatibility. New code should prefer `column_height_max`.
1312 The `column_midpoint_factor` parameter controls the position of the column at
1313 which ore emanates from.
1314 If 1, columns grow upward. If 0, columns grow downward. If 0.5, columns grow
1315 equally starting from each direction.
1316 `column_midpoint_factor` is a decimal number ranging in value from 0 to 1. If
1317 this parameter is not specified, the default is 0.5.
1319 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this
1323 Creates a sheet of ore in a cloud-like puff shape.
1325 As with the `sheet` ore type, the size and shape of puffs are described by
1326 `noise_params` and `noise_threshold` and are placed at random vertical
1327 positions within the currently generated chunk.
1329 The vertical top and bottom displacement of each puff are determined by the
1330 noise parameters `np_puff_top` and `np_puff_bottom`, respectively.
1333 Creates a deformed sphere of ore according to 3d perlin noise described by
1334 `noise_params`. The maximum size of the blob is `clust_size`, and
1335 `clust_scarcity` has the same meaning as with the `scatter` type.
1338 Creates veins of ore varying in density by according to the intersection of two
1339 instances of 3d perlin noise with different seeds, both described by
1342 `random_factor` varies the influence random chance has on placement of an ore
1343 inside the vein, which is `1` by default. Note that modifying this parameter
1344 may require adjusting `noise_threshold`.
1346 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
1349 This ore type is difficult to control since it is sensitive to small changes.
1350 The following is a decent set of parameters to work from:
1355 spread = {x=200, y=200, z=200},
1362 noise_threshold = 1.6
1364 **WARNING**: Use this ore type *very* sparingly since it is ~200x more
1365 computationally expensive than any other ore.
1368 Creates a single undulating ore stratum that is continuous across mapchunk
1369 borders and horizontally spans the world.
1371 The 2D perlin noise described by `noise_params` defines the Y co-ordinate of
1372 the stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
1373 defines the stratum's vertical thickness (in units of nodes). Due to being
1374 continuous across mapchunk borders the stratum's vertical thickness is
1377 If the noise parameter `noise_params` is omitted the ore will occur from y_min
1378 to y_max in a simple horizontal stratum.
1380 A parameter `stratum_thickness` can be provided instead of the noise parameter
1381 `np_stratum_thickness`, to create a constant thickness.
1383 Leaving out one or both noise parameters makes the ore generation less
1384 intensive, useful when adding multiple strata.
1386 `y_min` and `y_max` define the limits of the ore generation and for performance
1387 reasons should be set as close together as possible but without clipping the
1388 stratum's Y variation.
1390 Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
1391 solid-ore stratum would require a `clust_scarcity` of 1.
1393 The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
1394 `random_factor` are ignored by this ore type.
1398 See section "Flag Specifier Format".
1400 Currently supported flags:
1401 `puff_cliffs`, `puff_additive_composition`.
1404 If set, puff ore generation will not taper down large differences in
1405 displacement when approaching the edge of a puff. This flag has no effect for
1406 ore types other than `puff`.
1408 ### `puff_additive_composition`
1409 By default, when noise described by `np_puff_top` or `np_puff_bottom` results
1410 in a negative displacement, the sub-column at that point is not generated. With
1411 this attribute set, puff ore generation will instead generate the absolute
1412 difference in noise displacement values. This flag has no effect for ore types
1417 The varying types of decorations that can be placed.
1420 Creates a 1 times `H` times 1 column of a specified node (or a random node from
1421 a list, if a decoration list is specified). Can specify a certain node it must
1422 spawn next to, such as water or lava, for example. Can also generate a
1423 decoration of random height between a specified lower and upper bound.
1424 This type of decoration is intended for placement of grass, flowers, cacti,
1425 papyri, waterlilies and so on.
1428 Copies a box of `MapNodes` from a specified schematic file (or raw description).
1429 Can specify a probability of a node randomly appearing when placed.
1430 This decoration type is intended to be used for multi-node sized discrete
1431 structures, such as trees, cave spikes, rocks, and so on.
1435 --------------------
1436 A schematic specifier identifies a schematic by either a filename to a
1437 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
1438 in the form of a table. This table specifies the following fields:
1440 * The `size` field is a 3D vector containing the dimensions of the provided
1441 schematic. (required)
1442 * The `yslice_prob` field is a table of {ypos, prob} which sets the `ypos`th
1443 vertical slice of the schematic to have a `prob / 256 * 100` chance of
1444 occurring. (default: 255)
1445 * The `data` field is a flat table of MapNode tables making up the schematic,
1446 in the order of `[z [y [x]]]`. (required)
1447 Each MapNode table contains:
1448 * `name`: the name of the map node to place (required)
1449 * `prob` (alias `param1`): the probability of this node being placed
1451 * `param2`: the raw param2 value of the node being placed onto the map
1453 * `force_place`: boolean representing if the node should forcibly overwrite
1454 any previous contents (default: false)
1456 About probability values:
1458 * A probability value of `0` or `1` means that node will never appear
1460 * A probability value of `254` or `255` means the node will always appear
1462 * If the probability value `p` is greater than `1`, then there is a
1463 `(p / 256 * 100)` percent chance that node will appear when the schematic is
1467 Schematic attributes
1468 --------------------
1469 See section "Flag Specifier Format".
1471 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
1474 * `place_center_x`: Placement of this decoration is centered along the X axis.
1475 * `place_center_y`: Placement of this decoration is centered along the Y axis.
1476 * `place_center_z`: Placement of this decoration is centered along the Z axis.
1477 * `force_placement`: Schematic nodes other than "ignore" will replace existing
1483 The position field is used for all element types.
1485 To account for differing resolutions, the position coordinates are the
1486 percentage of the screen, ranging in value from `0` to `1`.
1488 The name field is not yet used, but should contain a description of what the
1489 HUD element represents. The direction field is the direction in which something
1492 `0` draws from left to right, `1` draws from right to left, `2` draws from
1493 top to bottom, and `3` draws from bottom to top.
1495 The `alignment` field specifies how the item will be aligned. It ranges from
1496 `-1` to `1`, with `0` being the center. `-1` is moved to the left/up, and `1`
1497 is to the right/down. Fractional values can be used.
1499 The `offset` field specifies a pixel offset from the position. Contrary to
1500 position, the offset is not scaled to screen size. This allows for some
1501 precisely positioned items in the HUD.
1503 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
1506 Below are the specific uses for fields in each type; fields not listed for that
1509 **Note**: Future revisions to the HUD API may be incompatible; the HUD API is
1510 still in the experimental stages.
1513 Displays an image on the HUD.
1515 * `scale`: The scale of the image, with 1 being the original texture size.
1516 Only the X coordinate scale is used (positive values).
1517 Negative values represent that percentage of the screen it
1518 should take; e.g. `x=-100` means 100% (width).
1519 * `text`: The name of the texture that is displayed.
1520 * `alignment`: The alignment of the image.
1521 * `offset`: offset in pixels from position.
1524 Displays text on the HUD.
1526 * `scale`: Defines the bounding rectangle of the text.
1527 A value such as `{x=100, y=100}` should work.
1528 * `text`: The text to be displayed in the HUD element.
1529 * `number`: An integer containing the RGB value of the color used to draw the
1530 text. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1531 * `alignment`: The alignment of the text.
1532 * `offset`: offset in pixels from position.
1535 Displays a horizontal bar made up of half-images.
1537 * `text`: The name of the texture that is used.
1538 * `number`: The number of half-textures that are displayed.
1539 If odd, will end with a vertically center-split texture.
1541 * `offset`: offset in pixels from position.
1542 * `size`: If used, will force full-image size to this value (override texture
1546 * `text`: The name of the inventory list to be displayed.
1547 * `number`: Number of items in the inventory to be displayed.
1548 * `item`: Position of item that is selected.
1550 * `offset`: offset in pixels from position.
1553 Displays distance to selected world position.
1555 * `name`: The name of the waypoint.
1556 * `text`: Distance suffix. Can be blank.
1557 * `number:` An integer containing the RGB value of the color used to draw the
1559 * `world_pos`: World position of the waypoint.
1561 Representations of simple things
1562 --------------------------------
1566 {x=num, y=num, z=num}
1568 For helper functions see "Vector helpers".
1571 * `{type="nothing"}`
1572 * `{type="node", under=pos, above=pos}`
1573 * `{type="object", ref=ObjectRef}`
1575 Flag Specifier Format
1576 ---------------------
1577 Flags using the standardized flag specifier format can be specified in either
1578 of two ways, by string or table.
1580 The string format is a comma-delimited set of flag names; whitespace and
1581 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1582 flag, and specifying a flag prefixed by the string `"no"` explicitly
1583 clears the flag from whatever the default may be.
1585 In addition to the standard string flag format, the schematic flags field can
1586 also be a table of flag names to boolean values representing whether or not the
1587 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1588 is present, mapped to a boolean of any value, the specified flag is unset.
1590 E.g. A flag field of value
1592 {place_center_x = true, place_center_y=false, place_center_z=true}
1596 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1598 which is equivalent to
1600 "place_center_x, noplace_center_y, place_center_z"
1604 "place_center_x, place_center_z"
1606 since, by default, no schematic attributes are set.
1612 There are three kinds of items: nodes, tools and craftitems.
1614 * Node (`register_node`): A node from the world.
1615 * Tool (`register_tool`): A tool/weapon that can dig and damage
1616 things according to `tool_capabilities`.
1617 * Craftitem (`register_craftitem`): A miscellaneous item.
1620 All item stacks have an amount between 0 to 65535. It is 1 by
1621 default. Tool item stacks can not have an amount greater than 1.
1623 Tools use a wear (=damage) value ranging from 0 to 65535. The
1624 value 0 is the default and used is for unworn tools. The values
1625 1 to 65535 are used for worn tools, where a higher value stands for
1626 a higher wear. Non-tools always have a wear value of 0.
1629 Items and item stacks can exist in three formats: Serializes, table format
1633 This is called "stackstring" or "itemstring". It is a simple string with
1634 1-3 components: the full item identifier, an optional amount and an optional
1637 <identifier> [<amount>[ <wear>]]
1641 * `'default:apple'`: 1 apple
1642 * `'default:dirt 5'`: 5 dirt
1643 * `'default:pick_stone'`: a new stone pickaxe
1644 * `'default:pick_wood 1 21323'`: a wooden pickaxe, ca. 1/3 worn out
1651 {name="default:dirt", count=5, wear=0, metadata=""}
1653 A wooden pick about 1/3 worn out:
1655 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1659 {name="default:apple", count=1, wear=0, metadata=""}
1662 A native C++ format with many helper methods. Useful for converting
1663 between formats. See the Class reference section for details.
1665 When an item must be passed to a function, it can usually be in any of
1671 In a number of places, there is a group table. Groups define the
1672 properties of a thing (item, node, armor of entity, capabilities of
1673 tool) in such a way that the engine and other mods can can interact with
1674 the thing without actually knowing what the thing is.
1677 Groups are stored in a table, having the group names with keys and the
1678 group ratings as values. For example:
1680 groups = {crumbly=3, soil=1}
1683 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1684 -- ^ A more special dirt-kind of thing
1686 Groups always have a rating associated with them. If there is no
1687 useful meaning for a rating for an enabled group, it shall be `1`.
1689 When not defined, the rating of a group defaults to `0`. Thus when you
1690 read groups, you must interpret `nil` and `0` as the same value, `0`.
1692 You can read the rating of a group for an item or a node by using
1694 minetest.get_item_group(itemname, groupname)
1697 Groups of items can define what kind of an item it is (e.g. wool).
1700 In addition to the general item things, groups are used to define whether
1701 a node is destroyable and how long it takes to destroy by a tool.
1703 ### Groups of entities
1704 For entities, groups are, as of now, used only for calculating damage.
1705 The rating is the percentage of damage caused by tools with this damage group.
1706 See "Entity damage mechanism".
1708 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1709 object.set_armor_groups({fleshy=30, cracky=80})
1712 Groups in tools define which groups of nodes and entities they are
1715 ### Groups in crafting recipes
1716 An example: Make meat soup from any meat, any water and any bowl:
1719 output = 'food:meat_soup_raw',
1725 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1728 Another example: Make red wool from white wool and red dye:
1732 output = 'wool:red',
1733 recipe = {'wool:white', 'group:dye,basecolor_red'},
1737 * `immortal`: Disables the group damage system for an entity
1738 * `punch_operable`: For entities; disables the regular damage mechanism for
1739 players punching it by hand or a non-tool item, so that it can do something
1740 else than take damage.
1741 * `level`: Can be used to give an additional sense of progression in the game.
1742 * A larger level will cause e.g. a weapon of a lower level make much less
1743 damage, and get worn out much faster, or not be able to get drops
1744 from destroyed nodes.
1745 * `0` is something that is directly accessible at the start of gameplay
1746 * There is no upper limit
1747 * `dig_immediate`: (player can always pick up node without reducing tool wear)
1748 * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
1749 * `3`: the node always gets the digging time 0 seconds (torch)
1750 * `disable_jump`: Player (and possibly other things) cannot jump from node
1751 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1752 * `bouncy`: value is bounce speed in percent
1753 * `falling_node`: if there is no walkable block under the node it will fall
1754 * `attached_node`: if the node under it is not a walkable block the node will be
1755 dropped as an item. If the node is wallmounted the wallmounted direction is
1757 * `soil`: saplings will grow on nodes in this group
1758 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1759 connect to each other
1760 * `slippery`: Players and items will slide on the node.
1761 Slipperiness rises steadily with `slippery` value, starting at 1.
1764 ### Known damage and digging time defining groups
1765 * `crumbly`: dirt, sand
1766 * `cracky`: tough but crackable stuff like stone.
1767 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1768 plants, wire, sheets of metal
1769 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1770 * `fleshy`: Living things like animals and the player. This could imply
1771 some blood effects when hitting.
1772 * `explody`: Especially prone to explosions
1773 * `oddly_breakable_by_hand`:
1774 Can be added to nodes that shouldn't logically be breakable by the
1775 hand but are. Somewhat similar to `dig_immediate`, but times are more
1776 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1777 speed of a tool if the tool can dig at a faster speed than this
1778 suggests for the hand.
1780 ### Examples of custom groups
1781 Item groups are often used for defining, well, _groups of items_.
1783 * `meat`: any meat-kind of a thing (rating might define the size or healing
1784 ability or be irrelevant -- it is not defined as of yet)
1785 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1787 * `flammable`: can be set on fire. Rating might define the intensity of the
1788 fire, affecting e.g. the speed of the spreading of an open fire.
1789 * `wool`: any wool (any origin, any color)
1790 * `metal`: any metal
1791 * `weapon`: any weapon
1792 * `heavy`: anything considerably heavy
1794 ### Digging time calculation specifics
1795 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1796 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1797 faster digging time.
1799 The `level` group is used to limit the toughness of nodes a tool can dig
1800 and to scale the digging times / damage to a greater extent.
1802 **Please do understand this**, otherwise you cannot use the system to it's
1805 Tools define their properties by a list of parameters for groups. They
1806 cannot dig other groups; thus it is important to use a standard bunch of
1807 groups to enable interaction with tools.
1809 #### Tools definition
1812 * Full punch interval
1813 * Maximum drop level
1814 * For an arbitrary list of groups:
1815 * Uses (until the tool breaks)
1816 * Maximum level (usually `0`, `1`, `2` or `3`)
1820 #### Full punch interval
1821 When used as a weapon, the tool will do full damage if this time is spent
1822 between punches. If e.g. half the time is spent, the tool will do half
1825 #### Maximum drop level
1826 Suggests the maximum level of node, when dug with the tool, that will drop
1827 it's useful item. (e.g. iron ore to drop a lump of iron).
1829 This is not automated; it is the responsibility of the node definition
1833 Determines how many uses the tool has when it is used for digging a node,
1834 of this group, of the maximum level. For lower leveled nodes, the use count
1835 is multiplied by `3^leveldiff`.
1837 * `uses=10, leveldiff=0`: actual uses: 10
1838 * `uses=10, leveldiff=1`: actual uses: 30
1839 * `uses=10, leveldiff=2`: actual uses: 90
1842 Tells what is the maximum level of a node of this group that the tool will
1846 List of digging times for different ratings of the group, for nodes of the
1849 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1850 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1851 for this group, and unable to dig the rating `1`, which is the toughest.
1852 Unless there is a matching group that enables digging otherwise.
1854 If the result digging time is 0, a delay of 0.15 seconds is added between
1855 digging nodes; If the player releases LMB after digging, this delay is set to 0,
1856 i.e. players can more quickly click the nodes away instead of holding LMB.
1859 List of damage for groups of entities. See "Entity damage mechanism".
1861 #### Example definition of the capabilities of a tool
1863 tool_capabilities = {
1864 full_punch_interval=1.5,
1867 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1869 damage_groups = {fleshy=2},
1872 This makes the tool be able to dig nodes that fulfil both of these:
1874 * Have the `crumbly` group
1875 * Have a `level` group less or equal to `2`
1877 Table of resulting digging times:
1879 crumbly 0 1 2 3 4 <- level
1881 1 0.80 1.60 1.60 - -
1882 2 0.60 1.20 1.20 - -
1883 3 0.40 0.80 0.80 - -
1885 level diff: 2 1 0 -1 -2
1887 Table of resulting tool uses:
1896 * At `crumbly==0`, the node is not diggable.
1897 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1898 easy nodes to be quickly breakable.
1899 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1901 Entity damage mechanism
1902 -----------------------
1906 foreach group in cap.damage_groups:
1907 damage += cap.damage_groups[group] * limit(actual_interval /
1908 cap.full_punch_interval, 0.0, 1.0)
1909 * (object.armor_groups[group] / 100.0)
1910 -- Where object.armor_groups[group] is 0 for inexistent values
1913 Client predicts damage based on damage groups. Because of this, it is able to
1914 give an immediate response when an entity is damaged or dies; the response is
1915 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1917 Currently a smoke puff will appear when an entity dies.
1919 The group `immortal` completely disables normal damage.
1921 Entities can define a special armor group, which is `punch_operable`. This
1922 group disables the regular damage mechanism for players punching it by hand or
1923 a non-tool item, so that it can do something else than take damage.
1925 On the Lua side, every punch calls:
1927 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction, damage)
1929 This should never be called directly, because damage is usually not handled by
1932 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1933 accessed unless absolutely required, to encourage interoperability.
1934 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1935 * `tool_capabilities` can be `nil`.
1936 * `direction` is a unit vector, pointing from the source of the punch to
1938 * `damage` damage that will be done to entity
1939 Return value of this function will determine if damage is done by this function
1940 (retval true) or shall be done by engine (retval false)
1942 To punch an entity/object in Lua, call:
1944 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1946 * Return value is tool wear.
1947 * Parameters are equal to the above callback.
1948 * If `direction` equals `nil` and `puncher` does not equal `nil`, `direction`
1949 will be automatically filled in based on the location of `puncher`.
1953 The instance of a node in the world normally only contains the three values
1954 mentioned in "Nodes". However, it is possible to insert extra data into a
1955 node. It is called "node metadata"; See `NodeMetaRef`.
1957 Node metadata contains two things:
1962 Some of the values in the key-value store are handled specially:
1964 * `formspec`: Defines a right-click inventory menu. See "Formspec".
1965 * `infotext`: Text shown on the screen when the node is pointed at
1969 local meta = minetest.get_meta(pos)
1970 meta:set_string("formspec",
1972 "list[context;main;0,0;8,4;]"..
1973 "list[current_player;main;0,5;8,4;]")
1974 meta:set_string("infotext", "Chest");
1975 local inv = meta:get_inventory()
1976 inv:set_size("main", 8*4)
1977 print(dump(meta:to_table()))
1980 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1981 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1982 [10] = "", [11] = "", [12] = "", [13] = "",
1983 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1984 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1985 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1986 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1990 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1997 Item stacks can store metadata too. See `ItemStackMetaRef`.
1999 Item metadata only contains a key-value store.
2001 Some of the values in the key-value store are handled specially:
2003 * `description`: Set the item stack's description. Defaults to
2005 * `color`: A `ColorString`, which sets the stack's color.
2006 * `palette_index`: If the item has a palette, this is used to get the
2007 current color from the palette.
2011 local meta = stack:get_meta()
2012 meta:set_string("key", "value")
2013 print(dump(meta:to_table()))
2017 Formspec defines a menu. Currently not much else than inventories are
2018 supported. It is a string, with a somewhat strange format.
2020 Spaces and newlines can be inserted between the blocks, as is used in the
2023 WARNING: Minetest allows you to add elements to every single formspec instance
2024 using player:set_formspec_prepend(), which may be the reason backgrounds are
2025 appearing when you don't expect them to. See `no_prepend[]`
2032 list[context;main;0,0;8,4;]
2033 list[current_player;main;0,5;8,4;]
2038 list[context;fuel;2,3;1,1;]
2039 list[context;src;2,1;1,1;]
2040 list[context;dst;5,1;2,2;]
2041 list[current_player;main;0,5;8,4;]
2043 #### Minecraft-like player inventory
2046 image[1,0.6;1,2;player.png]
2047 list[current_player;main;0,3.5;8,4;]
2048 list[current_player;craft;3,0;3,3;]
2049 list[current_player;craftpreview;7,1;1,1;]
2053 #### `size[<W>,<H>,<fixed_size>]`
2054 * Define the size of the menu in inventory slots
2055 * `fixed_size`: `true`/`false` (optional)
2056 * deprecated: `invsize[<W>,<H>;]`
2058 #### `position[<X>,<Y>]`
2059 * Must be used after `size` element.
2060 * Defines the position on the game window of the formspec's `anchor` point.
2061 * For X and Y, 0.0 and 1.0 represent opposite edges of the game window,
2063 * [0.0, 0.0] sets the position to the top left corner of the game window.
2064 * [1.0, 1.0] sets the position to the bottom right of the game window.
2065 * Defaults to the center of the game window [0.5, 0.5].
2067 #### `anchor[<X>,<Y>]`
2068 * Must be used after both `size` and `position` (if present) elements.
2069 * Defines the location of the anchor point within the formspec.
2070 * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec,
2072 * [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
2073 * [1.0, 0.0] sets the anchor to the top right of the formspec.
2074 * Defaults to the center of the formspec [0.5, 0.5].
2076 * `position` and `anchor` elements need suitable values to avoid a formspec
2077 extending off the game window due to particular game window sizes.
2080 * Must be used after the `size`, `position`, and `anchor` elements (if present).
2081 * Disables player:set_formspec_prepend() from applying to this formspec.
2083 #### `container[<X>,<Y>]`
2084 * Start of a container block, moves all physical elements in the container by
2086 * Must have matching `container_end`
2087 * Containers can be nested, in which case the offsets are added
2088 (child containers are relative to parent containers)
2090 #### `container_end[]`
2091 * End of a container, following elements are no longer relative to this
2094 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
2095 * Show an inventory list
2097 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
2098 * Show an inventory list
2100 #### `listring[<inventory location>;<list name>]`
2101 * Allows to create a ring of inventory lists
2102 * Shift-clicking on items in one element of the ring
2103 will send them to the next inventory list inside the ring
2104 * The first occurrence of an element inside the ring will
2105 determine the inventory where items will be sent to
2108 * Shorthand for doing `listring[<inventory location>;<list name>]`
2109 for the last two inventory lists added by list[...]
2111 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
2112 * Sets background color of slots as `ColorString`
2113 * Sets background color of slots on mouse hovering
2115 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
2116 * Sets background color of slots as `ColorString`
2117 * Sets background color of slots on mouse hovering
2118 * Sets color of slots border
2120 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
2121 * Sets background color of slots as `ColorString`
2122 * Sets background color of slots on mouse hovering
2123 * Sets color of slots border
2124 * Sets default background color of tooltips
2125 * Sets default font color of tooltips
2127 #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2128 * Adds tooltip for an element
2129 * `<bgcolor>` tooltip background color as `ColorString` (optional)
2130 * `<fontcolor>` tooltip font color as `ColorString` (optional)
2132 #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
2134 * Position and size units are inventory slots
2136 #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
2137 * Show an inventory image of registered item/node
2138 * Position and size units are inventory slots
2140 #### `bgcolor[<color>;<fullscreen>]`
2141 * Sets background color of formspec as `ColorString`
2142 * If `true`, the background color is drawn fullscreen (does not effect the size
2145 #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
2146 * Use a background. Inventory rectangles are not drawn then.
2147 * Position and size units are inventory slots
2148 * Example for formspec 8x4 in 16x resolution: image shall be sized
2149 8 times 16px times 4 times 16px.
2151 #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
2152 * Use a background. Inventory rectangles are not drawn then.
2153 * Position and size units are inventory slots
2154 * Example for formspec 8x4 in 16x resolution:
2155 image shall be sized 8 times 16px times 4 times 16px
2156 * If `true` the background is clipped to formspec size
2157 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2159 #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
2160 * Textual password style field; will be sent to server when a button is clicked
2161 * When enter is pressed in field, fields.key_enter_field will be sent with the
2163 * `x` and `y` position the field relative to the top left of the menu
2164 * `w` and `h` are the size of the field
2165 * Fields are a set height, but will be vertically centred on `h`
2166 * Position and size units are inventory slots
2167 * `name` is the name of the field as returned in fields to `on_receive_fields`
2168 * `label`, if not blank, will be text printed on the top left above the field
2169 * See field_close_on_enter to stop enter closing the formspec
2171 #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2172 * Textual field; will be sent to server when a button is clicked
2173 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2174 the name of this field.
2175 * `x` and `y` position the field relative to the top left of the menu
2176 * `w` and `h` are the size of the field
2177 * Fields are a set height, but will be vertically centred on `h`
2178 * Position and size units are inventory slots
2179 * `name` is the name of the field as returned in fields to `on_receive_fields`
2180 * `label`, if not blank, will be text printed on the top left above the field
2181 * `default` is the default value of the field
2182 * `default` may contain variable references such as `${text}'` which
2183 will fill the value from the metadata value `text`
2184 * **Note**: no extra text or more than a single variable is supported ATM.
2185 * See `field_close_on_enter` to stop enter closing the formspec
2187 #### `field[<name>;<label>;<default>]`
2188 * As above, but without position/size units
2189 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2190 the name of this field.
2191 * Special field for creating simple forms, such as sign text input
2192 * Must be used without a `size[]` element
2193 * A "Proceed" button will be added automatically
2194 * See `field_close_on_enter` to stop enter closing the formspec
2196 #### `field_close_on_enter[<name>;<close_on_enter>]`
2197 * <name> is the name of the field
2198 * if <close_on_enter> is false, pressing enter in the field will submit the
2199 form but not close it.
2200 * defaults to true when not specified (ie: no tag for a field)
2202 #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2203 * Same as fields above, but with multi-line input
2204 * if the text overflows a vertical scrollbar is added
2205 * if the name is empty the textarea is readonly, the label is not displayed.
2207 #### `label[<X>,<Y>;<label>]`
2208 * `x` and `y` work as per field
2209 * `label` is the text on the label
2210 * Position and size units are inventory slots
2212 #### `vertlabel[<X>,<Y>;<label>]`
2213 * Textual label drawn vertically
2214 * `x` and `y` work as per field
2215 * `label` is the text on the label
2216 * Position and size units are inventory slots
2218 #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
2219 * Clickable button. When clicked, fields will be sent.
2220 * `x`, `y` and `name` work as per field
2221 * `w` and `h` are the size of the button
2222 * Fixed button height. It will be vertically centred on `h`
2223 * `label` is the text on the button
2224 * Position and size units are inventory slots
2226 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2227 * `x`, `y`, `w`, `h`, and `name` work as per button
2228 * `texture name` is the filename of an image
2229 * Position and size units are inventory slots
2231 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
2232 * `x`, `y`, `w`, `h`, and `name` work as per button
2233 * `texture name` is the filename of an image
2234 * Position and size units are inventory slots
2235 * `noclip=true` means the image button doesn't need to be within specified
2237 * `drawborder`: draw button border or not
2238 * `pressed texture name` is the filename of an image on pressed state
2240 #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
2241 * `x`, `y`, `w`, `h`, `name` and `label` work as per button
2242 * `item name` is the registered name of an item/node,
2243 tooltip will be made out of its description
2244 to override it use tooltip element
2245 * Position and size units are inventory slots
2247 #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
2248 * When clicked, fields will be sent and the form will quit.
2250 #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2251 * When clicked, fields will be sent and the form will quit.
2253 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
2254 * Scrollable item list showing arbitrary text elements
2255 * `x` and `y` position the itemlist relative to the top left of the menu
2256 * `w` and `h` are the size of the itemlist
2257 * `name` fieldname sent to server on doubleclick value is current selected
2259 * `listelements` can be prepended by #color in hexadecimal format RRGGBB
2261 * if you want a listelement to start with "#" write "##".
2263 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
2264 * Scrollable itemlist showing arbitrary text elements
2265 * `x` and `y` position the item list relative to the top left of the menu
2266 * `w` and `h` are the size of the item list
2267 * `name` fieldname sent to server on doubleclick value is current selected
2269 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
2270 * if you want a listelement to start with "#" write "##"
2271 * Index to be selected within textlist
2272 * `true`/`false`: draw transparent background
2273 * See also `minetest.explode_textlist_event`
2274 (main menu: `engine.explode_textlist_event`).
2276 #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2277 * Show a tab**header** at specific position (ignores formsize)
2278 * `x` and `y` position the itemlist relative to the top left of the menu
2279 * `name` fieldname data is transferred to Lua
2280 * `caption 1`...: name shown on top of tab
2281 * `current_tab`: index of selected tab 1...
2282 * `transparent` (optional): show transparent
2283 * `draw_border` (optional): draw border
2285 #### `box[<X>,<Y>;<W>,<H>;<color>]`
2286 * Simple colored semitransparent box
2287 * `x` and `y` position the box relative to the top left of the menu
2288 * `w` and `h` are the size of box
2289 * `color` is color specified as a `ColorString`
2291 #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
2292 * Show a dropdown field
2293 * **Important note**: There are two different operation modes:
2294 1. handle directly on change (only changed dropdown is submitted)
2295 2. read the value on pressing a button (all dropdown values are available)
2296 * `x` and `y` position of dropdown
2298 * Fieldname data is transferred to Lua
2299 * Items to be shown in dropdown
2300 * Index of currently selected dropdown item
2302 #### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
2304 * `x` and `y`: position of checkbox
2305 * `name` fieldname data is transferred to Lua
2306 * `label` to be shown left of checkbox
2307 * `selected` (optional): `true`/`false`
2309 #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
2311 * There are two ways to use it:
2312 1. handle the changed event (only changed scrollbar is available)
2313 2. read the value on pressing a button (all scrollbars are available)
2314 * `x` and `y`: position of trackbar
2315 * `w` and `h`: width and height
2316 * `orientation`: `vertical`/`horizontal`
2317 * Fieldname data is transferred to Lua
2318 * Value this trackbar is set to (`0`-`1000`)
2319 * See also `minetest.explode_scrollbar_event`
2320 (main menu: `engine.explode_scrollbar_event`).
2322 #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
2323 * Show scrollable table using options defined by the previous `tableoptions[]`
2324 * Displays cells as defined by the previous `tablecolumns[]`
2325 * `x` and `y`: position the itemlist relative to the top left of the menu
2326 * `w` and `h` are the size of the itemlist
2327 * `name`: fieldname sent to server on row select or doubleclick
2328 * `cell 1`...`cell n`: cell contents given in row-major order
2329 * `selected idx`: index of row to be selected within table (first row = `1`)
2330 * See also `minetest.explode_table_event`
2331 (main menu: `engine.explode_table_event`).
2333 #### `tableoptions[<opt 1>;<opt 2>;...]`
2334 * Sets options for `table[]`
2336 * default text color (`ColorString`), defaults to `#FFFFFF`
2337 * `background=#RRGGBB`
2338 * table background color (`ColorString`), defaults to `#000000`
2339 * `border=<true/false>`
2340 * should the table be drawn with a border? (default: `true`)
2341 * `highlight=#RRGGBB`
2342 * highlight background color (`ColorString`), defaults to `#466432`
2343 * `highlight_text=#RRGGBB`
2344 * highlight text color (`ColorString`), defaults to `#FFFFFF`
2345 * `opendepth=<value>`
2346 * all subtrees up to `depth < value` are open (default value = `0`)
2347 * only useful when there is a column of type "tree"
2349 #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
2350 * Sets columns for `table[]`
2351 * Types: `text`, `image`, `color`, `indent`, `tree`
2352 * `text`: show cell contents as text
2353 * `image`: cell contents are an image index, use column options to define
2355 * `color`: cell contents are a ColorString and define color of following
2357 * `indent`: cell contents are a number and define indentation of following
2359 * `tree`: same as indent, but user can open and close subtrees
2363 * for `text` and `image`: content alignment within cells.
2364 Available values: `left` (default), `center`, `right`, `inline`
2366 * for `text` and `image`: minimum width in em (default: `0`)
2367 * for `indent` and `tree`: indent width in em (default: `1.5`)
2368 * `padding=<value>`: padding left of the column, in em (default `0.5`).
2369 Exception: defaults to 0 for indent columns
2370 * `tooltip=<value>`: tooltip text (default: empty)
2371 * `image` column options:
2372 * `0=<value>` sets image for image index 0
2373 * `1=<value>` sets image for image index 1
2374 * `2=<value>` sets image for image index 2
2375 * and so on; defined indices need not be contiguous empty or
2376 non-numeric cells are treated as `0`.
2377 * `color` column options:
2378 * `span=<value>`: number of following columns to affect
2379 (default: infinite).
2381 **Note**: do _not_ use a element name starting with `key_`; those names are
2382 reserved to pass key press events to formspec!
2386 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
2387 * `"current_player"`: Player to whom the menu is shown
2388 * `"player:<name>"`: Any player
2389 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
2390 * `"detached:<name>"`: A detached inventory
2392 Player Inventory lists
2393 ----------------------
2394 * `main`: list containing the default inventory
2395 * `craft`: list containing the craft input
2396 * `craftpreview`: list containing the craft output
2397 * `hand`: list containing an override for the empty hand
2401 `#RGB` defines a color in hexadecimal format.
2403 `#RGBA` defines a color in hexadecimal format and alpha channel.
2405 `#RRGGBB` defines a color in hexadecimal format.
2407 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
2409 Named colors are also supported and are equivalent to
2410 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
2411 To specify the value of the alpha channel, append `#AA` to the end of the color
2412 name (e.g. `colorname#08`). For named colors the hexadecimal string
2413 representing the alpha value must (always) be two hexadecimal digits.
2417 A ColorSpec specifies a 32-bit color. It can be written in either:
2418 table form, each element ranging from 0..255 (a, if absent, defaults to 255):
2419 `colorspec = {a=255, r=0, g=255, b=0}`
2420 numerical form, the raw integer value of an ARGB8 quad:
2421 `colorspec = 0xFF00FF00`
2422 or string form, a ColorString (defined above):
2423 `colorspec = "green"`
2427 Most text can contain escape sequences, that can for example color the text.
2428 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
2429 The following functions provide escape sequences:
2431 * `minetest.get_color_escape_sequence(color)`:
2432 * `color` is a ColorString
2433 * The escape sequence sets the text color to `color`
2434 * `minetest.colorize(color, message)`:
2436 `minetest.get_color_escape_sequence(color) ..
2438 minetest.get_color_escape_sequence("#ffffff")`
2439 * `minetest.get_background_escape_sequence(color)`
2440 * `color` is a ColorString
2441 * The escape sequence sets the background of the whole text element to
2442 `color`. Only defined for item descriptions and tooltips.
2443 * `minetest.strip_foreground_colors(str)`
2444 * Removes foreground colors added by `get_color_escape_sequence`.
2445 * `minetest.strip_background_colors(str)`
2446 * Removes background colors added by `get_background_escape_sequence`.
2447 * `minetest.strip_colors(str)`
2448 * Removes all color escape sequences.
2452 For the following functions, `v`, `v1`, `v2` are vectors,
2453 `p1`, `p2` are positions:
2455 * `vector.new(a[, b, c])`:
2457 * A copy of `a` if `a` is a vector.
2458 * `{x = a, y = b, z = c}`, if all of `a`, `b`, `c` are defined numbers.
2459 * `vector.direction(p1, p2)`:
2460 * Returns a vector of length 1 with direction `p1` to `p2`.
2461 * If `p1` and `p2` are identical, returns `{x = 0, y = 0, z = 0}`.
2462 * `vector.distance(p1, p2)`:
2463 * Returns zero or a positive number, the distance between `p1` and `p2`.
2464 * `vector.length(v)`:
2465 * Returns zero or a positive number, the length of vector `v`.
2466 * `vector.normalize(v)`:
2467 * Returns a vector of length 1 with direction of vector `v`.
2468 * If `v` has zero length, returns `{x = 0, y = 0, z = 0}`.
2469 * `vector.floor(v)`:
2470 * Returns a vector, each dimension rounded down.
2471 * `vector.round(v)`:
2472 * Returns a vector, each dimension rounded to nearest integer.
2473 * `vector.apply(v, func)`:
2474 * Returns a vector where the function `func` has been applied to each
2476 * `vector.equals(v1, v2)`:
2477 * Returns a boolean, `true` if the vectors are identical.
2478 * `vector.sort(v1, v2)`:
2479 * Returns in order minp, maxp vectors of the cuboid defined by `v1`, `v2`.
2481 For the following functions `x` can be either a vector or a number:
2483 * `vector.add(v, x)`:
2485 * `vector.subtract(v, x)`:
2487 * `vector.multiply(v, x)`:
2488 * Returns a scaled vector or Schur product.
2489 * `vector.divide(v, x)`:
2490 * Returns a scaled vector or Schur quotient.
2494 * `dump2(obj, name, dumped)`: returns a string which makes `obj`
2495 human-readable, handles reference loops.
2496 * `obj`: arbitrary variable
2497 * `name`: string, default: `"_"`
2498 * `dumped`: table, default: `{}`
2499 * `dump(obj, dumped)`: returns a string which makes `obj` human-readable
2500 * `obj`: arbitrary variable
2501 * `dumped`: table, default: `{}`
2502 * `math.hypot(x, y)`
2503 * Get the hypotenuse of a triangle with legs x and y.
2504 Useful for distance calculation.
2505 * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
2506 * Get the sign of a number.
2507 * tolerance: number, default: `0.0`
2508 * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
2510 * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
2511 * `separator`: string, default: `","`
2512 * `include_empty`: boolean, default: `false`
2513 * `max_splits`: number, if it's positive, splits aren't limited,
2515 * `sep_is_pattern`: boolean, it specifies whether separator is a plain
2516 string or a pattern (regex), default: `false`
2517 * e.g. `"a,b":split","` returns `{"a","b"}`
2518 * `string:trim()`: returns the string without whitespace pre- and suffixes
2519 * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
2520 * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
2521 * Adds newlines to the string to keep it within the specified character
2523 * Note that the returned lines may be longer than the limit since it only
2524 splits at word borders.
2525 * `limit`: number, maximal amount of characters in one line
2526 * `as_table`: boolean, if set to true, a table of lines instead of a string
2527 is returned, default: `false`
2528 * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
2529 * `pos`: table {x=X, y=Y, z=Z}
2530 * Converts the position `pos` to a human-readable, printable string
2531 * `decimal_places`: number, if specified, the x, y and z values of
2532 the position are rounded to the given decimal place.
2533 * `minetest.string_to_pos(string)`: returns a position or `nil`
2534 * Same but in reverse.
2535 * If the string can't be parsed to a position, nothing is returned.
2536 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
2537 * Converts a string representing an area box into two positions
2538 * `minetest.formspec_escape(string)`: returns a string
2539 * escapes the characters "[", "]", "\", "," and ";", which can not be used
2541 * `minetest.is_yes(arg)`
2542 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
2543 * `minetest.get_us_time()`
2544 * returns time with microsecond precision. May not return wall time.
2545 * `table.copy(table)`: returns a table
2546 * returns a deep copy of `table`
2547 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
2549 * returns the exact position on the surface of a pointed node
2554 Texts can be translated client-side with the help of `minetest.translate` and
2557 ### Translating a string
2558 Two functions are provided to translate strings: `minetest.translate` and
2559 `minetest.get_translator`.
2561 * `minetest.get_translator(textdomain)` is a simple wrapper around
2562 `minetest.translate`, and `minetest.get_translator(textdomain)(str, ...)` is
2563 equivalent to `minetest.translate(textdomain, str, ...)`.
2564 It is intended to be used in the following way, so that it avoids verbose
2565 repetitions of `minetest.translate`:
2567 local S = minetest.get_translator(textdomain)
2570 As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
2572 * `minetest.translate(textdomain, str, ...)` translates the string `str` with
2573 the given `textdomain` for disambiguation. The textdomain must match the
2574 textdomain specified in the translation file in order to get the string
2575 translated. This can be used so that a string is translated differently in
2577 It is advised to use the name of the mod as textdomain whenever possible, to
2578 avoid clashes with other mods.
2579 This function must be given a number of arguments equal to the number of
2580 arguments the translated string expects.
2581 Arguments are literal strings -- they will not be translated, so if you want
2582 them to be, they need to come as outputs of `minetest.translate` as well.
2584 For instance, suppose we want to translate "@1 Wool" with "@1" being replaced
2585 by the translation of "Red". We can do the following:
2587 local S = minetest.get_translator()
2588 S("@1 Wool", S("Red"))
2590 This will be displayed as "Red Wool" on old clients and on clients that do
2591 not have localization enabled. However, if we have for instance a translation
2592 file named `wool.fr.tr` containing the following:
2597 this will be displayed as "Laine Rouge" on clients with a French locale.
2599 ### Operations on translated strings
2601 The output of `minetest.translate` is a string, with escape sequences adding
2602 additional information to that string so that it can be translated on the
2603 different clients. In particular, you can't expect operations like string.length
2604 to work on them like you would expect them to, or string.gsub to work in the
2605 expected manner. However, string concatenation will still work as expected
2606 (note that you should only use this for things like formspecs; do not translate
2607 sentences by breaking them into parts; arguments should be used instead), and
2608 operations such as `minetest.colorize` which are also concatenation.
2610 ### Translation file format
2611 A translation file has the suffix `.[lang].tr`, where `[lang]` is the language
2613 The file should be a text file, with the following format:
2615 * Lines beginning with `# textdomain:` (the space is significant) can be used
2616 to specify the text domain of all following translations in the file.
2617 * All other empty lines or lines beginning with `#` are ignored.
2618 * Other lines should be in the format `original=translated`. Both `original`
2619 and `translated` can contain escape sequences beginning with `@` to insert
2620 arguments, literal `@`, `=` or newline (See ### Escapes below).
2621 There must be no extraneous whitespace around the `=` or at the beginning or
2622 the end of the line.
2625 Strings that need to be translated can contain several escapes, preceded by `@`.
2627 * `@@` acts as a literal `@`.
2628 * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated
2629 string that will be inlined when translation. Due to how translations are
2630 implemented, the original translation string **must** have its arguments in
2631 increasing order, without gaps or repetitions, starting from 1.
2632 * `@=` acts as a literal `=`. It is not required in strings given to
2633 `minetest.translate`, but is in translation files to avoid being confused
2634 with the `=` separating the original from the translation.
2635 * `@\n` (where the `\n` is a literal newline) acts as a literal newline.
2636 As with `@=`, this escape is not required in strings given to
2637 `minetest.translate`, but is in translation files.
2638 * `@n` acts as a literal newline as well.
2640 `minetest` namespace reference
2641 ------------------------------
2645 * `minetest.get_current_modname()`: returns the currently loading mod's name,
2647 * `minetest.get_modpath(modname)`: returns e.g.
2648 `"/home/user/.minetest/usermods/modname"`.
2649 * Useful for loading additional `.lua` modules or static data from mod
2650 * `minetest.get_modnames()`: returns a list of installed mods
2651 * Return a list of installed mods, sorted alphabetically
2652 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
2653 * Useful for storing custom data
2654 * `minetest.is_singleplayer()`
2655 * `minetest.features`: Table containing API feature flags
2658 glasslike_framed = true,
2659 nodebox_as_selectionbox = true,
2660 chat_send_player_param3 = true,
2661 get_all_craft_recipes_works = true,
2662 use_texture_alpha = true,
2663 -- ^ The transparency channel of textures can optionally be used on nodes
2664 no_legacy_abms = true,
2665 -- ^ Tree and grass ABMs are no longer done from C++
2666 texture_names_parens = true,
2667 -- ^ Texture grouping is possible using parentheses
2668 area_store_custom_ids = true,
2669 -- ^ Unique Area ID for AreaStore:insert_area
2670 add_entity_with_staticdata = true,
2671 -- ^ add_entity supports passing initial staticdata to on_activate
2672 no_chat_message_prediction = true,
2673 -- ^ Chat messages are no longer predicted
2674 object_use_texture_alpha = true
2675 -- ^ The transparency channel of textures can optionally be used on
2676 -- objects (ie: players and lua entities)
2678 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
2679 * `arg`: string or table in format `{foo=true, bar=true}`
2680 * `missing_features`: `{foo=true, bar=true}`
2681 * `minetest.get_player_information(player_name)`:
2682 * Returns a table containing information about a player.
2683 Example return value:
2686 address = "127.0.0.1", -- IP address of client
2687 ip_version = 4, -- IPv4 / IPv6
2688 min_rtt = 0.01, -- minimum round trip time
2689 max_rtt = 0.2, -- maximum round trip time
2690 avg_rtt = 0.02, -- average round trip time
2691 min_jitter = 0.01, -- minimum packet time jitter
2692 max_jitter = 0.5, -- maximum packet time jitter
2693 avg_jitter = 0.03, -- average packet time jitter
2694 connection_uptime = 200, -- seconds since client connected
2695 protocol_version = 32, -- protocol version used by client
2696 -- following information is available on debug build only!!!
2697 -- DO NOT USE IN MODS
2698 --ser_vers = 26, -- serialization version used by client
2699 --major = 0, -- major version number
2700 --minor = 4, -- minor version number
2701 --patch = 10, -- patch version number
2702 --vers_string = "0.4.9-git", -- full version string
2703 --state = "Active" -- current client state
2705 * `minetest.mkdir(path)`: returns success.
2706 * Creates a directory specified by `path`, creating parent directories
2707 if they don't exist.
2708 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
2710 * nil: return all entries,
2711 * true: return only subdirectory names, or
2712 * false: return only file names.
2713 * `minetest.safe_file_write(path, content)`: returns boolean indicating success
2714 * Replaces contents of file at path with new contents in a safe (atomic)
2715 way. Use this instead of below code when writing e.g. database files:
2716 `local f = io.open(path, "wb"); f:write(content); f:close()`
2717 * `minetest.get_version()`: returns a table containing components of the
2718 engine version. Components:
2719 * `project`: Name of the project, eg, "Minetest"
2720 * `string`: Simple version, eg, "1.2.3-dev"
2721 * `hash`: Full git version (only set if available),
2722 eg, "1.2.3-dev-01234567-dirty".
2723 Use this for informational purposes only. The information in the returned
2724 table does not represent the capabilities of the engine, nor is it
2725 reliable or verifiable. Compatible forks will have a different name and
2726 version entirely. To check for the presence of engine features, test
2727 whether the functions exported by the wanted features exist. For example:
2728 `if minetest.check_for_falling then ... end`.
2729 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
2730 * `data`: string of data to hash
2731 * `raw`: return raw bytes instead of hex digits, default: false
2734 * `minetest.debug(...)`
2735 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
2736 * `minetest.log([level,] text)`
2737 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
2738 `"info"`, or `"verbose"`. Default is `"none"`.
2740 ### Registration functions
2741 Call these functions only at load time!
2743 * `minetest.register_entity(name, prototype table)`
2744 * `minetest.register_abm(abm definition)`
2745 * `minetest.register_lbm(lbm definition)`
2746 * `minetest.register_node(name, node definition)`
2747 * `minetest.register_tool(name, item definition)`
2748 * `minetest.register_craftitem(name, item definition)`
2749 * `minetest.unregister_item(name)`
2750 * `minetest.register_alias(name, convert_to)`
2751 * Also use this to set the 'mapgen aliases' needed in a game for the core
2752 * mapgens. See 'Mapgen aliases' section above.
2753 * `minetest.register_alias_force(name, convert_to)`
2754 * `minetest.register_craft(recipe)`
2755 * Check recipe table syntax for different types below.
2756 * `minetest.clear_craft(recipe)`
2757 * Will erase existing craft based either on output item or on input recipe.
2758 * Specify either output or input only. If you specify both, input will be
2759 ignored. For input use the same recipe table syntax as for
2760 `minetest.register_craft(recipe)`. For output specify only the item,
2762 * If no erase candidate could be found, Lua exception will be thrown.
2763 * **Warning**! The type field ("shaped","cooking" or any other) will be
2764 ignored if the recipe contains output. Erasing is then done independently
2765 from the crafting method.
2766 * `minetest.register_ore(ore definition)`
2767 * `minetest.register_biome(biome definition)`
2768 * `minetest.register_decoration(decoration definition)`
2769 * `minetest.override_item(name, redefinition)`
2770 * Overrides fields of an item registered with register_node/tool/craftitem.
2771 * Note: Item must already be defined, (opt)depend on the mod defining it.
2772 * Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})`
2773 * `minetest.clear_registered_ores()`
2774 * `minetest.clear_registered_biomes()`
2775 * `minetest.clear_registered_decorations()`
2777 ### Global callback registration functions
2778 Call these functions only at load time!
2780 * `minetest.register_globalstep(func(dtime))`
2781 * Called every server step, usually interval of 0.1s
2782 * `minetest.register_on_shutdown(func())`
2783 * Called before server shutdown
2784 * **Warning**: If the server terminates abnormally (i.e. crashes), the
2785 registered callbacks **will likely not be run**. Data should be saved at
2786 semi-frequent intervals as well as on server shutdown.
2787 * `minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
2788 * Called when a node has been placed
2789 * If return `true` no item is taken from `itemstack`
2790 * `placer` may be any valid ObjectRef or nil.
2791 * **Not recommended**; use `on_construct` or `after_place_node` in node
2792 definition whenever possible.
2793 * `minetest.register_on_dignode(func(pos, oldnode, digger))`
2794 * Called when a node has been dug.
2795 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node
2796 definition whenever possible.
2797 * `minetest.register_on_punchnode(func(pos, node, puncher, pointed_thing))`
2798 * Called when a node is punched
2799 * `minetest.register_on_generated(func(minp, maxp, blockseed))`
2800 * Called after generating a piece of world. Modifying nodes inside the area
2801 is a bit faster than usually.
2802 * `minetest.register_on_newplayer(func(ObjectRef))`
2803 * Called after a new player has been created
2804 * `minetest.register_on_punchplayer(func(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
2805 * Called when a player is punched
2806 * `player` - ObjectRef - Player that was punched
2807 * `hitter` - ObjectRef - Player that hit
2808 * `time_from_last_punch`: Meant for disallowing spamming of clicks
2810 * `tool_capabilities`: capability table of used tool (can be nil)
2811 * `dir`: unit vector of direction of punch. Always defined. Points from
2812 the puncher to the punched.
2813 * `damage` - number that represents the damage calculated by the engine
2814 * should return `true` to prevent the default damage mechanism
2815 * `minetest.register_on_player_hpchange(func(player, hp_change, reason), modifier)`
2816 * Called when the player gets damaged or healed
2817 * `player`: ObjectRef of the player
2818 * `hp_change`: the amount of change. Negative when it is damage.
2819 * `reason`: a PlayerHPChangeReason table.
2820 * The `type` field will have one of the following values:
2821 * `set_hp` - A mod or the engine called `set_hp` without
2822 giving a type - use this for custom damage types.
2823 * `punch` - Was punched. `reason.object` will hold the puncher, or nil if none.
2825 * `node_damage` - damage_per_second from a neighbouring node.
2828 * Any of the above types may have additional fields from mods.
2829 * `reason.from` will be `mod` or `engine`.
2830 * `modifier`: when true, the function should return the actual `hp_change`.
2831 Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
2832 modifiers can return true as a second argument to stop the execution of further functions.
2833 Non-modifiers receive the final hp change calculated by the modifiers.
2834 * `minetest.register_on_dieplayer(func(ObjectRef, reason))`
2835 * Called when a player dies
2836 * `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
2837 * `minetest.register_on_respawnplayer(func(ObjectRef))`
2838 * Called when player is to be respawned
2839 * Called _before_ repositioning of player occurs
2840 * return true in func to disable regular player placement
2841 * `minetest.register_on_prejoinplayer(func(name, ip))`
2842 * Called before a player joins the game
2843 * If it returns a string, the player is disconnected with that string as
2845 * `minetest.register_on_joinplayer(func(ObjectRef))`
2846 * Called when a player joins the game
2847 * `minetest.register_on_leaveplayer(func(ObjectRef, timed_out))`
2848 * Called when a player leaves the game
2849 * `timed_out`: True for timeout, false for other reasons.
2850 * `minetest.register_on_auth_fail(func(name, ip))`
2851 * Called when a client attempts to log into an account but supplies the
2853 * `ip`: The IP address of the client.
2854 * `name`: The account the client attempted to log into.
2855 * `minetest.register_on_cheat(func(ObjectRef, cheat))`
2856 * Called when a player cheats
2857 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
2859 * `interacted_too_far`
2860 * `interacted_while_dead`
2861 * `finished_unknown_dig`
2864 * `minetest.register_on_chat_message(func(name, message))`
2865 * Called always when a player says something
2866 * Return `true` to mark the message as handled, which means that it will
2867 not be sent to other players.
2868 * `minetest.register_on_player_receive_fields(func(player, formname, fields))`
2869 * Called when a button is pressed in player's inventory form
2870 * Newest functions are called first
2871 * If function returns `true`, remaining functions are not called
2872 * `minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))`
2873 * Called when `player` crafts something
2874 * `itemstack` is the output
2875 * `old_craft_grid` contains the recipe (Note: the one in the inventory is
2877 * `craft_inv` is the inventory with the crafting grid
2878 * Return either an `ItemStack`, to replace the output, or `nil`, to not
2880 * `minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))`
2881 * The same as before, except that it is called before the player crafts, to
2882 make craft prediction, and it should not change anything.
2883 * `minetest.register_on_protection_violation(func(pos, name))`
2884 * Called by `builtin` and mods when a player violates protection at a
2885 position (eg, digs a node or punches a protected entity).
2886 * The registered functions can be called using
2887 `minetest.record_protection_violation`.
2888 * The provided function should check that the position is protected by the
2889 mod calling this function before it prints a message, if it does, to
2890 allow for multiple protection mods.
2891 * `minetest.register_on_item_eat(func(hp_change, replace_with_item, itemstack, user, pointed_thing))`
2892 * Called when an item is eaten, by `minetest.item_eat`
2893 * Return `true` or `itemstack` to cancel the default item eat response
2894 (i.e.: hp increase).
2895 * `minetest.register_on_priv_grant(function(name, granter, priv))`
2896 * Called when `granter` grants the priv `priv` to `name`.
2897 * Note that the callback will be called twice if it's done by a player,
2898 once with granter being the player name, and again with granter being nil.
2899 * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
2900 * Called when `revoker` revokes the priv `priv` from `name`.
2901 * Note that the callback will be called twice if it's done by a player,
2902 once with revoker being the player name, and again with revoker being nil.
2903 * `minetest.register_can_bypass_userlimit(function(name, ip))`
2904 * Called when `name` user connects with `ip`.
2905 * Return `true` to by pass the player limit
2906 * `minetest.register_on_modchannel_message(func(channel_name, sender, message))`
2907 * Called when an incoming mod channel message is received
2908 * You should have joined some channels to receive events.
2909 * If message comes from a server mod, `sender` field is an empty string.
2911 ### Other registration functions
2912 * `minetest.register_chatcommand(cmd, chatcommand definition)`
2913 * Adds definition to `minetest.registered_chatcommands`
2914 * `minetest.override_chatcommand(name, redefinition)`
2915 * Overrides fields of a chatcommand registered with `register_chatcommand`.
2916 * `minetest.unregister_chatcommand(name)`
2917 * Unregisters a chatcommands registered with `register_chatcommand`.
2918 * `minetest.register_privilege(name, definition)`
2919 * `definition`: `"description text"`
2921 `{description = "description text", give_to_singleplayer = boolean}`
2922 the default of `give_to_singleplayer` is true.
2923 * To allow players with `basic_privs` to grant, see `basic_privs`
2924 minetest.conf setting.
2925 * `on_grant(name, granter_name)`: Called when given to player `name` by
2927 `granter_name` will be nil if the priv was granted by a mod.
2928 * `on_revoke(name, revoker_name)`: Called when taken from player `name` by
2930 `revoker_name` will be nil if the priv was revoked by a mod
2931 * Note that the above two callbacks will be called twice if a player is
2932 responsible, once with the player name, and then with a nil player name.
2933 * Return true in the above callbacks to stop register_on_priv_grant or
2934 revoke being called.
2935 * `minetest.register_authentication_handler(authentication handler definition)`
2936 * Registers an auth handler that overrides the builtin one
2937 * This function can be called by a single mod once only.
2940 * `minetest.settings`: Settings object containing all of the settings from the
2941 main config file (`minetest.conf`).
2942 * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
2943 parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
2946 * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
2947 * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
2948 * Convert between two privilege representations
2949 * `minetest.get_player_privs(name) -> {priv1=true,...}`
2950 * `minetest.check_player_privs(player_or_name, ...)`:
2951 returns `bool, missing_privs`
2952 * A quickhand for checking privileges.
2953 * `player_or_name`: Either a Player object or the name of a player.
2954 * `...` is either a list of strings, e.g. `"priva", "privb"` or
2955 a table, e.g. `{ priva = true, privb = true }`.
2957 * `minetest.check_password_entry(name, entry, password)`
2958 * Returns true if the "password entry" for a player with name matches given
2959 password, false otherwise.
2960 * The "password entry" is the password representation generated by the
2961 engine as returned as part of a `get_auth()` call on the auth handler.
2962 * Only use this function for making it possible to log in via password from
2963 external protocols such as IRC, other uses are frowned upon.
2964 * `minetest.get_password_hash(name, raw_password)`
2965 * Convert a name-password pair to a password hash that Minetest can use.
2966 * The returned value alone is not a good basis for password checks based
2967 on comparing the password hash in the database with the password hash
2968 from the function, with an externally provided password, as the hash
2969 in the db might use the new SRP verifier format.
2970 * For this purpose, use `minetest.check_password_entry` instead.
2971 * `minetest.get_player_ip(name)`: returns an IP address string for the player
2973 * The player needs to be online for this to be successful.
2975 * `minetest.get_auth_handler()`: Return the currently active auth handler
2976 * See the `Authentication handler definition`
2977 * Use this to e.g. get the authentication data for a player:
2978 `local auth_data = minetest.get_auth_handler().get_auth(playername)`
2979 * `minetest.notify_authentication_modified(name)`
2980 * Must be called by the authentication handler for privilege changes.
2981 * `name`: string; if omitted, all auth data should be considered modified
2982 * `minetest.set_player_password(name, password_hash)`: Set password hash of
2984 * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player
2986 * `minetest.auth_reload()`
2987 * See `reload()` in authentication handler definition
2989 `minetest.set_player_password`, `minetest_set_player_privs`,
2990 `minetest_get_player_privs` and `minetest.auth_reload` call the authentication
2994 * `minetest.chat_send_all(text)`
2995 * `minetest.chat_send_player(name, text)`
2997 ### Environment access
2998 * `minetest.set_node(pos, node)`
2999 * `minetest.add_node(pos, node): alias to `minetest.set_node`
3000 * Set node at position `pos`
3001 * `node`: table `{name=string, param1=number, param2=number}`
3002 * If param1 or param2 is omitted, it's set to `0`.
3003 * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
3004 * `minetest.bulk_set_node({pos1, pos2, pos3, ...}, node)`
3005 * Set node on all positions set in the first argument.
3006 * e.g. `minetest.bulk_set_node({{x=0, y=1, z=1}, {x=1, y=2, z=2}}, {name="default:stone"})`
3007 * For node specification or position syntax see `minetest.set_node` call
3008 * Faster than set_node due to single call, but still considerably slower
3009 than Lua Voxel Manipulators (LVM) for large numbers of nodes.
3010 Unlike LVMs, this will call node callbacks. It also allows setting nodes
3011 in spread out positions which would cause LVMs to waste memory.
3012 For setting a cube, this is 1.3x faster than set_node whereas LVM is 20
3014 * `minetest.swap_node(pos, node)`
3015 * Set node at position, but don't remove metadata
3016 * `minetest.remove_node(pos)`
3017 * By default it does the same as `minetest.set_node(pos, {name="air"})`
3018 * `minetest.get_node(pos)`
3019 * Returns the node at the given position as table in the format
3020 `{name="node_name", param1=0, param2=0}`,
3021 returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
3022 * `minetest.get_node_or_nil(pos)`
3023 * Same as `get_node` but returns `nil` for unloaded areas.
3024 * `minetest.get_node_light(pos, timeofday)`
3025 * Gets the light value at the given position. Note that the light value
3026 "inside" the node at the given position is returned, so you usually want
3027 to get the light value of a neighbor.
3028 * `pos`: The position where to measure the light.
3029 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
3030 * Returns a number between `0` and `15` or `nil`
3031 * `minetest.place_node(pos, node)`
3032 * Place node with the same effects that a player would cause
3033 * `minetest.dig_node(pos)`
3034 * Dig node with the same effects that a player would cause
3035 * Returns `true` if successful, `false` on failure (e.g. protected location)
3036 * `minetest.punch_node(pos)`
3037 * Punch node with the same effects that a player would cause
3038 * `minetest.spawn_falling_node(pos)`
3039 * Change node into falling node
3040 * Returns `true` if successful, `false` on failure
3042 * `minetest.find_nodes_with_meta(pos1, pos2)`
3043 * Get a table of positions of nodes that have metadata within a region
3045 * `minetest.get_meta(pos)`
3046 * Get a `NodeMetaRef` at that position
3047 * `minetest.get_node_timer(pos)`
3048 * Get `NodeTimerRef`
3050 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at
3052 * Returns `ObjectRef`, or `nil` if failed
3053 * `minetest.add_item(pos, item)`: Spawn item
3054 * Returns `ObjectRef`, or `nil` if failed
3055 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
3056 * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of
3058 * `radius`: using an euclidean metric
3059 * `minetest.set_timeofday(val)`
3060 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
3061 * `minetest.get_timeofday()`
3062 * `minetest.get_gametime()`: returns the time, in seconds, since the world was
3064 * `minetest.get_day_count()`: returns number days elapsed since world was
3066 * accounts for time changes.
3067 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns
3069 * `radius`: using a maximum metric
3070 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
3071 * `search_center` is an optional boolean (default: `false`)
3072 If true `pos` is also checked for the nodes
3073 * `minetest.find_nodes_in_area(pos1, pos2, nodenames)`: returns a list of
3075 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
3076 * First return value: Table with all node positions
3077 * Second return value: Table with the count of each node with the node name
3079 * Area volume is limited to 4,096,000 nodes
3080 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
3082 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
3083 * Return value: Table with all node positions with a node air above
3084 * Area volume is limited to 4,096,000 nodes
3085 * `minetest.get_perlin(noiseparams)`
3086 * `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
3087 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
3088 * `minetest.get_voxel_manip([pos1, pos2])`
3089 * Return voxel manipulator object.
3090 * Loads the manipulator from the map if positions are passed.
3091 * `minetest.set_gen_notify(flags, {deco_ids})`
3092 * Set the types of on-generate notifications that should be collected.
3093 * `flags` is a flag field with the available flags:
3101 * The second parameter is a list of IDS of decorations which notification
3103 * `minetest.get_gen_notify()`
3104 * Returns a flagstring and a table with the `deco_id`s.
3105 * `minetest.get_decoration_id(decoration_name)
3106 * Returns the decoration ID number for the provided decoration name string,
3107 or `nil` on failure.
3108 * `minetest.get_mapgen_object(objectname)`
3109 * Return requested mapgen object if available (see "Mapgen objects")
3110 * `minetest.get_heat(pos)`
3111 * Returns the heat at the position, or `nil` on failure.
3112 * `minetest.get_humidity(pos)`
3113 * Returns the humidity at the position, or `nil` on failure.
3114 * `minetest.get_biome_data(pos)`
3115 * Returns a table containing:
3116 * `biome` the biome id of the biome at that position
3117 * `heat` the heat at the position
3118 * `humidity` the humidity at the position
3119 * Or returns `nil` on failure.
3120 * `minetest.get_biome_id(biome_name)`
3121 * Returns the biome id, as used in the biomemap Mapgen object and returned
3122 by `minetest.get_biome_data(pos)`, for a given biome_name string.
3123 * `minetest.get_biome_name(biome_id)`
3124 * Returns the biome name string for the provided biome id, or `nil` on
3126 * If no biomes have been registered, such as in mgv6, returns `default`.
3127 * `minetest.get_mapgen_params()`
3128 * Deprecated: use `minetest.get_mapgen_setting(name)` instead.
3129 * Returns a table containing:
3135 * `minetest.set_mapgen_params(MapgenParams)`
3136 * Deprecated: use `minetest.set_mapgen_setting(name, value, override)`
3138 * Set map generation parameters.
3139 * Function cannot be called after the registration period; only
3140 initialization and `on_mapgen_init`.
3141 * Takes a table as an argument with the fields:
3147 * Leave field unset to leave that parameter unchanged.
3148 * `flags` contains a comma-delimited string of flags to set, or if the
3149 prefix `"no"` is attached, clears instead.
3150 * `flags` is in the same format and has the same options as `mg_flags` in
3152 * `minetest.get_mapgen_setting(name)`
3153 * Gets the *active* mapgen setting (or nil if none exists) in string
3154 format with the following order of precedence:
3155 1) Settings loaded from map_meta.txt or overrides set during mod
3157 2) Settings set by mods without a metafile override
3158 3) Settings explicitly set in the user config file, minetest.conf
3159 4) Settings set as the user config default
3160 * `minetest.get_mapgen_setting_noiseparams(name)`
3161 * Same as above, but returns the value as a NoiseParams table if the
3162 setting `name` exists and is a valid NoiseParams.
3163 * `minetest.set_mapgen_setting(name, value, [override_meta])`
3164 * Sets a mapgen param to `value`, and will take effect if the corresponding
3165 mapgen setting is not already present in map_meta.txt.
3166 * `override_meta` is an optional boolean (default: `false`). If this is set
3167 to true, the setting will become the active setting regardless of the map
3169 * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`.
3170 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
3171 * Same as above, except value is a NoiseParams table.
3172 * `minetest.set_noiseparams(name, noiseparams, set_default)`
3173 * Sets the noiseparams setting of `name` to the noiseparams table specified
3175 * `set_default` is an optional boolean (default: `true`) that specifies
3176 whether the setting should be applied to the default config or current
3178 * `minetest.get_noiseparams(name)`
3179 * Returns a table of the noiseparams for name.
3180 * `minetest.generate_ores(vm, pos1, pos2)`
3181 * Generate all registered ores within the VoxelManip `vm` and in the area
3182 from `pos1` to `pos2`.
3183 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
3184 * `minetest.generate_decorations(vm, pos1, pos2)`
3185 * Generate all registered decorations within the VoxelManip `vm` and in the
3186 area from `pos1` to `pos2`.
3187 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
3188 * `minetest.clear_objects([options])`
3189 * Clear all objects in the environment
3190 * Takes an optional table as an argument with the field `mode`.
3191 * mode = `"full"` : Load and go through every mapblock, clearing
3193 * mode = `"quick"`: Clear objects immediately in loaded mapblocks,
3194 clear objects in unloaded mapblocks only when the
3195 mapblocks are next activated.
3196 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
3197 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be
3198 asynchronously fetched from memory, loaded from disk, or if inexistent,
3200 * If `callback` is a valid Lua function, this will be called for each block
3202 * The function signature of callback is:
3203 * `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
3204 * `blockpos` is the *block* coordinates of the block that had been
3206 * `action` could be one of the following constant values:
3207 * `minetest.EMERGE_CANCELLED`
3208 * `minetest.EMERGE_ERRORED`
3209 * `minetest.EMERGE_FROM_MEMORY`
3210 * `minetest.EMERGE_FROM_DISK`
3211 * `minetest.EMERGE_GENERATED`
3212 * `calls_remaining` is the number of callbacks to be expected after
3214 * `param` is the user-defined parameter passed to emerge_area (or
3215 nil if the parameter was absent).
3216 * `minetest.delete_area(pos1, pos2)`
3217 * delete all mapblocks in the area from pos1 to pos2, inclusive
3218 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
3219 * Checks if there is anything other than air between pos1 and pos2.
3220 * Returns false if something is blocking the sight.
3221 * Returns the position of the blocking node when `false`
3222 * `pos1`: First position
3223 * `pos2`: Second position
3224 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
3225 * Creates a `Raycast` object.
3226 * `pos1`: start of the ray
3227 * `pos2`: end of the ray
3228 * `objects` : if false, only nodes will be returned. Default is `true`.
3229 * `liquids' : if false, liquid nodes won't be returned. Default is `false`.
3230 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
3231 * returns table containing path
3232 * returns a table of 3D points representing a path from `pos1` to `pos2` or
3234 * `pos1`: start position
3235 * `pos2`: end position
3236 * `searchdistance`: number of blocks to search in each direction using a
3238 * `max_jump`: maximum height difference to consider walkable
3239 * `max_drop`: maximum height difference to consider droppable
3240 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
3241 * `minetest.spawn_tree (pos, {treedef})`
3242 * spawns L-system tree at given `pos` with definition in `treedef` table
3243 * `minetest.transforming_liquid_add(pos)`
3244 * add node to liquid update queue
3245 * `minetest.get_node_max_level(pos)`
3246 * get max available level for leveled node
3247 * `minetest.get_node_level(pos)`
3248 * get level of leveled node (water, snow)
3249 * `minetest.set_node_level(pos, level)`
3250 * set level of leveled node, default `level` equals `1`
3251 * if `totallevel > maxlevel`, returns rest (`total-max`).
3252 * `minetest.add_node_level(pos, level)`
3253 * increase level of leveled node by level, default `level` equals `1`
3254 * if `totallevel > maxlevel`, returns rest (`total-max`)
3255 * can be negative for decreasing
3256 * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
3257 * resets the light in a cuboid-shaped part of
3258 the map and removes lighting bugs.
3259 * Loads the area if it is not loaded.
3260 * `pos1` is the corner of the cuboid with the least coordinates
3261 (in node coordinates), inclusive.
3262 * `pos2` is the opposite corner of the cuboid, inclusive.
3263 * The actual updated cuboid might be larger than the specified one,
3264 because only whole map blocks can be updated.
3265 The actual updated area consists of those map blocks that intersect
3266 with the given cuboid.
3267 * However, the neighborhood of the updated area might change
3268 as well, as light can spread out of the cuboid, also light
3270 * returns `false` if the area is not fully generated,
3272 * `minetest.check_single_for_falling(pos)`
3273 * causes an unsupported `group:falling_node` node to fall and causes an
3274 unattached `group:attached_node` node to fall.
3275 * does not spread these updates to neighbours.
3276 * `minetest.check_for_falling(pos)`
3277 * causes an unsupported `group:falling_node` node to fall and causes an
3278 unattached `group:attached_node` node to fall.
3279 * spread these updates to neighbours and can cause a cascade
3281 * `minetest.get_spawn_level(x, z)`
3282 * Returns a player spawn y co-ordinate for the provided (x, z)
3283 co-ordinates, or `nil` for an unsuitable spawn point.
3284 * For most mapgens a 'suitable spawn point' is one with y between
3285 `water_level` and `water_level + 16`, and in mgv7 well away from rivers,
3286 so `nil` will be returned for many (x, z) co-ordinates.
3287 * The spawn level returned is for a player spawn in unmodified terrain.
3288 * The spawn level is intentionally above terrain level to cope with
3289 full-node biome 'dust' nodes.
3292 You can find mod channels communication scheme in `docs/mod_channels.png`.
3294 * `minetest.mod_channel_join(channel_name)`
3295 * Server joins channel `channel_name`, and creates it if necessary. You
3296 should listen from incoming messages with
3297 `minetest.register_on_modchannel_message` call to receive incoming
3301 `minetest.get_inventory(location)`: returns an `InvRef`
3304 * `{type="player", name="celeron55"}`
3305 * `{type="node", pos={x=, y=, z=}}`
3306 * `{type="detached", name="creative"}`
3307 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns
3309 * callbacks: See "Detached inventory callbacks"
3310 * `player_name`: Make detached inventory available to one player
3311 exclusively, by default they will be sent to every player (even if not
3313 Note that this parameter is mostly just a workaround and will be removed
3315 * Creates a detached inventory. If it already exists, it is cleared.
3316 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
3317 returns left over ItemStack.
3318 * See `minetest.item_eat` and `minetest.register_on_item_eat`
3321 * `minetest.show_formspec(playername, formname, formspec)`
3322 * `playername`: name of player to show formspec
3323 * `formname`: name passed to `on_player_receive_fields` callbacks.
3324 It should follow the `"modname:<whatever>"` naming convention
3325 * `formspec`: formspec to display
3326 * `minetest.close_formspec(playername, formname)`
3327 * `playername`: name of player to close formspec
3328 * `formname`: has to exactly match the one given in `show_formspec`, or the
3329 formspec will not close.
3330 * calling `show_formspec(playername, formname, "")` is equal to this
3332 * to close a formspec regardless of the formname, call
3333 `minetest.close_formspec(playername, "")`.
3334 **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
3335 * `minetest.formspec_escape(string)`: returns a string
3336 * escapes the characters "[", "]", "\", "," and ";", which can not be used
3338 * `minetest.explode_table_event(string)`: returns a table
3339 * returns e.g. `{type="CHG", row=1, column=2}`
3341 * `"INV"`: no row selected)
3342 * `"CHG"`: selected)
3343 * `"DCL"`: double-click
3344 * `minetest.explode_textlist_event(string)`: returns a table
3345 * returns e.g. `{type="CHG", index=1}`
3347 * `"INV"`: no row selected)
3348 * `"CHG"`: selected)
3349 * `"DCL"`: double-click
3350 * `minetest.explode_scrollbar_event(string)`: returns a table
3351 * returns e.g. `{type="CHG", value=500}`
3353 * `"INV"`: something failed
3354 * `"CHG"`: has been changed
3355 * `"VAL"`: not changed
3358 * `minetest.inventorycube(img1, img2, img3)`
3359 * Returns a string for making an image of a cube (useful as an item image)
3360 * `minetest.get_pointed_thing_position(pointed_thing, above)`
3361 * Get position of a `pointed_thing` (that you can get from somewhere)
3362 * `minetest.dir_to_facedir(dir, is6d)`
3363 * Convert a vector to a facedir value, used in `param2` for
3364 `paramtype2="facedir"`.
3365 * passing something non-`nil`/`false` for the optional second parameter
3366 causes it to take the y component into account.
3367 * `minetest.facedir_to_dir(facedir)`
3368 * Convert a facedir back into a vector aimed directly out the "back" of a
3370 * `minetest.dir_to_wallmounted(dir)`
3371 * Convert a vector to a wallmounted value, used for
3372 `paramtype2="wallmounted"`.
3373 * `minetest.wallmounted_to_dir(wallmounted)`
3374 * Convert a wallmounted value back into a vector aimed directly out the
3376 * `minetest.dir_to_yaw(dir)`
3377 * Convert a vector into a yaw (angle)
3378 * `minetest.yaw_to_dir(yaw)`
3379 * Convert yaw (angle) to a vector
3380 * `minetest.is_colored_paramtype(ptype)`
3381 * Returns a boolean. Returns `true` if the given `paramtype2` contains
3382 color information (`color`, `colorwallmounted` or `colorfacedir`).
3383 * `minetest.strip_param2_color(param2, paramtype2)`
3384 * Removes everything but the color information from the
3385 given `param2` value.
3386 * Returns `nil` if the given `paramtype2` does not contain color
3388 * `minetest.get_node_drops(nodename, toolname)`
3389 * Returns list of item names.
3390 * **Note**: This will be removed or modified in a future version.
3391 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
3392 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
3393 * `input.width` = for example `3`
3394 * `input.items` = for example
3395 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
3396 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
3397 * `output.time` = a number, if unsuccessful: `0`
3398 * `output.replacements` = list of `ItemStack`s that couldn't be placed in
3399 `decremented_input.items`
3400 * `decremented_input` = like `input`
3401 * `minetest.get_craft_recipe(output)`: returns input
3402 * returns last registered recipe for output item (node)
3403 * `output` is a node or item type such as `"default:torch"`
3404 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
3405 * `input.width` = for example `3`
3406 * `input.items` = for example
3407 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
3408 * `input.items` = `nil` if no recipe found
3409 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
3410 * returns indexed table with all registered recipes for query item (node)
3411 or `nil` if no recipe was found.
3412 * recipe entry table:
3415 method = 'normal' or 'cooking' or 'fuel'
3416 width = 0-3, 0 means shapeless recipe
3417 items = indexed [1-9] table with recipe items
3418 output = string with item name and quantity
3420 * Example query for `"default:gold_ingot"` will return table:
3423 [1]={method = "cooking", width = 3, output = "default:gold_ingot",
3424 items = {1 = "default:gold_lump"}},
3425 [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
3426 items = {1 = "default:goldblock"}}
3428 * `minetest.handle_node_drops(pos, drops, digger)`
3429 * `drops`: list of itemstrings
3430 * Handles drops from nodes after digging: Default action is to put them
3431 into digger's inventory.
3432 * Can be overridden to get different functionality (e.g. dropping items on
3434 * `minetest.itemstring_with_palette(item, palette_index)`: returns an item
3436 * Creates an item string which contains palette index information
3437 for hardware colorization. You can use the returned string
3438 as an output in a craft recipe.
3439 * `item`: the item stack which becomes colored. Can be in string,
3440 table and native form.
3441 * `palette_index`: this index is added to the item stack
3442 * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
3443 * Creates an item string which contains static color information
3444 for hardware colorization. Use this method if you wish to colorize
3445 an item that does not own a palette. You can use the returned string
3446 as an output in a craft recipe.
3447 * `item`: the item stack which becomes colored. Can be in string,
3448 table and native form.
3449 * `colorstring`: the new color of the item stack
3452 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
3453 returns `{{actor, pos, time, oldnode, newnode}, ...}`
3454 * Find who has done something to a node, or near a node
3455 * `actor`: `"player:<name>"`, also `"liquid"`.
3456 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns
3457 `boolean, log_messages`.
3458 * Revert latest actions of someone
3459 * `actor`: `"player:<name>"`, also `"liquid"`.
3461 ### Defaults for the `on_*` item definition functions
3462 These functions return the leftover itemstack.
3464 * `minetest.item_place_node(itemstack, placer, pointed_thing, param2)`
3465 * Place item as a node
3466 * `param2` overrides `facedir` and wallmounted `param2`
3467 * returns `itemstack, success`
3468 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
3470 * `minetest.item_place(itemstack, placer, pointed_thing, param2)`
3471 * Use one of the above based on what the item is.
3472 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
3473 * **Note**: is not called when wielded item overrides `on_place`
3474 * `param2` overrides `facedir` and wallmounted `param2`
3475 * returns `itemstack, success`
3476 * `minetest.item_drop(itemstack, dropper, pos)`
3478 * `minetest.item_eat(hp_change, replace_with_item)`
3480 * `replace_with_item` is the itemstring which is added to the inventory.
3481 If the player is eating a stack, then replace_with_item goes to a
3482 different spot. Can be `nil`
3483 * See `minetest.do_item_eat`
3485 ### Defaults for the `on_punch` and `on_dig` node definition callbacks
3486 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
3487 * Calls functions registered by `minetest.register_on_punchnode()`
3488 * `minetest.node_dig(pos, node, digger)`
3489 * Checks if node can be dug, puts item into inventory, removes node
3490 * Calls functions registered by `minetest.registered_on_dignodes()`
3493 * `minetest.sound_play(spec, parameters)`: returns a handle
3494 * `spec` is a `SimpleSoundSpec`
3495 * `parameters` is a sound parameter table
3496 * `minetest.sound_stop(handle)`
3497 * `minetest.sound_fade(handle, step, gain)`
3498 * `handle` is a handle returned by `minetest.sound_play`
3499 * `step` determines how fast a sound will fade.
3500 Negative step will lower the sound volume, positive step will increase
3502 * `gain` the target gain for the fade.
3505 * `minetest.after(time, func, ...)`
3506 * Call the function `func` after `time` seconds, may be fractional
3507 * Optional: Variable number of arguments that are passed to `func`
3510 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for
3511 server shutdown. Will display `message` to clients.
3512 * `reconnect` == true displays a reconnect button
3513 * `delay` adds an optional delay (in seconds) before shutdown.
3514 Negative delay cancels the current active shutdown.
3515 Zero delay triggers an immediate shutdown.
3516 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
3517 * `minetest.get_server_status()`: returns server status string
3518 * `minetest.get_server_uptime()`: returns the server uptime in seconds
3519 * `minetest.remove_player(name)`: remove player from database (if they are not
3521 * As auth data is not removed, minetest.player_exists will continue to
3522 return true. Call the below method as well if you want to remove auth
3524 * Returns a code (0: successful, 1: no such player, 2: player is connected)
3525 * `minetest.remove_player_auth(name)`: remove player authentication data
3526 * Returns boolean indicating success (false if player nonexistant)
3529 * `minetest.get_ban_list()`: returns the ban list
3530 (same as `minetest.get_ban_description("")`).
3531 * `minetest.get_ban_description(ip_or_name)`: returns ban description (string)
3532 * `minetest.ban_player(name)`: ban a player
3533 * `minetest.unban_player_or_ip(name)`: unban player or IP address
3534 * `minetest.kick_player(name, [reason])`: disconnect a player with a optional
3538 * `minetest.add_particle(particle definition)`
3539 * Deprecated: `minetest.add_particle(pos, velocity, acceleration,
3540 expirationtime, size, collisiondetection, texture, playername)`
3542 * `minetest.add_particlespawner(particlespawner definition)`
3543 * Add a `ParticleSpawner`, an object that spawns an amount of particles
3544 over `time` seconds.
3545 * Returns an `id`, and -1 if adding didn't succeed
3546 * `Deprecated: minetest.add_particlespawner(amount, time,
3550 minexptime, maxexptime,
3552 collisiondetection, texture, playername)`
3554 * `minetest.delete_particlespawner(id, player)`
3555 * Delete `ParticleSpawner` with `id` (return value from
3556 `minetest.add_particlespawner`).
3557 * If playername is specified, only deletes on the player's client,
3558 otherwise on all clients.
3561 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
3562 * Create a schematic from the volume of map specified by the box formed by
3564 * Apply the specified probability and per-node force-place to the specified
3565 nodes according to the `probability_list`.
3566 * `probability_list` is an array of tables containing two fields, `pos`
3568 * `pos` is the 3D vector specifying the absolute coordinates of the
3569 node being modified,
3570 * `prob` is an integer value from `0` to `255` that encodes
3571 probability and per-node force-place. Probability has levels
3572 0-127, then 128 may be added to encode per-node force-place.
3573 For probability stated as 0-255, divide by 2 and round down to
3574 get values 0-127, then add 128 to apply per-node force-place.
3575 * If there are two or more entries with the same pos value, the
3577 * If `pos` is not inside the box formed by `p1` and `p2`, it is
3579 * If `probability_list` equals `nil`, no probabilities are applied.
3580 * Apply the specified probability to the specified horizontal slices
3581 according to the `slice_prob_list`.
3582 * `slice_prob_list` is an array of tables containing two fields, `ypos`
3584 * `ypos` indicates the y position of the slice with a probability
3585 applied, the lowest slice being `ypos = 0`.
3586 * If slice probability list equals `nil`, no slice probabilities
3588 * Saves schematic in the Minetest Schematic format to filename.
3590 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement, flags)`
3591 * Place the schematic specified by schematic (see: Schematic specifier) at
3593 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
3594 * If the `rotation` parameter is omitted, the schematic is not rotated.
3595 * `replacements` = `{["old_name"] = "convert_to", ...}`
3596 * `force_placement` is a boolean indicating whether nodes other than `air`
3597 and `ignore` are replaced by the schematic.
3598 * Returns nil if the schematic could not be loaded.
3599 * **Warning**: Once you have loaded a schematic from a file, it will be
3600 cached. Future calls will always use the cached version and the
3601 replacement list defined for it, regardless of whether the file or the
3602 replacement list parameter have changed. The only way to load the file
3603 anew is to restart the server.
3604 * `flags` is a flag field with the available flags:
3609 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement, flags)`:
3610 * This function is analogous to minetest.place_schematic, but places a
3611 schematic onto the specified VoxelManip object `vmanip` instead of the
3613 * Returns false if any part of the schematic was cut-off due to the
3614 VoxelManip not containing the full area required, and true if the whole
3615 schematic was able to fit.
3616 * Returns nil if the schematic could not be loaded.
3617 * After execution, any external copies of the VoxelManip contents are
3619 * `flags` is a flag field with the available flags:
3624 * `minetest.serialize_schematic(schematic, format, options)`
3625 * Return the serialized schematic specified by schematic
3626 (see: Schematic specifier)
3627 * in the `format` of either "mts" or "lua".
3628 * "mts" - a string containing the binary MTS data used in the MTS file
3630 * "lua" - a string containing Lua code representing the schematic in table
3632 * `options` is a table containing the following optional parameters:
3633 * If `lua_use_comments` is true and `format` is "lua", the Lua code
3634 generated will have (X, Z) position comments for every X row
3635 generated in the schematic data for easier reading.
3636 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua",
3637 the Lua code generated will use that number of spaces as indentation
3638 instead of a tab character.
3641 * `minetest.request_http_api()`:
3642 * returns `HTTPApiTable` containing http functions if the calling mod has
3643 been granted access by being listed in the `secure.http_mods` or
3644 `secure.trusted_mods` setting, otherwise returns `nil`.
3645 * The returned table contains the functions `fetch`, `fetch_async` and
3646 `fetch_async_get` described below.
3647 * Only works at init time and must be called from the mod's main scope
3648 (not from a function).
3649 * Function only exists if minetest server was built with cURL support.
3650 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
3652 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
3653 * Performs given request asynchronously and calls callback upon completion
3654 * callback: `function(HTTPRequestResult res)`
3655 * Use this HTTP function if you are unsure, the others are for advanced use
3656 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
3657 * Performs given request asynchronously and returns handle for
3658 `HTTPApiTable.fetch_async_get`
3659 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
3660 * Return response data for given asynchronous HTTP request
3663 * `minetest.get_mod_storage()`:
3664 * returns reference to mod private `StorageRef`
3665 * must be called during mod load time
3668 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
3669 * `minetest.is_player(o)`: boolean, whether `o` is a player
3670 * `minetest.player_exists(name)`: boolean, whether player exists
3671 (regardless of online status)
3672 * `minetest.hud_replace_builtin(name, hud_definition)`
3673 * Replaces definition of a builtin hud element
3674 * `name`: `"breath"` or `"health"`
3675 * `hud_definition`: definition to replace builtin definition
3676 * `minetest.send_join_message(player_name)`
3677 * This function can be overridden by mods to change the join message.
3678 * `minetest.send_leave_message(player_name, timed_out)`
3679 * This function can be overridden by mods to change the leave message.
3680 * `minetest.hash_node_position(pos)`: returns an 48-bit integer
3681 * `pos`: table {x=number, y=number, z=number},
3682 * Gives a unique hash number for a node position (16+16+16=48bit)
3683 * `minetest.get_position_from_hash(hash)`: returns a position
3684 * Inverse transform of `minetest.hash_node_position`
3685 * `minetest.get_item_group(name, group)`: returns a rating
3686 * Get rating of a group of an item. (`0` means: not in group)
3687 * `minetest.get_node_group(name, group)`: returns a rating
3688 * Deprecated: An alias for the former.
3689 * `minetest.raillike_group(name)`: returns a rating
3690 * Returns rating of the connect_to_raillike group corresponding to name
3691 * If name is not yet the name of a connect_to_raillike group, a new group
3692 id is created, with that name.
3693 * `minetest.get_content_id(name)`: returns an integer
3694 * Gets the internal content ID of `name`
3695 * `minetest.get_name_from_content_id(content_id)`: returns a string
3696 * Gets the name of the content with that content ID
3697 * `minetest.parse_json(string[, nullvalue])`: returns something
3698 * Convert a string containing JSON data into the Lua equivalent
3699 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
3700 * On success returns a table, a string, a number, a boolean or `nullvalue`
3701 * On failure outputs an error message and returns `nil`
3702 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
3703 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error
3705 * Convert a Lua table into a JSON string
3706 * styled: Outputs in a human-readable format if this is set, defaults to
3708 * Unserializable things like functions and userdata will cause an error.
3709 * **Warning**: JSON is more strict than the Lua table format.
3710 1. You can only use strings and positive integers of at least one as
3712 2. You can not mix string and integer keys.
3713 This is due to the fact that JSON has two distinct array and object
3715 * Example: `write_json({10, {a = false}})`,
3716 returns `"[10, {\"a\": false}]"`
3717 * `minetest.serialize(table)`: returns a string
3718 * Convert a table containing tables, strings, numbers, booleans and `nil`s
3719 into string form readable by `minetest.deserialize`
3720 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
3721 * `minetest.deserialize(string)`: returns a table
3722 * Convert a string returned by `minetest.deserialize` into a table
3723 * `string` is loaded in an empty sandbox environment.
3724 * Will load functions, but they cannot access the global environment.
3725 * Example: `deserialize('return { ["foo"] = "bar" }')`,
3726 returns `{foo='bar'}`
3727 * Example: `deserialize('print("foo")')`, returns `nil`
3728 (function call fails), returns
3729 `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
3730 * `minetest.compress(data, method, ...)`: returns `compressed_data`
3731 * Compress a string of data.
3732 * `method` is a string identifying the compression method to be used.
3733 * Supported compression methods:
3734 * Deflate (zlib): `"deflate"`
3735 * `...` indicates method-specific arguments. Currently defined arguments
3737 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
3738 * `minetest.decompress(compressed_data, method, ...)`: returns data
3739 * Decompress a string of data (using ZLib).
3740 * See documentation on `minetest.compress()` for supported compression
3742 * `...` indicates method-specific arguments. Currently, no methods use this
3743 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
3744 * Each argument is a 8 Bit unsigned integer
3745 * Returns the ColorString from rgb or rgba values
3746 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
3747 * `minetest.encode_base64(string)`: returns string encoded in base64
3748 * Encodes a string in base64.
3749 * `minetest.decode_base64(string)`: returns string
3750 * Decodes a string encoded in base64.
3751 * `minetest.is_protected(pos, name)`: returns boolean
3752 * Returns true, if player `name` shouldn't be able to dig at `pos` or do
3753 other actions, definable by mods, due to some mod-defined ownership-like
3755 * Returns false or nil, if the player is allowed to do such actions.
3756 * `name` will be "" for non-players or unknown players.
3757 * This function should be overridden by protection mods and should be used
3758 to check if a player can interact at a position.
3759 * This function should call the old version of itself if the position is
3760 not protected by the mod.
3763 local old_is_protected = minetest.is_protected
3764 function minetest.is_protected(pos, name)
3765 if mymod:position_protected_from(pos, name) then
3768 return old_is_protected(pos, name)
3770 * `minetest.record_protection_violation(pos, name)`
3771 * This function calls functions registered with
3772 `minetest.register_on_protection_violation`.
3773 * `minetest.is_area_protected(pos1, pos2, player_name, interval)
3774 * Returns the position of the first node that `player_name` may not modify
3775 in the specified cuboid between `pos1` and `pos2`.
3776 * Returns `false` if no protections were found.
3777 * Applies `is_protected()` to a 3D lattice of points in the defined volume.
3778 The points are spaced evenly throughout the volume and have a spacing
3779 similar to, but no larger than, `interval`.
3780 * All corners and edges of the defined volume are checked.
3781 * `interval` defaults to 4.
3782 * `interval` should be carefully chosen and maximised to avoid an excessive
3783 number of points being checked.
3784 * Like `minetest.is_protected`, this function may be extended or
3785 overwritten by mods to provide a faster implementation to check the
3786 cuboid for intersections.
3787 * `minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)`
3788 * Attempt to predict the desired orientation of the facedir-capable node
3789 defined by `itemstack`, and place it accordingly (on-wall, on the floor,
3790 or hanging from the ceiling). Stacks are handled normally if the
3791 `infinitestacks` field is false or omitted (else, the itemstack is not
3792 changed). `orient_flags` is an optional table containing extra tweaks to
3794 * `invert_wall`: if `true`, place wall-orientation on the ground and
3795 ground-orientation on the wall.
3796 * `force_wall` : if `true`, always place the node in wall orientation.
3797 * `force_ceiling`: if `true`, always place on the ceiling.
3798 * `force_floor`: if `true`, always place the node on the floor.
3799 * `force_facedir`: if `true`, forcefully reset the facedir to north
3800 when placing on the floor or ceiling.
3801 * The first four options are mutually-exclusive; the last in the list
3802 takes precedence over the first.
3803 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
3804 * calls `rotate_and_place()` with infinitestacks set according to the state
3805 of the creative mode setting, and checks for "sneak" to set the
3806 `invert_wall` parameter.
3808 * `minetest.forceload_block(pos[, transient])`
3809 * forceloads the position `pos`.
3810 * returns `true` if area could be forceloaded
3811 * If `transient` is `false` or absent, the forceload will be persistent
3812 (saved between server runs). If `true`, the forceload will be transient
3813 (not saved between server runs).
3815 * `minetest.forceload_free_block(pos[, transient])`
3816 * stops forceloading the position `pos`
3817 * If `transient` is `false` or absent, frees a persistent forceload.
3818 If `true`, frees a transient forceload.
3820 * `minetest.request_insecure_environment()`: returns an environment containing
3821 insecure functions if the calling mod has been listed as trusted in the
3822 `secure.trusted_mods` setting or security is disabled, otherwise returns
3824 * Only works at init time and must be called from the mod's main scope (not
3826 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE
3827 IT IN A LOCAL VARIABLE!**
3829 * `minetest.global_exists(name)`
3830 * Checks if a global variable has been set, without triggering a warning.
3833 * `minetest.env`: `EnvRef` of the server environment and world.
3834 * Any function in the minetest namespace can be called using the syntax
3835 `minetest.env:somefunction(somearguments)`
3836 instead of `minetest.somefunction(somearguments)`
3837 * Deprecated, but support is not to be dropped soon
3840 * `minetest.registered_items`
3841 * Map of registered items, indexed by name
3842 * `minetest.registered_nodes`
3843 * Map of registered node definitions, indexed by name
3844 * `minetest.registered_craftitems`
3845 * Map of registered craft item definitions, indexed by name
3846 * `minetest.registered_tools`
3847 * Map of registered tool definitions, indexed by name
3848 * `minetest.registered_entities`
3849 * Map of registered entity prototypes, indexed by name
3850 * `minetest.object_refs`
3851 * Map of object references, indexed by active object id
3852 * `minetest.luaentities`
3853 * Map of Lua entities, indexed by active object id
3854 * `minetest.registered_chatcommands`
3855 * Map of registered chat command definitions, indexed by name
3856 * `minetest.registered_ores`
3857 * List of registered ore definitions.
3858 * `minetest.registered_biomes`
3859 * List of registered biome definitions.
3860 * `minetest.registered_decorations`
3861 * List of registered decoration definitions.
3868 An interface to use mod channels on client and server
3871 * `leave()`: leave the mod channel.
3872 * Server leaves channel `channel_name`.
3873 * No more incoming or outgoing messages can be sent to this channel from
3875 * This invalidate all future object usage.
3876 * Ensure your set mod_channel to nil after that to free Lua resources.
3877 * `is_writeable()`: returns true if channel is writeable and mod can send over
3879 * `send_all(message)`: Send `message` though the mod channel.
3880 * If mod channel is not writeable or invalid, message will be dropped.
3881 * Message size is limited to 65535 characters by protocol.
3884 See `StorageRef`, `NodeMetaRef` and `ItemStackMetaRef`.
3887 * `set_string(name, value)`
3888 * `get_string(name)`
3889 * `set_int(name, value)`
3891 * `set_float(name, value)`
3893 * `to_table()`: returns `nil` or a table with keys:
3894 * `fields`: key-value storage
3895 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
3896 * `from_table(nil or {})`
3897 * Any non-table value will clear the metadata
3898 * See "Node Metadata" for an example
3899 * returns `true` on success
3901 * returns `true` if this metadata has the same key-value pairs as `other`
3904 Node metadata: reference extra data and functionality stored in a node.
3905 Can be obtained via `minetest.get_meta(pos)`.
3908 * All methods in MetaDataRef
3909 * `get_inventory()`: returns `InvRef`
3910 * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
3911 This will prevent them from being sent to the client. Note that the "private"
3912 status will only be remembered if an associated key-value pair exists,
3913 meaning it's best to call this when initializing all other meta (e.g.
3916 ### `ItemStackMetaRef`
3917 ItemStack metadata: reference extra data and functionality stored in a stack.
3918 Can be obtained via `item:get_meta()`.
3921 * All methods in MetaDataRef
3922 * `set_tool_capabilities([tool_capabilities])`
3923 * Overrides the item's tool capabilities
3924 * A nil value will clear the override data and restore the original
3928 Mod metadata: per mod metadata, saved automatically.
3929 Can be obtained via `minetest.get_mod_storage()` during load time.
3932 * All methods in MetaDataRef
3935 Node Timers: a high resolution persistent per-node timer.
3936 Can be gotten via `minetest.get_node_timer(pos)`.
3939 * `set(timeout,elapsed)`
3940 * set a timer's state
3941 * `timeout` is in seconds, and supports fractional values (0.1 etc)
3942 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
3943 * will trigger the node's `on_timer` function after `(timeout - elapsed)`
3947 * equivalent to `set(timeout,0)`
3950 * `get_timeout()`: returns current timeout in seconds
3951 * if `timeout` equals `0`, timer is inactive
3952 * `get_elapsed()`: returns current elapsed time in seconds
3953 * the node's `on_timer` function will be called after `(timeout - elapsed)`
3955 * `is_started()`: returns boolean state of timer
3956 * returns `true` if timer is started, otherwise `false`
3959 Moving things in the game are generally these.
3961 This is basically a reference to a C++ `ServerActiveObject`
3964 * `remove()`: remove object (after returning from Lua)
3965 * Note: Doesn't work on players, use `minetest.kick_player` instead
3966 * `get_pos()`: returns `{x=num, y=num, z=num}`
3967 * `set_pos(pos)`; `pos`=`{x=num, y=num, z=num}`
3968 * `move_to(pos, continuous=false)`: interpolated move
3969 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
3970 * `puncher` = another `ObjectRef`,
3971 * `time_from_last_punch` = time since last punch action of the puncher
3972 * `direction`: can be `nil`
3973 * `right_click(clicker)`; `clicker` is another `ObjectRef`
3974 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
3975 * `set_hp(hp, reason)`: set number of hitpoints (2 * number of hearts).
3976 * See reason in register_on_player_hpchange
3977 * `get_inventory()`: returns an `InvRef`
3978 * `get_wield_list()`: returns the name of the inventory list the wielded item
3980 * `get_wield_index()`: returns the index of the wielded item
3981 * `get_wielded_item()`: returns an `ItemStack`
3982 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if
3984 * `set_armor_groups({group1=rating, group2=rating, ...})`
3985 * `get_armor_groups()`: returns a table with the armor group ratings
3986 * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
3987 * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
3988 * `frame_speed`: number, default: `15.0`
3989 * `frame_blend`: number, default: `0.0`
3990 * `frame_loop`: boolean, default: `true`
3991 * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and
3993 * `set_animation_frame_speed(frame_speed)`
3994 * `frame_speed`: number, default: `15.0`
3995 * `set_attach(parent, bone, position, rotation)`
3997 * `position`: `{x=num, y=num, z=num}` (relative)
3998 * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees
3999 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't
4002 * `set_bone_position(bone, position, rotation)`
4004 * `position`: `{x=num, y=num, z=num}` (relative)
4005 * `rotation`: `{x=num, y=num, z=num}`
4006 * `get_bone_position(bone)`: returns position and rotation of the bone
4007 * `set_properties(object property table)`
4008 * `get_properties()`: returns object property table
4009 * `is_player()`: returns true for players, false otherwise
4010 * `get_nametag_attributes()`
4011 * returns a table with the attributes of the nametag of an object
4013 color = {a=0..255, r=0..255, g=0..255, b=0..255},
4016 * `set_nametag_attributes(attributes)`
4017 * sets the attributes of the nametag of an object
4021 text = "My Nametag",
4024 ##### LuaEntitySAO-only (no-op for other objects)
4025 * `set_velocity(vel)`
4026 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
4027 * `get_velocity()`: returns the velocity, a vector
4028 * `set_acceleration(acc)`
4030 * `get_acceleration()`: returns the acceleration, a vector
4031 * `set_yaw(radians)`
4032 * `get_yaw()`: returns number in radians
4033 * `set_texture_mod(mod)`
4034 * `get_texture_mod()` returns current texture modifier
4035 * `set_sprite(p, num_frames, framelength, select_horiz_by_yawpitch)`
4036 * Select sprite from spritesheet with optional animation and Dungeon Master
4037 style texture selection based on yaw relative to camera
4038 * `p`: {x=number, y=number}, the coordinate of the first frame
4039 (x: column, y: row), default: `{x=0, y=0}`
4040 * `num_frames`: number, default: `1`
4041 * `framelength`: number, default: `0.2`
4042 * `select_horiz_by_yawpitch`: boolean, this was once used for the Dungeon
4043 Master mob, default: `false`
4044 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
4047 ##### Player-only (no-op for other objects)
4048 * `get_player_name()`: returns `""` if is not a player
4049 * `get_player_velocity()`: returns `nil` if is not a player, otherwise a
4050 table {x, y, z} representing the player's instantaneous velocity in nodes/s
4051 * `get_look_dir()`: get camera direction as a unit vector
4052 * `get_look_vertical()`: pitch in radians
4053 * Angle ranges between -pi/2 and pi/2, which are straight up and down
4055 * `get_look_horizontal()`: yaw in radians
4056 * Angle is counter-clockwise from the +z direction.
4057 * `set_look_vertical(radians)`: sets look pitch
4058 * radians - Angle from looking forward, where positive is downwards.
4059 * `set_look_horizontal(radians)`: sets look yaw
4060 * radians - Angle from the +z direction, where positive is
4062 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use
4063 `get_look_vertical`.
4064 * Angle ranges between -pi/2 and pi/2, which are straight down and up
4066 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use
4067 `get_look_horizontal`.
4068 * Angle is counter-clockwise from the +x direction.
4069 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use
4070 `set_look_vertical`.
4071 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use
4072 `set_look_horizontal`.
4073 * `get_breath()`: returns players breath
4074 * `set_breath(value)`: sets players breath
4076 * `0`: player is drowning
4077 * max: bubbles bar is not shown
4078 * See Object Properties for more information
4079 * `set_attribute(attribute, value)`:
4080 * Sets an extra attribute with value on player.
4081 * `value` must be a string, or a number which will be converted to a
4083 * If `value` is `nil`, remove attribute from player.
4084 * `get_attribute(attribute)`:
4085 * Returns value (a string) for extra attribute.
4086 * Returns `nil` if no attribute found.
4087 * `set_inventory_formspec(formspec)`
4088 * Redefine player's inventory form
4089 * Should usually be called in `on_joinplayer`
4090 * `get_inventory_formspec()`: returns a formspec string
4091 * `set_formspec_prepend(formspec)`:
4092 * the formspec string will be added to every formspec shown to the user,
4093 except for those with a no_prepend[] tag.
4094 * This should be used to set style elements such as background[] and
4095 bgcolor[], any non-style elements (eg: label) may result in weird behaviour.
4096 * Only affects formspecs shown after this is called.
4097 * `get_formspec_prepend(formspec)`: returns a formspec string.
4098 * `get_player_control()`: returns table with player pressed keys
4099 * The table consists of fields with boolean value representing the pressed
4100 keys, the fields are jump, right, left, LMB, RMB, sneak, aux1, down, up.
4101 * example: `{jump=false, right=true, left=false, LMB=false, RMB=false,
4102 sneak=true, aux1=false, down=false, up=false}`
4103 * `get_player_control_bits()`: returns integer with bit packed player pressed
4105 * bit nr/meaning: 0/up, 1/down, 2/left, 3/right, 4/jump, 5/aux1, 6/sneak,
4107 * `set_physics_override(override_table)`
4108 * `override_table` is a table with the following fields:
4109 * `speed`: multiplier to default walking speed value (default: `1`)
4110 * `jump`: multiplier to default jump value (default: `1`)
4111 * `gravity`: multiplier to default gravity value (default: `1`)
4112 * `sneak`: whether player can sneak (default: `true`)
4113 * `sneak_glitch`: whether player can use the new move code replications
4114 of the old sneak side-effects: sneak ladders and 2 node sneak jump
4116 * `new_move`: use new move/sneak code. When `false` the exact old code
4117 is used for the specific old sneak behaviour (default: `true`)
4118 * `get_physics_override()`: returns the table given to `set_physics_override`
4119 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
4121 * `hud_remove(id)`: remove the HUD element of the specified id
4122 * `hud_change(id, stat, value)`: change a value of a previously added HUD
4124 * element `stat` values:
4125 `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
4126 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
4127 * `hud_set_flags(flags)`: sets specified HUD flags to `true`/`false`
4128 * `flags`: (is visible) `hotbar`, `healthbar`, `crosshair`, `wielditem`,
4129 `breathbar`, `minimap`, `minimap_radar`
4130 * pass a table containing a `true`/`false` value of each flag to be set or
4132 * if a flag equals `nil`, the flag is not modified
4133 * note that setting `minimap` modifies the client's permission to view the
4134 minimap - the client may locally elect to not view the minimap.
4135 * minimap `radar` is only usable when `minimap` is true
4136 * `hud_get_flags()`: returns a table containing status of hud flags
4137 * returns `{hotbar=true, healthbar=true, crosshair=true, wielditem=true,
4138 breathbar=true, minimap=true, minimap_radar=true}`
4139 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
4140 * `count`: number of items, must be between `1` and `23`
4141 * `hud_get_hotbar_itemcount`: returns number of visible items
4142 * `hud_set_hotbar_image(texturename)`
4143 * sets background image for hotbar
4144 * `hud_get_hotbar_image`: returns texturename
4145 * `hud_set_hotbar_selected_image(texturename)`
4146 * sets image for selected item of hotbar
4147 * `hud_get_hotbar_selected_image`: returns texturename
4148 * `set_sky(bgcolor, type, {texture names}, clouds)`
4149 * `bgcolor`: ColorSpec, defaults to white
4150 * `type`: Available types:
4151 * `"regular"`: Uses 0 textures, `bgcolor` ignored
4152 * `"skybox"`: Uses 6 textures, `bgcolor` used
4153 * `"plain"`: Uses 0 textures, `bgcolor` used
4154 * `clouds`: Boolean for whether clouds appear in front of `"skybox"` or
4155 `"plain"` custom skyboxes (default: `true`)
4156 * `get_sky()`: returns bgcolor, type, table of textures, clouds
4157 * `set_clouds(parameters)`: set cloud parameters
4158 * `parameters` is a table with the following optional fields:
4159 * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
4160 * `color`: basic cloud color with alpha channel, ColorSpec
4161 (default `#fff0f0e5`).
4162 * `ambient`: cloud color lower bound, use for a "glow at night" effect.
4163 ColorSpec (alpha ignored, default `#000000`)
4164 * `height`: cloud height, i.e. y of cloud base (default per conf,
4166 * `thickness`: cloud thickness in nodes (default `16`)
4167 * `speed`: 2D cloud speed + direction in nodes per second
4168 (default `{x=0, z=-2}`).
4169 * `get_clouds()`: returns a table with the current cloud parameters as in
4171 * `override_day_night_ratio(ratio or nil)`
4172 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific
4174 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
4175 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
4176 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`:
4177 set animation for player model in third person view
4179 set_local_animation({x=0, y=79}, -- < stand/idle animation key frames
4180 {x=168, y=187}, -- < walk animation key frames
4181 {x=189, y=198}, -- < dig animation key frames
4182 {x=200, y=219}, -- < walk+dig animation key frames
4183 frame_speed=30): -- < animation frame speed
4184 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and
4186 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for
4188 * in first person view
4189 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
4190 * `get_eye_offset()`: returns `offset_first` and `offset_third`
4193 An `InvRef` is a reference to an inventory.
4196 * `is_empty(listname)`: return `true` if list is empty
4197 * `get_size(listname)`: get size of a list
4198 * `set_size(listname, size)`: set size of a list
4199 * returns `false` on error (e.g. invalid `listname` or `size`)
4200 * `get_width(listname)`: get width of a list
4201 * `set_width(listname, width)`: set width of list; currently used for crafting
4202 * `get_stack(listname, i)`: get a copy of stack index `i` in list
4203 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
4204 * `get_list(listname)`: return full list
4205 * `set_list(listname, list)`: set full list (size will not change)
4206 * `get_lists()`: returns list of inventory lists
4207 * `set_lists(lists)`: sets inventory lists (size will not change)
4208 * `add_item(listname, stack)`: add item somewhere in list, returns leftover
4210 * `room_for_item(listname, stack):` returns `true` if the stack of items
4211 can be fully added to the list
4212 * `contains_item(listname, stack, [match_meta])`: returns `true` if
4213 the stack of items can be fully taken from the list.
4214 If `match_meta` is false, only the items' names are compared
4216 * `remove_item(listname, stack)`: take as many items as specified from the
4217 list, returns the items that were actually removed (as an `ItemStack`)
4218 -- note that any item metadata is ignored, so attempting to remove a specific
4219 unique item this way will likely remove the wrong one -- to do that use
4220 `set_stack` with an empty `ItemStack`.
4221 * `get_location()`: returns a location compatible to
4222 `minetest.get_inventory(location)`.
4223 * returns `{type="undefined"}` in case location is not known
4226 A fast access data structure to store areas, and find areas near a given
4228 Every area has a `data` string attribute to store additional information.
4229 You can create an empty `AreaStore` by calling `AreaStore()`, or
4230 `AreaStore(type_name)`.
4231 If you chose the parameter-less constructor, a fast implementation will be
4232 automatically chosen for you.
4235 * `get_area(id, include_borders, include_data)`: returns the area with the id
4237 (optional) Boolean values `include_borders` and `include_data` control what's
4239 Returns nil if specified area id does not exist.
4240 * `get_areas_for_pos(pos, include_borders, include_data)`: returns all areas
4241 that contain the position `pos`.
4242 (optional) Boolean values `include_borders` and `include_data` control what's
4244 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`:
4245 returns all areas that contain all nodes inside the area specified by `edge1`
4246 and `edge2` (inclusive).
4247 If `accept_overlap` is true, also areas are returned that have nodes in
4248 common with the specified area.
4249 (optional) Boolean values `include_borders` and `include_data` control what's
4251 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store.
4252 Returns the new area's ID, or nil if the insertion failed.
4253 The (inclusive) positions `edge1` and `edge2` describe the area.
4254 `data` is a string stored with the area. If passed, `id` will be used as the
4255 internal area ID, it must be a unique number between 0 and 2^32-2. If you use
4256 the `id` parameter you must always use it, or insertions are likely to fail
4258 * `reserve(count)`: reserves resources for at most `count` many contained
4260 Only needed for efficiency, and only some implementations profit.
4261 * `remove_area(id)`: removes the area with the given id from the store, returns
4263 * `set_cache_params(params)`: sets params for the included prefiltering cache.
4264 Calling invalidates the cache, so that its elements have to be newly
4268 enabled = boolean, -- whether to enable, default true
4269 block_radius = number, -- the radius (in nodes) of the areas the cache
4270 generates prefiltered lists for, minimum 16,
4272 limit = number, -- the cache's size, minimum 20, default 1000
4274 * `to_string()`: Experimental. Returns area store serialized as a (binary)
4276 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to
4278 * `from_string(str)`: Experimental. Deserializes string and loads it into the
4280 Returns success and, optionally, an error message.
4281 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data
4285 An `ItemStack` is a stack of items.
4287 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
4288 an itemstring, a table or `nil`.
4291 * `is_empty()`: returns `true` if stack is empty.
4292 * `get_name()`: returns item name (e.g. `"default:stone"`).
4293 * `set_name(item_name)`: returns a boolean indicating whether the item was
4295 * `get_count()`: Returns number of items on the stack.
4296 * `set_count(count)`: returns a boolean indicating whether the item was cleared
4297 * `count`: number, unsigned 16 bit integer
4298 * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
4299 * `set_wear(wear)`: returns boolean indicating whether item was cleared
4300 * `wear`: number, unsigned 16 bit integer
4301 * `get_meta()`: returns ItemStackMetaRef. See section for more details
4302 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
4304 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
4305 * `clear()`: removes all items from the stack, making it empty.
4306 * `replace(item)`: replace the contents of this stack.
4307 * `item` can also be an itemstring or table.
4308 * `to_string()`: returns the stack in itemstring form.
4309 * `to_table()`: returns the stack in Lua table form.
4310 * `get_stack_max()`: returns the maximum size of the stack (depends on the
4312 * `get_free_space()`: returns `get_stack_max() - get_count()`.
4313 * `is_known()`: returns `true` if the item name refers to a defined item type.
4314 * `get_definition()`: returns the item definition table.
4315 * `get_tool_capabilities()`: returns the digging properties of the item,
4316 or those of the hand if none are defined for this item type
4317 * `add_wear(amount)`
4318 * Increases wear by `amount` if the item is a tool
4319 * `amount`: number, integer
4320 * `add_item(item)`: returns leftover `ItemStack`
4321 * Put some item or stack onto this stack
4322 * `item_fits(item)`: returns `true` if item or stack can be fully added to
4324 * `take_item(n)`: returns taken `ItemStack`
4325 * Take (and remove) up to `n` items from this stack
4326 * `n`: number, default: `1`
4327 * `peek_item(n)`: returns taken `ItemStack`
4328 * Copy (don't remove) up to `n` items from this stack
4329 * `n`: number, default: `1`
4332 A 16-bit pseudorandom number generator.
4333 Uses a well-known LCG algorithm introduced by K&R.
4335 It can be created via `PseudoRandom(seed)`.
4338 * `next()`: return next integer random number [`0`...`32767`]
4339 * `next(min, max)`: return next integer random number [`min`...`max`]
4340 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
4341 due to the simple implementation making bad distribution otherwise.
4344 A 32-bit pseudorandom number generator.
4345 Uses PCG32, an algorithm of the permuted congruential generator family,
4346 offering very strong randomness.
4348 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
4351 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
4352 * `next(min, max)`: return next integer random number [`min`...`max`]
4353 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed
4354 random number [`min`...`max`].
4355 * This is only a rough approximation of a normal distribution with:
4356 * `mean = (max - min) / 2`, and
4357 * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
4358 * Increasing `num_trials` improves accuracy of the approximation
4361 Interface for the operating system's crypto-secure PRNG.
4363 It can be created via `SecureRandom()`. The constructor returns nil if a
4364 secure random device cannot be found on the system.
4367 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many
4368 random bytes, as a string.
4371 A perlin noise generator.
4372 It can be created via `PerlinNoise(seed, octaves, persistence, scale)`
4373 or `PerlinNoise(noiseparams)`.
4374 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
4375 or `minetest.get_perlin(noiseparams)`.
4378 * `get_2d(pos)`: returns 2D noise value at `pos={x=,y=}`
4379 * `get_3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
4381 ### `PerlinNoiseMap`
4382 A fast, bulk perlin noise generator.
4384 It can be created via `PerlinNoiseMap(noiseparams, size)` or
4385 `minetest.get_perlin_map(noiseparams, size)`.
4387 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
4388 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
4391 For each of the functions with an optional `buffer` parameter: If `buffer` is
4392 not nil, this table will be used to store the result instead of creating a new
4396 * `get_2d_map(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
4397 with values starting at `pos={x=,y=}`
4398 * `get_3d_map(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>`
4399 3D array of 3D noise with values starting at `pos={x=,y=,z=}`.
4400 * `get_2d_map_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element
4401 array of 2D noise with values starting at `pos={x=,y=}`
4402 * `get_3d_map_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
4403 * `calc_2d_map(pos)`: Calculates the 2d noise map starting at `pos`. The result
4404 is stored internally.
4405 * `calc_3d_map(pos)`: Calculates the 3d noise map starting at `pos`. The result
4406 is stored internally.
4407 * `get_map_slice(slice_offset, slice_size, buffer)`: In the form of an array,
4408 returns a slice of the most recently computed noise results. The result slice
4409 begins at coordinates `slice_offset` and takes a chunk of `slice_size`.
4410 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer
4412 `noisevals = noise:get_map_slice({y=20}, {y=2})`
4413 It is important to note that `slice_offset` offset coordinates begin at 1,
4414 and are relative to the starting position of the most recently calculated
4416 To grab a single vertical column of noise starting at map coordinates
4417 x = 1023, y=1000, z = 1000:
4418 `noise:calc_3d_map({x=1000, y=1000, z=1000})`
4419 `noisevals = noise:get_map_slice({x=24, z=1}, {x=1, z=1})`
4423 #### About VoxelManip
4424 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator'
4425 facility. The purpose of this object is for fast, low-level, bulk access to
4426 reading and writing Map content. As such, setting map nodes through VoxelManip
4427 will lack many of the higher level features and concepts you may be used to
4428 with other methods of setting nodes. For example, nodes will not have their
4429 construction and destruction callbacks run, and no rollback information is
4432 It is important to note that VoxelManip is designed for speed, and *not* ease
4433 of use or flexibility. If your mod requires a map manipulation facility that
4434 will handle 100% of all edge cases, or the use of high level node placement
4435 features, perhaps `minetest.set_node()` is better suited for the job.
4437 In addition, VoxelManip might not be faster, or could even be slower, for your
4438 specific use case. VoxelManip is most effective when setting large areas of map
4439 at once - for example, if only setting a 3x3x3 node area, a
4440 `minetest.set_node()` loop may be more optimal. Always profile code using both
4441 methods of map manipulation to determine which is most appropriate for your
4444 A recent simple test of setting cubic areas showed that `minetest.set_node()`
4445 is faster than a VoxelManip for a 3x3x3 node cube or smaller.
4447 #### Using VoxelManip
4448 A VoxelManip object can be created any time using either:
4449 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
4451 If the optional position parameters are present for either of these routines,
4452 the specified region will be pre-loaded into the VoxelManip object on creation.
4453 Otherwise, the area of map you wish to manipulate must first be loaded into the
4454 VoxelManip object using `VoxelManip:read_from_map()`.
4456 Note that `VoxelManip:read_from_map()` returns two position vectors. The region
4457 formed by these positions indicate the minimum and maximum (respectively)
4458 positions of the area actually loaded in the VoxelManip, which may be larger
4459 than the area requested. For convenience, the loaded area coordinates can also
4460 be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
4462 Now that the VoxelManip object is populated with map data, your mod can fetch a
4463 copy of this data using either of two methods. `VoxelManip:get_node_at()`,
4464 which retrieves an individual node in a MapNode formatted table at the position
4465 requested is the simplest method to use, but also the slowest.
4467 Nodes in a VoxelManip object may also be read in bulk to a flat array table
4470 * `VoxelManip:get_data()` for node content (in Content ID form, see section
4472 * `VoxelManip:get_light_data()` for node light levels, and
4473 * `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
4475 See section 'Flat array format' for more details.
4477 It is very important to understand that the tables returned by any of the above
4478 three functions represent a snapshot of the VoxelManip's internal state at the
4479 time of the call. This copy of the data will not magically update itself if
4480 another function modifies the internal VoxelManip state.
4481 Any functions that modify a VoxelManip's contents work on the VoxelManip's
4482 internal state unless otherwise explicitly stated.
4484 Once the bulk data has been edited to your liking, the internal VoxelManip
4485 state can be set using:
4487 * `VoxelManip:set_data()` for node content (in Content ID form, see section
4489 * `VoxelManip:set_light_data()` for node light levels, and
4490 * `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
4492 The parameter to each of the above three functions can use any table at all in
4493 the same flat array format as produced by `get_data()` etc. and is not required
4494 to be a table retrieved from `get_data()`.
4496 Once the internal VoxelManip state has been modified to your liking, the
4497 changes can be committed back to the map by calling `VoxelManip:write_to_map()`
4500 ##### Flat array format
4502 `Nx = p2.X - p1.X + 1`,
4503 `Ny = p2.Y - p1.Y + 1`, and
4504 `Nz = p2.Z - p1.Z + 1`.
4506 Then, for a loaded region of p1..p2, this array ranges from `1` up to and
4507 including the value of the expression `Nx * Ny * Nz`.
4509 Positions offset from p1 are present in the array with the format of:
4513 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
4514 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
4516 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
4517 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
4519 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
4521 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
4525 and the array index for a position p contained completely in p1..p2 is:
4527 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
4529 Note that this is the same "flat 3D array" format as
4530 `PerlinNoiseMap:get3dMap_flat()`.
4531 VoxelArea objects (see section 'VoxelArea') can be used to simplify calculation
4532 of the index for a single point in a flat VoxelManip array.
4535 A Content ID is a unique integer identifier for a specific node type.
4536 These IDs are used by VoxelManip in place of the node name string for
4537 `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
4538 `minetest.get_content_id()` to look up the Content ID for the specified node
4539 name, and `minetest.get_name_from_content_id()` to look up the node name string
4540 for a given Content ID.
4541 After registration of a node, its Content ID will remain the same throughout
4542 execution of the mod.
4543 Note that the node being queried needs to have already been been registered.
4545 The following builtin node types have their Content IDs defined as constants:
4547 * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
4548 * `minetest.CONTENT_AIR`: ID for "air" nodes
4549 * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
4551 ##### Mapgen VoxelManip objects
4552 Inside of `on_generated()` callbacks, it is possible to retrieve the same
4553 VoxelManip object used by the core's Map Generator (commonly abbreviated
4554 Mapgen). Most of the rules previously described still apply but with a few
4557 * The Mapgen VoxelManip object is retrieved using:
4558 `minetest.get_mapgen_object("voxelmanip")`
4559 * This VoxelManip object already has the region of map just generated loaded
4560 into it; it's not necessary to call `VoxelManip:read_from_map()` before using
4561 a Mapgen VoxelManip.
4562 * The `on_generated()` callbacks of some mods may place individual nodes in the
4563 generated area using non-VoxelManip map modification methods. Because the
4564 same Mapgen VoxelManip object is passed through each `on_generated()`
4565 callback, it becomes necessary for the Mapgen VoxelManip object to maintain
4566 consistency with the current map state. For this reason, calling any of the
4567 following functions:
4568 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
4569 will also update the Mapgen VoxelManip object's internal state active on the
4571 * After modifying the Mapgen VoxelManip object's internal buffer, it may be
4572 necessary to update lighting information using either:
4573 `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
4575 ##### Other API functions operating on a VoxelManip
4576 If any VoxelManip contents were set to a liquid node,
4577 `VoxelManip:update_liquids()` must be called for these liquid nodes to begin
4578 flowing. It is recommended to call this function only after having written all
4579 buffered data back to the VoxelManip object, save for special situations where
4580 the modder desires to only have certain liquid nodes begin flowing.
4582 The functions `minetest.generate_ores()` and `minetest.generate_decorations()`
4583 will generate all registered decorations and ores throughout the full area
4584 inside of the specified VoxelManip object.
4586 `minetest.place_schematic_on_vmanip()` is otherwise identical to
4587 `minetest.place_schematic()`, except instead of placing the specified schematic
4588 directly on the map at the specified position, it will place the schematic
4589 inside the VoxelManip.
4592 * Attempting to read data from a VoxelManip object before map is read will
4593 result in a zero-length array table for `VoxelManip:get_data()`, and an
4594 "ignore" node at any position for `VoxelManip:get_node_at()`.
4595 * If either a region of map has not yet been generated or is out-of-bounds of
4596 the map, that region is filled with "ignore" nodes.
4597 * Other mods, or the core itself, could possibly modify the area of map
4598 currently loaded into a VoxelManip object. With the exception of Mapgen
4599 VoxelManips (see above section), the internal buffers are not updated. For
4600 this reason, it is strongly encouraged to complete the usage of a particular
4601 VoxelManip object in the same callback it had been created.
4602 * If a VoxelManip object will be used often, such as in an `on_generated()`
4603 callback, consider passing a file-scoped table as the optional parameter to
4604 `VoxelManip:get_data()`, which serves as a static buffer the function can use
4605 to write map data to instead of returning a new table each call. This greatly
4606 enhances performance by avoiding unnecessary memory allocations.
4609 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object
4610 containing the region formed by `p1` and `p2`.
4611 * returns actual emerged `pmin`, actual emerged `pmax`
4612 * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to
4614 * **important**: data must be set using `VoxelManip:set_data()` before
4616 * if `light` is true, then lighting is automatically recalculated.
4617 The default value is true.
4618 If `light` is false, no light calculations happen, and you should correct
4619 all modified blocks with `minetest.fix_light()` as soon as possible.
4620 Keep in mind that modifying the map where light is incorrect can cause
4622 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
4623 the `VoxelManip` at that position
4624 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
4626 * `get_data([buffer])`: Retrieves the node content data loaded into the
4627 `VoxelManip` object.
4628 * returns raw node data in the form of an array of node content IDs
4629 * if the param `buffer` is present, this table will be used to store the
4631 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
4632 * `update_map()`: Does nothing, kept for compatibility.
4633 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to
4635 * `light` is a table, `{day=<0...15>, night=<0...15>}`
4636 * To be used only by a `VoxelManip` object from
4637 `minetest.get_mapgen_object`.
4638 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4640 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
4641 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4643 * Each value is the bitwise combination of day and night light values
4645 * `light = day + (night * 16)`
4646 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
4647 in the `VoxelManip`.
4648 * expects lighting data in the same format that `get_light_data()` returns
4649 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the
4650 `VoxelManip` object.
4651 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4653 * If the param `buffer` is present, this table will be used to store the
4655 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in
4657 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the
4659 * To be used only by a `VoxelManip` object from
4660 `minetest.get_mapgen_object`.
4661 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4662 area if left out or nil.
4663 * `propagate_shadow` is an optional boolean deciding whether shadows in a
4664 generated mapchunk above are propagated down into the mapchunk, defaults
4665 to `true` if left out.
4666 * `update_liquids()`: Update liquid flow
4667 * `was_modified()`: Returns `true` or `false` if the data in the voxel
4668 manipulator had been modified since the last read from map, due to a call to
4669 `minetest.set_data()` on the loaded area elsewhere.
4670 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
4673 A helper class for voxel areas.
4674 It can be created via `VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}`.
4675 The coordinates are *inclusive*, like most other things in Minetest.
4678 * `getExtent()`: returns a 3D vector containing the size of the area formed by
4679 `MinEdge` and `MaxEdge`.
4680 * `getVolume()`: returns the volume of the area formed by `MinEdge` and
4682 * `index(x, y, z)`: returns the index of an absolute position in a flat array
4684 * useful for things like `VoxelManip`, raw Schematic specifiers,
4685 `PerlinNoiseMap:get2d`/`3dMap`, and so on.
4686 * `indexp(p)`: same as above, except takes a vector
4687 * `position(i)`: returns the absolute position vector corresponding to index
4689 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by
4690 `MinEdge` and `MaxEdge`.
4691 * `containsp(p)`: same as above, except takes a vector
4692 * `containsi(i)`: same as above, except takes an index `i`
4693 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns
4695 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of
4697 * `iterp(minp, maxp)`: same as above, except takes a vector
4700 An interface to read config files in the format of `minetest.conf`.
4702 It can be created via `Settings(filename)`.
4705 * `get(key)`: returns a value
4706 * `get_bool(key, [default])`: returns a boolean
4707 * `default` is the value returned if `key` is not found.
4708 * Returns `nil` if `key` is not found and `default` not specified.
4709 * `get_np_group(key)`: returns a NoiseParams table
4711 * Setting names can't contain whitespace or any of `="{}#`.
4712 * Setting values can't contain the sequence `\n"""`.
4713 * Setting names starting with "secure." can't be set on the main settings
4714 object (`minetest.settings`).
4715 * `set_bool(key, value)`
4716 * See documentation for set() above.
4717 * `set_np_group(key, value)`
4718 * `value` is a NoiseParams table.
4719 * Also, see documentation for set() above.
4720 * `remove(key)`: returns a boolean (`true` for success)
4721 * `get_names()`: returns `{key1,...}`
4722 * `write()`: returns a boolean (`true` for success)
4723 * Writes changes to file.
4724 * `to_table()`: returns `{[key1]=value1,...}`
4727 A raycast on the map. It works with selection boxes.
4728 Can be used as an iterator in a for loop.
4730 The map is loaded as the ray advances. If the
4731 map is modified after the `Raycast` is created,
4732 the changes may or may not have an effect on
4735 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
4736 `minetest.raycast(pos1, pos2, objects, liquids)` where:
4737 * `pos1`: start of the ray
4738 * `pos2`: end of the ray
4739 * `objects` : if false, only nodes will be returned. Default is true.
4740 * `liquids' : if false, liquid nodes won't be returned. Default is false.
4743 * `next()`: returns a `pointed_thing`
4744 * Returns the next thing pointed by the ray or nil.
4748 A mapgen object is a construct used in map generation. Mapgen objects can be
4749 used by an `on_generate` callback to speed up operations by avoiding
4750 unnecessary recalculations, these can be retrieved using the
4751 `minetest.get_mapgen_object()` function. If the requested Mapgen object is
4752 unavailable, or `get_mapgen_object()` was called outside of an `on_generate()`
4753 callback, `nil` is returned.
4755 The following Mapgen objects are currently available:
4758 This returns three values; the `VoxelManip` object to be used, minimum and
4759 maximum emerged position, in that order. All mapgens support this object.
4762 Returns an array containing the y coordinates of the ground levels of nodes in
4763 the most recently generated chunk by the current mapgen.
4766 Returns an array containing the biome IDs of nodes in the most recently
4767 generated chunk by the current mapgen.
4770 Returns an array containing the temperature values of nodes in the most
4771 recently generated chunk by the current mapgen.
4774 Returns an array containing the humidity values of nodes in the most recently
4775 generated chunk by the current mapgen.
4778 Returns a table mapping requested generation notification types to arrays of
4779 positions at which the corresponding generated structures are located within
4780 the current chunk. To set the capture of positions of interest to be recorded
4781 on generate, use `minetest.set_gen_notify()`.
4782 For decorations, the returned positions are the ground surface 'place_on'
4783 nodes, not the decorations themselves. A 'simple' type decoration is often 1
4784 node above the returned position and possibly displaced by 'place_offset_y'.
4786 Possible fields of the table returned are:
4792 * `large_cave_begin`
4796 Decorations have a key in the format of `"decoration#id"`, where `id` is the
4797 numeric unique decoration ID.
4801 * Functions receive a "luaentity" as `self`:
4802 * It has the member `.name`, which is the registered name `("mod:thing")`
4803 * It has the member `.object`, which is an `ObjectRef` pointing to the
4805 * The original prototype stuff is visible directly via a metatable
4807 * `on_activate(self, staticdata, dtime_s)`
4808 * Called when the object is instantiated.
4809 * `dtime_s` is the time passed since the object was unloaded, which can
4810 be used for updating the entity state.
4811 * `on_step(self, dtime)`
4812 * Called on every server tick, after movement and collision processing.
4813 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step`
4814 setting `in minetest.conf`.
4815 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)`
4816 * Called when somebody punches the object.
4817 * Note that you probably want to handle most punches using the
4818 automatic armor group system.
4819 * `puncher`: an `ObjectRef` (can be `nil`)
4820 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4822 * `tool_capabilities`: capability table of used tool (can be `nil`)
4823 * `dir`: unit vector of direction of punch. Always defined. Points from
4824 the puncher to the punched.
4825 * `on_death(self, killer)`
4826 * Called when the object dies.
4827 * `killer`: an `ObjectRef` (can be `nil`)
4828 * `on_rightclick(self, clicker)`
4829 * `get_staticdata(self)`
4830 * Should return a string that will be passed to `on_activate` when
4831 the object is instantiated the next time.
4839 axiom, --string initial tree axiom
4840 rules_a, --string rules set A
4841 rules_b, --string rules set B
4842 rules_c, --string rules set C
4843 rules_d, --string rules set D
4844 trunk, --string trunk node name
4845 leaves, --string leaves node name
4846 leaves2, --string secondary leaves node name
4847 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
4848 angle, --num angle in deg
4849 iterations, --num max # of iterations, usually 2 -5
4850 random_level, --num factor to lower nr of iterations, usually 0 - 3
4851 trunk_type, --string single/double/crossed) type of trunk: 1 node,
4852 -- 2x2 nodes or 3x3 in cross shape
4853 thin_branches, --boolean true -> use thin (1 node) branches
4854 fruit, --string fruit node name
4855 fruit_chance, --num chance (0-100) to replace leaves with fruit node
4856 seed, --num random seed, if no seed is provided, the engine
4860 ### Key for Special L-System Symbols used in Axioms
4862 * `G`: move forward one unit with the pen up
4863 * `F`: move forward one unit with the pen down drawing trunks and branches
4864 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
4865 * `T`: move forward one unit with the pen down drawing trunks only
4866 * `R`: move forward one unit with the pen down placing fruit
4867 * `A`: replace with rules set A
4868 * `B`: replace with rules set B
4869 * `C`: replace with rules set C
4870 * `D`: replace with rules set D
4871 * `a`: replace with rules set A, chance 90%
4872 * `b`: replace with rules set B, chance 80%
4873 * `c`: replace with rules set C, chance 70%
4874 * `d`: replace with rules set D, chance 60%
4875 * `+`: yaw the turtle right by `angle` parameter
4876 * `-`: yaw the turtle left by `angle` parameter
4877 * `&`: pitch the turtle down by `angle` parameter
4878 * `^`: pitch the turtle up by `angle` parameter
4879 * `/`: roll the turtle to the right by `angle` parameter
4880 * `*`: roll the turtle to the left by `angle` parameter
4881 * `[`: save in stack current state info
4882 * `]`: recover from stack state info
4885 Spawn a small apple tree:
4887 pos = {x=230,y=20,z=4}
4890 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
4891 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
4892 trunk="default:tree",
4893 leaves="default:leaves",
4897 trunk_type="single",
4900 fruit="default:apple"
4902 minetest.spawn_tree(pos,apple_tree)
4907 ### Object Properties
4911 -- ^ For players: Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`
4913 -- ^ For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`
4915 -- ^ For players only. Zoom FOV in degrees.
4916 -- Note that zoom loads and/or generates world beyond the server's
4917 -- maximum send and generate distances, so acts like a telescope.
4918 -- Smaller zoomFOV values increase the distance loaded and/or generated.
4919 -- Defaults to 15 in creative mode, 0 in survival mode.
4920 -- zoom_fov = 0 disables zooming for the player.
4922 -- ^ For players only. Camera height above feet position in nodes.
4923 -- Defaults to 1.625.
4925 collide_with_objects = true,
4926 -- ^ Collide with other objects if physical = true.
4928 collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
4929 selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
4930 -- ^ Default, uses collision box dimensions when not set.
4931 -- ^ For both boxes: {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from
4934 -- ^ Overrides selection box when false.
4935 visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem",
4936 -- ^ "cube" is a node-sized cube.
4937 -- ^ "sprite" is a flat texture always facing the player.
4938 -- ^ "upright_sprite" is a vertical flat texture.
4939 -- ^ "mesh" uses the defined mesh model.
4940 -- ^ "wielditem" is used for dropped items
4941 -- (see builtin/game/item_entity.lua).
4942 -- For this use 'textures = {itemname}'.
4943 -- If the item has a 'wield_image' the object will be an extrusion of
4945 -- If 'itemname' is a cubic node or nodebox the object will appear
4946 -- identical to 'itemname'.
4947 -- If 'itemname' is a plantlike node the object will be an extrusion of
4949 -- Otherwise for non-node items, the object will be an extrusion of
4950 -- 'inventory_image'.
4951 visual_size = {x = 1, y = 1},
4952 -- ^ `x` multiplies horizontal (X and Z) visual size.
4953 -- ^ `y` multiplies vertical (Y) visual size.
4956 -- ^ Number of required textures depends on visual.
4957 -- ^ "cube" uses 6 textures in the way a node does.
4958 -- ^ "sprite" uses 1 texture.
4959 -- ^ "upright_sprite" uses 2 textures: {front, back}.
4960 -- ^ "wielditem" expects 'textures = {itemname}' (see 'visual' above).
4962 -- ^ Number of required colors depends on visual.
4963 use_texture_alpha = false,
4964 -- ^ Use texture's alpha channel, excludes "upright_sprite" and "wielditem"
4965 -- ^ Note: currently causes visual issues when viewed through other
4966 -- ^ semi-transparent materials such as water.
4967 spritediv = {x = 1, y = 1},
4968 -- ^ Used with spritesheet textures for animation and/or frame selection
4969 -- according to position relative to player.
4970 -- ^ Defines the number of columns and rows in the spritesheet:
4972 initial_sprite_basepos = {x = 0, y = 0},
4973 -- ^ Used with spritesheet textures.
4974 -- ^ Defines the {column, row} position of the initially used frame in the
4977 makes_footstep_sound = false,
4978 automatic_rotate = 0,
4979 -- ^ Set constant rotation in radians per second, positive or negative.
4980 -- ^ Set to 0 to disable constant rotation.
4982 automatic_face_movement_dir = 0.0,
4983 -- ^ Automatically set yaw to movement direction, offset in degrees,
4984 -- 'false' to disable.
4985 automatic_face_movement_max_rotation_per_sec = -1,
4986 -- ^ Limit automatic rotation to this value in degrees per second,
4987 -- value < 0 no limit.
4988 backface_culling = true,
4989 -- ^ Set to false to disable backface_culling for model.
4991 -- ^ Add this much extra lighting when calculating texture color.
4992 -- Value < 0 disables light's effect on texture color.
4993 -- For faking self-lighting, UI style entities, or programmatic coloring
4996 -- ^ By default empty, for players their name is shown if empty.
4997 nametag_color = <color>,
4998 -- ^ Sets color of nametag as ColorSpec.
5000 -- ^ By default empty, text to be shown when pointed at object.
5002 -- ^ If false, never save this object statically. It will simply be
5003 -- deleted when the block gets unloaded.
5004 -- The get_staticdata() callback is never called then.
5005 -- Defaults to 'true'
5008 ### Entity definition (`register_entity`)
5011 -- Deprecated: Everything in object properties is read directly from here
5013 initial_properties = --[[<initial object properties>]],
5015 on_activate = function(self, staticdata, dtime_s),
5016 on_step = function(self, dtime),
5017 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
5018 on_rightclick = function(self, clicker),
5019 get_staticdata = function(self),
5020 -- ^ Called sometimes; the string returned is passed to on_activate when
5021 -- the entity is re-activated from static state
5023 _custom_field = whatever,
5024 -- ^ You can define arbitrary member variables here (see item definition
5025 -- for more info) by using a '_' prefix.
5028 ### ABM (ActiveBlockModifier) definition (`register_abm`)
5031 label = "Lava cooling",
5032 ^ Descriptive label for profiling purposes (optional).
5033 Definitions with identical labels will be listed as one.
5034 nodenames = {"default:lava_source"},
5035 ^ Apply `action` function to these nodes.
5036 ^ `group:groupname` can also be used here.
5037 neighbors = {"default:water_source", "default:water_flowing"},
5038 ^ Only apply `action` to nodes that have one of, or any
5039 combination of, these neighbors.
5040 ^ If left out or empty, any neighbor will do.
5041 ^ `group:groupname` can also be used here.
5043 ^ Operation interval in seconds.
5045 ^ Chance of triggering `action` per-node per-interval is 1.0 / this
5048 ^ If true, catch-up behaviour is enabled: The `chance` value is
5049 temporarily reduced when returning to an area to simulate time lost
5050 by the area being unattended. Note that the `chance` value can often
5052 action = function(pos, node, active_object_count, active_object_count_wider),
5053 ^ Function triggered for each qualifying node.
5054 ^ `active_object_count` is number of active objects in the node's
5056 ^ `active_object_count_wider` is number of active objects in the node's
5057 mapblock plus all 26 neighboring mapblocks. If any neighboring
5058 mapblocks are unloaded an estmate is calculated for them based on
5062 ### LBM (LoadingBlockModifier) definition (`register_lbm`)
5065 label = "Upgrade legacy doors",
5066 -- ^ Descriptive label for profiling purposes (optional).
5067 -- Definitions with identical labels will be listed as one.
5068 name = "modname:replace_legacy_door",
5069 nodenames = {"default:lava_source"},
5070 -- ^ List of node names to trigger the LBM on.
5071 -- Also non-registered nodes will work.
5072 -- Groups (as of group:groupname) will work as well.
5073 run_at_every_load = false,
5074 -- ^ Whether to run the LBM's action every time a block gets loaded,
5075 -- and not just for blocks that were saved last time before LBMs were
5076 -- introduced to the world.
5077 action = func(pos, node),
5080 ### Item definition (`register_node`, `register_craftitem`, `register_tool`)
5083 description = "Steel Axe",
5084 groups = {}, -- key = name, value = rating; rating = 1..3.
5085 if rating not applicable, use 1.
5086 e.g. {wool = 1, fluffy = 3}
5087 {soil = 2, outerspace = 1, crumbly = 1}
5088 {bendy = 2, snappy = 1},
5089 {hard = 1, metal = 1, spikes = 1}
5090 inventory_image = "default_tool_steelaxe.png",
5091 inventory_overlay = "overlay.png",
5092 ^ An overlay which does not get colorized.
5097 ^ An image file containing the palette of a node.
5098 ^ You can set the currently used color as the
5099 ^ "palette_index" field of the item stack metadata.
5100 ^ The palette is always stretched to fit indices
5101 ^ between 0 and 255, to ensure compatibility with
5102 ^ "colorfacedir" and "colorwallmounted" nodes.
5104 color = "0xFFFFFFFF",
5105 ^ The color of the item. The palette overrides this.
5106 wield_scale = {x = 1, y = 1, z = 1},
5109 liquids_pointable = false,
5110 tool_capabilities = {
5111 full_punch_interval = 1.0,
5115 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00},
5116 uses = 20, maxlevel = 2},
5118 damage_groups = {groupname = damage},
5120 node_placement_prediction = nil,
5122 ^ If nil and item is node, prediction is made automatically
5123 ^ If nil and item is not a node, no prediction is made
5124 ^ If "" and item is anything, no prediction is made
5125 ^ Otherwise should be name of node which the client immediately places
5126 on ground when the player places the item. Server will always update
5127 actual result to client in a short moment.
5129 node_dig_prediction = "air",
5131 ^ if "", no prediction is made
5132 ^ if "air", node is removed
5133 ^ Otherwise should be name of node which the client immediately places
5134 upon digging. Server will always update actual result shortly.
5137 breaks = "default_tool_break", -- tools only
5138 place = --[[<SimpleSoundSpec>]],
5141 on_place = func(itemstack, placer, pointed_thing),
5143 ^ Shall place item and return the leftover itemstack
5144 ^ The placer may be any ObjectRef or nil.
5145 ^ default: minetest.item_place ]]
5146 on_secondary_use = func(itemstack, user, pointed_thing),
5148 ^ Same as on_place but called when pointing at nothing.
5149 ^ The user may be any ObjectRef or nil.
5150 ^ pointed_thing : always { type = "nothing" }
5152 on_drop = func(itemstack, dropper, pos),
5154 ^ Shall drop item and return the leftover itemstack
5155 ^ The dropper may be any ObjectRef or nil.
5156 ^ default: minetest.item_drop ]]
5157 on_use = func(itemstack, user, pointed_thing),
5160 ^ Function must return either nil if no item shall be removed from
5161 inventory, or an itemstack to replace the original itemstack.
5162 e.g. itemstack:take_item(); return itemstack
5163 ^ Otherwise, the function is free to do what it wants.
5164 ^ The user may be any ObjectRef or nil.
5165 ^ The default functions handle regular use cases.
5167 after_use = func(itemstack, user, node, digparams),
5170 ^ If defined, should return an itemstack and will be called instead of
5171 wearing out the tool. If returns nil, does nothing.
5172 If after_use doesn't exist, it is the same as:
5173 function(itemstack, user, node, digparams)
5174 itemstack:add_wear(digparams.wear)
5177 ^ The user may be any ObjectRef or nil.
5179 _custom_field = whatever,
5181 ^ Add your own custom fields. By convention, all custom field names
5182 should start with `_` to avoid naming collisions with future engine
5189 * `{name="image.png", animation={Tile Animation definition}}`
5190 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
5191 tileable_horizontal=bool, align_style="node"/"world"/"user", scale=int}`
5192 * backface culling enabled by default for most nodes
5193 * tileable flags are info for shaders, how they should treat texture
5194 when displacement mapping is used
5195 Directions are from the point of view of the tile texture,
5196 not the node it's on
5197 * align style determines whether the texture will be rotated with the node
5198 or kept aligned with its surroundings. "user" means that client
5199 setting will be used, similar to `glasslike_framed_optional`.
5200 Note: supported by solid nodes and nodeboxes only.
5201 * scale is used to make texture span several (exactly `scale`) nodes,
5202 instead of just one, in each direction. Works for world-aligned
5204 Note that as the effect is applied on per-mapblock basis, `16` should
5205 be equally divisible by `scale` or you may get wrong results.
5206 * `{name="image.png", color=ColorSpec}`
5207 * the texture's color will be multiplied with this color.
5208 * the tile's color overrides the owning node's color in all cases.
5209 * deprecated, yet still supported field names:
5212 ### Tile animation definition
5215 type = "vertical_frames",
5217 -- ^ specify width of a frame in pixels
5219 -- ^ specify height of a frame in pixels
5221 -- ^ specify full loop length
5227 -- ^ specify width in number of frames
5229 -- ^ specify height in number of frames
5231 -- ^ specify length of a single frame
5234 ### Node definition (`register_node`)
5237 -- <all fields allowed in item definitions>,
5239 drawtype = "normal", -- See "Node drawtypes"
5240 visual_scale = 1.0, --[[
5241 ^ Supported for drawtypes "plantlike", "signlike", "torchlike",
5242 ^ "firelike", "mesh".
5243 ^ For plantlike and firelike, the image will start at the bottom of the
5244 ^ node, for the other drawtypes the image will be centered on the node.
5245 ^ Note that positioning for "torchlike" may still change. ]]
5246 tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
5247 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z
5248 ^ Old field name was 'tile_images'.
5249 ^ List can be shortened to needed length ]]
5250 overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
5251 ^ Same as `tiles`, but these textures are drawn on top of the
5252 ^ base tiles. You can use this to colorize only specific parts of
5253 ^ your texture. If the texture name is an empty string, that
5254 ^ overlay is not drawn. Since such tiles are drawn twice, it
5255 ^ is not recommended to use overlays on very common nodes. ]]
5256 special_tiles = {tile definition 1, Tile definition 2}, --[[
5257 ^ Special textures of node; used rarely
5258 ^ Old field name was 'special_materials'.
5259 ^ List can be shortened to needed length ]]
5260 color = ColorSpec, --[[
5261 ^ The node's original color will be multiplied with this color.
5262 ^ If the node has a palette, then this setting only has an effect
5263 ^ in the inventory and on the wield item. ]]
5264 use_texture_alpha = false,
5265 ^ Use texture's alpha channel.
5266 palette = "palette.png", --[[
5267 ^ The node's `param2` is used to select a pixel from the image
5268 ^ (pixels are arranged from left to right and from top to bottom).
5269 ^ The node's color will be multiplied with the selected pixel's
5270 ^ color. Tiles can override this behavior.
5271 ^ Only when `paramtype2` supports palettes. ]]
5272 post_effect_color = "green#0F",
5273 ^ Screen tint if player is inside node, see "ColorSpec".
5274 paramtype = "none", --[[
5276 ^ paramtype = "light" allows light to propagate from or through the
5277 ^ node with light value falling by 1 per node. This line is essential
5278 ^ for a light source node to spread its light. ]]
5279 paramtype2 = "none", -- See "Nodes"
5280 place_param2 = nil, -- Force value for param2 when player places node
5281 is_ground_content = true,
5282 ^ If false, the cave generator will not carve through this node.
5283 sunlight_propagates = false,
5284 ^ If true, sunlight will go infinitely through this.
5285 walkable = true, -- If true, objects collide with node
5286 pointable = true, -- If true, can be pointed at
5287 diggable = true, -- If false, can never be dug
5288 climbable = false, -- If true, can be climbed on (ladder)
5289 buildable_to = false, -- If true, placed nodes can replace this node
5290 floodable = false, --[[
5291 ^ If true, liquids flow into and replace this node.
5292 ^ Warning: making a liquid node 'floodable' will cause problems. ]]
5293 liquidtype = "none", -- "none"/"source"/"flowing"
5294 liquid_alternative_flowing = "", -- Flowing version of source liquid
5295 liquid_alternative_source = "", -- Source version of flowing liquid
5296 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
5297 liquid_renewable = true, --[[
5298 ^ If true, a new liquid source can be created by placing two or more
5301 ^ Only valid for "nodebox" drawtype with 'type = "leveled"'.
5302 ^ Allows defining the nodebox height without using param2.
5303 ^ The nodebox height is 'leveled' / 64 nodes.
5304 ^ The maximum value of 'leveled' is 127. ]]
5305 liquid_range = 8, -- number of flowing nodes around source (max. 8)
5307 ^ Player will take this amount of damage if no bubbles are left.
5308 light_source = 0, --[[
5309 ^ Amount of light emitted by node.
5310 ^ To set the maximum (currently 14), use the value
5311 ^ 'minetest.LIGHT_MAX'.
5312 ^ A value outside the range 0 to minetest.LIGHT_MAX causes undefined
5314 damage_per_second = 0,
5315 ^ If player is inside node, this damage is caused.
5316 node_box = {type="regular"}, -- See "Node boxes"
5317 connects_to = nodenames, --[[
5318 ^ Used for nodebox nodes with the type == "connected"
5319 ^ Specifies to what neighboring nodes connections will be drawn
5320 ^ e.g. `{"group:fence", "default:wood"}` or `"default:stone"` ]]
5321 connect_sides = { "top", "bottom", "front", "left", "back", "right" },
5323 ^ Tells connected nodebox nodes to connect only to these sides of this
5326 selection_box = {type="regular"}, --[[
5328 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box
5330 legacy_facedir_simple = false,
5331 ^ Support maps made in and before January 2012.
5332 legacy_wallmounted = false,
5333 ^ Support maps made in and before January 2012.
5335 ^ Valid for mesh, nodebox, plantlike, allfaces_optional nodes.
5336 ^ 1 - wave node like plants (top of node moves, bottom is fixed)
5337 ^ 2 - wave node like leaves (whole node moves side-to-side)
5338 ^ caveats: not all models will properly wave.
5339 ^ plantlike drawtype nodes can only wave like plants.
5340 ^ allfaces_optional drawtype nodes can only wave like leaves. --]]
5342 footstep = <SimpleSoundSpec>,
5343 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
5344 dug = <SimpleSoundSpec>,
5345 place = <SimpleSoundSpec>,
5346 place_failed = <SimpleSoundSpec>,
5349 ^ Name of dropped node when dug. Default is the node itself.
5352 max_items = 1, -- Maximum number of items to drop.
5353 items = { -- Choose max_items randomly from this list.
5355 items = {"foo:bar", "baz:frob"}, -- Items to drop.
5356 rarity = 1, -- Probability of dropping is 1 / rarity.
5357 inherit_color = true, -- To inherit palette color from the
5363 on_construct = func(pos), --[[
5364 ^ Node constructor; called after adding node
5365 ^ Can set up metadata and stuff like that
5366 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
5369 on_destruct = func(pos), --[[
5370 ^ Node destructor; called before removing node
5371 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
5374 after_destruct = func(pos, oldnode), --[[
5375 ^ Node destructor; called after removing node
5376 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
5379 on_flood = func(pos, oldnode, newnode), --[[
5380 ^ Called when a liquid (newnode) is about to flood oldnode, if
5381 ^ it has `floodable = true` in the nodedef. Not called for bulk
5382 ^ node placement (i.e. schematics and VoxelManip) or air nodes. If
5383 ^ return true the node is not flooded, but on_flood callback will
5384 ^ most likely be called over and over again every liquid update
5385 ^ interval. Default: nil.
5386 ^ Warning: making a liquid node 'floodable' will cause problems. ]]
5388 preserve_metadata = func(pos, oldnode, oldmeta, drops) --[[
5389 ^ Called when oldnode is about be converted to an item, but before the
5390 ^ node is deleted from the world or the drops are added. This is
5391 ^ generally the result of either the node being dug or an attached node
5392 ^ becoming detached.
5393 ^ drops is a table of ItemStacks, so any metadata to be preserved can
5394 ^ be added directly to one or more of the dropped items. See
5395 ^ "ItemStackMetaRef".
5398 after_place_node = func(pos, placer, itemstack, pointed_thing) --[[
5399 ^ Called after constructing node when node was placed using
5400 ^ minetest.item_place_node / minetest.place_node
5401 ^ If return true no item is taken from itemstack
5402 ^ `placer` may be any valid ObjectRef or nil
5405 after_dig_node = func(pos, oldnode, oldmetadata, digger), --[[
5406 ^ oldmetadata is in table format
5407 ^ Called after destructing node when node was dug using
5408 ^ minetest.node_dig / minetest.dig_node
5411 can_dig = function(pos, [player]) --[[
5412 ^ returns true if node can be dug, or false if not
5415 on_punch = func(pos, node, puncher, pointed_thing), --[[
5416 ^ default: minetest.node_punch
5417 ^ By default: Calls minetest.register_on_punchnode callbacks ]]
5419 on_rightclick = func(pos, node, clicker, itemstack, pointed_thing),
5422 ^ itemstack will hold clicker's wielded item
5423 ^ Shall return the leftover itemstack
5424 ^ Note: pointed_thing can be nil, if a mod calls this function
5425 ^ This function does not get triggered by clients <=0.4.16 if the
5426 ^ "formspec" node metadata field is set ]]
5428 on_dig = func(pos, node, digger), --[[
5429 ^ default: minetest.node_dig
5430 ^ By default: checks privileges, wears out tool and removes node ]]
5432 on_timer = function(pos,elapsed), --[[
5434 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
5435 ^ elapsed is the total time passed since the timer was started
5436 ^ return true to run the timer for another cycle with the same timeout
5439 on_receive_fields = func(pos, formname, fields, sender), --[[
5440 ^ fields = {name1 = value1, name2 = value2, ...}
5441 ^ Called when an UI form (e.g. sign text input) returns data
5444 allow_metadata_inventory_move = func(pos, from_list, from_index, to_list, to_index, count, player),
5446 ^ Called when a player wants to move items inside the inventory
5447 ^ Return value: number of items allowed to move ]]
5449 allow_metadata_inventory_put = func(pos, listname, index, stack, player),
5451 ^ Called when a player wants to put something into the inventory
5452 ^ Return value: number of items allowed to put
5453 ^ Return value: -1: Allow and don't modify item count in inventory ]]
5455 allow_metadata_inventory_take = func(pos, listname, index, stack, player),
5457 ^ Called when a player wants to take something out of the inventory
5458 ^ Return value: number of items allowed to take
5459 ^ Return value: -1: Allow and don't modify item count in inventory ]]
5461 on_metadata_inventory_move = func(pos, from_list, from_index, to_list, to_index, count, player),
5462 on_metadata_inventory_put = func(pos, listname, index, stack, player),
5463 on_metadata_inventory_take = func(pos, listname, index, stack, player),
5465 ^ Called after the actual action has happened, according to what was
5467 ^ No return value ]]
5469 on_blast = func(pos, intensity), --[[
5470 ^ intensity: 1.0 = mid range of regular TNT
5471 ^ If defined, called when an explosion touches the node, instead of
5472 removing the node ]]
5475 ### Recipe for `register_craft` (shaped)
5478 output = 'default:pick_stone',
5480 {'default:cobble', 'default:cobble', 'default:cobble'},
5481 {'', 'default:stick', ''},
5482 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
5484 replacements = --[[<optional list of item pairs,
5485 replace one input item with another item on crafting>]]
5488 ### Recipe for `register_craft` (shapeless)
5492 output = 'mushrooms:mushroom_stew',
5495 "mushrooms:mushroom_brown",
5496 "mushrooms:mushroom_red",
5498 replacements = --[[<optional list of item pairs,
5499 replace one input item with another item on crafting>]]
5502 ### Recipe for `register_craft` (tool repair)
5505 type = "toolrepair",
5506 additional_wear = -0.02,
5509 ### Recipe for `register_craft` (cooking)
5513 output = "default:glass",
5514 recipe = "default:sand",
5518 ### Recipe for `register_craft` (furnace fuel)
5522 recipe = "default:leaves",
5526 ### Ore definition (`register_ore`)
5528 See 'Ore types' section above for essential information.
5531 ore_type = "scatter",
5532 ore = "default:stone_with_coal",
5534 -- ^ Facedir rotation. Default is 0 (unchanged rotation)
5535 wherein = "default:stone",
5536 -- ^ a list of nodenames is supported too
5537 clust_scarcity = 8 * 8 * 8,
5538 -- ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
5539 -- ^ If the desired average distance between ores is 'd', set this to
5542 -- ^ Number of ores in a cluster
5544 -- ^ Size of the bounding box of the cluster
5545 -- ^ In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27
5546 -- ^ nodes are coal ore.
5549 -- ^ Lower and upper limits for ore.
5551 -- ^ Attributes for this ore generation, see 'Ore attributes' section
5553 noise_threshold = 0.5,
5554 -- ^ If noise is above this threshold, ore is placed. Not needed for a
5555 -- ^ uniform distribution.
5559 spread = {x = 100, y = 100, z = 100},
5564 -- ^ NoiseParams structure describing one of the perlin noises used for
5565 -- ^ ore distribution.
5566 -- ^ Needed by "sheet", "puff", "blob" and "vein" ores.
5567 -- ^ Omit from "scatter" ore for a uniform ore distribution.
5568 -- ^ Omit from "stratum ore for a simple horizontal strata from y_min to
5570 biomes = {"desert", "rainforest"}
5571 -- ^ List of biomes in which this decoration occurs.
5572 -- ^ Occurs in all biomes if this is omitted, and ignored if the Mapgen
5573 -- ^ being used does not support biomes.
5574 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
5575 column_height_min = 1,
5576 column_height_max = 16,
5577 column_midpoint_factor = 0.5,
5578 -- ^ See 'Ore types' section above.
5579 -- ^ The above 3 parameters are only valid for "sheet" ore.
5583 spread = {x = 100, y = 100, z = 100},
5591 spread = {x = 100, y = 100, z = 100},
5596 -- ^ See 'Ore types' section above.
5597 -- ^ The above 2 parameters are only valid for "puff" ore.
5598 random_factor = 1.0,
5599 -- ^ See 'Ore types' section above.
5600 -- ^ Only valid for "vein" ore.
5601 np_stratum_thickness = {
5604 spread = {x = 100, y = 100, z = 100},
5609 stratum_thickness = 8,
5610 -- ^ See 'Ore types' section above.
5611 -- ^ The above 2 parameters are only valid for "stratum" ore.
5614 ### Biome definition (`register_biome`)
5618 node_dust = "default:snow",
5619 -- ^ Node dropped onto upper surface after all else is generated.
5620 node_top = "default:dirt_with_snow",
5622 -- ^ Node forming surface layer of biome and thickness of this layer.
5623 node_filler = "default:permafrost",
5625 -- ^ Node forming lower layer of biome and thickness of this layer.
5626 node_stone = "default:bluestone",
5627 -- ^ Node that replaces all stone nodes between roughly y_min and y_max.
5628 node_water_top = "default:ice",
5629 depth_water_top = 10,
5630 -- ^ Node forming a surface layer in seawater with the defined thickness.
5632 -- ^ Node that replaces all seawater nodes not in the defined surface
5634 node_river_water = "default:ice",
5635 -- ^ Node that replaces river water in mapgens that use
5636 -- ^ default:river_water.
5637 node_riverbed = "default:gravel",
5639 -- ^ Node placed under river water and thickness of this layer.
5642 -- ^ Upper and lower limits for biome.
5643 -- ^ Alternatively you can use xyz limits as shown below.
5644 max_pos = {x = 31000, y = 128, z = 31000},
5645 min_pos = {x = -31000, y = 9, z = -31000},
5646 -- ^ xyz limits for biome, an alternative to using 'y_min' and 'y_max'.
5647 -- ^ Biome is limited to a cuboid defined by these positions.
5648 -- ^ Any x, y or z field left undefined defaults to -31000 in 'min_pos' or
5649 -- ^ 31000 in 'max_pos'.
5651 -- ^ Vertical distance in nodes above 'y_max' over which the biome will
5652 -- ^ blend with the biome above.
5653 -- ^ Set to 0 for no vertical blend. Defaults to 0.
5655 humidity_point = 50,
5656 -- ^ Characteristic temperature and humidity for the biome.
5657 -- ^ These values create 'biome points' on a voronoi diagram with heat and
5658 -- ^ humidity as axes. The resulting voronoi cells determine the
5659 -- ^ distribution of the biomes.
5660 -- ^ Heat and humidity have average values of 50, vary mostly between
5661 -- ^ 0 and 100 but can exceed these values.
5664 ### Decoration definition (`register_decoration`)
5667 deco_type = "simple", -- See "Decoration types"
5668 place_on = "default:dirt_with_grass",
5669 -- ^ Node (or list of nodes) that the decoration can be placed on
5671 -- ^ Size of the square divisions of the mapchunk being generated.
5672 -- ^ Determines the resolution of noise variation if used.
5673 -- ^ If the chunk size is not evenly divisible by sidelen, sidelen is made
5674 -- ^ equal to the chunk size.
5676 -- ^ The value determines 'decorations per surface node'.
5677 -- ^ Used only if noise_params is not specified.
5681 spread = {x = 100, y = 100, z = 100},
5688 -- ^ NoiseParams structure describing the perlin noise used for decoration
5690 -- ^ A noise value is calculated for each square division and determines
5691 -- ^ 'decorations per surface node' within each division.
5692 biomes = {"Oceanside", "Hills", "Plains"},
5693 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes
5694 -- ^ if this is omitted, and ignored if the Mapgen being used does not
5695 -- ^ support biomes.
5696 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
5699 -- ^ Lower and upper limits for decoration.
5700 -- ^ These parameters refer to the Y co-ordinate of the 'place_on' node.
5701 spawn_by = "default:water",
5702 -- ^ Node (or list of nodes) that the decoration only spawns next to.
5703 -- ^ Checks two horizontal planes of 8 neighbouring nodes (including
5704 -- ^ diagonal neighbours), one plane level with the 'place_on' node and a
5705 -- ^ plane one node above that.
5707 -- ^ Number of spawn_by nodes that must be surrounding the decoration
5708 -- ^ position to occur.
5709 -- ^ If absent or -1, decorations occur next to any nodes.
5710 flags = "liquid_surface, force_placement, all_floors, all_ceilings",
5711 -- ^ Flags for all decoration types.
5712 -- ^ "liquid_surface": Instead of placement on the highest solid surface
5713 -- ^ in a mapchunk column, placement is on the highest liquid surface.
5714 -- ^ Placement is disabled if solid nodes are found above the liquid
5716 -- ^ "force_placement": Nodes other than "air" and "ignore" are replaced
5717 -- ^ by the decoration.
5718 -- ^ "all_floors", "all_ceilings": Instead of placement on the highest
5719 -- ^ surface in a mapchunk the decoration is placed on all floor and/or
5720 -- ^ ceiling surfaces, for example in caves.
5721 -- ^ Ceiling decorations act as an inversion of floor decorations so the
5722 -- ^ effect of 'place_offset_y' is inverted.
5723 -- ^ If a single decoration registration has both flags the floor and
5724 -- ^ ceiling decorations will be aligned vertically and may sometimes
5725 -- ^ meet to form a column.
5727 ----- Simple-type parameters
5728 decoration = "default:grass",
5729 -- ^ The node name used as the decoration.
5730 -- ^ If instead a list of strings, a randomly selected node from the list
5731 -- ^ is placed as the decoration.
5733 -- ^ Decoration height in nodes.
5734 -- ^ If height_max is not 0, this is the lower limit of a randomly
5735 -- ^ selected height.
5737 -- ^ Upper limit of the randomly selected height.
5738 -- ^ If absent, the parameter 'height' is used as a constant.
5740 -- ^ Param2 value of decoration nodes.
5741 -- ^ If param2_max is not 0, this is the lower limit of a randomly
5742 -- ^ selected param2.
5744 -- ^ Upper limit of the randomly selected param2.
5745 -- ^ If absent, the parameter 'param2' is used as a constant.
5747 -- ^ Y offset of the decoration base node relative to the standard base
5749 -- ^ Can be positive or negative. Default is 0.
5750 -- ^ Effect is inverted for "all_ceilings" decorations.
5751 -- ^ Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
5752 -- ^ to the 'place_on' node.
5754 ----- Schematic-type parameters
5755 schematic = "foobar.mts",
5756 -- ^ If schematic is a string, it is the filepath relative to the current
5757 -- ^ working directory of the specified Minetest schematic file.
5758 -- ^ - OR -, could be the ID of a previously registered schematic
5759 -- ^ - OR -, could instead be a table containing two mandatory fields,
5760 -- ^ size and data, and an optional table yslice_prob:
5762 size = {x = 4, y = 6, z = 4},
5764 {name = "default:cobble", param1 = 255, param2 = 0},
5765 {name = "default:dirt_with_grass", param1 = 255, param2 = 0},
5766 {name = "air", param1 = 255, param2 = 0},
5770 {ypos = 2, prob = 128},
5771 {ypos = 5, prob = 64},
5775 -- ^ See 'Schematic specifier' for details.
5776 replacements = {["oldname"] = "convert_to", ...},
5777 flags = "place_center_x, place_center_y, place_center_z",
5778 -- ^ Flags for schematic decorations. See 'Schematic attributes'.
5780 -- ^ Rotation can be "0", "90", "180", "270", or "random".
5782 -- ^ If the flag 'place_center_y' is set this parameter is ignored.
5783 -- ^ Y offset of the schematic base node layer relative to the 'place_on'
5785 -- ^ Can be positive or negative. Default is 0.
5786 -- ^ Effect is inverted for "all_ceilings" decorations.
5787 -- ^ Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
5788 -- ^ to the 'place_on' node.
5791 ### Chat command definition (`register_chatcommand`)
5794 params = "<name> <privilege>", -- Short parameter description
5795 description = "Remove privilege from player", -- Full description
5796 privs = {privs=true}, -- Require the "privs" privilege to run
5797 func = function(name, param), -- Called when command is run.
5798 -- Returns boolean success and text
5802 Note that in params, use of symbols is as follows:
5804 * `<>` signifies a placeholder to be replaced when the command is used. For
5805 example, when a player name is needed: `<name>`
5806 * `[]` signifies param is optional and not required when the command is used.
5807 For example, if you require param1 but param2 is optional:
5808 `<param1> [<param2>]`
5809 * `|` signifies exclusive or. The command requires one param from the options
5810 provided. For example: `<param1> | <param2>`
5811 * `()` signifies grouping. For example, when param1 and param2 are both
5812 required, or only param3 is required: `(<param1> <param2>) | <param3>`
5814 ### Detached inventory callbacks
5817 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
5818 -- ^ Called when a player wants to move items inside the inventory
5819 -- ^ Return value: number of items allowed to move
5821 allow_put = func(inv, listname, index, stack, player),
5822 -- ^ Called when a player wants to put something into the inventory
5823 -- ^ Return value: number of items allowed to put
5824 -- ^ Return value: -1: Allow and don't modify item count in inventory
5826 allow_take = func(inv, listname, index, stack, player),
5827 -- ^ Called when a player wants to take something out of the inventory
5828 -- ^ Return value: number of items allowed to take
5829 -- ^ Return value: -1: Allow and don't modify item count in inventory
5831 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
5832 on_put = func(inv, listname, index, stack, player),
5833 on_take = func(inv, listname, index, stack, player),
5834 -- ^ Called after the actual action has happened, according to what was
5836 -- ^ No return value
5839 ### HUD Definition (`hud_add`, `hud_get`)
5842 hud_elem_type = "image", -- see HUD element types
5843 -- ^ type of HUD element, can be either of "image", "text", "statbar",
5845 position = {x=0.5, y=0.5},
5846 -- ^ Left corner position of element
5848 scale = {x = 2, y = 2},
5852 -- ^ Selected item in inventory. 0 for no item selected.
5854 -- ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
5855 alignment = {x=0, y=0},
5856 -- ^ See "HUD Element Types"
5857 offset = {x=0, y=0},
5858 -- ^ See "HUD Element Types"
5859 size = { x=100, y=100 },
5860 -- ^ Size of element in pixels
5863 ### Particle definition (`add_particle`)
5866 pos = {x=0, y=0, z=0},
5867 velocity = {x=0, y=0, z=0},
5868 acceleration = {x=0, y=0, z=0},
5869 -- ^ Spawn particle at pos with velocity and acceleration
5871 -- ^ Disappears after expirationtime seconds
5873 collisiondetection = false,
5874 -- ^ collisiondetection: if true collides with physical objects
5875 collision_removal = false,
5876 -- ^ collision_removal: if true then particle is removed when it collides,
5877 -- ^ requires collisiondetection = true to have any effect
5879 -- ^ vertical: if true faces player using y axis only
5880 texture = "image.png",
5881 -- ^ Uses texture (string)
5882 playername = "singleplayer",
5883 -- ^ optional, if specified spawns particle only on the player's client
5884 animation = {Tile Animation definition},
5885 -- ^ optional, specifies how to animate the particle texture
5887 -- ^ optional, specify particle self-luminescence in darkness
5891 ### `ParticleSpawner` definition (`add_particlespawner`)
5896 -- ^ If time is 0 has infinite lifespan and spawns the amount on a
5897 -- ^ per-second basis.
5898 minpos = {x=0, y=0, z=0},
5899 maxpos = {x=0, y=0, z=0},
5900 minvel = {x=0, y=0, z=0},
5901 maxvel = {x=0, y=0, z=0},
5902 minacc = {x=0, y=0, z=0},
5903 maxacc = {x=0, y=0, z=0},
5908 -- ^ The particle's properties are random values in between the bounds:
5909 -- ^ minpos/maxpos, minvel/maxvel (velocity),
5910 -- ^ minacc/maxacc (acceleration), minsize/maxsize,
5911 -- ^ minexptime/maxexptime (expirationtime).
5912 collisiondetection = false,
5913 -- ^ collisiondetection: if true uses collision detection
5914 collision_removal = false,
5915 -- ^ collision_removal: if true then particle is removed when it collides,
5916 -- ^ requires collisiondetection = true to have any effect
5917 attached = ObjectRef,
5918 -- ^ attached: if defined, particle positions, velocities and
5919 -- ^ accelerations are relative to this object's position and yaw.
5921 -- ^ vertical: if true faces player using y axis only
5922 texture = "image.png",
5923 -- ^ Uses texture (string)
5924 playername = "singleplayer"
5925 -- ^ Playername is optional, if specified spawns particle only on the
5926 -- ^ player's client.
5927 animation = {Tile Animation definition},
5928 -- ^ optional, specifies how to animate the particle texture
5930 -- ^ optional, specify particle self-luminescence in darkness
5933 ### `HTTPRequest` definition (`HTTPApiTable.fetch_async`, `HTTPApiTable.fetch_async`)
5936 url = "http://example.org",
5938 -- ^ Timeout for connection in seconds. Default is 3 seconds.
5939 post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
5940 -- ^ Optional, if specified a POST request with post_data is performed.
5941 -- ^ Accepts both a string and a table. If a table is specified, encodes
5942 -- ^ table as x-www-form-urlencoded key-value pairs.
5943 -- ^ If post_data ist not specified, a GET request is performed instead.
5944 user_agent = "ExampleUserAgent",
5945 -- ^ Optional, if specified replaces the default minetest user agent with
5947 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
5948 -- ^ Optional, if specified adds additional headers to the HTTP request.
5949 -- ^ You must make sure that the header strings follow HTTP specification
5950 -- ^ ("Key: Value").
5952 -- ^ Optional, if true performs a multipart HTTP request.
5953 -- ^ Default is false.
5956 ### `HTTPRequestResult` definition (`HTTPApiTable.fetch` callback, `HTTPApiTable.fetch_async_get`)
5960 -- ^ If true, the request has finished (either succeeded, failed or timed
5963 -- ^ If true, the request was successful
5965 -- ^ If true, the request timed out
5967 -- ^ HTTP status code
5971 ### Authentication handler definition
5974 get_auth = func(name),
5975 -- ^ Get authentication data for existing player `name` (`nil` if player
5977 -- ^ returns following structure:
5978 -- ^ `{password=<string>, privileges=<table>, last_login=<number or nil>}`
5979 create_auth = func(name, password),
5980 -- ^ Create new auth data for player `name`
5981 -- ^ Note that `password` is not plain-text but an arbitrary
5982 -- ^ representation decided by the engine
5983 delete_auth = func(name),
5984 -- ^ Delete auth data of player `name`, returns boolean indicating success
5985 -- ^ (false if player nonexistant).
5986 set_password = func(name, password),
5987 -- ^ Set password of player `name` to `password`
5988 Auth data should be created if not present
5989 set_privileges = func(name, privileges),
5990 -- ^ Set privileges of player `name`
5991 -- ^ `privileges` is in table form, auth data should be created if not
5994 -- ^ Reload authentication data from the storage location
5995 -- ^ Returns boolean indicating success
5996 record_login = func(name),
5997 -- ^ Called when player joins, used for keeping track of last_login
5999 -- ^ Returns an iterator (use with `for` loops) for all player names
6000 -- ^ currently in the auth database.