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`, with the following keys:
59 * `name` - required, human readable name e.g. `name = Minetest`
60 * `description` - Short description to be shown in the content tab
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
911 Required by a light source node to enable spreading its light.
912 Required by the following drawtypes as they determine their visual
913 brightness from their internal light value:
924 `param2` is reserved for the engine when any of these are used:
926 liquidtype == "flowing"
927 ^ The level and some flags of the liquid is stored in param2
928 drawtype == "flowingliquid"
929 ^ The drawn liquid level is read from param2
930 drawtype == "torchlike"
931 drawtype == "signlike"
932 paramtype2 == "wallmounted"
933 ^ The rotation of the node is stored in param2. You can make this value
934 by using minetest.dir_to_wallmounted().
935 paramtype2 == "facedir"
936 ^ The rotation of the node is stored in param2. Furnaces and chests are
937 rotated this way. Can be made by using minetest.dir_to_facedir().
939 facedir / 4 = axis direction:
940 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
941 facedir modulo 4 = rotation around that axis
942 paramtype2 == "leveled"
943 ^ Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
945 The level of the top face of the nodebox is stored in param2.
946 The other faces are defined by 'fixed = {}' like 'type = "fixed"'
948 The nodebox height is (param2 / 64) nodes.
949 The maximum accepted value of param2 is 127.
951 The height of the 'plantlike' section is stored in param2.
952 The height is (param2 / 16) nodes.
953 paramtype2 == "degrotate"
954 ^ Only valid for "plantlike". The rotation of the node is stored in param2.
955 Values range 0 - 179. The value stored in param2 is multiplied by two to
956 get the actual rotation in degrees of the node.
957 paramtype2 == "meshoptions"
958 ^ Only valid for "plantlike". The value of param2 becomes a bitfield which
959 can be used to change how the client draws plantlike nodes.
960 Bits 0, 1 and 2 form a mesh selector.
961 Currently the following meshes are choosable:
962 0 = a "x" shaped plant (ordinary plant)
963 1 = a "+" shaped plant (just rotated 45 degrees)
964 2 = a "*" shaped plant with 3 faces instead of 2
965 3 = a "#" shaped plant with 4 faces instead of 2
966 4 = a "#" shaped plant with 4 faces that lean outwards
967 5-7 are unused and reserved for future meshes.
968 Bits 3 through 7 are optional flags that can be combined and give these
970 bit 3 (0x08) - Makes the plant slightly vary placement horizontally
971 bit 4 (0x10) - Makes the plant mesh 1.4x larger
972 bit 5 (0x20) - Moves each face randomly a small bit down (1/8 max)
973 bits 6-7 are reserved for future use.
974 paramtype2 == "color"
975 ^ `param2` tells which color is picked from the palette.
976 The palette should have 256 pixels.
977 paramtype2 == "colorfacedir"
978 ^ Same as `facedir`, but with colors.
979 The first three bits of `param2` tells which color
980 is picked from the palette.
981 The palette should have 8 pixels.
982 paramtype2 == "colorwallmounted"
983 ^ Same as `wallmounted`, but with colors.
984 The first five bits of `param2` tells which color
985 is picked from the palette.
986 The palette should have 32 pixels.
987 paramtype2 == "glasslikeliquidlevel"
988 ^ Only valid for "glasslike_framed" or "glasslike_framed_optional"
990 param2 values 0-63 define 64 levels of internal liquid, 0 being empty and
992 Liquid texture is defined using `special_tiles = {"modname_tilename.png"},`
994 Nodes can also contain extra data. See "Node Metadata".
998 There are a bunch of different looking node types.
1000 Look for examples in `games/minimal` or `games/minetest_game`.
1003 * A node-sized cube.
1005 * Invisible, uses no texture.
1007 * The cubic source node for a liquid.
1009 * The flowing version of a liquid, appears with various heights and slopes.
1011 * Often used for partially-transparent nodes.
1012 * Only external sides of textures are visible.
1013 * `glasslike_framed`
1014 * All face-connected nodes are drawn as one volume within a surrounding
1016 * The frame appearence is generated from the edges of the first texture
1017 specified in `tiles`. The width of the edges used are 1/16th of texture
1018 size: 1 pixel for 16x16, 2 pixels for 32x32 etc.
1019 * The glass 'shine' (or other desired detail) on each node face is supplied
1020 by the second texture specified in `tiles`.
1021 * `glasslike_framed_optional`
1022 * This switches between the above 2 drawtypes according to the menu setting
1025 * Often used for partially-transparent nodes.
1026 * External and internal sides of textures are visible.
1027 * `allfaces_optional`
1028 * Often used for leaves nodes.
1029 * This switches between `normal`, `glasslike` and `allfaces` according to
1030 the menu setting: Opaque Leaves / Simple Leaves / Fancy Leaves.
1031 * With 'Simple Leaves' selected, the texture specified in `special_tiles`
1032 is used instead, if present. This allows a visually thicker texture to be
1033 used to compensate for how `glasslike` reduces visual thickness.
1035 * A single vertical texture.
1036 * If placed on top of a node, uses the first texture specified in `tiles`.
1037 * If placed against the underside of a node, uses the second texture
1038 specified in `tiles`.
1039 * If placed on the side of a node, uses the third texture specified in
1040 `tiles` and is perpendicular to that node.
1042 * A single texture parallel to, and mounted against, the top, underside or
1045 * Two vertical and diagonal textures at right-angles to each other.
1046 * See `paramtype2 == "meshoptions"` above for other options.
1048 * When above a flat surface, appears as 6 textures, the central 2 as
1049 `plantlike` plus 4 more surrounding those.
1050 * If not above a surface the central 2 do not appear, but the texture
1051 appears against the faces of surrounding nodes if they are present.
1053 * A 3D model suitable for a wooden fence.
1054 * One placed node appears as a single vertical post.
1055 * Adjacently-placed nodes cause horizontal bars to appear between them.
1057 * Often used for tracks for mining carts.
1058 * Requires 4 textures to be specified in `tiles`, in order: Straight,
1059 curved, t-junction, crossing.
1060 * Each placed node automatically switches to a suitable rotated texture
1061 determined by the adjacent `raillike` nodes, in order to create a
1062 continuous track network.
1063 * Becomes a sloping node if placed against stepped nodes.
1065 * Often used for stairs and slabs.
1066 * Allows defining nodes consisting of an arbitrary number of boxes.
1067 * See 'Node boxes' below for more information.
1069 * Uses models for nodes.
1070 * Tiles should hold model materials textures.
1071 * Only static meshes are implemented.
1072 * For supported model formats see Irrlicht engine documentation.
1073 * `plantlike_rooted`
1074 * Enables underwater `plantlike` without air bubbles around the nodes.
1075 * Consists of a base cube at the co-ordinates of the node plus a
1076 `plantlike` extension above with a height of `param2 / 16` nodes.
1077 * The `plantlike` extension visually passes through any nodes above the
1078 base cube without affecting them.
1079 * The base cube texture tiles are defined as normal, the `plantlike`
1080 extension uses the defined special tile, for example:
1081 `special_tiles = {{name = "default_papyrus.png", tileable_vertical = true}},`
1083 `*_optional` drawtypes need less rendering time if deactivated
1084 (always client-side).
1088 Node selection boxes are defined using "node boxes".
1090 A nodebox is defined as any of:
1093 -- A normal cube; the default in most things
1097 -- A fixed box (or boxes) (facedir param2 is used, if applicable)
1099 fixed = box OR {box1, box2, ...}
1102 -- A variable height box (or boxes) with the top face position defined
1103 -- by the node parameter 'leveled = ', or if 'paramtype2 == "leveled"'
1105 -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
1107 fixed = box OR {box1, box2, ...}
1110 -- A box like the selection box for torches
1111 -- (wallmounted param2 is used, if applicable)
1112 type = "wallmounted",
1118 -- A node that has optional boxes depending on neighbouring nodes'
1119 -- presence and type. See also `connects_to`.
1121 fixed = box OR {box1, box2, ...}
1122 connect_top = box OR {box1, box2, ...}
1123 connect_bottom = box OR {box1, box2, ...}
1124 connect_front = box OR {box1, box2, ...}
1125 connect_left = box OR {box1, box2, ...}
1126 connect_back = box OR {box1, box2, ...}
1127 connect_right = box OR {box1, box2, ...}
1128 -- The following `disconnected_*` boxes are the opposites of the
1129 -- `connect_*` ones above, i.e. when a node has no suitable neighbour
1130 -- on the respective side, the corresponding disconnected box is drawn.
1131 disconnected_top = box OR {box1, box2, ...}
1132 disconnected_bottom = box OR {box1, box2, ...}
1133 disconnected_front = box OR {box1, box2, ...}
1134 disconnected_left = box OR {box1, box2, ...}
1135 disconnected_back = box OR {box1, box2, ...}
1136 disconnected_right = box OR {box1, box2, ...}
1137 disconnected = box OR {box1, box2, ...} -- when there is *no* neighbour
1138 disconnected_sides = box OR {box1, box2, ...} -- when there are *no*
1139 neighbours to the sides
1142 A `box` is defined as:
1144 {x1, y1, z1, x2, y2, z2}
1146 A box of a regular node would look like:
1148 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
1154 The position field is used for all element types.
1156 To account for differing resolutions, the position coordinates are the
1157 percentage of the screen, ranging in value from `0` to `1`.
1159 The name field is not yet used, but should contain a description of what the
1160 HUD element represents. The direction field is the direction in which something
1163 `0` draws from left to right, `1` draws from right to left, `2` draws from
1164 top to bottom, and `3` draws from bottom to top.
1166 The `alignment` field specifies how the item will be aligned. It ranges from
1167 `-1` to `1`, with `0` being the center. `-1` is moved to the left/up, and `1`
1168 is to the right/down. Fractional values can be used.
1170 The `offset` field specifies a pixel offset from the position. Contrary to
1171 position, the offset is not scaled to screen size. This allows for some
1172 precisely positioned items in the HUD.
1174 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
1177 Below are the specific uses for fields in each type; fields not listed for that
1181 Displays an image on the HUD.
1183 * `scale`: The scale of the image, with 1 being the original texture size.
1184 Only the X coordinate scale is used (positive values).
1185 Negative values represent that percentage of the screen it
1186 should take; e.g. `x=-100` means 100% (width).
1187 * `text`: The name of the texture that is displayed.
1188 * `alignment`: The alignment of the image.
1189 * `offset`: offset in pixels from position.
1192 Displays text on the HUD.
1194 * `scale`: Defines the bounding rectangle of the text.
1195 A value such as `{x=100, y=100}` should work.
1196 * `text`: The text to be displayed in the HUD element.
1197 * `number`: An integer containing the RGB value of the color used to draw the
1198 text. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1199 * `alignment`: The alignment of the text.
1200 * `offset`: offset in pixels from position.
1203 Displays a horizontal bar made up of half-images.
1205 * `text`: The name of the texture that is used.
1206 * `number`: The number of half-textures that are displayed.
1207 If odd, will end with a vertically center-split texture.
1209 * `offset`: offset in pixels from position.
1210 * `size`: If used, will force full-image size to this value (override texture
1214 * `text`: The name of the inventory list to be displayed.
1215 * `number`: Number of items in the inventory to be displayed.
1216 * `item`: Position of item that is selected.
1218 * `offset`: offset in pixels from position.
1221 Displays distance to selected world position.
1223 * `name`: The name of the waypoint.
1224 * `text`: Distance suffix. Can be blank.
1225 * `number:` An integer containing the RGB value of the color used to draw the
1227 * `world_pos`: World position of the waypoint.
1229 Representations of simple things
1230 --------------------------------
1234 {x=num, y=num, z=num}
1236 For helper functions see "Spatial Vectors".
1239 * `{type="nothing"}`
1240 * `{type="node", under=pos, above=pos}`
1241 * `{type="object", ref=ObjectRef}`
1243 Flag Specifier Format
1244 ---------------------
1245 Flags using the standardized flag specifier format can be specified in either
1246 of two ways, by string or table.
1248 The string format is a comma-delimited set of flag names; whitespace and
1249 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1250 flag, and specifying a flag prefixed by the string `"no"` explicitly
1251 clears the flag from whatever the default may be.
1253 In addition to the standard string flag format, the schematic flags field can
1254 also be a table of flag names to boolean values representing whether or not the
1255 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1256 is present, mapped to a boolean of any value, the specified flag is unset.
1258 E.g. A flag field of value
1260 {place_center_x = true, place_center_y=false, place_center_z=true}
1264 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1266 which is equivalent to
1268 "place_center_x, noplace_center_y, place_center_z"
1272 "place_center_x, place_center_z"
1274 since, by default, no schematic attributes are set.
1280 There are three kinds of items: nodes, tools and craftitems.
1282 * Node (`register_node`): A node from the world.
1283 * Tool (`register_tool`): A tool/weapon that can dig and damage
1284 things according to `tool_capabilities`.
1285 * Craftitem (`register_craftitem`): A miscellaneous item.
1288 All item stacks have an amount between 0 to 65535. It is 1 by
1289 default. Tool item stacks can not have an amount greater than 1.
1291 Tools use a wear (=damage) value ranging from 0 to 65535. The
1292 value 0 is the default and used is for unworn tools. The values
1293 1 to 65535 are used for worn tools, where a higher value stands for
1294 a higher wear. Non-tools always have a wear value of 0.
1297 Items and item stacks can exist in three formats: Serializes, table format
1301 This is called "stackstring" or "itemstring". It is a simple string with
1302 1-3 components: the full item identifier, an optional amount and an optional
1305 <identifier> [<amount>[ <wear>]]
1309 * `'default:apple'`: 1 apple
1310 * `'default:dirt 5'`: 5 dirt
1311 * `'default:pick_stone'`: a new stone pickaxe
1312 * `'default:pick_wood 1 21323'`: a wooden pickaxe, ca. 1/3 worn out
1319 {name="default:dirt", count=5, wear=0, metadata=""}
1321 A wooden pick about 1/3 worn out:
1323 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1327 {name="default:apple", count=1, wear=0, metadata=""}
1330 A native C++ format with many helper methods. Useful for converting
1331 between formats. See the Class reference section for details.
1333 When an item must be passed to a function, it can usually be in any of
1339 In a number of places, there is a group table. Groups define the
1340 properties of a thing (item, node, armor of entity, capabilities of
1341 tool) in such a way that the engine and other mods can can interact with
1342 the thing without actually knowing what the thing is.
1345 Groups are stored in a table, having the group names with keys and the
1346 group ratings as values. For example:
1348 groups = {crumbly=3, soil=1}
1351 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1352 -- ^ A more special dirt-kind of thing
1354 Groups always have a rating associated with them. If there is no
1355 useful meaning for a rating for an enabled group, it shall be `1`.
1357 When not defined, the rating of a group defaults to `0`. Thus when you
1358 read groups, you must interpret `nil` and `0` as the same value, `0`.
1360 You can read the rating of a group for an item or a node by using
1362 minetest.get_item_group(itemname, groupname)
1365 Groups of items can define what kind of an item it is (e.g. wool).
1368 In addition to the general item things, groups are used to define whether
1369 a node is destroyable and how long it takes to destroy by a tool.
1371 ### Groups of entities
1372 For entities, groups are, as of now, used only for calculating damage.
1373 The rating is the percentage of damage caused by tools with this damage group.
1374 See "Entity damage mechanism".
1376 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1377 object.set_armor_groups({fleshy=30, cracky=80})
1380 Groups in tools define which groups of nodes and entities they are
1383 ### Groups in crafting recipes
1384 An example: Make meat soup from any meat, any water and any bowl:
1387 output = 'food:meat_soup_raw',
1393 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1396 Another example: Make red wool from white wool and red dye:
1400 output = 'wool:red',
1401 recipe = {'wool:white', 'group:dye,basecolor_red'},
1405 * `immortal`: Disables the group damage system for an entity
1406 * `punch_operable`: For entities; disables the regular damage mechanism for
1407 players punching it by hand or a non-tool item, so that it can do something
1408 else than take damage.
1409 * `level`: Can be used to give an additional sense of progression in the game.
1410 * A larger level will cause e.g. a weapon of a lower level make much less
1411 damage, and get worn out much faster, or not be able to get drops
1412 from destroyed nodes.
1413 * `0` is something that is directly accessible at the start of gameplay
1414 * There is no upper limit
1415 * `dig_immediate`: (player can always pick up node without reducing tool wear)
1416 * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
1417 * `3`: the node always gets the digging time 0 seconds (torch)
1418 * `disable_jump`: Player (and possibly other things) cannot jump from node
1419 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1420 * `bouncy`: value is bounce speed in percent
1421 * `falling_node`: if there is no walkable block under the node it will fall
1422 * `attached_node`: if the node under it is not a walkable block the node will be
1423 dropped as an item. If the node is wallmounted the wallmounted direction is
1425 * `soil`: saplings will grow on nodes in this group
1426 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1427 connect to each other
1428 * `slippery`: Players and items will slide on the node.
1429 Slipperiness rises steadily with `slippery` value, starting at 1.
1432 ### Known damage and digging time defining groups
1433 * `crumbly`: dirt, sand
1434 * `cracky`: tough but crackable stuff like stone.
1435 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1436 plants, wire, sheets of metal
1437 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1438 * `fleshy`: Living things like animals and the player. This could imply
1439 some blood effects when hitting.
1440 * `explody`: Especially prone to explosions
1441 * `oddly_breakable_by_hand`:
1442 Can be added to nodes that shouldn't logically be breakable by the
1443 hand but are. Somewhat similar to `dig_immediate`, but times are more
1444 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1445 speed of a tool if the tool can dig at a faster speed than this
1446 suggests for the hand.
1448 ### Examples of custom groups
1449 Item groups are often used for defining, well, _groups of items_.
1451 * `meat`: any meat-kind of a thing (rating might define the size or healing
1452 ability or be irrelevant -- it is not defined as of yet)
1453 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1455 * `flammable`: can be set on fire. Rating might define the intensity of the
1456 fire, affecting e.g. the speed of the spreading of an open fire.
1457 * `wool`: any wool (any origin, any color)
1458 * `metal`: any metal
1459 * `weapon`: any weapon
1460 * `heavy`: anything considerably heavy
1462 ### Digging time calculation specifics
1463 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1464 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1465 faster digging time.
1467 The `level` group is used to limit the toughness of nodes a tool can dig
1468 and to scale the digging times / damage to a greater extent.
1470 **Please do understand this**, otherwise you cannot use the system to it's
1473 Tools define their properties by a list of parameters for groups. They
1474 cannot dig other groups; thus it is important to use a standard bunch of
1475 groups to enable interaction with tools.
1477 #### Tools definition
1480 * Full punch interval
1481 * Maximum drop level
1482 * For an arbitrary list of groups:
1483 * Uses (until the tool breaks)
1484 * Maximum level (usually `0`, `1`, `2` or `3`)
1488 #### Full punch interval
1489 When used as a weapon, the tool will do full damage if this time is spent
1490 between punches. If e.g. half the time is spent, the tool will do half
1493 #### Maximum drop level
1494 Suggests the maximum level of node, when dug with the tool, that will drop
1495 it's useful item. (e.g. iron ore to drop a lump of iron).
1497 This is not automated; it is the responsibility of the node definition
1501 Determines how many uses the tool has when it is used for digging a node,
1502 of this group, of the maximum level. For lower leveled nodes, the use count
1503 is multiplied by `3^leveldiff`.
1505 * `uses=10, leveldiff=0`: actual uses: 10
1506 * `uses=10, leveldiff=1`: actual uses: 30
1507 * `uses=10, leveldiff=2`: actual uses: 90
1510 Tells what is the maximum level of a node of this group that the tool will
1514 List of digging times for different ratings of the group, for nodes of the
1517 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1518 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1519 for this group, and unable to dig the rating `1`, which is the toughest.
1520 Unless there is a matching group that enables digging otherwise.
1522 If the result digging time is 0, a delay of 0.15 seconds is added between
1523 digging nodes; If the player releases LMB after digging, this delay is set to 0,
1524 i.e. players can more quickly click the nodes away instead of holding LMB.
1527 List of damage for groups of entities. See "Entity damage mechanism".
1529 #### Example definition of the capabilities of a tool
1531 tool_capabilities = {
1532 full_punch_interval=1.5,
1535 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1537 damage_groups = {fleshy=2},
1540 This makes the tool be able to dig nodes that fulfil both of these:
1542 * Have the `crumbly` group
1543 * Have a `level` group less or equal to `2`
1545 Table of resulting digging times:
1547 crumbly 0 1 2 3 4 <- level
1549 1 0.80 1.60 1.60 - -
1550 2 0.60 1.20 1.20 - -
1551 3 0.40 0.80 0.80 - -
1553 level diff: 2 1 0 -1 -2
1555 Table of resulting tool uses:
1564 * At `crumbly==0`, the node is not diggable.
1565 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1566 easy nodes to be quickly breakable.
1567 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1569 Entity damage mechanism
1570 -----------------------
1574 foreach group in cap.damage_groups:
1575 damage += cap.damage_groups[group] * limit(actual_interval /
1576 cap.full_punch_interval, 0.0, 1.0)
1577 * (object.armor_groups[group] / 100.0)
1578 -- Where object.armor_groups[group] is 0 for inexistent values
1581 Client predicts damage based on damage groups. Because of this, it is able to
1582 give an immediate response when an entity is damaged or dies; the response is
1583 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1585 Currently a smoke puff will appear when an entity dies.
1587 The group `immortal` completely disables normal damage.
1589 Entities can define a special armor group, which is `punch_operable`. This
1590 group disables the regular damage mechanism for players punching it by hand or
1591 a non-tool item, so that it can do something else than take damage.
1593 On the Lua side, every punch calls:
1595 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction, damage)
1597 This should never be called directly, because damage is usually not handled by
1600 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1601 accessed unless absolutely required, to encourage interoperability.
1602 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1603 * `tool_capabilities` can be `nil`.
1604 * `direction` is a unit vector, pointing from the source of the punch to
1606 * `damage` damage that will be done to entity
1607 Return value of this function will determine if damage is done by this function
1608 (retval true) or shall be done by engine (retval false)
1610 To punch an entity/object in Lua, call:
1612 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1614 * Return value is tool wear.
1615 * Parameters are equal to the above callback.
1616 * If `direction` equals `nil` and `puncher` does not equal `nil`, `direction`
1617 will be automatically filled in based on the location of `puncher`.
1621 The instance of a node in the world normally only contains the three values
1622 mentioned in "Nodes". However, it is possible to insert extra data into a
1623 node. It is called "node metadata"; See `NodeMetaRef`.
1625 Node metadata contains two things:
1630 Some of the values in the key-value store are handled specially:
1632 * `formspec`: Defines a right-click inventory menu. See "Formspec".
1633 * `infotext`: Text shown on the screen when the node is pointed at
1637 local meta = minetest.get_meta(pos)
1638 meta:set_string("formspec",
1640 "list[context;main;0,0;8,4;]"..
1641 "list[current_player;main;0,5;8,4;]")
1642 meta:set_string("infotext", "Chest");
1643 local inv = meta:get_inventory()
1644 inv:set_size("main", 8*4)
1645 print(dump(meta:to_table()))
1648 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1649 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1650 [10] = "", [11] = "", [12] = "", [13] = "",
1651 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1652 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1653 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1654 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1658 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1665 Item stacks can store metadata too. See `ItemStackMetaRef`.
1667 Item metadata only contains a key-value store.
1669 Some of the values in the key-value store are handled specially:
1671 * `description`: Set the item stack's description. Defaults to
1673 * `color`: A `ColorString`, which sets the stack's color.
1674 * `palette_index`: If the item has a palette, this is used to get the
1675 current color from the palette.
1679 local meta = stack:get_meta()
1680 meta:set_string("key", "value")
1681 print(dump(meta:to_table()))
1685 Formspec defines a menu. Currently not much else than inventories are
1686 supported. It is a string, with a somewhat strange format.
1688 Spaces and newlines can be inserted between the blocks, as is used in the
1691 WARNING: Minetest allows you to add elements to every single formspec instance
1692 using player:set_formspec_prepend(), which may be the reason backgrounds are
1693 appearing when you don't expect them to. See `no_prepend[]`
1700 list[context;main;0,0;8,4;]
1701 list[current_player;main;0,5;8,4;]
1706 list[context;fuel;2,3;1,1;]
1707 list[context;src;2,1;1,1;]
1708 list[context;dst;5,1;2,2;]
1709 list[current_player;main;0,5;8,4;]
1711 #### Minecraft-like player inventory
1714 image[1,0.6;1,2;player.png]
1715 list[current_player;main;0,3.5;8,4;]
1716 list[current_player;craft;3,0;3,3;]
1717 list[current_player;craftpreview;7,1;1,1;]
1721 #### `size[<W>,<H>,<fixed_size>]`
1722 * Define the size of the menu in inventory slots
1723 * `fixed_size`: `true`/`false` (optional)
1724 * deprecated: `invsize[<W>,<H>;]`
1726 #### `position[<X>,<Y>]`
1727 * Must be used after `size` element.
1728 * Defines the position on the game window of the formspec's `anchor` point.
1729 * For X and Y, 0.0 and 1.0 represent opposite edges of the game window,
1731 * [0.0, 0.0] sets the position to the top left corner of the game window.
1732 * [1.0, 1.0] sets the position to the bottom right of the game window.
1733 * Defaults to the center of the game window [0.5, 0.5].
1735 #### `anchor[<X>,<Y>]`
1736 * Must be used after both `size` and `position` (if present) elements.
1737 * Defines the location of the anchor point within the formspec.
1738 * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec,
1740 * [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
1741 * [1.0, 0.0] sets the anchor to the top right of the formspec.
1742 * Defaults to the center of the formspec [0.5, 0.5].
1744 * `position` and `anchor` elements need suitable values to avoid a formspec
1745 extending off the game window due to particular game window sizes.
1748 * Must be used after the `size`, `position`, and `anchor` elements (if present).
1749 * Disables player:set_formspec_prepend() from applying to this formspec.
1751 #### `container[<X>,<Y>]`
1752 * Start of a container block, moves all physical elements in the container by
1754 * Must have matching `container_end`
1755 * Containers can be nested, in which case the offsets are added
1756 (child containers are relative to parent containers)
1758 #### `container_end[]`
1759 * End of a container, following elements are no longer relative to this
1762 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
1763 * Show an inventory list
1765 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
1766 * Show an inventory list
1768 #### `listring[<inventory location>;<list name>]`
1769 * Allows to create a ring of inventory lists
1770 * Shift-clicking on items in one element of the ring
1771 will send them to the next inventory list inside the ring
1772 * The first occurrence of an element inside the ring will
1773 determine the inventory where items will be sent to
1776 * Shorthand for doing `listring[<inventory location>;<list name>]`
1777 for the last two inventory lists added by list[...]
1779 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
1780 * Sets background color of slots as `ColorString`
1781 * Sets background color of slots on mouse hovering
1783 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
1784 * Sets background color of slots as `ColorString`
1785 * Sets background color of slots on mouse hovering
1786 * Sets color of slots border
1788 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
1789 * Sets background color of slots as `ColorString`
1790 * Sets background color of slots on mouse hovering
1791 * Sets color of slots border
1792 * Sets default background color of tooltips
1793 * Sets default font color of tooltips
1795 #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
1796 * Adds tooltip for an element
1797 * `<bgcolor>` tooltip background color as `ColorString` (optional)
1798 * `<fontcolor>` tooltip font color as `ColorString` (optional)
1800 #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
1802 * Position and size units are inventory slots
1804 #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
1805 * Show an inventory image of registered item/node
1806 * Position and size units are inventory slots
1808 #### `bgcolor[<color>;<fullscreen>]`
1809 * Sets background color of formspec as `ColorString`
1810 * If `true`, the background color is drawn fullscreen (does not effect the size
1813 #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
1814 * Use a background. Inventory rectangles are not drawn then.
1815 * Position and size units are inventory slots
1816 * Example for formspec 8x4 in 16x resolution: image shall be sized
1817 8 times 16px times 4 times 16px.
1819 #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
1820 * Use a background. Inventory rectangles are not drawn then.
1821 * Position and size units are inventory slots
1822 * Example for formspec 8x4 in 16x resolution:
1823 image shall be sized 8 times 16px times 4 times 16px
1824 * If `true` the background is clipped to formspec size
1825 (`x` and `y` are used as offset values, `w` and `h` are ignored)
1827 #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
1828 * Textual password style field; will be sent to server when a button is clicked
1829 * When enter is pressed in field, fields.key_enter_field will be sent with the
1831 * `x` and `y` position the field relative to the top left of the menu
1832 * `w` and `h` are the size of the field
1833 * Fields are a set height, but will be vertically centred on `h`
1834 * Position and size units are inventory slots
1835 * `name` is the name of the field as returned in fields to `on_receive_fields`
1836 * `label`, if not blank, will be text printed on the top left above the field
1837 * See field_close_on_enter to stop enter closing the formspec
1839 #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1840 * Textual field; will be sent to server when a button is clicked
1841 * When enter is pressed in field, `fields.key_enter_field` will be sent with
1842 the name of this field.
1843 * `x` and `y` position the field relative to the top left of the menu
1844 * `w` and `h` are the size of the field
1845 * Fields are a set height, but will be vertically centred on `h`
1846 * Position and size units are inventory slots
1847 * `name` is the name of the field as returned in fields to `on_receive_fields`
1848 * `label`, if not blank, will be text printed on the top left above the field
1849 * `default` is the default value of the field
1850 * `default` may contain variable references such as `${text}'` which
1851 will fill the value from the metadata value `text`
1852 * **Note**: no extra text or more than a single variable is supported ATM.
1853 * See `field_close_on_enter` to stop enter closing the formspec
1855 #### `field[<name>;<label>;<default>]`
1856 * As above, but without position/size units
1857 * When enter is pressed in field, `fields.key_enter_field` will be sent with
1858 the name of this field.
1859 * Special field for creating simple forms, such as sign text input
1860 * Must be used without a `size[]` element
1861 * A "Proceed" button will be added automatically
1862 * See `field_close_on_enter` to stop enter closing the formspec
1864 #### `field_close_on_enter[<name>;<close_on_enter>]`
1865 * <name> is the name of the field
1866 * if <close_on_enter> is false, pressing enter in the field will submit the
1867 form but not close it.
1868 * defaults to true when not specified (ie: no tag for a field)
1870 #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1871 * Same as fields above, but with multi-line input
1872 * if the text overflows a vertical scrollbar is added
1873 * if the name is empty the textarea is readonly, the label is not displayed.
1875 #### `label[<X>,<Y>;<label>]`
1876 * `x` and `y` work as per field
1877 * `label` is the text on the label
1878 * Position and size units are inventory slots
1880 #### `vertlabel[<X>,<Y>;<label>]`
1881 * Textual label drawn vertically
1882 * `x` and `y` work as per field
1883 * `label` is the text on the label
1884 * Position and size units are inventory slots
1886 #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
1887 * Clickable button. When clicked, fields will be sent.
1888 * `x`, `y` and `name` work as per field
1889 * `w` and `h` are the size of the button
1890 * Fixed button height. It will be vertically centred on `h`
1891 * `label` is the text on the button
1892 * Position and size units are inventory slots
1894 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1895 * `x`, `y`, `w`, `h`, and `name` work as per button
1896 * `texture name` is the filename of an image
1897 * Position and size units are inventory slots
1899 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
1900 * `x`, `y`, `w`, `h`, and `name` work as per button
1901 * `texture name` is the filename of an image
1902 * Position and size units are inventory slots
1903 * `noclip=true` means the image button doesn't need to be within specified
1905 * `drawborder`: draw button border or not
1906 * `pressed texture name` is the filename of an image on pressed state
1908 #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
1909 * `x`, `y`, `w`, `h`, `name` and `label` work as per button
1910 * `item name` is the registered name of an item/node,
1911 tooltip will be made out of its description
1912 to override it use tooltip element
1913 * Position and size units are inventory slots
1915 #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
1916 * When clicked, fields will be sent and the form will quit.
1918 #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1919 * When clicked, fields will be sent and the form will quit.
1921 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
1922 * Scrollable item list showing arbitrary text elements
1923 * `x` and `y` position the itemlist relative to the top left of the menu
1924 * `w` and `h` are the size of the itemlist
1925 * `name` fieldname sent to server on doubleclick value is current selected
1927 * `listelements` can be prepended by #color in hexadecimal format RRGGBB
1929 * if you want a listelement to start with "#" write "##".
1931 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
1932 * Scrollable itemlist showing arbitrary text elements
1933 * `x` and `y` position the item list relative to the top left of the menu
1934 * `w` and `h` are the size of the item list
1935 * `name` fieldname sent to server on doubleclick value is current selected
1937 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
1938 * if you want a listelement to start with "#" write "##"
1939 * Index to be selected within textlist
1940 * `true`/`false`: draw transparent background
1941 * See also `minetest.explode_textlist_event`
1942 (main menu: `core.explode_textlist_event`).
1944 #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
1945 * Show a tab**header** at specific position (ignores formsize)
1946 * `x` and `y` position the itemlist relative to the top left of the menu
1947 * `name` fieldname data is transferred to Lua
1948 * `caption 1`...: name shown on top of tab
1949 * `current_tab`: index of selected tab 1...
1950 * `transparent` (optional): show transparent
1951 * `draw_border` (optional): draw border
1953 #### `box[<X>,<Y>;<W>,<H>;<color>]`
1954 * Simple colored box
1955 * `x` and `y` position the box relative to the top left of the menu
1956 * `w` and `h` are the size of box
1957 * `color` is color specified as a `ColorString`.
1958 If the alpha component is left blank, the box will be semitransparent.
1960 #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
1961 * Show a dropdown field
1962 * **Important note**: There are two different operation modes:
1963 1. handle directly on change (only changed dropdown is submitted)
1964 2. read the value on pressing a button (all dropdown values are available)
1965 * `x` and `y` position of dropdown
1967 * Fieldname data is transferred to Lua
1968 * Items to be shown in dropdown
1969 * Index of currently selected dropdown item
1971 #### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
1973 * `x` and `y`: position of checkbox
1974 * `name` fieldname data is transferred to Lua
1975 * `label` to be shown left of checkbox
1976 * `selected` (optional): `true`/`false`
1978 #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
1980 * There are two ways to use it:
1981 1. handle the changed event (only changed scrollbar is available)
1982 2. read the value on pressing a button (all scrollbars are available)
1983 * `x` and `y`: position of trackbar
1984 * `w` and `h`: width and height
1985 * `orientation`: `vertical`/`horizontal`
1986 * Fieldname data is transferred to Lua
1987 * Value this trackbar is set to (`0`-`1000`)
1988 * See also `minetest.explode_scrollbar_event`
1989 (main menu: `core.explode_scrollbar_event`).
1991 #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
1992 * Show scrollable table using options defined by the previous `tableoptions[]`
1993 * Displays cells as defined by the previous `tablecolumns[]`
1994 * `x` and `y`: position the itemlist relative to the top left of the menu
1995 * `w` and `h` are the size of the itemlist
1996 * `name`: fieldname sent to server on row select or doubleclick
1997 * `cell 1`...`cell n`: cell contents given in row-major order
1998 * `selected idx`: index of row to be selected within table (first row = `1`)
1999 * See also `minetest.explode_table_event`
2000 (main menu: `core.explode_table_event`).
2002 #### `tableoptions[<opt 1>;<opt 2>;...]`
2003 * Sets options for `table[]`
2005 * default text color (`ColorString`), defaults to `#FFFFFF`
2006 * `background=#RRGGBB`
2007 * table background color (`ColorString`), defaults to `#000000`
2008 * `border=<true/false>`
2009 * should the table be drawn with a border? (default: `true`)
2010 * `highlight=#RRGGBB`
2011 * highlight background color (`ColorString`), defaults to `#466432`
2012 * `highlight_text=#RRGGBB`
2013 * highlight text color (`ColorString`), defaults to `#FFFFFF`
2014 * `opendepth=<value>`
2015 * all subtrees up to `depth < value` are open (default value = `0`)
2016 * only useful when there is a column of type "tree"
2018 #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
2019 * Sets columns for `table[]`
2020 * Types: `text`, `image`, `color`, `indent`, `tree`
2021 * `text`: show cell contents as text
2022 * `image`: cell contents are an image index, use column options to define
2024 * `color`: cell contents are a ColorString and define color of following
2026 * `indent`: cell contents are a number and define indentation of following
2028 * `tree`: same as indent, but user can open and close subtrees
2032 * for `text` and `image`: content alignment within cells.
2033 Available values: `left` (default), `center`, `right`, `inline`
2035 * for `text` and `image`: minimum width in em (default: `0`)
2036 * for `indent` and `tree`: indent width in em (default: `1.5`)
2037 * `padding=<value>`: padding left of the column, in em (default `0.5`).
2038 Exception: defaults to 0 for indent columns
2039 * `tooltip=<value>`: tooltip text (default: empty)
2040 * `image` column options:
2041 * `0=<value>` sets image for image index 0
2042 * `1=<value>` sets image for image index 1
2043 * `2=<value>` sets image for image index 2
2044 * and so on; defined indices need not be contiguous empty or
2045 non-numeric cells are treated as `0`.
2046 * `color` column options:
2047 * `span=<value>`: number of following columns to affect
2048 (default: infinite).
2050 **Note**: do _not_ use a element name starting with `key_`; those names are
2051 reserved to pass key press events to formspec!
2055 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
2056 * `"current_player"`: Player to whom the menu is shown
2057 * `"player:<name>"`: Any player
2058 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
2059 * `"detached:<name>"`: A detached inventory
2061 Player Inventory lists
2062 ----------------------
2063 * `main`: list containing the default inventory
2064 * `craft`: list containing the craft input
2065 * `craftpreview`: list containing the craft output
2066 * `hand`: list containing an override for the empty hand
2070 `#RGB` defines a color in hexadecimal format.
2072 `#RGBA` defines a color in hexadecimal format and alpha channel.
2074 `#RRGGBB` defines a color in hexadecimal format.
2076 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
2078 Named colors are also supported and are equivalent to
2079 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
2080 To specify the value of the alpha channel, append `#AA` to the end of the color
2081 name (e.g. `colorname#08`). For named colors the hexadecimal string
2082 representing the alpha value must (always) be two hexadecimal digits.
2086 A ColorSpec specifies a 32-bit color. It can be written in either:
2087 table form, each element ranging from 0..255 (a, if absent, defaults to 255):
2088 `colorspec = {a=255, r=0, g=255, b=0}`
2089 numerical form, the raw integer value of an ARGB8 quad:
2090 `colorspec = 0xFF00FF00`
2091 or string form, a ColorString (defined above):
2092 `colorspec = "green"`
2096 Most text can contain escape sequences, that can for example color the text.
2097 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
2098 The following functions provide escape sequences:
2100 * `minetest.get_color_escape_sequence(color)`:
2101 * `color` is a ColorString
2102 * The escape sequence sets the text color to `color`
2103 * `minetest.colorize(color, message)`:
2105 `minetest.get_color_escape_sequence(color) ..
2107 minetest.get_color_escape_sequence("#ffffff")`
2108 * `minetest.get_background_escape_sequence(color)`
2109 * `color` is a ColorString
2110 * The escape sequence sets the background of the whole text element to
2111 `color`. Only defined for item descriptions and tooltips.
2112 * `minetest.strip_foreground_colors(str)`
2113 * Removes foreground colors added by `get_color_escape_sequence`.
2114 * `minetest.strip_background_colors(str)`
2115 * Removes background colors added by `get_background_escape_sequence`.
2116 * `minetest.strip_colors(str)`
2117 * Removes all color escape sequences.
2121 For the following functions, `v`, `v1`, `v2` are vectors,
2122 `p1`, `p2` are positions:
2124 * `vector.new(a[, b, c])`:
2126 * A copy of `a` if `a` is a vector.
2127 * `{x = a, y = b, z = c}`, if all of `a`, `b`, `c` are defined numbers.
2128 * `vector.direction(p1, p2)`:
2129 * Returns a vector of length 1 with direction `p1` to `p2`.
2130 * If `p1` and `p2` are identical, returns `{x = 0, y = 0, z = 0}`.
2131 * `vector.distance(p1, p2)`:
2132 * Returns zero or a positive number, the distance between `p1` and `p2`.
2133 * `vector.length(v)`:
2134 * Returns zero or a positive number, the length of vector `v`.
2135 * `vector.normalize(v)`:
2136 * Returns a vector of length 1 with direction of vector `v`.
2137 * If `v` has zero length, returns `{x = 0, y = 0, z = 0}`.
2138 * `vector.floor(v)`:
2139 * Returns a vector, each dimension rounded down.
2140 * `vector.round(v)`:
2141 * Returns a vector, each dimension rounded to nearest integer.
2142 * `vector.apply(v, func)`:
2143 * Returns a vector where the function `func` has been applied to each
2145 * `vector.equals(v1, v2)`:
2146 * Returns a boolean, `true` if the vectors are identical.
2147 * `vector.sort(v1, v2)`:
2148 * Returns in order minp, maxp vectors of the cuboid defined by `v1`, `v2`.
2150 For the following functions `x` can be either a vector or a number:
2152 * `vector.add(v, x)`:
2154 * `vector.subtract(v, x)`:
2156 * `vector.multiply(v, x)`:
2157 * Returns a scaled vector or Schur product.
2158 * `vector.divide(v, x)`:
2159 * Returns a scaled vector or Schur quotient.
2163 * `dump2(obj, name, dumped)`: returns a string which makes `obj`
2164 human-readable, handles reference loops.
2165 * `obj`: arbitrary variable
2166 * `name`: string, default: `"_"`
2167 * `dumped`: table, default: `{}`
2168 * `dump(obj, dumped)`: returns a string which makes `obj` human-readable
2169 * `obj`: arbitrary variable
2170 * `dumped`: table, default: `{}`
2171 * `math.hypot(x, y)`
2172 * Get the hypotenuse of a triangle with legs x and y.
2173 Useful for distance calculation.
2174 * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
2175 * Get the sign of a number.
2176 * tolerance: number, default: `0.0`
2177 * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
2179 * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
2180 * `separator`: string, default: `","`
2181 * `include_empty`: boolean, default: `false`
2182 * `max_splits`: number, if it's positive, splits aren't limited,
2184 * `sep_is_pattern`: boolean, it specifies whether separator is a plain
2185 string or a pattern (regex), default: `false`
2186 * e.g. `"a,b":split","` returns `{"a","b"}`
2187 * `string:trim()`: returns the string without whitespace pre- and suffixes
2188 * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
2189 * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
2190 * Adds newlines to the string to keep it within the specified character
2192 * Note that the returned lines may be longer than the limit since it only
2193 splits at word borders.
2194 * `limit`: number, maximal amount of characters in one line
2195 * `as_table`: boolean, if set to true, a table of lines instead of a string
2196 is returned, default: `false`
2197 * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
2198 * `pos`: table {x=X, y=Y, z=Z}
2199 * Converts the position `pos` to a human-readable, printable string
2200 * `decimal_places`: number, if specified, the x, y and z values of
2201 the position are rounded to the given decimal place.
2202 * `minetest.string_to_pos(string)`: returns a position or `nil`
2203 * Same but in reverse.
2204 * If the string can't be parsed to a position, nothing is returned.
2205 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
2206 * Converts a string representing an area box into two positions
2207 * `minetest.formspec_escape(string)`: returns a string
2208 * escapes the characters "[", "]", "\", "," and ";", which can not be used
2210 * `minetest.is_yes(arg)`
2211 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
2212 * `minetest.is_nan(arg)`
2213 * returns true when the passed number represents NaN.
2214 * `minetest.get_us_time()`
2215 * returns time with microsecond precision. May not return wall time.
2216 * `table.copy(table)`: returns a table
2217 * returns a deep copy of `table`
2218 * `table.insert_all(table, other_table)`:
2219 * Appends all values in `other_table` to `table` - uses `#table + 1` to
2221 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
2223 * returns the exact position on the surface of a pointed node
2228 Texts can be translated client-side with the help of `minetest.translate` and
2231 ### Translating a string
2232 Two functions are provided to translate strings: `minetest.translate` and
2233 `minetest.get_translator`.
2235 * `minetest.get_translator(textdomain)` is a simple wrapper around
2236 `minetest.translate`, and `minetest.get_translator(textdomain)(str, ...)` is
2237 equivalent to `minetest.translate(textdomain, str, ...)`.
2238 It is intended to be used in the following way, so that it avoids verbose
2239 repetitions of `minetest.translate`:
2241 local S = minetest.get_translator(textdomain)
2244 As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
2246 * `minetest.translate(textdomain, str, ...)` translates the string `str` with
2247 the given `textdomain` for disambiguation. The textdomain must match the
2248 textdomain specified in the translation file in order to get the string
2249 translated. This can be used so that a string is translated differently in
2251 It is advised to use the name of the mod as textdomain whenever possible, to
2252 avoid clashes with other mods.
2253 This function must be given a number of arguments equal to the number of
2254 arguments the translated string expects.
2255 Arguments are literal strings -- they will not be translated, so if you want
2256 them to be, they need to come as outputs of `minetest.translate` as well.
2258 For instance, suppose we want to translate "@1 Wool" with "@1" being replaced
2259 by the translation of "Red". We can do the following:
2261 local S = minetest.get_translator()
2262 S("@1 Wool", S("Red"))
2264 This will be displayed as "Red Wool" on old clients and on clients that do
2265 not have localization enabled. However, if we have for instance a translation
2266 file named `wool.fr.tr` containing the following:
2271 this will be displayed as "Laine Rouge" on clients with a French locale.
2273 ### Operations on translated strings
2275 The output of `minetest.translate` is a string, with escape sequences adding
2276 additional information to that string so that it can be translated on the
2277 different clients. In particular, you can't expect operations like string.length
2278 to work on them like you would expect them to, or string.gsub to work in the
2279 expected manner. However, string concatenation will still work as expected
2280 (note that you should only use this for things like formspecs; do not translate
2281 sentences by breaking them into parts; arguments should be used instead), and
2282 operations such as `minetest.colorize` which are also concatenation.
2284 ### Translation file format
2285 A translation file has the suffix `.[lang].tr`, where `[lang]` is the language
2286 it corresponds to. It must be put into the `locale` subdirectory of the mod.
2287 The file should be a text file, with the following format:
2289 * Lines beginning with `# textdomain:` (the space is significant) can be used
2290 to specify the text domain of all following translations in the file.
2291 * All other empty lines or lines beginning with `#` are ignored.
2292 * Other lines should be in the format `original=translated`. Both `original`
2293 and `translated` can contain escape sequences beginning with `@` to insert
2294 arguments, literal `@`, `=` or newline (See ### Escapes below).
2295 There must be no extraneous whitespace around the `=` or at the beginning or
2296 the end of the line.
2299 Strings that need to be translated can contain several escapes, preceded by `@`.
2301 * `@@` acts as a literal `@`.
2302 * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated
2303 string that will be inlined when translation. Due to how translations are
2304 implemented, the original translation string **must** have its arguments in
2305 increasing order, without gaps or repetitions, starting from 1.
2306 * `@=` acts as a literal `=`. It is not required in strings given to
2307 `minetest.translate`, but is in translation files to avoid being confused
2308 with the `=` separating the original from the translation.
2309 * `@\n` (where the `\n` is a literal newline) acts as a literal newline.
2310 As with `@=`, this escape is not required in strings given to
2311 `minetest.translate`, but is in translation files.
2312 * `@n` acts as a literal newline as well.
2316 Perlin noise creates a continuously-varying value depending on the input values.
2317 Usually in Minetest the input values are either 2D or 3D co-ordinates in nodes.
2318 The result is used during map generation to create the terrain shape, vary heat
2319 and humidity to distribute biomes, vary the density of decorations or vary the
2322 ### Structure of perlin noise
2323 An 'octave' is a simple noise generator that outputs a value between -1 and 1.
2324 The smooth wavy noise it generates has a single characteristic scale, almost
2325 like a 'wavelength', so on its own does not create fine detail.
2326 Due to this perlin noise combines several octaves to create variation on
2327 multiple scales. Each additional octave has a smaller 'wavelength' than the
2330 This combination results in noise varying very roughly between -2.0 and 2.0 and
2331 with an average value of 0.0, so `scale` and `offset` are then used to multiply
2332 and offset the noise variation.
2334 The final perlin noise variation is created as follows:
2336 noise = offset + scale * (octave1 +
2337 octave2 * persistence +
2338 octave3 * persistence ^ 2 +
2339 octave4 * persistence ^ 3 +
2344 Noise Parameters are commonly called `NoiseParams`.
2347 After the multiplication by `scale` this is added to the result and is the final
2348 step in creating the noise value.
2349 Can be positive or negative.
2352 Once all octaves have been combined, the result is multiplied by this.
2353 Can be positive or negative.
2356 For octave1, this is roughly the change of input value needed for a very large
2357 variation in the noise value generated by octave1. It is almost like a
2358 'wavelength' for the wavy noise variation.
2359 Each additional octave has a 'wavelength' that is smaller than the previous
2360 octave, to create finer detail. `spread` will therefore roughly be the typical
2361 size of the largest structures in the final noise variation.
2363 `spread` is a vector with values for x, y, z to allow the noise variation to be
2364 stretched or compressed in the desired axes.
2365 Values are positive numbers.
2368 This is a whole number that determines the entire pattern of the noise
2369 variation. Altering it enables different noise patterns to be created.
2370 With other parameters equal, different seeds produce different noise patterns
2371 and identical seeds produce identical noise patterns.
2373 For this parameter you can randomly choose any whole number. Usually it is
2374 preferable for this to be different from other seeds, but sometimes it is useful
2375 to be able to create identical noise patterns.
2377 When used in mapgen this is actually a 'seed offset', it is added to the
2378 'world seed' to create the seed used by the noise, to ensure the noise has a
2379 different pattern in different worlds.
2382 The number of simple noise generators that are combined.
2383 A whole number, 1 or more.
2384 Each additional octave adds finer detail to the noise but also increases the
2385 noise calculation load.
2386 3 is a typical minimum for a high quality, complex and natural-looking noise
2387 variation. 1 octave has a slight 'gridlike' appearence.
2389 Choose the number of octaves according to the `spread` and `lacunarity`, and the
2390 size of the finest detail you require. For example:
2391 if `spread` is 512 nodes, `lacunarity` is 2.0 and finest detail required is 16
2392 nodes, octaves will be 6 because the 'wavelengths' of the octaves will be
2393 512, 256, 128, 64, 32, 16 nodes.
2394 Warning: If the 'wavelength' of any octave falls below 1 an error will occur.
2397 Each additional octave has an amplitude that is the amplitude of the previous
2398 octave multiplied by `persistence`, to reduce the amplitude of finer details,
2399 as is often helpful and natural to do so.
2400 Since this controls the balance of fine detail to large-scale detail
2401 `persistence` can be thought of as the 'roughness' of the noise.
2403 A positive or negative non-zero number, often between 0.3 and 1.0.
2404 A common medium value is 0.5, such that each octave has half the amplitude of
2405 the previous octave.
2406 This may need to be tuned when altering `lacunarity`; when doing so consider
2407 that a common medium value is 1 / lacunarity.
2410 Each additional octave has a 'wavelength' that is the 'wavelength' of the
2411 previous octave multiplied by 1 / lacunarity, to create finer detail.
2412 'lacunarity' is often 2.0 so 'wavelength' often halves per octave.
2414 A positive number no smaller than 1.0.
2415 Values below 2.0 create higher quality noise at the expense of requiring more
2416 octaves to cover a paticular range of 'wavelengths'.
2419 Leave this field unset for no special handling.
2420 Currently supported are `defaults`, `eased` and `absvalue`:
2423 Specify this if you would like to keep auto-selection of eased/not-eased while
2424 specifying some other flags.
2427 Maps noise gradient values onto a quintic S-curve before performing
2428 interpolation. This results in smooth, rolling noise.
2429 Disable this (`noeased`) for sharp-looking noise with a slightly gridded
2431 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is
2433 Easing a 3D noise significantly increases the noise calculation load, so use
2437 The absolute value of each octave's noise variation is used when combining the
2438 octaves. The final perlin noise variation is created as follows:
2440 noise = offset + scale * (abs(octave1) +
2441 abs(octave2) * persistence +
2442 abs(octave3) * persistence ^ 2 +
2443 abs(octave4) * persistence ^ 3 +
2447 For 2D or 3D perlin noise or perlin noise maps:
2452 spread = {x = 500, y = 500, z = 500},
2457 flags = "defaults, absvalue",
2460 For 2D noise the Z component of `spread` is still defined but is ignored.
2461 A single noise parameter table can be used for 2D or 3D noise.
2465 These tell in what manner the ore is generated.
2467 All default ores are of the uniformly-distributed scatter type.
2470 Randomly chooses a location and generates a cluster of ore.
2472 If `noise_params` is specified, the ore will be placed if the 3D perlin noise
2473 at that point is greater than the `noise_threshold`, giving the ability to
2474 create a non-equal distribution of ore.
2477 Creates a sheet of ore in a blob shape according to the 2D perlin noise
2478 described by `noise_params` and `noise_threshold`. This is essentially an
2479 improved version of the so-called "stratus" ore seen in some unofficial mods.
2481 This sheet consists of vertical columns of uniform randomly distributed height,
2482 varying between the inclusive range `column_height_min` and `column_height_max`.
2483 If `column_height_min` is not specified, this parameter defaults to 1.
2484 If `column_height_max` is not specified, this parameter defaults to `clust_size`
2485 for reverse compatibility. New code should prefer `column_height_max`.
2487 The `column_midpoint_factor` parameter controls the position of the column at
2488 which ore emanates from.
2489 If 1, columns grow upward. If 0, columns grow downward. If 0.5, columns grow
2490 equally starting from each direction.
2491 `column_midpoint_factor` is a decimal number ranging in value from 0 to 1. If
2492 this parameter is not specified, the default is 0.5.
2494 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this
2498 Creates a sheet of ore in a cloud-like puff shape.
2500 As with the `sheet` ore type, the size and shape of puffs are described by
2501 `noise_params` and `noise_threshold` and are placed at random vertical
2502 positions within the currently generated chunk.
2504 The vertical top and bottom displacement of each puff are determined by the
2505 noise parameters `np_puff_top` and `np_puff_bottom`, respectively.
2508 Creates a deformed sphere of ore according to 3d perlin noise described by
2509 `noise_params`. The maximum size of the blob is `clust_size`, and
2510 `clust_scarcity` has the same meaning as with the `scatter` type.
2513 Creates veins of ore varying in density by according to the intersection of two
2514 instances of 3d perlin noise with different seeds, both described by
2517 `random_factor` varies the influence random chance has on placement of an ore
2518 inside the vein, which is `1` by default. Note that modifying this parameter
2519 may require adjusting `noise_threshold`.
2521 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
2524 This ore type is difficult to control since it is sensitive to small changes.
2525 The following is a decent set of parameters to work from:
2530 spread = {x=200, y=200, z=200},
2537 noise_threshold = 1.6
2539 **WARNING**: Use this ore type *very* sparingly since it is ~200x more
2540 computationally expensive than any other ore.
2543 Creates a single undulating ore stratum that is continuous across mapchunk
2544 borders and horizontally spans the world.
2546 The 2D perlin noise described by `noise_params` defines the Y co-ordinate of
2547 the stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
2548 defines the stratum's vertical thickness (in units of nodes). Due to being
2549 continuous across mapchunk borders the stratum's vertical thickness is
2552 If the noise parameter `noise_params` is omitted the ore will occur from y_min
2553 to y_max in a simple horizontal stratum.
2555 A parameter `stratum_thickness` can be provided instead of the noise parameter
2556 `np_stratum_thickness`, to create a constant thickness.
2558 Leaving out one or both noise parameters makes the ore generation less
2559 intensive, useful when adding multiple strata.
2561 `y_min` and `y_max` define the limits of the ore generation and for performance
2562 reasons should be set as close together as possible but without clipping the
2563 stratum's Y variation.
2565 Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
2566 solid-ore stratum would require a `clust_scarcity` of 1.
2568 The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
2569 `random_factor` are ignored by this ore type.
2573 See section "Flag Specifier Format".
2575 Currently supported flags:
2576 `puff_cliffs`, `puff_additive_composition`.
2579 If set, puff ore generation will not taper down large differences in
2580 displacement when approaching the edge of a puff. This flag has no effect for
2581 ore types other than `puff`.
2583 ### `puff_additive_composition`
2584 By default, when noise described by `np_puff_top` or `np_puff_bottom` results
2585 in a negative displacement, the sub-column at that point is not generated. With
2586 this attribute set, puff ore generation will instead generate the absolute
2587 difference in noise displacement values. This flag has no effect for ore types
2592 The varying types of decorations that can be placed.
2595 Creates a 1 times `H` times 1 column of a specified node (or a random node from
2596 a list, if a decoration list is specified). Can specify a certain node it must
2597 spawn next to, such as water or lava, for example. Can also generate a
2598 decoration of random height between a specified lower and upper bound.
2599 This type of decoration is intended for placement of grass, flowers, cacti,
2600 papyri, waterlilies and so on.
2603 Copies a box of `MapNodes` from a specified schematic file (or raw description).
2604 Can specify a probability of a node randomly appearing when placed.
2605 This decoration type is intended to be used for multi-node sized discrete
2606 structures, such as trees, cave spikes, rocks, and so on.
2609 --------------------
2610 A schematic specifier identifies a schematic by either a filename to a
2611 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
2612 in the form of a table. This table specifies the following fields:
2614 * The `size` field is a 3D vector containing the dimensions of the provided
2615 schematic. (required)
2616 * The `yslice_prob` field is a table of {ypos, prob} which sets the `ypos`th
2617 vertical slice of the schematic to have a `prob / 256 * 100` chance of
2618 occurring. (default: 255)
2619 * The `data` field is a flat table of MapNode tables making up the schematic,
2620 in the order of `[z [y [x]]]`. (required)
2621 Each MapNode table contains:
2622 * `name`: the name of the map node to place (required)
2623 * `prob` (alias `param1`): the probability of this node being placed
2625 * `param2`: the raw param2 value of the node being placed onto the map
2627 * `force_place`: boolean representing if the node should forcibly overwrite
2628 any previous contents (default: false)
2630 About probability values:
2632 * A probability value of `0` or `1` means that node will never appear
2634 * A probability value of `254` or `255` means the node will always appear
2636 * If the probability value `p` is greater than `1`, then there is a
2637 `(p / 256 * 100)` percent chance that node will appear when the schematic is
2640 Schematic attributes
2641 --------------------
2642 See section "Flag Specifier Format".
2644 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
2647 * `place_center_x`: Placement of this decoration is centered along the X axis.
2648 * `place_center_y`: Placement of this decoration is centered along the Y axis.
2649 * `place_center_z`: Placement of this decoration is centered along the Z axis.
2650 * `force_placement`: Schematic nodes other than "ignore" will replace existing
2653 Lua Voxel Manipulator
2654 ---------------------
2655 ### About VoxelManip
2656 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator'
2657 facility. The purpose of this object is for fast, low-level, bulk access to
2658 reading and writing Map content. As such, setting map nodes through VoxelManip
2659 will lack many of the higher level features and concepts you may be used to
2660 with other methods of setting nodes. For example, nodes will not have their
2661 construction and destruction callbacks run, and no rollback information is
2664 It is important to note that VoxelManip is designed for speed, and *not* ease
2665 of use or flexibility. If your mod requires a map manipulation facility that
2666 will handle 100% of all edge cases, or the use of high level node placement
2667 features, perhaps `minetest.set_node()` is better suited for the job.
2669 In addition, VoxelManip might not be faster, or could even be slower, for your
2670 specific use case. VoxelManip is most effective when setting large areas of map
2671 at once - for example, if only setting a 3x3x3 node area, a
2672 `minetest.set_node()` loop may be more optimal. Always profile code using both
2673 methods of map manipulation to determine which is most appropriate for your
2676 A recent simple test of setting cubic areas showed that `minetest.set_node()`
2677 is faster than a VoxelManip for a 3x3x3 node cube or smaller.
2679 ### Using VoxelManip
2680 A VoxelManip object can be created any time using either:
2681 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
2683 If the optional position parameters are present for either of these routines,
2684 the specified region will be pre-loaded into the VoxelManip object on creation.
2685 Otherwise, the area of map you wish to manipulate must first be loaded into the
2686 VoxelManip object using `VoxelManip:read_from_map()`.
2688 Note that `VoxelManip:read_from_map()` returns two position vectors. The region
2689 formed by these positions indicate the minimum and maximum (respectively)
2690 positions of the area actually loaded in the VoxelManip, which may be larger
2691 than the area requested. For convenience, the loaded area coordinates can also
2692 be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
2694 Now that the VoxelManip object is populated with map data, your mod can fetch a
2695 copy of this data using either of two methods. `VoxelManip:get_node_at()`,
2696 which retrieves an individual node in a MapNode formatted table at the position
2697 requested is the simplest method to use, but also the slowest.
2699 Nodes in a VoxelManip object may also be read in bulk to a flat array table
2702 * `VoxelManip:get_data()` for node content (in Content ID form, see section
2704 * `VoxelManip:get_light_data()` for node light levels, and
2705 * `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
2707 See section 'Flat array format' for more details.
2709 It is very important to understand that the tables returned by any of the above
2710 three functions represent a snapshot of the VoxelManip's internal state at the
2711 time of the call. This copy of the data will not magically update itself if
2712 another function modifies the internal VoxelManip state.
2713 Any functions that modify a VoxelManip's contents work on the VoxelManip's
2714 internal state unless otherwise explicitly stated.
2716 Once the bulk data has been edited to your liking, the internal VoxelManip
2717 state can be set using:
2719 * `VoxelManip:set_data()` for node content (in Content ID form, see section
2721 * `VoxelManip:set_light_data()` for node light levels, and
2722 * `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
2724 The parameter to each of the above three functions can use any table at all in
2725 the same flat array format as produced by `get_data()` etc. and is not required
2726 to be a table retrieved from `get_data()`.
2728 Once the internal VoxelManip state has been modified to your liking, the
2729 changes can be committed back to the map by calling `VoxelManip:write_to_map()`
2732 #### Flat array format
2734 `Nx = p2.X - p1.X + 1`,
2735 `Ny = p2.Y - p1.Y + 1`, and
2736 `Nz = p2.Z - p1.Z + 1`.
2738 Then, for a loaded region of p1..p2, this array ranges from `1` up to and
2739 including the value of the expression `Nx * Ny * Nz`.
2741 Positions offset from p1 are present in the array with the format of:
2745 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
2746 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
2748 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
2749 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
2751 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
2753 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
2757 and the array index for a position p contained completely in p1..p2 is:
2759 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
2761 Note that this is the same "flat 3D array" format as
2762 `PerlinNoiseMap:get3dMap_flat()`.
2763 VoxelArea objects (see section 'VoxelArea') can be used to simplify calculation
2764 of the index for a single point in a flat VoxelManip array.
2767 A Content ID is a unique integer identifier for a specific node type.
2768 These IDs are used by VoxelManip in place of the node name string for
2769 `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
2770 `minetest.get_content_id()` to look up the Content ID for the specified node
2771 name, and `minetest.get_name_from_content_id()` to look up the node name string
2772 for a given Content ID.
2773 After registration of a node, its Content ID will remain the same throughout
2774 execution of the mod.
2775 Note that the node being queried needs to have already been been registered.
2777 The following builtin node types have their Content IDs defined as constants:
2779 * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
2780 * `minetest.CONTENT_AIR`: ID for "air" nodes
2781 * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
2783 #### Mapgen VoxelManip objects
2784 Inside of `on_generated()` callbacks, it is possible to retrieve the same
2785 VoxelManip object used by the core's Map Generator (commonly abbreviated
2786 Mapgen). Most of the rules previously described still apply but with a few
2789 * The Mapgen VoxelManip object is retrieved using:
2790 `minetest.get_mapgen_object("voxelmanip")`
2791 * This VoxelManip object already has the region of map just generated loaded
2792 into it; it's not necessary to call `VoxelManip:read_from_map()` before using
2793 a Mapgen VoxelManip.
2794 * The `on_generated()` callbacks of some mods may place individual nodes in the
2795 generated area using non-VoxelManip map modification methods. Because the
2796 same Mapgen VoxelManip object is passed through each `on_generated()`
2797 callback, it becomes necessary for the Mapgen VoxelManip object to maintain
2798 consistency with the current map state. For this reason, calling any of the
2799 following functions:
2800 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
2801 will also update the Mapgen VoxelManip object's internal state active on the
2803 * After modifying the Mapgen VoxelManip object's internal buffer, it may be
2804 necessary to update lighting information using either:
2805 `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
2807 #### Other API functions operating on a VoxelManip
2808 If any VoxelManip contents were set to a liquid node,
2809 `VoxelManip:update_liquids()` must be called for these liquid nodes to begin
2810 flowing. It is recommended to call this function only after having written all
2811 buffered data back to the VoxelManip object, save for special situations where
2812 the modder desires to only have certain liquid nodes begin flowing.
2814 The functions `minetest.generate_ores()` and `minetest.generate_decorations()`
2815 will generate all registered decorations and ores throughout the full area
2816 inside of the specified VoxelManip object.
2818 `minetest.place_schematic_on_vmanip()` is otherwise identical to
2819 `minetest.place_schematic()`, except instead of placing the specified schematic
2820 directly on the map at the specified position, it will place the schematic
2821 inside the VoxelManip.
2824 * Attempting to read data from a VoxelManip object before map is read will
2825 result in a zero-length array table for `VoxelManip:get_data()`, and an
2826 "ignore" node at any position for `VoxelManip:get_node_at()`.
2827 * If either a region of map has not yet been generated or is out-of-bounds of
2828 the map, that region is filled with "ignore" nodes.
2829 * Other mods, or the core itself, could possibly modify the area of map
2830 currently loaded into a VoxelManip object. With the exception of Mapgen
2831 VoxelManips (see above section), the internal buffers are not updated. For
2832 this reason, it is strongly encouraged to complete the usage of a particular
2833 VoxelManip object in the same callback it had been created.
2834 * If a VoxelManip object will be used often, such as in an `on_generated()`
2835 callback, consider passing a file-scoped table as the optional parameter to
2836 `VoxelManip:get_data()`, which serves as a static buffer the function can use
2837 to write map data to instead of returning a new table each call. This greatly
2838 enhances performance by avoiding unnecessary memory allocations.
2841 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object
2842 containing the region formed by `p1` and `p2`.
2843 * returns actual emerged `pmin`, actual emerged `pmax`
2844 * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to
2846 * **important**: data must be set using `VoxelManip:set_data()` before
2848 * if `light` is true, then lighting is automatically recalculated.
2849 The default value is true.
2850 If `light` is false, no light calculations happen, and you should correct
2851 all modified blocks with `minetest.fix_light()` as soon as possible.
2852 Keep in mind that modifying the map where light is incorrect can cause
2854 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
2855 the `VoxelManip` at that position
2856 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
2858 * `get_data([buffer])`: Retrieves the node content data loaded into the
2859 `VoxelManip` object.
2860 * returns raw node data in the form of an array of node content IDs
2861 * if the param `buffer` is present, this table will be used to store the
2863 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
2864 * `update_map()`: Does nothing, kept for compatibility.
2865 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to
2867 * `light` is a table, `{day=<0...15>, night=<0...15>}`
2868 * To be used only by a `VoxelManip` object from
2869 `minetest.get_mapgen_object`.
2870 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
2872 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
2873 * Returns an array (indices 1 to volume) of integers ranging from `0` to
2875 * Each value is the bitwise combination of day and night light values
2877 * `light = day + (night * 16)`
2878 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
2879 in the `VoxelManip`.
2880 * expects lighting data in the same format that `get_light_data()` returns
2881 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the
2882 `VoxelManip` object.
2883 * Returns an array (indices 1 to volume) of integers ranging from `0` to
2885 * If the param `buffer` is present, this table will be used to store the
2887 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in
2889 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the
2891 * To be used only by a `VoxelManip` object from
2892 `minetest.get_mapgen_object`.
2893 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
2894 area if left out or nil.
2895 * `propagate_shadow` is an optional boolean deciding whether shadows in a
2896 generated mapchunk above are propagated down into the mapchunk, defaults
2897 to `true` if left out.
2898 * `update_liquids()`: Update liquid flow
2899 * `was_modified()`: Returns `true` or `false` if the data in the voxel
2900 manipulator had been modified since the last read from map, due to a call to
2901 `minetest.set_data()` on the loaded area elsewhere.
2902 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
2905 A helper class for voxel areas.
2906 It can be created via `VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}`.
2907 The coordinates are *inclusive*, like most other things in Minetest.
2910 * `getExtent()`: returns a 3D vector containing the size of the area formed by
2911 `MinEdge` and `MaxEdge`.
2912 * `getVolume()`: returns the volume of the area formed by `MinEdge` and
2914 * `index(x, y, z)`: returns the index of an absolute position in a flat array
2916 * `x`, `y` and `z` must be integers to avoid an incorrect index result.
2917 * The position (x, y, z) is not checked for being inside the area volume,
2918 being outside can cause an incorrect index result.
2919 * Useful for things like `VoxelManip`, raw Schematic specifiers,
2920 `PerlinNoiseMap:get2d`/`3dMap`, and so on.
2921 * `indexp(p)`: same functionality as `index(x, y, z)` but takes a vector.
2922 * As with `index(x, y, z)`, the components of `p` must be integers, and `p`
2923 is not checked for being inside the area volume.
2924 * `position(i)`: returns the absolute position vector corresponding to index
2926 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by
2927 `MinEdge` and `MaxEdge`.
2928 * `containsp(p)`: same as above, except takes a vector
2929 * `containsi(i)`: same as above, except takes an index `i`
2930 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns
2932 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of
2934 * `iterp(minp, maxp)`: same as above, except takes a vector
2938 A mapgen object is a construct used in map generation. Mapgen objects can be
2939 used by an `on_generate` callback to speed up operations by avoiding
2940 unnecessary recalculations, these can be retrieved using the
2941 `minetest.get_mapgen_object()` function. If the requested Mapgen object is
2942 unavailable, or `get_mapgen_object()` was called outside of an `on_generate()`
2943 callback, `nil` is returned.
2945 The following Mapgen objects are currently available:
2948 This returns three values; the `VoxelManip` object to be used, minimum and
2949 maximum emerged position, in that order. All mapgens support this object.
2952 Returns an array containing the y coordinates of the ground levels of nodes in
2953 the most recently generated chunk by the current mapgen.
2956 Returns an array containing the biome IDs of nodes in the most recently
2957 generated chunk by the current mapgen.
2960 Returns an array containing the temperature values of nodes in the most
2961 recently generated chunk by the current mapgen.
2964 Returns an array containing the humidity values of nodes in the most recently
2965 generated chunk by the current mapgen.
2968 Returns a table mapping requested generation notification types to arrays of
2969 positions at which the corresponding generated structures are located within
2970 the current chunk. To set the capture of positions of interest to be recorded
2971 on generate, use `minetest.set_gen_notify()`.
2972 For decorations, the returned positions are the ground surface 'place_on'
2973 nodes, not the decorations themselves. A 'simple' type decoration is often 1
2974 node above the returned position and possibly displaced by 'place_offset_y'.
2976 Possible fields of the table returned are:
2982 * `large_cave_begin`
2986 Decorations have a key in the format of `"decoration#id"`, where `id` is the
2987 numeric unique decoration ID.
2991 * Functions receive a "luaentity" as `self`:
2992 * It has the member `.name`, which is the registered name `("mod:thing")`
2993 * It has the member `.object`, which is an `ObjectRef` pointing to the
2995 * The original prototype stuff is visible directly via a metatable
2997 * `on_activate(self, staticdata, dtime_s)`
2998 * Called when the object is instantiated.
2999 * `dtime_s` is the time passed since the object was unloaded, which can
3000 be used for updating the entity state.
3001 * `on_step(self, dtime)`
3002 * Called on every server tick, after movement and collision processing.
3003 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step`
3004 setting `in minetest.conf`.
3005 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)`
3006 * Called when somebody punches the object.
3007 * Note that you probably want to handle most punches using the
3008 automatic armor group system.
3009 * `puncher`: an `ObjectRef` (can be `nil`)
3010 * `time_from_last_punch`: Meant for disallowing spamming of clicks
3012 * `tool_capabilities`: capability table of used tool (can be `nil`)
3013 * `dir`: unit vector of direction of punch. Always defined. Points from
3014 the puncher to the punched.
3015 * `on_death(self, killer)`
3016 * Called when the object dies.
3017 * `killer`: an `ObjectRef` (can be `nil`)
3018 * `on_rightclick(self, clicker)`
3019 * `on_attach_child(self, child)`
3020 * `child`: an `ObjectRef` of the child that attaches
3021 * `on_detach_child(self, child)`
3022 * `child`: an `ObjectRef` of the child that detaches
3023 * `on_detach(self, parent)`
3024 * `parent`: an `ObjectRef` (can be `nil`) from where it got detached
3025 * This happens before the parent object is removed from the world
3026 * `get_staticdata(self)`
3027 * Should return a string that will be passed to `on_activate` when
3028 the object is instantiated the next time.
3036 axiom, --string initial tree axiom
3037 rules_a, --string rules set A
3038 rules_b, --string rules set B
3039 rules_c, --string rules set C
3040 rules_d, --string rules set D
3041 trunk, --string trunk node name
3042 leaves, --string leaves node name
3043 leaves2, --string secondary leaves node name
3044 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
3045 angle, --num angle in deg
3046 iterations, --num max # of iterations, usually 2 -5
3047 random_level, --num factor to lower nr of iterations, usually 0 - 3
3048 trunk_type, --string single/double/crossed) type of trunk: 1 node,
3049 -- 2x2 nodes or 3x3 in cross shape
3050 thin_branches, --boolean true -> use thin (1 node) branches
3051 fruit, --string fruit node name
3052 fruit_chance, --num chance (0-100) to replace leaves with fruit node
3053 seed, --num random seed, if no seed is provided, the engine
3057 ### Key for Special L-System Symbols used in Axioms
3059 * `G`: move forward one unit with the pen up
3060 * `F`: move forward one unit with the pen down drawing trunks and branches
3061 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
3062 * `T`: move forward one unit with the pen down drawing trunks only
3063 * `R`: move forward one unit with the pen down placing fruit
3064 * `A`: replace with rules set A
3065 * `B`: replace with rules set B
3066 * `C`: replace with rules set C
3067 * `D`: replace with rules set D
3068 * `a`: replace with rules set A, chance 90%
3069 * `b`: replace with rules set B, chance 80%
3070 * `c`: replace with rules set C, chance 70%
3071 * `d`: replace with rules set D, chance 60%
3072 * `+`: yaw the turtle right by `angle` parameter
3073 * `-`: yaw the turtle left by `angle` parameter
3074 * `&`: pitch the turtle down by `angle` parameter
3075 * `^`: pitch the turtle up by `angle` parameter
3076 * `/`: roll the turtle to the right by `angle` parameter
3077 * `*`: roll the turtle to the left by `angle` parameter
3078 * `[`: save in stack current state info
3079 * `]`: recover from stack state info
3082 Spawn a small apple tree:
3084 pos = {x=230,y=20,z=4}
3087 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
3088 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
3089 trunk="default:tree",
3090 leaves="default:leaves",
3094 trunk_type="single",
3097 fruit="default:apple"
3099 minetest.spawn_tree(pos,apple_tree)
3102 `minetest` namespace reference
3103 ------------------------------
3107 * `minetest.get_current_modname()`: returns the currently loading mod's name,
3109 * `minetest.get_modpath(modname)`: returns e.g.
3110 `"/home/user/.minetest/usermods/modname"`.
3111 * Useful for loading additional `.lua` modules or static data from mod
3112 * `minetest.get_modnames()`: returns a list of installed mods
3113 * Return a list of installed mods, sorted alphabetically
3114 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
3115 * Useful for storing custom data
3116 * `minetest.is_singleplayer()`
3117 * `minetest.features`: Table containing API feature flags
3120 glasslike_framed = true,
3121 nodebox_as_selectionbox = true,
3122 chat_send_player_param3 = true,
3123 get_all_craft_recipes_works = true,
3124 use_texture_alpha = true,
3125 -- ^ The transparency channel of textures can optionally be used on nodes
3126 no_legacy_abms = true,
3127 -- ^ Tree and grass ABMs are no longer done from C++
3128 texture_names_parens = true,
3129 -- ^ Texture grouping is possible using parentheses
3130 area_store_custom_ids = true,
3131 -- ^ Unique Area ID for AreaStore:insert_area
3132 add_entity_with_staticdata = true,
3133 -- ^ add_entity supports passing initial staticdata to on_activate
3134 no_chat_message_prediction = true,
3135 -- ^ Chat messages are no longer predicted
3136 object_use_texture_alpha = true
3137 -- ^ The transparency channel of textures can optionally be used on
3138 -- objects (ie: players and lua entities)
3140 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
3141 * `arg`: string or table in format `{foo=true, bar=true}`
3142 * `missing_features`: `{foo=true, bar=true}`
3143 * `minetest.get_player_information(player_name)`:
3144 * Returns a table containing information about a player.
3145 Example return value:
3148 address = "127.0.0.1", -- IP address of client
3149 ip_version = 4, -- IPv4 / IPv6
3150 min_rtt = 0.01, -- minimum round trip time
3151 max_rtt = 0.2, -- maximum round trip time
3152 avg_rtt = 0.02, -- average round trip time
3153 min_jitter = 0.01, -- minimum packet time jitter
3154 max_jitter = 0.5, -- maximum packet time jitter
3155 avg_jitter = 0.03, -- average packet time jitter
3156 connection_uptime = 200, -- seconds since client connected
3157 protocol_version = 32, -- protocol version used by client
3158 -- following information is available on debug build only!!!
3159 -- DO NOT USE IN MODS
3160 --ser_vers = 26, -- serialization version used by client
3161 --major = 0, -- major version number
3162 --minor = 4, -- minor version number
3163 --patch = 10, -- patch version number
3164 --vers_string = "0.4.9-git", -- full version string
3165 --state = "Active" -- current client state
3167 * `minetest.mkdir(path)`: returns success.
3168 * Creates a directory specified by `path`, creating parent directories
3169 if they don't exist.
3170 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
3172 * nil: return all entries,
3173 * true: return only subdirectory names, or
3174 * false: return only file names.
3175 * `minetest.safe_file_write(path, content)`: returns boolean indicating success
3176 * Replaces contents of file at path with new contents in a safe (atomic)
3177 way. Use this instead of below code when writing e.g. database files:
3178 `local f = io.open(path, "wb"); f:write(content); f:close()`
3179 * `minetest.get_version()`: returns a table containing components of the
3180 engine version. Components:
3181 * `project`: Name of the project, eg, "Minetest"
3182 * `string`: Simple version, eg, "1.2.3-dev"
3183 * `hash`: Full git version (only set if available),
3184 eg, "1.2.3-dev-01234567-dirty".
3185 Use this for informational purposes only. The information in the returned
3186 table does not represent the capabilities of the engine, nor is it
3187 reliable or verifiable. Compatible forks will have a different name and
3188 version entirely. To check for the presence of engine features, test
3189 whether the functions exported by the wanted features exist. For example:
3190 `if minetest.check_for_falling then ... end`.
3191 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
3192 * `data`: string of data to hash
3193 * `raw`: return raw bytes instead of hex digits, default: false
3196 * `minetest.debug(...)`
3197 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
3198 * `minetest.log([level,] text)`
3199 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
3200 `"info"`, or `"verbose"`. Default is `"none"`.
3202 ### Registration functions
3203 Call these functions only at load time!
3205 * `minetest.register_entity(name, prototype table)`
3206 * `minetest.register_abm(abm definition)`
3207 * `minetest.register_lbm(lbm definition)`
3208 * `minetest.register_node(name, node definition)`
3209 * `minetest.register_tool(name, item definition)`
3210 * `minetest.register_craftitem(name, item definition)`
3211 * `minetest.unregister_item(name)`
3212 * `minetest.register_alias(name, convert_to)`
3213 * Also use this to set the 'mapgen aliases' needed in a game for the core
3214 * mapgens. See 'Mapgen aliases' section above.
3215 * `minetest.register_alias_force(name, convert_to)`
3216 * `minetest.register_craft(recipe)`
3217 * Check recipe table syntax for different types below.
3218 * `minetest.clear_craft(recipe)`
3219 * Will erase existing craft based either on output item or on input recipe.
3220 * Specify either output or input only. If you specify both, input will be
3221 ignored. For input use the same recipe table syntax as for
3222 `minetest.register_craft(recipe)`. For output specify only the item,
3224 * If no erase candidate could be found, Lua exception will be thrown.
3225 * **Warning**! The type field ("shaped","cooking" or any other) will be
3226 ignored if the recipe contains output. Erasing is then done independently
3227 from the crafting method.
3228 * `minetest.register_ore(ore definition)`
3229 * `minetest.register_biome(biome definition)`
3230 * `minetest.register_decoration(decoration definition)`
3231 * `minetest.override_item(name, redefinition)`
3232 * Overrides fields of an item registered with register_node/tool/craftitem.
3233 * Note: Item must already be defined, (opt)depend on the mod defining it.
3234 * Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})`
3235 * `minetest.clear_registered_ores()`
3236 * `minetest.clear_registered_biomes()`
3237 * `minetest.clear_registered_decorations()`
3239 ### Global callback registration functions
3240 Call these functions only at load time!
3242 * `minetest.register_globalstep(func(dtime))`
3243 * Called every server step, usually interval of 0.1s
3244 * `minetest.register_on_mods_loaded(func())`
3245 * Called after mods have finished loading and before the media is cached or the
3247 * `minetest.register_on_shutdown(func())`
3248 * Called before server shutdown
3249 * **Warning**: If the server terminates abnormally (i.e. crashes), the
3250 registered callbacks **will likely not be run**. Data should be saved at
3251 semi-frequent intervals as well as on server shutdown.
3252 * `minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
3253 * Called when a node has been placed
3254 * If return `true` no item is taken from `itemstack`
3255 * `placer` may be any valid ObjectRef or nil.
3256 * **Not recommended**; use `on_construct` or `after_place_node` in node
3257 definition whenever possible.
3258 * `minetest.register_on_dignode(func(pos, oldnode, digger))`
3259 * Called when a node has been dug.
3260 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node
3261 definition whenever possible.
3262 * `minetest.register_on_punchnode(func(pos, node, puncher, pointed_thing))`
3263 * Called when a node is punched
3264 * `minetest.register_on_generated(func(minp, maxp, blockseed))`
3265 * Called after generating a piece of world. Modifying nodes inside the area
3266 is a bit faster than usually.
3267 * `minetest.register_on_newplayer(func(ObjectRef))`
3268 * Called after a new player has been created
3269 * `minetest.register_on_punchplayer(func(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
3270 * Called when a player is punched
3271 * `player` - ObjectRef - Player that was punched
3272 * `hitter` - ObjectRef - Player that hit
3273 * `time_from_last_punch`: Meant for disallowing spamming of clicks
3275 * `tool_capabilities`: capability table of used tool (can be nil)
3276 * `dir`: unit vector of direction of punch. Always defined. Points from
3277 the puncher to the punched.
3278 * `damage` - number that represents the damage calculated by the engine
3279 * should return `true` to prevent the default damage mechanism
3280 * `minetest.register_on_player_hpchange(func(player, hp_change, reason), modifier)`
3281 * Called when the player gets damaged or healed
3282 * `player`: ObjectRef of the player
3283 * `hp_change`: the amount of change. Negative when it is damage.
3284 * `reason`: a PlayerHPChangeReason table.
3285 * The `type` field will have one of the following values:
3286 * `set_hp` - A mod or the engine called `set_hp` without
3287 giving a type - use this for custom damage types.
3288 * `punch` - Was punched. `reason.object` will hold the puncher, or nil if none.
3290 * `node_damage` - damage_per_second from a neighbouring node.
3293 * Any of the above types may have additional fields from mods.
3294 * `reason.from` will be `mod` or `engine`.
3295 * `modifier`: when true, the function should return the actual `hp_change`.
3296 Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
3297 modifiers can return true as a second argument to stop the execution of further functions.
3298 Non-modifiers receive the final hp change calculated by the modifiers.
3299 * `minetest.register_on_dieplayer(func(ObjectRef, reason))`
3300 * Called when a player dies
3301 * `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
3302 * `minetest.register_on_respawnplayer(func(ObjectRef))`
3303 * Called when player is to be respawned
3304 * Called _before_ repositioning of player occurs
3305 * return true in func to disable regular player placement
3306 * `minetest.register_on_prejoinplayer(func(name, ip))`
3307 * Called before a player joins the game
3308 * If it returns a string, the player is disconnected with that string as
3310 * `minetest.register_on_joinplayer(func(ObjectRef))`
3311 * Called when a player joins the game
3312 * `minetest.register_on_leaveplayer(func(ObjectRef, timed_out))`
3313 * Called when a player leaves the game
3314 * `timed_out`: True for timeout, false for other reasons.
3315 * `minetest.register_on_auth_fail(func(name, ip))`
3316 * Called when a client attempts to log into an account but supplies the
3318 * `ip`: The IP address of the client.
3319 * `name`: The account the client attempted to log into.
3320 * `minetest.register_on_cheat(func(ObjectRef, cheat))`
3321 * Called when a player cheats
3322 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
3324 * `interacted_too_far`
3325 * `interacted_while_dead`
3326 * `finished_unknown_dig`
3329 * `minetest.register_on_chat_message(func(name, message))`
3330 * Called always when a player says something
3331 * Return `true` to mark the message as handled, which means that it will
3332 not be sent to other players.
3333 * `minetest.register_on_player_receive_fields(func(player, formname, fields))`
3334 * Called when a button is pressed in player's inventory form
3335 * Newest functions are called first
3336 * If function returns `true`, remaining functions are not called
3337 * `minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))`
3338 * Called when `player` crafts something
3339 * `itemstack` is the output
3340 * `old_craft_grid` contains the recipe (Note: the one in the inventory is
3342 * `craft_inv` is the inventory with the crafting grid
3343 * Return either an `ItemStack`, to replace the output, or `nil`, to not
3345 * `minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))`
3346 * The same as before, except that it is called before the player crafts, to
3347 make craft prediction, and it should not change anything.
3348 * `minetest.register_allow_player_inventory_action(func(player, inventory, action, inventory_info))`
3349 * Determinates how much of a stack may be taken, put or moved to a
3351 * `player` (type `ObjectRef`) is the player who modified the inventory
3352 `inventory` (type `InvRef`).
3353 * List of possible `action` (string) values and their
3354 `inventory_info` (table) contents:
3355 * `move`: `{from_list=string, to_list=string, from_index=number, to_index=number, count=number}`
3356 * `put`: `{listname=string, index=number, stack=ItemStack}`
3357 * `take`: Same as `put`
3358 * Return a numeric value to limit the amount of items to be taken, put or
3359 moved. A value of `-1` for `take` will make the source stack infinite.
3360 * `minetest.register_on_player_inventory_action(func(player, inventory, action, inventory_info))`
3361 * Called after a take, put or move event from/to/in a player inventory
3362 * Function arguments: see `minetest.register_allow_player_inventory_action`
3363 * Does not accept or handle any return value.
3364 * `minetest.register_on_protection_violation(func(pos, name))`
3365 * Called by `builtin` and mods when a player violates protection at a
3366 position (eg, digs a node or punches a protected entity).
3367 * The registered functions can be called using
3368 `minetest.record_protection_violation`.
3369 * The provided function should check that the position is protected by the
3370 mod calling this function before it prints a message, if it does, to
3371 allow for multiple protection mods.
3372 * `minetest.register_on_item_eat(func(hp_change, replace_with_item, itemstack, user, pointed_thing))`
3373 * Called when an item is eaten, by `minetest.item_eat`
3374 * Return `true` or `itemstack` to cancel the default item eat response
3375 (i.e.: hp increase).
3376 * `minetest.register_on_priv_grant(function(name, granter, priv))`
3377 * Called when `granter` grants the priv `priv` to `name`.
3378 * Note that the callback will be called twice if it's done by a player,
3379 once with granter being the player name, and again with granter being nil.
3380 * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
3381 * Called when `revoker` revokes the priv `priv` from `name`.
3382 * Note that the callback will be called twice if it's done by a player,
3383 once with revoker being the player name, and again with revoker being nil.
3384 * `minetest.register_can_bypass_userlimit(function(name, ip))`
3385 * Called when `name` user connects with `ip`.
3386 * Return `true` to by pass the player limit
3387 * `minetest.register_on_modchannel_message(func(channel_name, sender, message))`
3388 * Called when an incoming mod channel message is received
3389 * You should have joined some channels to receive events.
3390 * If message comes from a server mod, `sender` field is an empty string.
3392 ### Other registration functions
3393 * `minetest.register_chatcommand(cmd, chatcommand definition)`
3394 * Adds definition to `minetest.registered_chatcommands`
3395 * `minetest.override_chatcommand(name, redefinition)`
3396 * Overrides fields of a chatcommand registered with `register_chatcommand`.
3397 * `minetest.unregister_chatcommand(name)`
3398 * Unregisters a chatcommands registered with `register_chatcommand`.
3399 * `minetest.register_privilege(name, definition)`
3400 * `definition`: `"description text"`
3402 `{description = "description text", give_to_singleplayer = boolean}`
3403 the default of `give_to_singleplayer` is true.
3404 * To allow players with `basic_privs` to grant, see `basic_privs`
3405 minetest.conf setting.
3406 * `on_grant(name, granter_name)`: Called when given to player `name` by
3408 `granter_name` will be nil if the priv was granted by a mod.
3409 * `on_revoke(name, revoker_name)`: Called when taken from player `name` by
3411 `revoker_name` will be nil if the priv was revoked by a mod
3412 * Note that the above two callbacks will be called twice if a player is
3413 responsible, once with the player name, and then with a nil player name.
3414 * Return true in the above callbacks to stop register_on_priv_grant or
3415 revoke being called.
3416 * `minetest.register_authentication_handler(authentication handler definition)`
3417 * Registers an auth handler that overrides the builtin one
3418 * This function can be called by a single mod once only.
3421 * `minetest.settings`: Settings object containing all of the settings from the
3422 main config file (`minetest.conf`).
3423 * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
3424 parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
3427 * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
3428 * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
3429 * Convert between two privilege representations
3430 * `minetest.get_player_privs(name) -> {priv1=true,...}`
3431 * `minetest.check_player_privs(player_or_name, ...)`:
3432 returns `bool, missing_privs`
3433 * A quickhand for checking privileges.
3434 * `player_or_name`: Either a Player object or the name of a player.
3435 * `...` is either a list of strings, e.g. `"priva", "privb"` or
3436 a table, e.g. `{ priva = true, privb = true }`.
3438 * `minetest.check_password_entry(name, entry, password)`
3439 * Returns true if the "password entry" for a player with name matches given
3440 password, false otherwise.
3441 * The "password entry" is the password representation generated by the
3442 engine as returned as part of a `get_auth()` call on the auth handler.
3443 * Only use this function for making it possible to log in via password from
3444 external protocols such as IRC, other uses are frowned upon.
3445 * `minetest.get_password_hash(name, raw_password)`
3446 * Convert a name-password pair to a password hash that Minetest can use.
3447 * The returned value alone is not a good basis for password checks based
3448 on comparing the password hash in the database with the password hash
3449 from the function, with an externally provided password, as the hash
3450 in the db might use the new SRP verifier format.
3451 * For this purpose, use `minetest.check_password_entry` instead.
3452 * `minetest.get_player_ip(name)`: returns an IP address string for the player
3454 * The player needs to be online for this to be successful.
3456 * `minetest.get_auth_handler()`: Return the currently active auth handler
3457 * See the `Authentication handler definition`
3458 * Use this to e.g. get the authentication data for a player:
3459 `local auth_data = minetest.get_auth_handler().get_auth(playername)`
3460 * `minetest.notify_authentication_modified(name)`
3461 * Must be called by the authentication handler for privilege changes.
3462 * `name`: string; if omitted, all auth data should be considered modified
3463 * `minetest.set_player_password(name, password_hash)`: Set password hash of
3465 * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player
3467 * `minetest.auth_reload()`
3468 * See `reload()` in authentication handler definition
3470 `minetest.set_player_password`, `minetest_set_player_privs`,
3471 `minetest_get_player_privs` and `minetest.auth_reload` call the authentication
3475 * `minetest.chat_send_all(text)`
3476 * `minetest.chat_send_player(name, text)`
3478 ### Environment access
3479 * `minetest.set_node(pos, node)`
3480 * `minetest.add_node(pos, node): alias to `minetest.set_node`
3481 * Set node at position `pos`
3482 * `node`: table `{name=string, param1=number, param2=number}`
3483 * If param1 or param2 is omitted, it's set to `0`.
3484 * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
3485 * `minetest.bulk_set_node({pos1, pos2, pos3, ...}, node)`
3486 * Set node on all positions set in the first argument.
3487 * e.g. `minetest.bulk_set_node({{x=0, y=1, z=1}, {x=1, y=2, z=2}}, {name="default:stone"})`
3488 * For node specification or position syntax see `minetest.set_node` call
3489 * Faster than set_node due to single call, but still considerably slower
3490 than Lua Voxel Manipulators (LVM) for large numbers of nodes.
3491 Unlike LVMs, this will call node callbacks. It also allows setting nodes
3492 in spread out positions which would cause LVMs to waste memory.
3493 For setting a cube, this is 1.3x faster than set_node whereas LVM is 20
3495 * `minetest.swap_node(pos, node)`
3496 * Set node at position, but don't remove metadata
3497 * `minetest.remove_node(pos)`
3498 * By default it does the same as `minetest.set_node(pos, {name="air"})`
3499 * `minetest.get_node(pos)`
3500 * Returns the node at the given position as table in the format
3501 `{name="node_name", param1=0, param2=0}`,
3502 returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
3503 * `minetest.get_node_or_nil(pos)`
3504 * Same as `get_node` but returns `nil` for unloaded areas.
3505 * `minetest.get_node_light(pos, timeofday)`
3506 * Gets the light value at the given position. Note that the light value
3507 "inside" the node at the given position is returned, so you usually want
3508 to get the light value of a neighbor.
3509 * `pos`: The position where to measure the light.
3510 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
3511 * Returns a number between `0` and `15` or `nil`
3512 * `minetest.place_node(pos, node)`
3513 * Place node with the same effects that a player would cause
3514 * `minetest.dig_node(pos)`
3515 * Dig node with the same effects that a player would cause
3516 * Returns `true` if successful, `false` on failure (e.g. protected location)
3517 * `minetest.punch_node(pos)`
3518 * Punch node with the same effects that a player would cause
3519 * `minetest.spawn_falling_node(pos)`
3520 * Change node into falling node
3521 * Returns `true` if successful, `false` on failure
3523 * `minetest.find_nodes_with_meta(pos1, pos2)`
3524 * Get a table of positions of nodes that have metadata within a region
3526 * `minetest.get_meta(pos)`
3527 * Get a `NodeMetaRef` at that position
3528 * `minetest.get_node_timer(pos)`
3529 * Get `NodeTimerRef`
3531 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at
3533 * Returns `ObjectRef`, or `nil` if failed
3534 * `minetest.add_item(pos, item)`: Spawn item
3535 * Returns `ObjectRef`, or `nil` if failed
3536 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
3537 * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of
3539 * `radius`: using an euclidean metric
3540 * `minetest.set_timeofday(val)`
3541 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
3542 * `minetest.get_timeofday()`
3543 * `minetest.get_gametime()`: returns the time, in seconds, since the world was
3545 * `minetest.get_day_count()`: returns number days elapsed since world was
3547 * accounts for time changes.
3548 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns
3550 * `radius`: using a maximum metric
3551 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
3552 * `search_center` is an optional boolean (default: `false`)
3553 If true `pos` is also checked for the nodes
3554 * `minetest.find_nodes_in_area(pos1, pos2, nodenames)`: returns a list of
3556 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
3557 * First return value: Table with all node positions
3558 * Second return value: Table with the count of each node with the node name
3560 * Area volume is limited to 4,096,000 nodes
3561 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
3563 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
3564 * Return value: Table with all node positions with a node air above
3565 * Area volume is limited to 4,096,000 nodes
3566 * `minetest.get_perlin(noiseparams)`
3567 * `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
3568 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
3569 * `minetest.get_voxel_manip([pos1, pos2])`
3570 * Return voxel manipulator object.
3571 * Loads the manipulator from the map if positions are passed.
3572 * `minetest.set_gen_notify(flags, {deco_ids})`
3573 * Set the types of on-generate notifications that should be collected.
3574 * `flags` is a flag field with the available flags:
3582 * The second parameter is a list of IDS of decorations which notification
3584 * `minetest.get_gen_notify()`
3585 * Returns a flagstring and a table with the `deco_id`s.
3586 * `minetest.get_decoration_id(decoration_name)
3587 * Returns the decoration ID number for the provided decoration name string,
3588 or `nil` on failure.
3589 * `minetest.get_mapgen_object(objectname)`
3590 * Return requested mapgen object if available (see "Mapgen objects")
3591 * `minetest.get_heat(pos)`
3592 * Returns the heat at the position, or `nil` on failure.
3593 * `minetest.get_humidity(pos)`
3594 * Returns the humidity at the position, or `nil` on failure.
3595 * `minetest.get_biome_data(pos)`
3596 * Returns a table containing:
3597 * `biome` the biome id of the biome at that position
3598 * `heat` the heat at the position
3599 * `humidity` the humidity at the position
3600 * Or returns `nil` on failure.
3601 * `minetest.get_biome_id(biome_name)`
3602 * Returns the biome id, as used in the biomemap Mapgen object and returned
3603 by `minetest.get_biome_data(pos)`, for a given biome_name string.
3604 * `minetest.get_biome_name(biome_id)`
3605 * Returns the biome name string for the provided biome id, or `nil` on
3607 * If no biomes have been registered, such as in mgv6, returns `default`.
3608 * `minetest.get_mapgen_params()`
3609 * Deprecated: use `minetest.get_mapgen_setting(name)` instead.
3610 * Returns a table containing:
3616 * `minetest.set_mapgen_params(MapgenParams)`
3617 * Deprecated: use `minetest.set_mapgen_setting(name, value, override)`
3619 * Set map generation parameters.
3620 * Function cannot be called after the registration period; only
3621 initialization and `on_mapgen_init`.
3622 * Takes a table as an argument with the fields:
3628 * Leave field unset to leave that parameter unchanged.
3629 * `flags` contains a comma-delimited string of flags to set, or if the
3630 prefix `"no"` is attached, clears instead.
3631 * `flags` is in the same format and has the same options as `mg_flags` in
3633 * `minetest.get_mapgen_setting(name)`
3634 * Gets the *active* mapgen setting (or nil if none exists) in string
3635 format with the following order of precedence:
3636 1) Settings loaded from map_meta.txt or overrides set during mod
3638 2) Settings set by mods without a metafile override
3639 3) Settings explicitly set in the user config file, minetest.conf
3640 4) Settings set as the user config default
3641 * `minetest.get_mapgen_setting_noiseparams(name)`
3642 * Same as above, but returns the value as a NoiseParams table if the
3643 setting `name` exists and is a valid NoiseParams.
3644 * `minetest.set_mapgen_setting(name, value, [override_meta])`
3645 * Sets a mapgen param to `value`, and will take effect if the corresponding
3646 mapgen setting is not already present in map_meta.txt.
3647 * `override_meta` is an optional boolean (default: `false`). If this is set
3648 to true, the setting will become the active setting regardless of the map
3650 * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`.
3651 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
3652 * Same as above, except value is a NoiseParams table.
3653 * `minetest.set_noiseparams(name, noiseparams, set_default)`
3654 * Sets the noiseparams setting of `name` to the noiseparams table specified
3656 * `set_default` is an optional boolean (default: `true`) that specifies
3657 whether the setting should be applied to the default config or current
3659 * `minetest.get_noiseparams(name)`
3660 * Returns a table of the noiseparams for name.
3661 * `minetest.generate_ores(vm, pos1, pos2)`
3662 * Generate all registered ores within the VoxelManip `vm` and in the area
3663 from `pos1` to `pos2`.
3664 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
3665 * `minetest.generate_decorations(vm, pos1, pos2)`
3666 * Generate all registered decorations within the VoxelManip `vm` and in the
3667 area from `pos1` to `pos2`.
3668 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
3669 * `minetest.clear_objects([options])`
3670 * Clear all objects in the environment
3671 * Takes an optional table as an argument with the field `mode`.
3672 * mode = `"full"` : Load and go through every mapblock, clearing
3674 * mode = `"quick"`: Clear objects immediately in loaded mapblocks,
3675 clear objects in unloaded mapblocks only when the
3676 mapblocks are next activated.
3677 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
3678 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be
3679 asynchronously fetched from memory, loaded from disk, or if inexistent,
3681 * If `callback` is a valid Lua function, this will be called for each block
3683 * The function signature of callback is:
3684 * `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
3685 * `blockpos` is the *block* coordinates of the block that had been
3687 * `action` could be one of the following constant values:
3688 * `minetest.EMERGE_CANCELLED`
3689 * `minetest.EMERGE_ERRORED`
3690 * `minetest.EMERGE_FROM_MEMORY`
3691 * `minetest.EMERGE_FROM_DISK`
3692 * `minetest.EMERGE_GENERATED`
3693 * `calls_remaining` is the number of callbacks to be expected after
3695 * `param` is the user-defined parameter passed to emerge_area (or
3696 nil if the parameter was absent).
3697 * `minetest.delete_area(pos1, pos2)`
3698 * delete all mapblocks in the area from pos1 to pos2, inclusive
3699 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
3700 * Checks if there is anything other than air between pos1 and pos2.
3701 * Returns false if something is blocking the sight.
3702 * Returns the position of the blocking node when `false`
3703 * `pos1`: First position
3704 * `pos2`: Second position
3705 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
3706 * Creates a `Raycast` object.
3707 * `pos1`: start of the ray
3708 * `pos2`: end of the ray
3709 * `objects` : if false, only nodes will be returned. Default is `true`.
3710 * `liquids' : if false, liquid nodes won't be returned. Default is `false`.
3711 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
3712 * returns table containing path
3713 * returns a table of 3D points representing a path from `pos1` to `pos2` or
3715 * `pos1`: start position
3716 * `pos2`: end position
3717 * `searchdistance`: number of blocks to search in each direction using a
3719 * `max_jump`: maximum height difference to consider walkable
3720 * `max_drop`: maximum height difference to consider droppable
3721 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
3722 * `minetest.spawn_tree (pos, {treedef})`
3723 * spawns L-system tree at given `pos` with definition in `treedef` table
3724 * `minetest.transforming_liquid_add(pos)`
3725 * add node to liquid update queue
3726 * `minetest.get_node_max_level(pos)`
3727 * get max available level for leveled node
3728 * `minetest.get_node_level(pos)`
3729 * get level of leveled node (water, snow)
3730 * `minetest.set_node_level(pos, level)`
3731 * set level of leveled node, default `level` equals `1`
3732 * if `totallevel > maxlevel`, returns rest (`total-max`).
3733 * `minetest.add_node_level(pos, level)`
3734 * increase level of leveled node by level, default `level` equals `1`
3735 * if `totallevel > maxlevel`, returns rest (`total-max`)
3736 * can be negative for decreasing
3737 * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
3738 * resets the light in a cuboid-shaped part of
3739 the map and removes lighting bugs.
3740 * Loads the area if it is not loaded.
3741 * `pos1` is the corner of the cuboid with the least coordinates
3742 (in node coordinates), inclusive.
3743 * `pos2` is the opposite corner of the cuboid, inclusive.
3744 * The actual updated cuboid might be larger than the specified one,
3745 because only whole map blocks can be updated.
3746 The actual updated area consists of those map blocks that intersect
3747 with the given cuboid.
3748 * However, the neighborhood of the updated area might change
3749 as well, as light can spread out of the cuboid, also light
3751 * returns `false` if the area is not fully generated,
3753 * `minetest.check_single_for_falling(pos)`
3754 * causes an unsupported `group:falling_node` node to fall and causes an
3755 unattached `group:attached_node` node to fall.
3756 * does not spread these updates to neighbours.
3757 * `minetest.check_for_falling(pos)`
3758 * causes an unsupported `group:falling_node` node to fall and causes an
3759 unattached `group:attached_node` node to fall.
3760 * spread these updates to neighbours and can cause a cascade
3762 * `minetest.get_spawn_level(x, z)`
3763 * Returns a player spawn y co-ordinate for the provided (x, z)
3764 co-ordinates, or `nil` for an unsuitable spawn point.
3765 * For most mapgens a 'suitable spawn point' is one with y between
3766 `water_level` and `water_level + 16`, and in mgv7 well away from rivers,
3767 so `nil` will be returned for many (x, z) co-ordinates.
3768 * The spawn level returned is for a player spawn in unmodified terrain.
3769 * The spawn level is intentionally above terrain level to cope with
3770 full-node biome 'dust' nodes.
3773 You can find mod channels communication scheme in `docs/mod_channels.png`.
3775 * `minetest.mod_channel_join(channel_name)`
3776 * Server joins channel `channel_name`, and creates it if necessary. You
3777 should listen from incoming messages with
3778 `minetest.register_on_modchannel_message` call to receive incoming
3782 `minetest.get_inventory(location)`: returns an `InvRef`
3785 * `{type="player", name="celeron55"}`
3786 * `{type="node", pos={x=, y=, z=}}`
3787 * `{type="detached", name="creative"}`
3788 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns
3790 * callbacks: See "Detached inventory callbacks"
3791 * `player_name`: Make detached inventory available to one player
3792 exclusively, by default they will be sent to every player (even if not
3794 Note that this parameter is mostly just a workaround and will be removed
3796 * Creates a detached inventory. If it already exists, it is cleared.
3797 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
3798 returns left over ItemStack.
3799 * See `minetest.item_eat` and `minetest.register_on_item_eat`
3802 * `minetest.show_formspec(playername, formname, formspec)`
3803 * `playername`: name of player to show formspec
3804 * `formname`: name passed to `on_player_receive_fields` callbacks.
3805 It should follow the `"modname:<whatever>"` naming convention
3806 * `formspec`: formspec to display
3807 * `minetest.close_formspec(playername, formname)`
3808 * `playername`: name of player to close formspec
3809 * `formname`: has to exactly match the one given in `show_formspec`, or the
3810 formspec will not close.
3811 * calling `show_formspec(playername, formname, "")` is equal to this
3813 * to close a formspec regardless of the formname, call
3814 `minetest.close_formspec(playername, "")`.
3815 **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
3816 * `minetest.formspec_escape(string)`: returns a string
3817 * escapes the characters "[", "]", "\", "," and ";", which can not be used
3819 * `minetest.explode_table_event(string)`: returns a table
3820 * returns e.g. `{type="CHG", row=1, column=2}`
3822 * `"INV"`: no row selected)
3823 * `"CHG"`: selected)
3824 * `"DCL"`: double-click
3825 * `minetest.explode_textlist_event(string)`: returns a table
3826 * returns e.g. `{type="CHG", index=1}`
3828 * `"INV"`: no row selected)
3829 * `"CHG"`: selected)
3830 * `"DCL"`: double-click
3831 * `minetest.explode_scrollbar_event(string)`: returns a table
3832 * returns e.g. `{type="CHG", value=500}`
3834 * `"INV"`: something failed
3835 * `"CHG"`: has been changed
3836 * `"VAL"`: not changed
3839 * `minetest.inventorycube(img1, img2, img3)`
3840 * Returns a string for making an image of a cube (useful as an item image)
3841 * `minetest.get_pointed_thing_position(pointed_thing, above)`
3842 * Get position of a `pointed_thing` (that you can get from somewhere)
3843 * `minetest.dir_to_facedir(dir, is6d)`
3844 * Convert a vector to a facedir value, used in `param2` for
3845 `paramtype2="facedir"`.
3846 * passing something non-`nil`/`false` for the optional second parameter
3847 causes it to take the y component into account.
3848 * `minetest.facedir_to_dir(facedir)`
3849 * Convert a facedir back into a vector aimed directly out the "back" of a
3851 * `minetest.dir_to_wallmounted(dir)`
3852 * Convert a vector to a wallmounted value, used for
3853 `paramtype2="wallmounted"`.
3854 * `minetest.wallmounted_to_dir(wallmounted)`
3855 * Convert a wallmounted value back into a vector aimed directly out the
3857 * `minetest.dir_to_yaw(dir)`
3858 * Convert a vector into a yaw (angle)
3859 * `minetest.yaw_to_dir(yaw)`
3860 * Convert yaw (angle) to a vector
3861 * `minetest.is_colored_paramtype(ptype)`
3862 * Returns a boolean. Returns `true` if the given `paramtype2` contains
3863 color information (`color`, `colorwallmounted` or `colorfacedir`).
3864 * `minetest.strip_param2_color(param2, paramtype2)`
3865 * Removes everything but the color information from the
3866 given `param2` value.
3867 * Returns `nil` if the given `paramtype2` does not contain color
3869 * `minetest.get_node_drops(nodename, toolname)`
3870 * Returns list of item names.
3871 * **Note**: This will be removed or modified in a future version.
3872 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
3873 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
3874 * `input.width` = for example `3`
3875 * `input.items` = for example
3876 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
3877 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
3878 * `output.time` = a number, if unsuccessful: `0`
3879 * `output.replacements` = list of `ItemStack`s that couldn't be placed in
3880 `decremented_input.items`
3881 * `decremented_input` = like `input`
3882 * `minetest.get_craft_recipe(output)`: returns input
3883 * returns last registered recipe for output item (node)
3884 * `output` is a node or item type such as `"default:torch"`
3885 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
3886 * `input.width` = for example `3`
3887 * `input.items` = for example
3888 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
3889 * `input.items` = `nil` if no recipe found
3890 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
3891 * returns indexed table with all registered recipes for query item (node)
3892 or `nil` if no recipe was found.
3893 * recipe entry table:
3896 method = 'normal' or 'cooking' or 'fuel'
3897 width = 0-3, 0 means shapeless recipe
3898 items = indexed [1-9] table with recipe items
3899 output = string with item name and quantity
3901 * Example query for `"default:gold_ingot"` will return table:
3904 [1]={method = "cooking", width = 3, output = "default:gold_ingot",
3905 items = {1 = "default:gold_lump"}},
3906 [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
3907 items = {1 = "default:goldblock"}}
3909 * `minetest.handle_node_drops(pos, drops, digger)`
3910 * `drops`: list of itemstrings
3911 * Handles drops from nodes after digging: Default action is to put them
3912 into digger's inventory.
3913 * Can be overridden to get different functionality (e.g. dropping items on
3915 * `minetest.itemstring_with_palette(item, palette_index)`: returns an item
3917 * Creates an item string which contains palette index information
3918 for hardware colorization. You can use the returned string
3919 as an output in a craft recipe.
3920 * `item`: the item stack which becomes colored. Can be in string,
3921 table and native form.
3922 * `palette_index`: this index is added to the item stack
3923 * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
3924 * Creates an item string which contains static color information
3925 for hardware colorization. Use this method if you wish to colorize
3926 an item that does not own a palette. You can use the returned string
3927 as an output in a craft recipe.
3928 * `item`: the item stack which becomes colored. Can be in string,
3929 table and native form.
3930 * `colorstring`: the new color of the item stack
3933 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
3934 returns `{{actor, pos, time, oldnode, newnode}, ...}`
3935 * Find who has done something to a node, or near a node
3936 * `actor`: `"player:<name>"`, also `"liquid"`.
3937 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns
3938 `boolean, log_messages`.
3939 * Revert latest actions of someone
3940 * `actor`: `"player:<name>"`, also `"liquid"`.
3942 ### Defaults for the `on_*` item definition functions
3943 These functions return the leftover itemstack.
3945 * `minetest.item_place_node(itemstack, placer, pointed_thing[, param2, prevent_after_place])`
3946 * Place item as a node
3947 * `param2` overrides `facedir` and wallmounted `param2`
3948 * `prevent_after_place`: if set to `true`, `after_place_node` is not called
3949 for the newly placed node to prevent a callback and placement loop
3950 * returns `itemstack, success`
3951 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
3953 * `minetest.item_place(itemstack, placer, pointed_thing, param2)`
3954 * Use one of the above based on what the item is.
3955 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
3956 * **Note**: is not called when wielded item overrides `on_place`
3957 * `param2` overrides `facedir` and wallmounted `param2`
3958 * returns `itemstack, success`
3959 * `minetest.item_drop(itemstack, dropper, pos)`
3961 * `minetest.item_eat(hp_change, replace_with_item)`
3963 * `replace_with_item` is the itemstring which is added to the inventory.
3964 If the player is eating a stack, then replace_with_item goes to a
3965 different spot. Can be `nil`
3966 * See `minetest.do_item_eat`
3968 ### Defaults for the `on_punch` and `on_dig` node definition callbacks
3969 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
3970 * Calls functions registered by `minetest.register_on_punchnode()`
3971 * `minetest.node_dig(pos, node, digger)`
3972 * Checks if node can be dug, puts item into inventory, removes node
3973 * Calls functions registered by `minetest.registered_on_dignodes()`
3976 * `minetest.sound_play(spec, parameters)`: returns a handle
3977 * `spec` is a `SimpleSoundSpec`
3978 * `parameters` is a sound parameter table
3979 * `minetest.sound_stop(handle)`
3980 * `minetest.sound_fade(handle, step, gain)`
3981 * `handle` is a handle returned by `minetest.sound_play`
3982 * `step` determines how fast a sound will fade.
3983 Negative step will lower the sound volume, positive step will increase
3985 * `gain` the target gain for the fade.
3988 * `minetest.after(time, func, ...)`
3989 * Call the function `func` after `time` seconds, may be fractional
3990 * Optional: Variable number of arguments that are passed to `func`
3993 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for
3994 server shutdown. Will display `message` to clients.
3995 * `reconnect` == true displays a reconnect button
3996 * `delay` adds an optional delay (in seconds) before shutdown.
3997 Negative delay cancels the current active shutdown.
3998 Zero delay triggers an immediate shutdown.
3999 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
4000 * `minetest.get_server_status(name, joined)`
4001 * Returns the server status string when a player joins or when the command
4002 `/status` is called. Returns `nil` or an empty string when the message is
4004 * `joined`: Boolean value, indicates whether the function was called when
4006 * This function may be overwritten by mods to customize the status message.
4007 * `minetest.get_server_uptime()`: returns the server uptime in seconds
4008 * `minetest.remove_player(name)`: remove player from database (if they are not
4010 * As auth data is not removed, minetest.player_exists will continue to
4011 return true. Call the below method as well if you want to remove auth
4013 * Returns a code (0: successful, 1: no such player, 2: player is connected)
4014 * `minetest.remove_player_auth(name)`: remove player authentication data
4015 * Returns boolean indicating success (false if player nonexistant)
4018 * `minetest.get_ban_list()`: returns the ban list
4019 (same as `minetest.get_ban_description("")`).
4020 * `minetest.get_ban_description(ip_or_name)`: returns ban description (string)
4021 * `minetest.ban_player(name)`: ban a player
4022 * `minetest.unban_player_or_ip(name)`: unban player or IP address
4023 * `minetest.kick_player(name, [reason])`: disconnect a player with a optional
4027 * `minetest.add_particle(particle definition)`
4028 * Deprecated: `minetest.add_particle(pos, velocity, acceleration,
4029 expirationtime, size, collisiondetection, texture, playername)`
4031 * `minetest.add_particlespawner(particlespawner definition)`
4032 * Add a `ParticleSpawner`, an object that spawns an amount of particles
4033 over `time` seconds.
4034 * Returns an `id`, and -1 if adding didn't succeed
4035 * `Deprecated: minetest.add_particlespawner(amount, time,
4039 minexptime, maxexptime,
4041 collisiondetection, texture, playername)`
4043 * `minetest.delete_particlespawner(id, player)`
4044 * Delete `ParticleSpawner` with `id` (return value from
4045 `minetest.add_particlespawner`).
4046 * If playername is specified, only deletes on the player's client,
4047 otherwise on all clients.
4050 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
4051 * Create a schematic from the volume of map specified by the box formed by
4053 * Apply the specified probability and per-node force-place to the specified
4054 nodes according to the `probability_list`.
4055 * `probability_list` is an array of tables containing two fields, `pos`
4057 * `pos` is the 3D vector specifying the absolute coordinates of the
4058 node being modified,
4059 * `prob` is an integer value from `0` to `255` that encodes
4060 probability and per-node force-place. Probability has levels
4061 0-127, then 128 may be added to encode per-node force-place.
4062 For probability stated as 0-255, divide by 2 and round down to
4063 get values 0-127, then add 128 to apply per-node force-place.
4064 * If there are two or more entries with the same pos value, the
4066 * If `pos` is not inside the box formed by `p1` and `p2`, it is
4068 * If `probability_list` equals `nil`, no probabilities are applied.
4069 * Apply the specified probability to the specified horizontal slices
4070 according to the `slice_prob_list`.
4071 * `slice_prob_list` is an array of tables containing two fields, `ypos`
4073 * `ypos` indicates the y position of the slice with a probability
4074 applied, the lowest slice being `ypos = 0`.
4075 * If slice probability list equals `nil`, no slice probabilities
4077 * Saves schematic in the Minetest Schematic format to filename.
4079 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement, flags)`
4080 * Place the schematic specified by schematic (see: Schematic specifier) at
4082 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
4083 * If the `rotation` parameter is omitted, the schematic is not rotated.
4084 * `replacements` = `{["old_name"] = "convert_to", ...}`
4085 * `force_placement` is a boolean indicating whether nodes other than `air`
4086 and `ignore` are replaced by the schematic.
4087 * Returns nil if the schematic could not be loaded.
4088 * **Warning**: Once you have loaded a schematic from a file, it will be
4089 cached. Future calls will always use the cached version and the
4090 replacement list defined for it, regardless of whether the file or the
4091 replacement list parameter have changed. The only way to load the file
4092 anew is to restart the server.
4093 * `flags` is a flag field with the available flags:
4098 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement, flags)`:
4099 * This function is analogous to minetest.place_schematic, but places a
4100 schematic onto the specified VoxelManip object `vmanip` instead of the
4102 * Returns false if any part of the schematic was cut-off due to the
4103 VoxelManip not containing the full area required, and true if the whole
4104 schematic was able to fit.
4105 * Returns nil if the schematic could not be loaded.
4106 * After execution, any external copies of the VoxelManip contents are
4108 * `flags` is a flag field with the available flags:
4113 * `minetest.serialize_schematic(schematic, format, options)`
4114 * Return the serialized schematic specified by schematic
4115 (see: Schematic specifier)
4116 * in the `format` of either "mts" or "lua".
4117 * "mts" - a string containing the binary MTS data used in the MTS file
4119 * "lua" - a string containing Lua code representing the schematic in table
4121 * `options` is a table containing the following optional parameters:
4122 * If `lua_use_comments` is true and `format` is "lua", the Lua code
4123 generated will have (X, Z) position comments for every X row
4124 generated in the schematic data for easier reading.
4125 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua",
4126 the Lua code generated will use that number of spaces as indentation
4127 instead of a tab character.
4130 * `minetest.request_http_api()`:
4131 * returns `HTTPApiTable` containing http functions if the calling mod has
4132 been granted access by being listed in the `secure.http_mods` or
4133 `secure.trusted_mods` setting, otherwise returns `nil`.
4134 * The returned table contains the functions `fetch`, `fetch_async` and
4135 `fetch_async_get` described below.
4136 * Only works at init time and must be called from the mod's main scope
4137 (not from a function).
4138 * Function only exists if minetest server was built with cURL support.
4139 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
4141 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
4142 * Performs given request asynchronously and calls callback upon completion
4143 * callback: `function(HTTPRequestResult res)`
4144 * Use this HTTP function if you are unsure, the others are for advanced use
4145 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
4146 * Performs given request asynchronously and returns handle for
4147 `HTTPApiTable.fetch_async_get`
4148 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
4149 * Return response data for given asynchronous HTTP request
4152 * `minetest.get_mod_storage()`:
4153 * returns reference to mod private `StorageRef`
4154 * must be called during mod load time
4157 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
4158 * `minetest.is_player(o)`: boolean, whether `o` is a player
4159 * `minetest.player_exists(name)`: boolean, whether player exists
4160 (regardless of online status)
4161 * `minetest.hud_replace_builtin(name, hud_definition)`
4162 * Replaces definition of a builtin hud element
4163 * `name`: `"breath"` or `"health"`
4164 * `hud_definition`: definition to replace builtin definition
4165 * `minetest.send_join_message(player_name)`
4166 * This function can be overridden by mods to change the join message.
4167 * `minetest.send_leave_message(player_name, timed_out)`
4168 * This function can be overridden by mods to change the leave message.
4169 * `minetest.hash_node_position(pos)`: returns an 48-bit integer
4170 * `pos`: table {x=number, y=number, z=number},
4171 * Gives a unique hash number for a node position (16+16+16=48bit)
4172 * `minetest.get_position_from_hash(hash)`: returns a position
4173 * Inverse transform of `minetest.hash_node_position`
4174 * `minetest.get_item_group(name, group)`: returns a rating
4175 * Get rating of a group of an item. (`0` means: not in group)
4176 * `minetest.get_node_group(name, group)`: returns a rating
4177 * Deprecated: An alias for the former.
4178 * `minetest.raillike_group(name)`: returns a rating
4179 * Returns rating of the connect_to_raillike group corresponding to name
4180 * If name is not yet the name of a connect_to_raillike group, a new group
4181 id is created, with that name.
4182 * `minetest.get_content_id(name)`: returns an integer
4183 * Gets the internal content ID of `name`
4184 * `minetest.get_name_from_content_id(content_id)`: returns a string
4185 * Gets the name of the content with that content ID
4186 * `minetest.parse_json(string[, nullvalue])`: returns something
4187 * Convert a string containing JSON data into the Lua equivalent
4188 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
4189 * On success returns a table, a string, a number, a boolean or `nullvalue`
4190 * On failure outputs an error message and returns `nil`
4191 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
4192 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error
4194 * Convert a Lua table into a JSON string
4195 * styled: Outputs in a human-readable format if this is set, defaults to
4197 * Unserializable things like functions and userdata will cause an error.
4198 * **Warning**: JSON is more strict than the Lua table format.
4199 1. You can only use strings and positive integers of at least one as
4201 2. You can not mix string and integer keys.
4202 This is due to the fact that JSON has two distinct array and object
4204 * Example: `write_json({10, {a = false}})`,
4205 returns `"[10, {\"a\": false}]"`
4206 * `minetest.serialize(table)`: returns a string
4207 * Convert a table containing tables, strings, numbers, booleans and `nil`s
4208 into string form readable by `minetest.deserialize`
4209 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
4210 * `minetest.deserialize(string)`: returns a table
4211 * Convert a string returned by `minetest.deserialize` into a table
4212 * `string` is loaded in an empty sandbox environment.
4213 * Will load functions, but they cannot access the global environment.
4214 * Example: `deserialize('return { ["foo"] = "bar" }')`,
4215 returns `{foo='bar'}`
4216 * Example: `deserialize('print("foo")')`, returns `nil`
4217 (function call fails), returns
4218 `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
4219 * `minetest.compress(data, method, ...)`: returns `compressed_data`
4220 * Compress a string of data.
4221 * `method` is a string identifying the compression method to be used.
4222 * Supported compression methods:
4223 * Deflate (zlib): `"deflate"`
4224 * `...` indicates method-specific arguments. Currently defined arguments
4226 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
4227 * `minetest.decompress(compressed_data, method, ...)`: returns data
4228 * Decompress a string of data (using ZLib).
4229 * See documentation on `minetest.compress()` for supported compression
4231 * `...` indicates method-specific arguments. Currently, no methods use this
4232 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
4233 * Each argument is a 8 Bit unsigned integer
4234 * Returns the ColorString from rgb or rgba values
4235 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
4236 * `minetest.encode_base64(string)`: returns string encoded in base64
4237 * Encodes a string in base64.
4238 * `minetest.decode_base64(string)`: returns string
4239 * Decodes a string encoded in base64.
4240 * `minetest.is_protected(pos, name)`: returns boolean
4241 * Returns true, if player `name` shouldn't be able to dig at `pos` or do
4242 other actions, definable by mods, due to some mod-defined ownership-like
4244 * Returns false or nil, if the player is allowed to do such actions.
4245 * `name` will be "" for non-players or unknown players.
4246 * This function should be overridden by protection mods and should be used
4247 to check if a player can interact at a position.
4248 * This function should call the old version of itself if the position is
4249 not protected by the mod.
4252 local old_is_protected = minetest.is_protected
4253 function minetest.is_protected(pos, name)
4254 if mymod:position_protected_from(pos, name) then
4257 return old_is_protected(pos, name)
4259 * `minetest.record_protection_violation(pos, name)`
4260 * This function calls functions registered with
4261 `minetest.register_on_protection_violation`.
4262 * `minetest.is_area_protected(pos1, pos2, player_name, interval)
4263 * Returns the position of the first node that `player_name` may not modify
4264 in the specified cuboid between `pos1` and `pos2`.
4265 * Returns `false` if no protections were found.
4266 * Applies `is_protected()` to a 3D lattice of points in the defined volume.
4267 The points are spaced evenly throughout the volume and have a spacing
4268 similar to, but no larger than, `interval`.
4269 * All corners and edges of the defined volume are checked.
4270 * `interval` defaults to 4.
4271 * `interval` should be carefully chosen and maximised to avoid an excessive
4272 number of points being checked.
4273 * Like `minetest.is_protected`, this function may be extended or
4274 overwritten by mods to provide a faster implementation to check the
4275 cuboid for intersections.
4276 * `minetest.rotate_and_place(itemstack, placer, pointed_thing[, infinitestacks,
4277 orient_flags, prevent_after_place])`
4278 * Attempt to predict the desired orientation of the facedir-capable node
4279 defined by `itemstack`, and place it accordingly (on-wall, on the floor,
4280 or hanging from the ceiling).
4281 * `infinitestacks`: if `true`, the itemstack is not changed. Otherwise the
4282 stacks are handled normally.
4283 * `orient_flags`: Optional table containing extra tweaks to the placement code:
4284 * `invert_wall`: if `true`, place wall-orientation on the ground and
4285 ground-orientation on the wall.
4286 * `force_wall` : if `true`, always place the node in wall orientation.
4287 * `force_ceiling`: if `true`, always place on the ceiling.
4288 * `force_floor`: if `true`, always place the node on the floor.
4289 * `force_facedir`: if `true`, forcefully reset the facedir to north
4290 when placing on the floor or ceiling.
4291 * The first four options are mutually-exclusive; the last in the list
4292 takes precedence over the first.
4293 * `prevent_after_place` is directly passed to `minetest.item_place_node`
4294 * Returns the new itemstack after placement
4295 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
4296 * calls `rotate_and_place()` with `infinitestacks` set according to the state
4297 of the creative mode setting, checks for "sneak" to set the `invert_wall`
4298 parameter and `prevent_after_place` set to `true`.
4300 * `minetest.forceload_block(pos[, transient])`
4301 * forceloads the position `pos`.
4302 * returns `true` if area could be forceloaded
4303 * If `transient` is `false` or absent, the forceload will be persistent
4304 (saved between server runs). If `true`, the forceload will be transient
4305 (not saved between server runs).
4307 * `minetest.forceload_free_block(pos[, transient])`
4308 * stops forceloading the position `pos`
4309 * If `transient` is `false` or absent, frees a persistent forceload.
4310 If `true`, frees a transient forceload.
4312 * `minetest.request_insecure_environment()`: returns an environment containing
4313 insecure functions if the calling mod has been listed as trusted in the
4314 `secure.trusted_mods` setting or security is disabled, otherwise returns
4316 * Only works at init time and must be called from the mod's main scope (not
4318 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE
4319 IT IN A LOCAL VARIABLE!**
4321 * `minetest.global_exists(name)`
4322 * Checks if a global variable has been set, without triggering a warning.
4325 * `minetest.env`: `EnvRef` of the server environment and world.
4326 * Any function in the minetest namespace can be called using the syntax
4327 `minetest.env:somefunction(somearguments)`
4328 instead of `minetest.somefunction(somearguments)`
4329 * Deprecated, but support is not to be dropped soon
4332 * `minetest.registered_items`
4333 * Map of registered items, indexed by name
4334 * `minetest.registered_nodes`
4335 * Map of registered node definitions, indexed by name
4336 * `minetest.registered_craftitems`
4337 * Map of registered craft item definitions, indexed by name
4338 * `minetest.registered_tools`
4339 * Map of registered tool definitions, indexed by name
4340 * `minetest.registered_entities`
4341 * Map of registered entity prototypes, indexed by name
4342 * `minetest.object_refs`
4343 * Map of object references, indexed by active object id
4344 * `minetest.luaentities`
4345 * Map of Lua entities, indexed by active object id
4346 * `minetest.registered_chatcommands`
4347 * Map of registered chat command definitions, indexed by name
4348 * `minetest.registered_ores`
4349 * List of registered ore definitions.
4350 * `minetest.registered_biomes`
4351 * List of registered biome definitions.
4352 * `minetest.registered_decorations`
4353 * List of registered decoration definitions.
4360 A fast access data structure to store areas, and find areas near a given
4362 Every area has a `data` string attribute to store additional information.
4363 You can create an empty `AreaStore` by calling `AreaStore()`, or
4364 `AreaStore(type_name)`.
4365 If you chose the parameter-less constructor, a fast implementation will be
4366 automatically chosen for you.
4369 * `get_area(id, include_borders, include_data)`: returns the area with the id
4371 (optional) Boolean values `include_borders` and `include_data` control what's
4373 Returns nil if specified area id does not exist.
4374 * `get_areas_for_pos(pos, include_borders, include_data)`: returns all areas
4375 that contain the position `pos`.
4376 (optional) Boolean values `include_borders` and `include_data` control what's
4378 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`:
4379 returns all areas that contain all nodes inside the area specified by `edge1`
4380 and `edge2` (inclusive).
4381 If `accept_overlap` is true, also areas are returned that have nodes in
4382 common with the specified area.
4383 (optional) Boolean values `include_borders` and `include_data` control what's
4385 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store.
4386 Returns the new area's ID, or nil if the insertion failed.
4387 The (inclusive) positions `edge1` and `edge2` describe the area.
4388 `data` is a string stored with the area. If passed, `id` will be used as the
4389 internal area ID, it must be a unique number between 0 and 2^32-2. If you use
4390 the `id` parameter you must always use it, or insertions are likely to fail
4392 * `reserve(count)`: reserves resources for at most `count` many contained
4394 Only needed for efficiency, and only some implementations profit.
4395 * `remove_area(id)`: removes the area with the given id from the store, returns
4397 * `set_cache_params(params)`: sets params for the included prefiltering cache.
4398 Calling invalidates the cache, so that its elements have to be newly
4402 enabled = boolean, -- whether to enable, default true
4403 block_radius = number, -- the radius (in nodes) of the areas the cache
4404 generates prefiltered lists for, minimum 16,
4406 limit = number, -- the cache's size, minimum 20, default 1000
4408 * `to_string()`: Experimental. Returns area store serialized as a (binary)
4410 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to
4412 * `from_string(str)`: Experimental. Deserializes string and loads it into the
4414 Returns success and, optionally, an error message.
4415 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data
4419 An `InvRef` is a reference to an inventory.
4422 * `is_empty(listname)`: return `true` if list is empty
4423 * `get_size(listname)`: get size of a list
4424 * `set_size(listname, size)`: set size of a list
4425 * returns `false` on error (e.g. invalid `listname` or `size`)
4426 * `get_width(listname)`: get width of a list
4427 * `set_width(listname, width)`: set width of list; currently used for crafting
4428 * `get_stack(listname, i)`: get a copy of stack index `i` in list
4429 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
4430 * `get_list(listname)`: return full list
4431 * `set_list(listname, list)`: set full list (size will not change)
4432 * `get_lists()`: returns list of inventory lists
4433 * `set_lists(lists)`: sets inventory lists (size will not change)
4434 * `add_item(listname, stack)`: add item somewhere in list, returns leftover
4436 * `room_for_item(listname, stack):` returns `true` if the stack of items
4437 can be fully added to the list
4438 * `contains_item(listname, stack, [match_meta])`: returns `true` if
4439 the stack of items can be fully taken from the list.
4440 If `match_meta` is false, only the items' names are compared
4442 * `remove_item(listname, stack)`: take as many items as specified from the
4443 list, returns the items that were actually removed (as an `ItemStack`)
4444 -- note that any item metadata is ignored, so attempting to remove a specific
4445 unique item this way will likely remove the wrong one -- to do that use
4446 `set_stack` with an empty `ItemStack`.
4447 * `get_location()`: returns a location compatible to
4448 `minetest.get_inventory(location)`.
4449 * returns `{type="undefined"}` in case location is not known
4452 An `ItemStack` is a stack of items.
4454 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
4455 an itemstring, a table or `nil`.
4458 * `is_empty()`: returns `true` if stack is empty.
4459 * `get_name()`: returns item name (e.g. `"default:stone"`).
4460 * `set_name(item_name)`: returns a boolean indicating whether the item was
4462 * `get_count()`: Returns number of items on the stack.
4463 * `set_count(count)`: returns a boolean indicating whether the item was cleared
4464 * `count`: number, unsigned 16 bit integer
4465 * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
4466 * `set_wear(wear)`: returns boolean indicating whether item was cleared
4467 * `wear`: number, unsigned 16 bit integer
4468 * `get_meta()`: returns ItemStackMetaRef. See section for more details
4469 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
4471 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
4472 * `clear()`: removes all items from the stack, making it empty.
4473 * `replace(item)`: replace the contents of this stack.
4474 * `item` can also be an itemstring or table.
4475 * `to_string()`: returns the stack in itemstring form.
4476 * `to_table()`: returns the stack in Lua table form.
4477 * `get_stack_max()`: returns the maximum size of the stack (depends on the
4479 * `get_free_space()`: returns `get_stack_max() - get_count()`.
4480 * `is_known()`: returns `true` if the item name refers to a defined item type.
4481 * `get_definition()`: returns the item definition table.
4482 * `get_tool_capabilities()`: returns the digging properties of the item,
4483 or those of the hand if none are defined for this item type
4484 * `add_wear(amount)`
4485 * Increases wear by `amount` if the item is a tool
4486 * `amount`: number, integer
4487 * `add_item(item)`: returns leftover `ItemStack`
4488 * Put some item or stack onto this stack
4489 * `item_fits(item)`: returns `true` if item or stack can be fully added to
4491 * `take_item(n)`: returns taken `ItemStack`
4492 * Take (and remove) up to `n` items from this stack
4493 * `n`: number, default: `1`
4494 * `peek_item(n)`: returns taken `ItemStack`
4495 * Copy (don't remove) up to `n` items from this stack
4496 * `n`: number, default: `1`
4498 ### `ItemStackMetaRef`
4499 ItemStack metadata: reference extra data and functionality stored in a stack.
4500 Can be obtained via `item:get_meta()`.
4503 * All methods in MetaDataRef
4504 * `set_tool_capabilities([tool_capabilities])`
4505 * Overrides the item's tool capabilities
4506 * A nil value will clear the override data and restore the original
4510 See `StorageRef`, `NodeMetaRef`, `ItemStackMetaRef`, and `PlayerMetaRef`.
4513 * `contains(key)`: Returns true if key present, otherwise false.
4514 * Returns `nil` when the MetaData is inexistent.
4515 * `get(key)`: Returns `nil` if key not present, else the stored string.
4516 * `set_string(key, value)`: Value of `""` will delete the key.
4517 * `get_string(key)`: Returns `""` if key not present.
4518 * `set_int(key, value)`
4519 * `get_int(key)`: Returns `0` if key not present.
4520 * `set_float(key, value)`
4521 * `get_float(key)`: Returns `0` if key not present.
4522 * `to_table()`: returns `nil` or a table with keys:
4523 * `fields`: key-value storage
4524 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
4525 * `from_table(nil or {})`
4526 * Any non-table value will clear the metadata
4527 * See "Node Metadata" for an example
4528 * returns `true` on success
4530 * returns `true` if this metadata has the same key-value pairs as `other`
4533 An interface to use mod channels on client and server
4536 * `leave()`: leave the mod channel.
4537 * Server leaves channel `channel_name`.
4538 * No more incoming or outgoing messages can be sent to this channel from
4540 * This invalidate all future object usage.
4541 * Ensure your set mod_channel to nil after that to free Lua resources.
4542 * `is_writeable()`: returns true if channel is writeable and mod can send over
4544 * `send_all(message)`: Send `message` though the mod channel.
4545 * If mod channel is not writeable or invalid, message will be dropped.
4546 * Message size is limited to 65535 characters by protocol.
4549 Node metadata: reference extra data and functionality stored in a node.
4550 Can be obtained via `minetest.get_meta(pos)`.
4553 * All methods in MetaDataRef
4554 * `get_inventory()`: returns `InvRef`
4555 * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
4556 This will prevent them from being sent to the client. Note that the "private"
4557 status will only be remembered if an associated key-value pair exists,
4558 meaning it's best to call this when initializing all other meta (e.g.
4562 Node Timers: a high resolution persistent per-node timer.
4563 Can be gotten via `minetest.get_node_timer(pos)`.
4566 * `set(timeout,elapsed)`
4567 * set a timer's state
4568 * `timeout` is in seconds, and supports fractional values (0.1 etc)
4569 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
4570 * will trigger the node's `on_timer` function after `(timeout - elapsed)`
4574 * equivalent to `set(timeout,0)`
4577 * `get_timeout()`: returns current timeout in seconds
4578 * if `timeout` equals `0`, timer is inactive
4579 * `get_elapsed()`: returns current elapsed time in seconds
4580 * the node's `on_timer` function will be called after `(timeout - elapsed)`
4582 * `is_started()`: returns boolean state of timer
4583 * returns `true` if timer is started, otherwise `false`
4586 Moving things in the game are generally these.
4588 This is basically a reference to a C++ `ServerActiveObject`
4591 * `remove()`: remove object (after returning from Lua)
4592 * Note: Doesn't work on players, use `minetest.kick_player` instead
4593 * `get_pos()`: returns `{x=num, y=num, z=num}`
4594 * `set_pos(pos)`; `pos`=`{x=num, y=num, z=num}`
4595 * `move_to(pos, continuous=false)`: interpolated move
4596 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
4597 * `puncher` = another `ObjectRef`,
4598 * `time_from_last_punch` = time since last punch action of the puncher
4599 * `direction`: can be `nil`
4600 * `right_click(clicker)`; `clicker` is another `ObjectRef`
4601 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
4602 * `set_hp(hp, reason)`: set number of hitpoints (2 * number of hearts).
4603 * See reason in register_on_player_hpchange
4604 * `get_inventory()`: returns an `InvRef`
4605 * `get_wield_list()`: returns the name of the inventory list the wielded item
4607 * `get_wield_index()`: returns the index of the wielded item
4608 * `get_wielded_item()`: returns an `ItemStack`
4609 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if
4611 * `set_armor_groups({group1=rating, group2=rating, ...})`
4612 * `get_armor_groups()`: returns a table with the armor group ratings
4613 * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
4614 * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
4615 * `frame_speed`: number, default: `15.0`
4616 * `frame_blend`: number, default: `0.0`
4617 * `frame_loop`: boolean, default: `true`
4618 * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and
4620 * `set_animation_frame_speed(frame_speed)`
4621 * `frame_speed`: number, default: `15.0`
4622 * `set_attach(parent, bone, position, rotation)`
4624 * `position`: `{x=num, y=num, z=num}` (relative)
4625 * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees
4626 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't
4629 * `set_bone_position(bone, position, rotation)`
4631 * `position`: `{x=num, y=num, z=num}` (relative)
4632 * `rotation`: `{x=num, y=num, z=num}`
4633 * `get_bone_position(bone)`: returns position and rotation of the bone
4634 * `set_properties(object property table)`
4635 * `get_properties()`: returns object property table
4636 * `is_player()`: returns true for players, false otherwise
4637 * `get_nametag_attributes()`
4638 * returns a table with the attributes of the nametag of an object
4640 color = {a=0..255, r=0..255, g=0..255, b=0..255},
4643 * `set_nametag_attributes(attributes)`
4644 * sets the attributes of the nametag of an object
4648 text = "My Nametag",
4651 ##### LuaEntitySAO-only (no-op for other objects)
4652 * `set_velocity(vel)`
4653 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
4654 * `add_velocity(vel)`
4655 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
4656 * In comparison to using get_velocity, adding the velocity and then using
4657 set_velocity, add_velocity is supposed to avoid synchronization problems.
4658 * `get_velocity()`: returns the velocity, a vector
4659 * `set_acceleration(acc)`
4661 * `get_acceleration()`: returns the acceleration, a vector
4662 * `set_yaw(radians)`
4663 * `get_yaw()`: returns number in radians
4664 * `set_texture_mod(mod)`
4665 * `get_texture_mod()` returns current texture modifier
4666 * `set_sprite(p, num_frames, framelength, select_horiz_by_yawpitch)`
4667 * Select sprite from spritesheet with optional animation and Dungeon Master
4668 style texture selection based on yaw relative to camera
4669 * `p`: {x=number, y=number}, the coordinate of the first frame
4670 (x: column, y: row), default: `{x=0, y=0}`
4671 * `num_frames`: number, default: `1`
4672 * `framelength`: number, default: `0.2`
4673 * `select_horiz_by_yawpitch`: boolean, this was once used for the Dungeon
4674 Master mob, default: `false`
4675 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
4678 ##### Player-only (no-op for other objects)
4679 * `get_player_name()`: returns `""` if is not a player
4680 * `get_player_velocity()`: returns `nil` if is not a player, otherwise a
4681 table {x, y, z} representing the player's instantaneous velocity in nodes/s
4682 * `get_look_dir()`: get camera direction as a unit vector
4683 * `get_look_vertical()`: pitch in radians
4684 * Angle ranges between -pi/2 and pi/2, which are straight up and down
4686 * `get_look_horizontal()`: yaw in radians
4687 * Angle is counter-clockwise from the +z direction.
4688 * `set_look_vertical(radians)`: sets look pitch
4689 * radians - Angle from looking forward, where positive is downwards.
4690 * `set_look_horizontal(radians)`: sets look yaw
4691 * radians - Angle from the +z direction, where positive is
4693 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use
4694 `get_look_vertical`.
4695 * Angle ranges between -pi/2 and pi/2, which are straight down and up
4697 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use
4698 `get_look_horizontal`.
4699 * Angle is counter-clockwise from the +x direction.
4700 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use
4701 `set_look_vertical`.
4702 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use
4703 `set_look_horizontal`.
4704 * `get_breath()`: returns players breath
4705 * `set_breath(value)`: sets players breath
4707 * `0`: player is drowning
4708 * max: bubbles bar is not shown
4709 * See Object Properties for more information
4710 * `set_attribute(attribute, value)`: DEPRECATED, use get_meta() instead
4711 * Sets an extra attribute with value on player.
4712 * `value` must be a string, or a number which will be converted to a
4714 * If `value` is `nil`, remove attribute from player.
4715 * `get_attribute(attribute)`: DEPRECATED, use get_meta() instead
4716 * Returns value (a string) for extra attribute.
4717 * Returns `nil` if no attribute found.
4718 * `get_meta()`: Returns a PlayerMetaRef.
4719 * `set_inventory_formspec(formspec)`
4720 * Redefine player's inventory form
4721 * Should usually be called in `on_joinplayer`
4722 * `get_inventory_formspec()`: returns a formspec string
4723 * `set_formspec_prepend(formspec)`:
4724 * the formspec string will be added to every formspec shown to the user,
4725 except for those with a no_prepend[] tag.
4726 * This should be used to set style elements such as background[] and
4727 bgcolor[], any non-style elements (eg: label) may result in weird behaviour.
4728 * Only affects formspecs shown after this is called.
4729 * `get_formspec_prepend(formspec)`: returns a formspec string.
4730 * `get_player_control()`: returns table with player pressed keys
4731 * The table consists of fields with boolean value representing the pressed
4732 keys, the fields are jump, right, left, LMB, RMB, sneak, aux1, down, up.
4733 * example: `{jump=false, right=true, left=false, LMB=false, RMB=false,
4734 sneak=true, aux1=false, down=false, up=false}`
4735 * `get_player_control_bits()`: returns integer with bit packed player pressed
4737 * bit nr/meaning: 0/up, 1/down, 2/left, 3/right, 4/jump, 5/aux1, 6/sneak,
4739 * `set_physics_override(override_table)`
4740 * `override_table` is a table with the following fields:
4741 * `speed`: multiplier to default walking speed value (default: `1`)
4742 * `jump`: multiplier to default jump value (default: `1`)
4743 * `gravity`: multiplier to default gravity value (default: `1`)
4744 * `sneak`: whether player can sneak (default: `true`)
4745 * `sneak_glitch`: whether player can use the new move code replications
4746 of the old sneak side-effects: sneak ladders and 2 node sneak jump
4748 * `new_move`: use new move/sneak code. When `false` the exact old code
4749 is used for the specific old sneak behaviour (default: `true`)
4750 * `get_physics_override()`: returns the table given to `set_physics_override`
4751 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
4753 * `hud_remove(id)`: remove the HUD element of the specified id
4754 * `hud_change(id, stat, value)`: change a value of a previously added HUD
4756 * element `stat` values:
4757 `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
4758 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
4759 * `hud_set_flags(flags)`: sets specified HUD flags to `true`/`false`
4760 * `flags`: (is visible) `hotbar`, `healthbar`, `crosshair`, `wielditem`,
4761 `breathbar`, `minimap`, `minimap_radar`
4762 * pass a table containing a `true`/`false` value of each flag to be set or
4764 * if a flag equals `nil`, the flag is not modified
4765 * note that setting `minimap` modifies the client's permission to view the
4766 minimap - the client may locally elect to not view the minimap.
4767 * minimap `radar` is only usable when `minimap` is true
4768 * `hud_get_flags()`: returns a table containing status of hud flags
4769 * returns `{hotbar=true, healthbar=true, crosshair=true, wielditem=true,
4770 breathbar=true, minimap=true, minimap_radar=true}`
4771 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
4772 * `count`: number of items, must be between `1` and `23`
4773 * `hud_get_hotbar_itemcount`: returns number of visible items
4774 * `hud_set_hotbar_image(texturename)`
4775 * sets background image for hotbar
4776 * `hud_get_hotbar_image`: returns texturename
4777 * `hud_set_hotbar_selected_image(texturename)`
4778 * sets image for selected item of hotbar
4779 * `hud_get_hotbar_selected_image`: returns texturename
4780 * `set_sky(bgcolor, type, {texture names}, clouds)`
4781 * `bgcolor`: ColorSpec, defaults to white
4782 * `type`: Available types:
4783 * `"regular"`: Uses 0 textures, `bgcolor` ignored
4784 * `"skybox"`: Uses 6 textures, `bgcolor` used
4785 * `"plain"`: Uses 0 textures, `bgcolor` used
4786 * `clouds`: Boolean for whether clouds appear in front of `"skybox"` or
4787 `"plain"` custom skyboxes (default: `true`)
4788 * `get_sky()`: returns bgcolor, type, table of textures, clouds
4789 * `set_clouds(parameters)`: set cloud parameters
4790 * `parameters` is a table with the following optional fields:
4791 * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
4792 * `color`: basic cloud color with alpha channel, ColorSpec
4793 (default `#fff0f0e5`).
4794 * `ambient`: cloud color lower bound, use for a "glow at night" effect.
4795 ColorSpec (alpha ignored, default `#000000`)
4796 * `height`: cloud height, i.e. y of cloud base (default per conf,
4798 * `thickness`: cloud thickness in nodes (default `16`)
4799 * `speed`: 2D cloud speed + direction in nodes per second
4800 (default `{x=0, z=-2}`).
4801 * `get_clouds()`: returns a table with the current cloud parameters as in
4803 * `override_day_night_ratio(ratio or nil)`
4804 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific
4806 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
4807 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
4808 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`:
4809 set animation for player model in third person view
4811 set_local_animation({x=0, y=79}, -- < stand/idle animation key frames
4812 {x=168, y=187}, -- < walk animation key frames
4813 {x=189, y=198}, -- < dig animation key frames
4814 {x=200, y=219}, -- < walk+dig animation key frames
4815 frame_speed=30): -- < animation frame speed
4816 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and
4818 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for
4820 * in first person view
4821 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
4822 * `get_eye_offset()`: returns `offset_first` and `offset_third`
4825 A 32-bit pseudorandom number generator.
4826 Uses PCG32, an algorithm of the permuted congruential generator family,
4827 offering very strong randomness.
4829 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
4832 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
4833 * `next(min, max)`: return next integer random number [`min`...`max`]
4834 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed
4835 random number [`min`...`max`].
4836 * This is only a rough approximation of a normal distribution with:
4837 * `mean = (max - min) / 2`, and
4838 * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
4839 * Increasing `num_trials` improves accuracy of the approximation
4842 A perlin noise generator.
4843 It can be created via `PerlinNoise(seed, octaves, persistence, scale)`
4844 or `PerlinNoise(noiseparams)`.
4845 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
4846 or `minetest.get_perlin(noiseparams)`.
4849 * `get_2d(pos)`: returns 2D noise value at `pos={x=,y=}`
4850 * `get_3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
4852 ### `PerlinNoiseMap`
4853 A fast, bulk perlin noise generator.
4855 It can be created via `PerlinNoiseMap(noiseparams, size)` or
4856 `minetest.get_perlin_map(noiseparams, size)`.
4858 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
4859 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
4862 For each of the functions with an optional `buffer` parameter: If `buffer` is
4863 not nil, this table will be used to store the result instead of creating a new
4867 * `get_2d_map(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
4868 with values starting at `pos={x=,y=}`
4869 * `get_3d_map(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>`
4870 3D array of 3D noise with values starting at `pos={x=,y=,z=}`.
4871 * `get_2d_map_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element
4872 array of 2D noise with values starting at `pos={x=,y=}`
4873 * `get_3d_map_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
4874 * `calc_2d_map(pos)`: Calculates the 2d noise map starting at `pos`. The result
4875 is stored internally.
4876 * `calc_3d_map(pos)`: Calculates the 3d noise map starting at `pos`. The result
4877 is stored internally.
4878 * `get_map_slice(slice_offset, slice_size, buffer)`: In the form of an array,
4879 returns a slice of the most recently computed noise results. The result slice
4880 begins at coordinates `slice_offset` and takes a chunk of `slice_size`.
4881 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer
4883 `noisevals = noise:get_map_slice({y=20}, {y=2})`
4884 It is important to note that `slice_offset` offset coordinates begin at 1,
4885 and are relative to the starting position of the most recently calculated
4887 To grab a single vertical column of noise starting at map coordinates
4888 x = 1023, y=1000, z = 1000:
4889 `noise:calc_3d_map({x=1000, y=1000, z=1000})`
4890 `noisevals = noise:get_map_slice({x=24, z=1}, {x=1, z=1})`
4894 Uses the same method of storage as the deprecated player attribute API, so
4895 data there will also be in player meta.
4896 Can be obtained using `player:get_meta()`.
4899 * All methods in MetaDataRef
4902 A 16-bit pseudorandom number generator.
4903 Uses a well-known LCG algorithm introduced by K&R.
4905 It can be created via `PseudoRandom(seed)`.
4908 * `next()`: return next integer random number [`0`...`32767`]
4909 * `next(min, max)`: return next integer random number [`min`...`max`]
4910 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
4911 due to the simple implementation making bad distribution otherwise.
4914 A raycast on the map. It works with selection boxes.
4915 Can be used as an iterator in a for loop.
4917 The map is loaded as the ray advances. If the
4918 map is modified after the `Raycast` is created,
4919 the changes may or may not have an effect on
4922 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
4923 `minetest.raycast(pos1, pos2, objects, liquids)` where:
4924 * `pos1`: start of the ray
4925 * `pos2`: end of the ray
4926 * `objects` : if false, only nodes will be returned. Default is true.
4927 * `liquids' : if false, liquid nodes won't be returned. Default is false.
4930 * `next()`: returns a `pointed_thing`
4931 * Returns the next thing pointed by the ray or nil.
4934 Interface for the operating system's crypto-secure PRNG.
4936 It can be created via `SecureRandom()`. The constructor returns nil if a
4937 secure random device cannot be found on the system.
4940 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many
4941 random bytes, as a string.
4944 An interface to read config files in the format of `minetest.conf`.
4946 It can be created via `Settings(filename)`.
4949 * `get(key)`: returns a value
4950 * `get_bool(key, [default])`: returns a boolean
4951 * `default` is the value returned if `key` is not found.
4952 * Returns `nil` if `key` is not found and `default` not specified.
4953 * `get_np_group(key)`: returns a NoiseParams table
4955 * Setting names can't contain whitespace or any of `="{}#`.
4956 * Setting values can't contain the sequence `\n"""`.
4957 * Setting names starting with "secure." can't be set on the main settings
4958 object (`minetest.settings`).
4959 * `set_bool(key, value)`
4960 * See documentation for set() above.
4961 * `set_np_group(key, value)`
4962 * `value` is a NoiseParams table.
4963 * Also, see documentation for set() above.
4964 * `remove(key)`: returns a boolean (`true` for success)
4965 * `get_names()`: returns `{key1,...}`
4966 * `write()`: returns a boolean (`true` for success)
4967 * Writes changes to file.
4968 * `to_table()`: returns `{[key1]=value1,...}`
4971 Mod metadata: per mod metadata, saved automatically.
4972 Can be obtained via `minetest.get_mod_storage()` during load time.
4975 * All methods in MetaDataRef
4981 ### Object Properties
4985 -- ^ For players: Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`
4987 -- ^ For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`
4989 -- ^ For players only. Zoom FOV in degrees.
4990 -- Note that zoom loads and/or generates world beyond the server's
4991 -- maximum send and generate distances, so acts like a telescope.
4992 -- Smaller zoomFOV values increase the distance loaded and/or generated.
4993 -- Defaults to 15 in creative mode, 0 in survival mode.
4994 -- zoom_fov = 0 disables zooming for the player.
4996 -- ^ For players only. Camera height above feet position in nodes.
4997 -- Defaults to 1.625.
4999 collide_with_objects = true,
5000 -- ^ Collide with other objects if physical = true.
5002 collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
5003 selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
5004 -- ^ Default, uses collision box dimensions when not set.
5005 -- ^ For both boxes: {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from
5008 -- ^ Overrides selection box when false.
5009 visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem",
5010 -- ^ "cube" is a node-sized cube.
5011 -- ^ "sprite" is a flat texture always facing the player.
5012 -- ^ "upright_sprite" is a vertical flat texture.
5013 -- ^ "mesh" uses the defined mesh model.
5014 -- ^ "wielditem" is used for dropped items
5015 -- (see builtin/game/item_entity.lua).
5016 -- For this use 'textures = {itemname}'.
5017 -- If the item has a 'wield_image' the object will be an extrusion of
5019 -- If 'itemname' is a cubic node or nodebox the object will appear
5020 -- identical to 'itemname'.
5021 -- If 'itemname' is a plantlike node the object will be an extrusion of
5023 -- Otherwise for non-node items, the object will be an extrusion of
5024 -- 'inventory_image'.
5025 visual_size = {x = 1, y = 1},
5026 -- ^ `x` multiplies horizontal (X and Z) visual size.
5027 -- ^ `y` multiplies vertical (Y) visual size.
5030 -- ^ Number of required textures depends on visual.
5031 -- ^ "cube" uses 6 textures in the way a node does.
5032 -- ^ "sprite" uses 1 texture.
5033 -- ^ "upright_sprite" uses 2 textures: {front, back}.
5034 -- ^ "wielditem" expects 'textures = {itemname}' (see 'visual' above).
5036 -- ^ Number of required colors depends on visual.
5037 use_texture_alpha = false,
5038 -- ^ Use texture's alpha channel, excludes "upright_sprite" and "wielditem"
5039 -- ^ Note: currently causes visual issues when viewed through other
5040 -- ^ semi-transparent materials such as water.
5041 spritediv = {x = 1, y = 1},
5042 -- ^ Used with spritesheet textures for animation and/or frame selection
5043 -- according to position relative to player.
5044 -- ^ Defines the number of columns and rows in the spritesheet:
5046 initial_sprite_basepos = {x = 0, y = 0},
5047 -- ^ Used with spritesheet textures.
5048 -- ^ Defines the {column, row} position of the initially used frame in the
5051 makes_footstep_sound = false,
5052 automatic_rotate = 0,
5053 -- ^ Set constant rotation in radians per second, positive or negative.
5054 -- ^ Set to 0 to disable constant rotation.
5056 automatic_face_movement_dir = 0.0,
5057 -- ^ Automatically set yaw to movement direction, offset in degrees,
5058 -- 'false' to disable.
5059 automatic_face_movement_max_rotation_per_sec = -1,
5060 -- ^ Limit automatic rotation to this value in degrees per second,
5061 -- value < 0 no limit.
5062 backface_culling = true,
5063 -- ^ Set to false to disable backface_culling for model.
5065 -- ^ Add this much extra lighting when calculating texture color.
5066 -- Value < 0 disables light's effect on texture color.
5067 -- For faking self-lighting, UI style entities, or programmatic coloring
5070 -- ^ By default empty, for players their name is shown if empty.
5071 nametag_color = <color>,
5072 -- ^ Sets color of nametag as ColorSpec.
5074 -- ^ By default empty, text to be shown when pointed at object.
5076 -- ^ If false, never save this object statically. It will simply be
5077 -- deleted when the block gets unloaded.
5078 -- The get_staticdata() callback is never called then.
5079 -- Defaults to 'true'
5082 ### Entity definition (`register_entity`)
5085 -- Deprecated: Everything in object properties is read directly from here
5087 initial_properties = --[[<initial object properties>]],
5089 on_activate = function(self, staticdata, dtime_s),
5090 on_step = function(self, dtime),
5091 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
5092 on_rightclick = function(self, clicker),
5093 get_staticdata = function(self),
5094 -- ^ Called sometimes; the string returned is passed to on_activate when
5095 -- the entity is re-activated from static state
5097 _custom_field = whatever,
5098 -- ^ You can define arbitrary member variables here (see item definition
5099 -- for more info) by using a '_' prefix.
5102 ### ABM (ActiveBlockModifier) definition (`register_abm`)
5105 label = "Lava cooling",
5106 ^ Descriptive label for profiling purposes (optional).
5107 Definitions with identical labels will be listed as one.
5108 nodenames = {"default:lava_source"},
5109 ^ Apply `action` function to these nodes.
5110 ^ `group:groupname` can also be used here.
5111 neighbors = {"default:water_source", "default:water_flowing"},
5112 ^ Only apply `action` to nodes that have one of, or any
5113 combination of, these neighbors.
5114 ^ If left out or empty, any neighbor will do.
5115 ^ `group:groupname` can also be used here.
5117 ^ Operation interval in seconds.
5119 ^ Chance of triggering `action` per-node per-interval is 1.0 / this
5122 ^ If true, catch-up behaviour is enabled: The `chance` value is
5123 temporarily reduced when returning to an area to simulate time lost
5124 by the area being unattended. Note that the `chance` value can often
5126 action = function(pos, node, active_object_count, active_object_count_wider),
5127 ^ Function triggered for each qualifying node.
5128 ^ `active_object_count` is number of active objects in the node's
5130 ^ `active_object_count_wider` is number of active objects in the node's
5131 mapblock plus all 26 neighboring mapblocks. If any neighboring
5132 mapblocks are unloaded an estmate is calculated for them based on
5136 ### LBM (LoadingBlockModifier) definition (`register_lbm`)
5139 label = "Upgrade legacy doors",
5140 -- ^ Descriptive label for profiling purposes (optional).
5141 -- Definitions with identical labels will be listed as one.
5142 name = "modname:replace_legacy_door",
5143 nodenames = {"default:lava_source"},
5144 -- ^ List of node names to trigger the LBM on.
5145 -- Also non-registered nodes will work.
5146 -- Groups (as of group:groupname) will work as well.
5147 run_at_every_load = false,
5148 -- ^ Whether to run the LBM's action every time a block gets loaded,
5149 -- and not just for blocks that were saved last time before LBMs were
5150 -- introduced to the world.
5151 action = func(pos, node),
5154 ### Item definition (`register_node`, `register_craftitem`, `register_tool`)
5157 description = "Steel Axe",
5158 groups = {}, -- key = name, value = rating; rating = 1..3.
5159 if rating not applicable, use 1.
5160 e.g. {wool = 1, fluffy = 3}
5161 {soil = 2, outerspace = 1, crumbly = 1}
5162 {bendy = 2, snappy = 1},
5163 {hard = 1, metal = 1, spikes = 1}
5164 inventory_image = "default_tool_steelaxe.png",
5165 inventory_overlay = "overlay.png",
5166 ^ An overlay which does not get colorized.
5171 ^ An image file containing the palette of a node.
5172 ^ You can set the currently used color as the
5173 ^ "palette_index" field of the item stack metadata.
5174 ^ The palette is always stretched to fit indices
5175 ^ between 0 and 255, to ensure compatibility with
5176 ^ "colorfacedir" and "colorwallmounted" nodes.
5178 color = "0xFFFFFFFF",
5179 ^ The color of the item. The palette overrides this.
5180 wield_scale = {x = 1, y = 1, z = 1},
5183 liquids_pointable = false,
5184 tool_capabilities = {
5185 full_punch_interval = 1.0,
5189 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00},
5190 uses = 20, maxlevel = 2},
5192 damage_groups = {groupname = damage},
5194 node_placement_prediction = nil,
5196 ^ If nil and item is node, prediction is made automatically
5197 ^ If nil and item is not a node, no prediction is made
5198 ^ If "" and item is anything, no prediction is made
5199 ^ Otherwise should be name of node which the client immediately places
5200 on ground when the player places the item. Server will always update
5201 actual result to client in a short moment.
5203 node_dig_prediction = "air",
5205 ^ if "", no prediction is made
5206 ^ if "air", node is removed
5207 ^ Otherwise should be name of node which the client immediately places
5208 upon digging. Server will always update actual result shortly.
5211 breaks = "default_tool_break", -- tools only
5212 place = --[[<SimpleSoundSpec>]],
5215 on_place = func(itemstack, placer, pointed_thing),
5217 ^ Shall place item and return the leftover itemstack
5218 ^ The placer may be any ObjectRef or nil.
5219 ^ default: minetest.item_place ]]
5220 on_secondary_use = func(itemstack, user, pointed_thing),
5222 ^ Same as on_place but called when pointing at nothing.
5223 ^ The user may be any ObjectRef or nil.
5224 ^ pointed_thing : always { type = "nothing" }
5226 on_drop = func(itemstack, dropper, pos),
5228 ^ Shall drop item and return the leftover itemstack
5229 ^ The dropper may be any ObjectRef or nil.
5230 ^ default: minetest.item_drop ]]
5231 on_use = func(itemstack, user, pointed_thing),
5234 ^ Function must return either nil if no item shall be removed from
5235 inventory, or an itemstack to replace the original itemstack.
5236 e.g. itemstack:take_item(); return itemstack
5237 ^ Otherwise, the function is free to do what it wants.
5238 ^ The user may be any ObjectRef or nil.
5239 ^ The default functions handle regular use cases.
5241 after_use = func(itemstack, user, node, digparams),
5244 ^ If defined, should return an itemstack and will be called instead of
5245 wearing out the tool. If returns nil, does nothing.
5246 If after_use doesn't exist, it is the same as:
5247 function(itemstack, user, node, digparams)
5248 itemstack:add_wear(digparams.wear)
5251 ^ The user may be any ObjectRef or nil.
5253 _custom_field = whatever,
5255 ^ Add your own custom fields. By convention, all custom field names
5256 should start with `_` to avoid naming collisions with future engine
5263 * `{name="image.png", animation={Tile Animation definition}}`
5264 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
5265 tileable_horizontal=bool, align_style="node"/"world"/"user", scale=int}`
5266 * backface culling enabled by default for most nodes
5267 * tileable flags are info for shaders, how they should treat texture
5268 when displacement mapping is used
5269 Directions are from the point of view of the tile texture,
5270 not the node it's on
5271 * align style determines whether the texture will be rotated with the node
5272 or kept aligned with its surroundings. "user" means that client
5273 setting will be used, similar to `glasslike_framed_optional`.
5274 Note: supported by solid nodes and nodeboxes only.
5275 * scale is used to make texture span several (exactly `scale`) nodes,
5276 instead of just one, in each direction. Works for world-aligned
5278 Note that as the effect is applied on per-mapblock basis, `16` should
5279 be equally divisible by `scale` or you may get wrong results.
5280 * `{name="image.png", color=ColorSpec}`
5281 * the texture's color will be multiplied with this color.
5282 * the tile's color overrides the owning node's color in all cases.
5283 * deprecated, yet still supported field names:
5286 ### Tile animation definition
5289 type = "vertical_frames",
5291 -- ^ specify width of a frame in pixels
5293 -- ^ specify height of a frame in pixels
5295 -- ^ specify full loop length
5301 -- ^ specify width in number of frames
5303 -- ^ specify height in number of frames
5305 -- ^ specify length of a single frame
5308 ### Node definition (`register_node`)
5311 -- <all fields allowed in item definitions>,
5313 drawtype = "normal", -- See "Node drawtypes"
5314 visual_scale = 1.0, --[[
5315 ^ Supported for drawtypes "plantlike", "signlike", "torchlike",
5316 ^ "firelike", "mesh".
5317 ^ For plantlike and firelike, the image will start at the bottom of the
5318 ^ node, for the other drawtypes the image will be centered on the node.
5319 ^ Note that positioning for "torchlike" may still change. ]]
5320 tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
5321 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z
5322 ^ Old field name was 'tile_images'.
5323 ^ List can be shortened to needed length ]]
5324 overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
5325 ^ Same as `tiles`, but these textures are drawn on top of the
5326 ^ base tiles. You can use this to colorize only specific parts of
5327 ^ your texture. If the texture name is an empty string, that
5328 ^ overlay is not drawn. Since such tiles are drawn twice, it
5329 ^ is not recommended to use overlays on very common nodes. ]]
5330 special_tiles = {tile definition 1, Tile definition 2}, --[[
5331 ^ Special textures of node; used rarely
5332 ^ Old field name was 'special_materials'.
5333 ^ List can be shortened to needed length ]]
5334 color = ColorSpec, --[[
5335 ^ The node's original color will be multiplied with this color.
5336 ^ If the node has a palette, then this setting only has an effect
5337 ^ in the inventory and on the wield item. ]]
5338 use_texture_alpha = false,
5339 ^ Use texture's alpha channel.
5340 palette = "palette.png", --[[
5341 ^ The node's `param2` is used to select a pixel from the image
5342 ^ (pixels are arranged from left to right and from top to bottom).
5343 ^ The node's color will be multiplied with the selected pixel's
5344 ^ color. Tiles can override this behavior.
5345 ^ Only when `paramtype2` supports palettes. ]]
5346 post_effect_color = "green#0F",
5347 ^ Screen tint if player is inside node, see "ColorSpec".
5348 paramtype = "none", -- See "Nodes".
5349 paramtype2 = "none", -- See "Nodes"
5350 place_param2 = nil, -- Force value for param2 when player places node
5351 is_ground_content = true,
5352 ^ If false, the cave generator will not carve through this node.
5353 sunlight_propagates = false,
5354 ^ If true, sunlight will go infinitely through this.
5355 walkable = true, -- If true, objects collide with node
5356 pointable = true, -- If true, can be pointed at
5357 diggable = true, -- If false, can never be dug
5358 climbable = false, -- If true, can be climbed on (ladder)
5359 buildable_to = false, -- If true, placed nodes can replace this node
5360 floodable = false, --[[
5361 ^ If true, liquids flow into and replace this node.
5362 ^ Warning: making a liquid node 'floodable' will cause problems. ]]
5363 liquidtype = "none", -- "none"/"source"/"flowing"
5364 liquid_alternative_flowing = "", -- Flowing version of source liquid
5365 liquid_alternative_source = "", -- Source version of flowing liquid
5366 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
5367 liquid_renewable = true, --[[
5368 ^ If true, a new liquid source can be created by placing two or more
5371 ^ Only valid for "nodebox" drawtype with 'type = "leveled"'.
5372 ^ Allows defining the nodebox height without using param2.
5373 ^ The nodebox height is 'leveled' / 64 nodes.
5374 ^ The maximum value of 'leveled' is 127. ]]
5375 liquid_range = 8, -- number of flowing nodes around source (max. 8)
5377 ^ Player will take this amount of damage if no bubbles are left.
5378 light_source = 0, --[[
5379 ^ Amount of light emitted by node.
5380 ^ To set the maximum (currently 14), use the value
5381 ^ 'minetest.LIGHT_MAX'.
5382 ^ A value outside the range 0 to minetest.LIGHT_MAX causes undefined
5384 damage_per_second = 0,
5385 ^ If player is inside node, this damage is caused.
5386 node_box = {type="regular"}, -- See "Node boxes"
5387 connects_to = nodenames, --[[
5388 ^ Used for nodebox nodes with the type == "connected"
5389 ^ Specifies to what neighboring nodes connections will be drawn
5390 ^ e.g. `{"group:fence", "default:wood"}` or `"default:stone"` ]]
5391 connect_sides = { "top", "bottom", "front", "left", "back", "right" },
5393 ^ Tells connected nodebox nodes to connect only to these sides of this
5399 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
5402 ^ Custom selection box definition. Multiple boxes can be defined.
5403 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box
5404 ^ definition is used for the selection box.
5408 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
5411 ^ Custom collision box definition. Multiple boxes can be defined.
5412 ^ If drawtype "nodebox" is used and collision_box is nil, then node_box
5413 ^ definition is used for the collision box.
5414 ^ For both of the above a box is defined as:
5415 ^ {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from node center.
5416 legacy_facedir_simple = false,
5417 ^ Support maps made in and before January 2012.
5418 legacy_wallmounted = false,
5419 ^ Support maps made in and before January 2012.
5421 ^ Valid for mesh, nodebox, plantlike, allfaces_optional nodes.
5422 ^ 1 - wave node like plants (top of node moves, bottom is fixed)
5423 ^ 2 - wave node like leaves (whole node moves side-to-side)
5424 ^ caveats: not all models will properly wave.
5425 ^ plantlike drawtype nodes can only wave like plants.
5426 ^ allfaces_optional drawtype nodes can only wave like leaves. --]]
5428 footstep = <SimpleSoundSpec>,
5429 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
5430 dug = <SimpleSoundSpec>,
5431 place = <SimpleSoundSpec>,
5432 place_failed = <SimpleSoundSpec>,
5435 ^ Name of dropped node when dug. Default is the node itself.
5438 max_items = 1, -- Maximum number of items to drop.
5439 items = { -- Choose max_items randomly from this list.
5441 items = {"foo:bar", "baz:frob"}, -- Items to drop.
5442 rarity = 1, -- Probability of dropping is 1 / rarity.
5443 inherit_color = true, -- To inherit palette color from the
5449 on_construct = func(pos), --[[
5450 ^ Node constructor; called after adding node
5451 ^ Can set up metadata and stuff like that
5452 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
5455 on_destruct = func(pos), --[[
5456 ^ Node destructor; called before removing node
5457 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
5460 after_destruct = func(pos, oldnode), --[[
5461 ^ Node destructor; called after removing node
5462 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
5465 on_flood = func(pos, oldnode, newnode), --[[
5466 ^ Called when a liquid (newnode) is about to flood oldnode, if
5467 ^ it has `floodable = true` in the nodedef. Not called for bulk
5468 ^ node placement (i.e. schematics and VoxelManip) or air nodes. If
5469 ^ return true the node is not flooded, but on_flood callback will
5470 ^ most likely be called over and over again every liquid update
5471 ^ interval. Default: nil.
5472 ^ Warning: making a liquid node 'floodable' will cause problems. ]]
5474 preserve_metadata = func(pos, oldnode, oldmeta, drops) --[[
5475 ^ Called when oldnode is about be converted to an item, but before the
5476 ^ node is deleted from the world or the drops are added. This is
5477 ^ generally the result of either the node being dug or an attached node
5478 ^ becoming detached.
5479 ^ drops is a table of ItemStacks, so any metadata to be preserved can
5480 ^ be added directly to one or more of the dropped items. See
5481 ^ "ItemStackMetaRef".
5484 after_place_node = func(pos, placer, itemstack, pointed_thing) --[[
5485 ^ Called after constructing node when node was placed using
5486 ^ minetest.item_place_node / minetest.place_node
5487 ^ If return true no item is taken from itemstack
5488 ^ `placer` may be any valid ObjectRef or nil
5491 after_dig_node = func(pos, oldnode, oldmetadata, digger), --[[
5492 ^ oldmetadata is in table format
5493 ^ Called after destructing node when node was dug using
5494 ^ minetest.node_dig / minetest.dig_node
5497 can_dig = function(pos, [player]) --[[
5498 ^ returns true if node can be dug, or false if not
5501 on_punch = func(pos, node, puncher, pointed_thing), --[[
5502 ^ default: minetest.node_punch
5503 ^ By default: Calls minetest.register_on_punchnode callbacks ]]
5505 on_rightclick = func(pos, node, clicker, itemstack, pointed_thing),
5508 ^ itemstack will hold clicker's wielded item
5509 ^ Shall return the leftover itemstack
5510 ^ Note: pointed_thing can be nil, if a mod calls this function
5511 ^ This function does not get triggered by clients <=0.4.16 if the
5512 ^ "formspec" node metadata field is set ]]
5514 on_dig = func(pos, node, digger), --[[
5515 ^ default: minetest.node_dig
5516 ^ By default: checks privileges, wears out tool and removes node ]]
5518 on_timer = function(pos,elapsed), --[[
5520 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
5521 ^ elapsed is the total time passed since the timer was started
5522 ^ return true to run the timer for another cycle with the same timeout
5525 on_receive_fields = func(pos, formname, fields, sender), --[[
5526 ^ fields = {name1 = value1, name2 = value2, ...}
5527 ^ Called when an UI form (e.g. sign text input) returns data
5530 allow_metadata_inventory_move = func(pos, from_list, from_index, to_list, to_index, count, player),
5532 ^ Called when a player wants to move items inside the inventory
5533 ^ Return value: number of items allowed to move ]]
5535 allow_metadata_inventory_put = func(pos, listname, index, stack, player),
5537 ^ Called when a player wants to put something into the inventory
5538 ^ Return value: number of items allowed to put
5539 ^ Return value: -1: Allow and don't modify item count in inventory ]]
5541 allow_metadata_inventory_take = func(pos, listname, index, stack, player),
5543 ^ Called when a player wants to take something out of the inventory
5544 ^ Return value: number of items allowed to take
5545 ^ Return value: -1: Allow and don't modify item count in inventory ]]
5547 on_metadata_inventory_move = func(pos, from_list, from_index, to_list, to_index, count, player),
5548 on_metadata_inventory_put = func(pos, listname, index, stack, player),
5549 on_metadata_inventory_take = func(pos, listname, index, stack, player),
5551 ^ Called after the actual action has happened, according to what was
5553 ^ No return value ]]
5555 on_blast = func(pos, intensity), --[[
5556 ^ intensity: 1.0 = mid range of regular TNT
5557 ^ If defined, called when an explosion touches the node, instead of
5558 removing the node ]]
5561 ### Recipe for `register_craft` (shaped)
5564 output = 'default:pick_stone',
5566 {'default:cobble', 'default:cobble', 'default:cobble'},
5567 {'', 'default:stick', ''},
5568 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
5570 replacements = --[[<optional list of item pairs,
5571 replace one input item with another item on crafting>]]
5574 ### Recipe for `register_craft` (shapeless)
5578 output = 'mushrooms:mushroom_stew',
5581 "mushrooms:mushroom_brown",
5582 "mushrooms:mushroom_red",
5584 replacements = --[[<optional list of item pairs,
5585 replace one input item with another item on crafting>]]
5588 ### Recipe for `register_craft` (tool repair)
5591 type = "toolrepair",
5592 additional_wear = -0.02,
5595 ### Recipe for `register_craft` (cooking)
5599 output = "default:glass",
5600 recipe = "default:sand",
5604 ### Recipe for `register_craft` (furnace fuel)
5608 recipe = "default:leaves",
5612 ### Ore definition (`register_ore`)
5614 See 'Ore types' section above for essential information.
5617 ore_type = "scatter",
5618 ore = "default:stone_with_coal",
5620 -- ^ Facedir rotation. Default is 0 (unchanged rotation)
5621 wherein = "default:stone",
5622 -- ^ a list of nodenames is supported too
5623 clust_scarcity = 8 * 8 * 8,
5624 -- ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
5625 -- ^ If the desired average distance between ores is 'd', set this to
5628 -- ^ Number of ores in a cluster
5630 -- ^ Size of the bounding box of the cluster
5631 -- ^ In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27
5632 -- ^ nodes are coal ore.
5635 -- ^ Lower and upper limits for ore.
5637 -- ^ Attributes for this ore generation, see 'Ore attributes' section
5639 noise_threshold = 0.5,
5640 -- ^ If noise is above this threshold, ore is placed. Not needed for a
5641 -- ^ uniform distribution.
5645 spread = {x = 100, y = 100, z = 100},
5650 -- ^ NoiseParams structure describing one of the perlin noises used for
5651 -- ^ ore distribution.
5652 -- ^ Needed by "sheet", "puff", "blob" and "vein" ores.
5653 -- ^ Omit from "scatter" ore for a uniform ore distribution.
5654 -- ^ Omit from "stratum ore for a simple horizontal strata from y_min to
5656 biomes = {"desert", "rainforest"}
5657 -- ^ List of biomes in which this decoration occurs.
5658 -- ^ Occurs in all biomes if this is omitted, and ignored if the Mapgen
5659 -- ^ being used does not support biomes.
5660 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
5661 column_height_min = 1,
5662 column_height_max = 16,
5663 column_midpoint_factor = 0.5,
5664 -- ^ See 'Ore types' section above.
5665 -- ^ The above 3 parameters are only valid for "sheet" ore.
5669 spread = {x = 100, y = 100, z = 100},
5677 spread = {x = 100, y = 100, z = 100},
5682 -- ^ See 'Ore types' section above.
5683 -- ^ The above 2 parameters are only valid for "puff" ore.
5684 random_factor = 1.0,
5685 -- ^ See 'Ore types' section above.
5686 -- ^ Only valid for "vein" ore.
5687 np_stratum_thickness = {
5690 spread = {x = 100, y = 100, z = 100},
5695 stratum_thickness = 8,
5696 -- ^ See 'Ore types' section above.
5697 -- ^ The above 2 parameters are only valid for "stratum" ore.
5700 ### Biome definition (`register_biome`)
5704 node_dust = "default:snow",
5705 -- ^ Node dropped onto upper surface after all else is generated.
5706 node_top = "default:dirt_with_snow",
5708 -- ^ Node forming surface layer of biome and thickness of this layer.
5709 node_filler = "default:permafrost",
5711 -- ^ Node forming lower layer of biome and thickness of this layer.
5712 node_stone = "default:bluestone",
5713 -- ^ Node that replaces all stone nodes between roughly y_min and y_max.
5714 node_water_top = "default:ice",
5715 depth_water_top = 10,
5716 -- ^ Node forming a surface layer in seawater with the defined thickness.
5718 -- ^ Node that replaces all seawater nodes not in the defined surface
5720 node_river_water = "default:ice",
5721 -- ^ Node that replaces river water in mapgens that use
5722 -- ^ default:river_water.
5723 node_riverbed = "default:gravel",
5725 -- ^ Node placed under river water and thickness of this layer.
5726 node_cave_liquid = "default:water_source",
5727 -- ^ Nodes placed as a blob of liquid in 50% of large caves.
5728 -- ^ If absent, cave liquids fall back to classic behaviour of lava or
5729 -- ^ water distributed according to a hardcoded 3D noise.
5730 node_dungeon = "default:cobble",
5731 -- ^ Node used for primary dungeon structure.
5732 -- ^ If absent, dungeon materials fall back to classic behaviour.
5733 -- ^ If present, the following two nodes are also used.
5734 node_dungeon_alt = "default:mossycobble",
5735 -- ^ Node used for randomly-distributed alternative structure nodes.
5736 -- ^ If alternative structure nodes are not wanted leave this absent for
5737 -- ^ performance reasons.
5738 node_dungeon_stair = "stairs:stair_cobble",
5739 -- ^ Node used for dungeon stairs.
5740 -- ^ If absent, stairs fall back to 'node_dungeon'.
5743 -- ^ Upper and lower limits for biome.
5744 -- ^ Alternatively you can use xyz limits as shown below.
5745 max_pos = {x = 31000, y = 128, z = 31000},
5746 min_pos = {x = -31000, y = 9, z = -31000},
5747 -- ^ xyz limits for biome, an alternative to using 'y_min' and 'y_max'.
5748 -- ^ Biome is limited to a cuboid defined by these positions.
5749 -- ^ Any x, y or z field left undefined defaults to -31000 in 'min_pos' or
5750 -- ^ 31000 in 'max_pos'.
5752 -- ^ Vertical distance in nodes above 'y_max' over which the biome will
5753 -- ^ blend with the biome above.
5754 -- ^ Set to 0 for no vertical blend. Defaults to 0.
5756 humidity_point = 50,
5757 -- ^ Characteristic temperature and humidity for the biome.
5758 -- ^ These values create 'biome points' on a voronoi diagram with heat and
5759 -- ^ humidity as axes. The resulting voronoi cells determine the
5760 -- ^ distribution of the biomes.
5761 -- ^ Heat and humidity have average values of 50, vary mostly between
5762 -- ^ 0 and 100 but can exceed these values.
5765 ### Decoration definition (`register_decoration`)
5768 deco_type = "simple", -- See "Decoration types"
5769 place_on = "default:dirt_with_grass",
5770 -- ^ Node (or list of nodes) that the decoration can be placed on
5772 -- ^ Size of the square divisions of the mapchunk being generated.
5773 -- ^ Determines the resolution of noise variation if used.
5774 -- ^ If the chunk size is not evenly divisible by sidelen, sidelen is made
5775 -- ^ equal to the chunk size.
5777 -- ^ The value determines 'decorations per surface node'.
5778 -- ^ Used only if noise_params is not specified.
5779 -- ^ If >= 10.0 complete coverage is enabled and decoration placement uses
5780 -- ^ a different and much faster method.
5784 spread = {x = 100, y = 100, z = 100},
5791 -- ^ NoiseParams structure describing the perlin noise used for decoration
5793 -- ^ A noise value is calculated for each square division and determines
5794 -- ^ 'decorations per surface node' within each division.
5795 -- ^ If the noise value >= 10.0 complete coverage is enabled and decoration
5796 -- ^ placement uses a different and much faster method.
5797 biomes = {"Oceanside", "Hills", "Plains"},
5798 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes
5799 -- ^ if this is omitted, and ignored if the Mapgen being used does not
5800 -- ^ support biomes.
5801 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
5804 -- ^ Lower and upper limits for decoration.
5805 -- ^ These parameters refer to the Y co-ordinate of the 'place_on' node.
5806 spawn_by = "default:water",
5807 -- ^ Node (or list of nodes) that the decoration only spawns next to.
5808 -- ^ Checks two horizontal planes of 8 neighbouring nodes (including
5809 -- ^ diagonal neighbours), one plane level with the 'place_on' node and a
5810 -- ^ plane one node above that.
5812 -- ^ Number of spawn_by nodes that must be surrounding the decoration
5813 -- ^ position to occur.
5814 -- ^ If absent or -1, decorations occur next to any nodes.
5815 flags = "liquid_surface, force_placement, all_floors, all_ceilings",
5816 -- ^ Flags for all decoration types.
5817 -- ^ "liquid_surface": Instead of placement on the highest solid surface
5818 -- ^ in a mapchunk column, placement is on the highest liquid surface.
5819 -- ^ Placement is disabled if solid nodes are found above the liquid
5821 -- ^ "force_placement": Nodes other than "air" and "ignore" are replaced
5822 -- ^ by the decoration.
5823 -- ^ "all_floors", "all_ceilings": Instead of placement on the highest
5824 -- ^ surface in a mapchunk the decoration is placed on all floor and/or
5825 -- ^ ceiling surfaces, for example in caves.
5826 -- ^ Ceiling decorations act as an inversion of floor decorations so the
5827 -- ^ effect of 'place_offset_y' is inverted.
5828 -- ^ If a single decoration registration has both flags the floor and
5829 -- ^ ceiling decorations will be aligned vertically and may sometimes
5830 -- ^ meet to form a column.
5832 ----- Simple-type parameters
5833 decoration = "default:grass",
5834 -- ^ The node name used as the decoration.
5835 -- ^ If instead a list of strings, a randomly selected node from the list
5836 -- ^ is placed as the decoration.
5838 -- ^ Decoration height in nodes.
5839 -- ^ If height_max is not 0, this is the lower limit of a randomly
5840 -- ^ selected height.
5842 -- ^ Upper limit of the randomly selected height.
5843 -- ^ If absent, the parameter 'height' is used as a constant.
5845 -- ^ Param2 value of decoration nodes.
5846 -- ^ If param2_max is not 0, this is the lower limit of a randomly
5847 -- ^ selected param2.
5849 -- ^ Upper limit of the randomly selected param2.
5850 -- ^ If absent, the parameter 'param2' is used as a constant.
5852 -- ^ Y offset of the decoration base node relative to the standard base
5854 -- ^ Can be positive or negative. Default is 0.
5855 -- ^ Effect is inverted for "all_ceilings" decorations.
5856 -- ^ Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
5857 -- ^ to the 'place_on' node.
5859 ----- Schematic-type parameters
5860 schematic = "foobar.mts",
5861 -- ^ If schematic is a string, it is the filepath relative to the current
5862 -- ^ working directory of the specified Minetest schematic file.
5863 -- ^ - OR -, could be the ID of a previously registered schematic
5864 -- ^ - OR -, could instead be a table containing two mandatory fields,
5865 -- ^ size and data, and an optional table yslice_prob:
5867 size = {x = 4, y = 6, z = 4},
5869 {name = "default:cobble", param1 = 255, param2 = 0},
5870 {name = "default:dirt_with_grass", param1 = 255, param2 = 0},
5871 {name = "air", param1 = 255, param2 = 0},
5875 {ypos = 2, prob = 128},
5876 {ypos = 5, prob = 64},
5880 -- ^ See 'Schematic specifier' for details.
5881 replacements = {["oldname"] = "convert_to", ...},
5882 flags = "place_center_x, place_center_y, place_center_z",
5883 -- ^ Flags for schematic decorations. See 'Schematic attributes'.
5885 -- ^ Rotation can be "0", "90", "180", "270", or "random".
5887 -- ^ If the flag 'place_center_y' is set this parameter is ignored.
5888 -- ^ Y offset of the schematic base node layer relative to the 'place_on'
5890 -- ^ Can be positive or negative. Default is 0.
5891 -- ^ Effect is inverted for "all_ceilings" decorations.
5892 -- ^ Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
5893 -- ^ to the 'place_on' node.
5896 ### Chat command definition (`register_chatcommand`)
5899 params = "<name> <privilege>", -- Short parameter description
5900 description = "Remove privilege from player", -- Full description
5901 privs = {privs=true}, -- Require the "privs" privilege to run
5902 func = function(name, param), -- Called when command is run.
5903 -- Returns boolean success and text
5907 Note that in params, use of symbols is as follows:
5909 * `<>` signifies a placeholder to be replaced when the command is used. For
5910 example, when a player name is needed: `<name>`
5911 * `[]` signifies param is optional and not required when the command is used.
5912 For example, if you require param1 but param2 is optional:
5913 `<param1> [<param2>]`
5914 * `|` signifies exclusive or. The command requires one param from the options
5915 provided. For example: `<param1> | <param2>`
5916 * `()` signifies grouping. For example, when param1 and param2 are both
5917 required, or only param3 is required: `(<param1> <param2>) | <param3>`
5919 ### Detached inventory callbacks
5922 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
5923 -- ^ Called when a player wants to move items inside the inventory
5924 -- ^ Return value: number of items allowed to move
5926 allow_put = func(inv, listname, index, stack, player),
5927 -- ^ Called when a player wants to put something into the inventory
5928 -- ^ Return value: number of items allowed to put
5929 -- ^ Return value: -1: Allow and don't modify item count in inventory
5931 allow_take = func(inv, listname, index, stack, player),
5932 -- ^ Called when a player wants to take something out of the inventory
5933 -- ^ Return value: number of items allowed to take
5934 -- ^ Return value: -1: Allow and don't modify item count in inventory
5936 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
5937 on_put = func(inv, listname, index, stack, player),
5938 on_take = func(inv, listname, index, stack, player),
5939 -- ^ Called after the actual action has happened, according to what was
5941 -- ^ No return value
5944 ### HUD Definition (`hud_add`, `hud_get`)
5947 hud_elem_type = "image", -- see HUD element types
5948 -- ^ type of HUD element, can be either of "image", "text", "statbar",
5950 position = {x=0.5, y=0.5},
5951 -- ^ Left corner position of element
5953 scale = {x = 2, y = 2},
5957 -- ^ Selected item in inventory. 0 for no item selected.
5959 -- ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
5960 alignment = {x=0, y=0},
5961 -- ^ See "HUD Element Types"
5962 offset = {x=0, y=0},
5963 -- ^ See "HUD Element Types"
5964 size = { x=100, y=100 },
5965 -- ^ Size of element in pixels
5968 ### Particle definition (`add_particle`)
5971 pos = {x=0, y=0, z=0},
5972 velocity = {x=0, y=0, z=0},
5973 acceleration = {x=0, y=0, z=0},
5974 -- ^ Spawn particle at pos with velocity and acceleration
5976 -- ^ Disappears after expirationtime seconds
5978 collisiondetection = false,
5979 -- ^ collisiondetection: if true collides with physical objects
5980 collision_removal = false,
5981 -- ^ collision_removal: if true then particle is removed when it collides,
5982 -- ^ requires collisiondetection = true to have any effect
5984 -- ^ vertical: if true faces player using y axis only
5985 texture = "image.png",
5986 -- ^ Uses texture (string)
5987 playername = "singleplayer",
5988 -- ^ Optional, if specified spawns particle only on the player's client
5989 animation = {Tile Animation definition},
5990 -- ^ Optional, specifies how to animate the particle texture
5992 -- ^ Optional, specify particle self-luminescence in darkness.
5997 ### `ParticleSpawner` definition (`add_particlespawner`)
6002 -- ^ If time is 0 has infinite lifespan and spawns the amount on a
6003 -- ^ per-second basis.
6004 minpos = {x=0, y=0, z=0},
6005 maxpos = {x=0, y=0, z=0},
6006 minvel = {x=0, y=0, z=0},
6007 maxvel = {x=0, y=0, z=0},
6008 minacc = {x=0, y=0, z=0},
6009 maxacc = {x=0, y=0, z=0},
6014 -- ^ The particle's properties are random values in between the bounds:
6015 -- ^ minpos/maxpos, minvel/maxvel (velocity),
6016 -- ^ minacc/maxacc (acceleration), minsize/maxsize,
6017 -- ^ minexptime/maxexptime (expirationtime).
6018 collisiondetection = false,
6019 -- ^ collisiondetection: if true uses collision detection
6020 collision_removal = false,
6021 -- ^ collision_removal: if true then particle is removed when it collides,
6022 -- ^ requires collisiondetection = true to have any effect
6023 attached = ObjectRef,
6024 -- ^ attached: if defined, particle positions, velocities and
6025 -- ^ accelerations are relative to this object's position and yaw.
6027 -- ^ vertical: if true faces player using y axis only
6028 texture = "image.png",
6029 -- ^ Uses texture (string)
6030 playername = "singleplayer"
6031 -- ^ Playername is optional, if specified spawns particle only on the
6032 -- ^ player's client.
6033 animation = {Tile Animation definition},
6034 -- ^ Optional, specifies how to animate the particle texture
6036 -- ^ Optional, specify particle self-luminescence in darkness.
6040 ### `HTTPRequest` definition (`HTTPApiTable.fetch_async`, `HTTPApiTable.fetch_async`)
6043 url = "http://example.org",
6045 -- ^ Timeout for connection in seconds. Default is 3 seconds.
6046 post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
6047 -- ^ Optional, if specified a POST request with post_data is performed.
6048 -- ^ Accepts both a string and a table. If a table is specified, encodes
6049 -- ^ table as x-www-form-urlencoded key-value pairs.
6050 -- ^ If post_data ist not specified, a GET request is performed instead.
6051 user_agent = "ExampleUserAgent",
6052 -- ^ Optional, if specified replaces the default minetest user agent with
6054 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
6055 -- ^ Optional, if specified adds additional headers to the HTTP request.
6056 -- ^ You must make sure that the header strings follow HTTP specification
6057 -- ^ ("Key: Value").
6059 -- ^ Optional, if true performs a multipart HTTP request.
6060 -- ^ Default is false.
6063 ### `HTTPRequestResult` definition (`HTTPApiTable.fetch` callback, `HTTPApiTable.fetch_async_get`)
6067 -- ^ If true, the request has finished (either succeeded, failed or timed
6070 -- ^ If true, the request was successful
6072 -- ^ If true, the request timed out
6074 -- ^ HTTP status code
6078 ### Authentication handler definition
6081 get_auth = func(name),
6082 -- ^ Get authentication data for existing player `name` (`nil` if player
6084 -- ^ returns following structure:
6085 -- ^ `{password=<string>, privileges=<table>, last_login=<number or nil>}`
6086 create_auth = func(name, password),
6087 -- ^ Create new auth data for player `name`
6088 -- ^ Note that `password` is not plain-text but an arbitrary
6089 -- ^ representation decided by the engine
6090 delete_auth = func(name),
6091 -- ^ Delete auth data of player `name`, returns boolean indicating success
6092 -- ^ (false if player nonexistant).
6093 set_password = func(name, password),
6094 -- ^ Set password of player `name` to `password`
6095 Auth data should be created if not present
6096 set_privileges = func(name, privileges),
6097 -- ^ Set privileges of player `name`
6098 -- ^ `privileges` is in table form, auth data should be created if not
6101 -- ^ Reload authentication data from the storage location
6102 -- ^ Returns boolean indicating success
6103 record_login = func(name),
6104 -- ^ Called when player joins, used for keeping track of last_login
6106 -- ^ Returns an iterator (use with `for` loops) for all player names
6107 -- ^ currently in the auth database.