1 Minetest Lua Modding API Reference 0.4.15
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 0.4 by using Lua
9 scripting in run-time loaded mods.
11 A mod is a self-contained bunch of scripts, textures and other related
12 things that 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. You can send such improvements as
19 source code patches to <celeron55@gmail.com>.
23 If you have any difficulty in understanding this, please read
24 [Programming in Lua](http://www.lua.org/pil/).
28 Mods are loaded during server startup from the mod load paths by running
29 the `init.lua` scripts in a shared environment.
33 * `RUN_IN_PLACE=1` (Windows release, local build)
35 * Linux: `<build directory>`
36 * Windows: `<build directory>`
38 * Linux: `<build directory>`
39 * Windows: `<build directory>`
40 * `RUN_IN_PLACE=0`: (Linux release)
42 * Linux: `/usr/share/minetest`
43 * Windows: `<install directory>/minetest-0.4.x`
45 * Linux: `$HOME/.minetest`
46 * Windows: `C:/users/<user>/AppData/minetest` (maybe)
50 Games are looked up from:
52 * `$path_share/games/gameid/`
53 * `$path_user/games/gameid/`
55 where `gameid` is unique to each game.
57 The game directory contains the file `game.conf`, which contains these fields:
59 name = <Human-readable full name of the game>
65 The game directory can contain the file minetest.conf, which will be used
66 to set default settings when running the particular game.
67 It can also contain a settingtypes.txt in the same format as the one in builtin.
68 This settingtypes.txt will be parsed by the menu and the settings will be displayed
69 in the "Games" category in the settings tab.
73 Games can provide custom main menu images. They are put inside a `menu` directory
74 inside the game directory.
76 The images are named `$identifier.png`, where `$identifier` is
77 one of `overlay,background,footer,header`.
78 If you want to specify multiple images for one identifier, add additional images named
79 like `$identifier.$n.png`, with an ascending number $n starting with 1, and a random
80 image will be chosen from the provided ones.
87 * `$path_share/games/gameid/mods/`
89 * `$path_user/games/gameid/mods/`
90 * `$path_user/mods/` (User-installed mods)
91 * `$worldpath/worldmods/`
93 In a run-in-place version (e.g. the distributed windows version):
95 * `minetest-0.4.x/games/gameid/mods/`
96 * `minetest-0.4.x/mods/` (User-installed mods)
97 * `minetest-0.4.x/worlds/worldname/worldmods/`
99 On an installed version on Linux:
101 * `/usr/share/minetest/games/gameid/mods/`
102 * `$HOME/.minetest/mods/` (User-installed mods)
103 * `$HOME/.minetest/worlds/worldname/worldmods`
105 Mod load path for world-specific games
106 --------------------------------------
107 It is possible to include a game in a world; in this case, no mods or
108 games are loaded or checked from anywhere else.
110 This is useful for e.g. adventure worlds.
112 This happens if the following directory exists:
116 Mods should be then be placed in:
122 Mods can be put in a subdirectory, if the parent directory, which otherwise
123 should be a mod, contains a file named `modpack.txt`. This file shall be
124 empty, except for lines starting with `#`, which are comments.
126 Mod directory structure
127 ------------------------
133 | |-- description.txt
134 | |-- settingtypes.txt
138 | | |-- modname_stuff.png
139 | | `-- modname_something_else.png
147 The location of this directory can be fetched by using
148 `minetest.get_modpath(modname)`.
151 List of mods that have to be loaded before loading this mod.
153 A single line contains a single modname.
155 Optional dependencies can be defined by appending a question mark
156 to a single modname. Their meaning is that if the specified mod
157 is missing, that does not prevent this mod from being loaded.
160 A screenshot shown in the mod manager within the main menu. It should
161 have an aspect ratio of 3:2 and a minimum size of 300×200 pixels.
163 ### `description.txt`
164 A File containing description to be shown within mainmenu.
166 ### `settingtypes.txt`
167 A file in the same format as the one in builtin. It will be parsed by the
168 settings menu and the settings will be displayed in the "Mods" category.
171 The main Lua script. Running this script should register everything it
172 wants to register. Subsequent execution depends on minetest calling the
173 registered callbacks.
175 `minetest.setting_get(name)` and `minetest.setting_getbool(name)` can be used
176 to read custom or existing settings at load time, if necessary.
179 Models for entities or meshnodes.
181 ### `textures`, `sounds`, `media`
182 Media files (textures, sounds, whatever) that will be transferred to the
183 client and will be available for use by the mod.
185 Naming convention for registered textual names
186 ----------------------------------------------
187 Registered names should generally be in this format:
189 "modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
191 This is to prevent conflicting names from corrupting maps and is
192 enforced by the mod loader.
195 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
196 So the name should be `experimental:tnt`.
198 Enforcement can be overridden by prefixing the name with `:`. This can
199 be used for overriding the registrations of some other mod.
201 Example: Any mod can redefine `experimental:tnt` by using the name
206 (also that mod is required to have `experimental` as a dependency)
208 The `:` prefix can also be used for maintaining backwards compatibility.
211 Aliases can be added by using `minetest.register_alias(name, convert_to)` or
212 `minetest.register_alias_force(name, convert_to).
214 This will make Minetest to convert things called name to things called
217 The only difference between `minetest.register_alias` and
218 `minetest.register_alias_force` is that if an item called `name` exists,
219 `minetest.register_alias` will do nothing while
220 `minetest.register_alias_force` will unregister it.
222 This can be used for maintaining backwards compatibility.
224 This can be also used for setting quick access names for things, e.g. if
225 you have an item called `epiclylongmodname:stuff`, you could do
227 minetest.register_alias("stuff", "epiclylongmodname:stuff")
229 and be able to use `/giveme stuff`.
233 Mods should generally prefix their textures with `modname_`, e.g. given
234 the mod name `foomod`, a texture could be called:
238 Textures are referred to by their complete name, or alternatively by
239 stripping out the file extension:
241 * e.g. `foomod_foothing.png`
242 * e.g. `foomod_foothing`
246 There are various texture modifiers that can be used
247 to generate textures on-the-fly.
249 ### Texture overlaying
250 Textures can be overlaid by putting a `^` between them.
254 default_dirt.png^default_grass_side.png
256 `default_grass_side.png` is overlayed over `default_dirt.png`.
257 The texture with the lower resolution will be automatically upscaled to
258 the higher resolution texture.
261 Textures can be grouped together by enclosing them in `(` and `)`.
263 Example: `cobble.png^(thing1.png^thing2.png)`
265 A texture for `thing1.png^thing2.png` is created and the resulting
266 texture is overlaid on top of `cobble.png`.
269 Modifiers that accept texture names (e.g. `[combine`) accept escaping to allow
270 passing complex texture names as arguments. Escaping is done with backslash and
271 is required for `^` and `:`.
273 Example: `cobble.png^[lowpart:50:color.png\^[mask\:trans.png`
275 The lower 50 percent of `color.png^[mask:trans.png` are overlaid
276 on top of `cobble.png`.
278 ### Advanced texture modifiers
280 #### `[crack:<n>:<p>`
281 * `<n>` = animation frame count
282 * `<p>` = current animation frame
284 Draw a step of the crack animation on the texture.
288 default_cobble.png^[crack:10:1
290 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
295 * `<file>` = texture to combine
297 Creates a texture of size `<w>` times `<h>` and blits the listed files to their
298 specified coordinates.
302 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
304 #### `[resize:<w>x<h>`
305 Resizes the texture to the given dimensions.
309 default_sandstone.png^[resize:16x16
312 Makes the base image transparent according to the given ratio.
313 r must be between 0 and 255.
314 0 means totally transparent.
315 255 means totally opaque.
319 default_sandstone.png^[opacity:127
321 #### `[invert:<mode>`
322 Inverts the given channels of the base image.
323 Mode may contain the characters "r", "g", "b", "a".
324 Only the channels that are mentioned in the mode string will be inverted.
328 default_apple.png^[invert:rgb
331 Brightens the texture.
335 tnt_tnt_side.png^[brighten
338 Makes the texture completely opaque.
342 default_leaves.png^[noalpha
344 #### `[makealpha:<r>,<g>,<b>`
345 Convert one color to transparency.
349 default_cobble.png^[makealpha:128,128,128
352 * `<t>` = transformation(s) to apply
354 Rotates and/or flips the image.
356 `<t>` can be a number (between 0 and 7) or a transform name.
357 Rotations are counter-clockwise.
360 1 R90 rotate by 90 degrees
361 2 R180 rotate by 180 degrees
362 3 R270 rotate by 270 degrees
364 5 FXR90 flip X then rotate by 90 degrees
366 7 FYR90 flip Y then rotate by 90 degrees
370 default_stone.png^[transformFXR90
372 #### `[inventorycube{<top>{<left>{<right>`
373 Escaping does not apply here and `^` is replaced by `&` in texture names instead.
375 Create an inventory cube texture using the side textures.
379 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
381 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
382 `dirt.png^grass_side.png` textures
384 #### `[lowpart:<percent>:<file>`
385 Blit the lower `<percent>`% part of `<file>` on the texture.
389 base.png^[lowpart:25:overlay.png
391 #### `[verticalframe:<t>:<n>`
392 * `<t>` = animation frame count
393 * `<n>` = current animation frame
395 Crops the texture to a frame of a vertical animation.
399 default_torch_animated.png^[verticalframe:16:8
402 Apply a mask to the base image.
404 The mask is applied using binary AND.
406 #### `[sheet:<w>x<h>:<x>,<y>`
407 Retrieves a tile at position x,y from the base image
408 which it assumes to be a tilesheet with dimensions w,h.
411 #### `[colorize:<color>:<ratio>`
412 Colorize the textures with the given color.
413 `<color>` is specified as a `ColorString`.
414 `<ratio>` is an int ranging from 0 to 255 or the word "`alpha`". If
415 it is an int, then it specifies how far to interpolate between the
416 colors where 0 is only the texture color and 255 is only `<color>`. If
417 omitted, the alpha of `<color>` will be used as the ratio. If it is
418 the word "`alpha`", then each texture pixel will contain the RGB of
419 `<color>` and the alpha of `<color>` multiplied by the alpha of the
422 #### `[multiply:<color>`
423 Multiplies texture colors with the given color.
424 `<color>` is specified as a `ColorString`.
425 Result is more like what you'd expect if you put a color on top of another
426 color. Meaning white surfaces get a lot of your new color while black parts don't
431 Only Ogg Vorbis files are supported.
433 For positional playing of sounds, only single-channel (mono) files are
434 supported. Otherwise OpenAL will play them non-positionally.
436 Mods should generally prefix their sounds with `modname_`, e.g. given
437 the mod name "`foomod`", a sound could be called:
441 Sounds are referred to by their name with a dot, a single digit and the
442 file extension stripped out. When a sound is played, the actual sound file
443 is chosen randomly from the matching sounds.
445 When playing the sound `foomod_foosound`, the sound is chosen randomly
446 from the available ones of the following files:
448 * `foomod_foosound.ogg`
449 * `foomod_foosound.0.ogg`
450 * `foomod_foosound.1.ogg`
452 * `foomod_foosound.9.ogg`
454 Examples of sound parameter tables:
456 -- Play locationless on all clients
458 gain = 1.0, -- default
460 -- Play locationless to one player
463 gain = 1.0, -- default
465 -- Play locationless to one player, looped
468 gain = 1.0, -- default
471 -- Play in a location
473 pos = {x = 1, y = 2, z = 3},
474 gain = 1.0, -- default
475 max_hear_distance = 32, -- default, uses an euclidean metric
477 -- Play connected to an object, looped
479 object = <an ObjectRef>,
480 gain = 1.0, -- default
481 max_hear_distance = 32, -- default, uses an euclidean metric
485 Looped sounds must either be connected to an object or played locationless to
486 one player using `to_player = name,`
488 ### `SimpleSoundSpec`
490 * e.g. `"default_place_node"`
492 * e.g. `{name = "default_place_node"}`
493 * e.g. `{name = "default_place_node", gain = 1.0}`
495 Registered definitions of stuff
496 -------------------------------
497 Anything added using certain `minetest.register_*` functions get added to
498 the global `minetest.registered_*` tables.
500 * `minetest.register_entity(name, prototype table)`
501 * added to `minetest.registered_entities[name]`
503 * `minetest.register_node(name, node definition)`
504 * added to `minetest.registered_items[name]`
505 * added to `minetest.registered_nodes[name]`
507 * `minetest.register_tool(name, item definition)`
508 * added to `minetest.registered_items[name]`
510 * `minetest.register_craftitem(name, item definition)`
511 * added to `minetest.registered_items[name]`
513 * `minetest.unregister_item(name)`
514 * Unregisters the item name from engine, and deletes the entry with key
515 * `name` from `minetest.registered_items` and from the associated item
516 * table according to its nature: minetest.registered_nodes[] etc
518 * `minetest.register_biome(biome definition)`
519 * returns an integer uniquely identifying the registered biome
520 * added to `minetest.registered_biome` with the key of `biome.name`
521 * if `biome.name` is nil, the key is the returned ID
523 * `minetest.register_ore(ore definition)`
524 * returns an integer uniquely identifying the registered ore
525 * added to `minetest.registered_ores` with the key of `ore.name`
526 * if `ore.name` is nil, the key is the returned ID
528 * `minetest.register_decoration(decoration definition)`
529 * returns an integer uniquely identifying the registered decoration
530 * added to `minetest.registered_decorations` with the key of `decoration.name`
531 * if `decoration.name` is nil, the key is the returned ID
533 * `minetest.register_schematic(schematic definition)`
534 * returns an integer uniquely identifying the registered schematic
535 * added to `minetest.registered_schematic` with the key of `schematic.name`
536 * if `schematic.name` is nil, the key is the returned ID
537 * if the schematic is loaded from a file, schematic.name is set to the filename
538 * if the function is called when loading the mod, and schematic.name is a relative
539 path, then the current mod path will be prepended to the schematic filename
541 * `minetest.clear_registered_biomes()`
542 * clears all biomes currently registered
544 * `minetest.clear_registered_ores()`
545 * clears all ores currently registered
547 * `minetest.clear_registered_decorations()`
548 * clears all decorations currently registered
550 * `minetest.clear_registered_schematics()`
551 * clears all schematics currently registered
553 Note that in some cases you will stumble upon things that are not contained
554 in these tables (e.g. when a mod has been removed). Always check for
555 existence before trying to access the fields.
557 Example: If you want to check the drawtype of a node, you could do:
559 local function get_nodedef_field(nodename, fieldname)
560 if not minetest.registered_nodes[nodename] then
563 return minetest.registered_nodes[nodename][fieldname]
565 local drawtype = get_nodedef_field(nodename, "drawtype")
567 Example: `minetest.get_item_group(name, group)` has been implemented as:
569 function minetest.get_item_group(name, group)
570 if not minetest.registered_items[name] or not
571 minetest.registered_items[name].groups[group] then
574 return minetest.registered_items[name].groups[group]
579 Nodes are the bulk data of the world: cubes and other things that take the
580 space of a cube. Huge amounts of them are handled efficiently, but they
583 The definition of a node is stored and can be accessed by name in
585 minetest.registered_nodes[node.name]
587 See "Registered definitions of stuff".
589 Nodes are passed by value between Lua and the engine.
590 They are represented by a table:
592 {name="name", param1=num, param2=num}
594 `param1` and `param2` are 8-bit integers. The engine uses them for certain
595 automated functions. If you don't use these functions, you can use them to
596 store arbitrary values.
598 The functions of `param1` and `param2` are determined by certain fields in the
601 `param1` is reserved for the engine when `paramtype != "none"`:
604 ^ The value stores light with and without sun in its upper and lower 4 bits
605 respectively. Allows light to propagate from or through the node with
606 light value falling by 1 per node. This is essential for a light source
607 node to spread its light.
609 `param2` is reserved for the engine when any of these are used:
611 liquidtype == "flowing"
612 ^ The level and some flags of the liquid is stored in param2
613 drawtype == "flowingliquid"
614 ^ The drawn liquid level is read from param2
615 drawtype == "torchlike"
616 drawtype == "signlike"
617 paramtype2 == "wallmounted"
618 ^ The rotation of the node is stored in param2. You can make this value
619 by using minetest.dir_to_wallmounted().
620 paramtype2 == "facedir"
621 ^ The rotation of the node is stored in param2. Furnaces and chests are
622 rotated this way. Can be made by using minetest.dir_to_facedir().
624 facedir / 4 = axis direction:
625 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
626 facedir modulo 4 = rotation around that axis
627 paramtype2 == "leveled"
628 paramtype2 == "degrotate"
629 ^ The rotation of this node is stored in param2. Plants are rotated this way.
630 Values range 0 - 179. The value stored in param2 is multiplied by two to
631 get the actual rotation of the node.
632 paramtype2 == "meshoptions"
633 ^ Only valid for "plantlike". The value of param2 becomes a bitfield which can
634 be used to change how the client draws plantlike nodes. Bits 0, 1 and 2 form
635 a mesh selector. Currently the following meshes are choosable:
636 0 = a "x" shaped plant (ordinary plant)
637 1 = a "+" shaped plant (just rotated 45 degrees)
638 2 = a "*" shaped plant with 3 faces instead of 2
639 3 = a "#" shaped plant with 4 faces instead of 2
640 4 = a "#" shaped plant with 4 faces that lean outwards
641 5-7 are unused and reserved for future meshes.
642 Bits 3 through 7 are optional flags that can be combined and give these
644 bit 3 (0x08) - Makes the plant slightly vary placement horizontally
645 bit 4 (0x10) - Makes the plant mesh 1.4x larger
646 bit 5 (0x20) - Moves each face randomly a small bit down (1/8 max)
647 bits 6-7 are reserved for future use.
648 paramtype2 == "color"
649 ^ `param2` tells which color is picked from the palette.
650 The palette should have 256 pixels.
651 paramtype2 == "colorfacedir"
652 ^ Same as `facedir`, but with colors.
653 The first three bits of `param2` tells which color
654 is picked from the palette.
655 The palette should have 8 pixels.
656 paramtype2 == "colorwallmounted"
657 ^ Same as `wallmounted`, but with colors.
658 The first five bits of `param2` tells which color
659 is picked from the palette.
660 The palette should have 32 pixels.
661 paramtype2 == "glasslikeliquidlevel"
662 ^ Only valid for "glasslike_framed" or "glasslike_framed_optional" drawtypes.
663 param2 defines 64 levels of internal liquid.
664 Liquid texture is defined using `special_tiles = {"modname_tilename.png"},`
668 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
671 ^ defines list of collision boxes for the node. If empty, collision boxes
672 will be the same as nodeboxes, in case of any other nodes will be full cube
673 as in the example above.
675 Nodes can also contain extra data. See "Node Metadata".
679 There are a bunch of different looking node types.
681 Look for examples in `games/minimal` or `games/minetest_game`.
689 * `glasslike_framed_optional`
691 * `allfaces_optional`
698 * `nodebox` -- See below. (**Experimental!**)
699 * `mesh` -- use models for nodes
701 `*_optional` drawtypes need less rendering time if deactivated (always client side).
705 Node selection boxes are defined using "node boxes"
707 The `nodebox` node drawtype allows defining visual of nodes consisting of
708 arbitrary number of boxes. It allows defining stuff like stairs. Only the
709 `fixed` and `leveled` box type is supported for these.
711 Please note that this is still experimental, and may be incompatibly
712 changed in the future.
714 A nodebox is defined as any of:
717 -- A normal cube; the default in most things
721 -- A fixed box (facedir param2 is used, if applicable)
723 fixed = box OR {box1, box2, ...}
726 -- A box like the selection box for torches
727 -- (wallmounted param2 is used, if applicable)
728 type = "wallmounted",
734 -- A node that has optional boxes depending on neighbouring nodes'
735 -- presence and type. See also `connects_to`.
737 fixed = box OR {box1, box2, ...}
738 connect_top = box OR {box1, box2, ...}
739 connect_bottom = box OR {box1, box2, ...}
740 connect_front = box OR {box1, box2, ...}
741 connect_left = box OR {box1, box2, ...}
742 connect_back = box OR {box1, box2, ...}
743 connect_right = box OR {box1, box2, ...}
746 A `box` is defined as:
748 {x1, y1, z1, x2, y2, z2}
750 A box of a regular node would look like:
752 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
754 `type = "leveled"` is same as `type = "fixed"`, but `y2` will be automatically
755 set to level from `param2`.
760 If drawtype `mesh` is used, tiles should hold model materials textures.
761 Only static meshes are implemented.
762 For supported model formats see Irrlicht engine documentation.
767 Noise Parameters, or commonly called "`NoiseParams`", define the properties of
771 Offset that the noise is translated by (i.e. added) after calculation.
774 Factor that the noise is scaled by (i.e. multiplied) after calculation.
777 Vector containing values by which each coordinate is divided by before calculation.
778 Higher spread values result in larger noise features.
780 A value of `{x=250, y=250, z=250}` is common.
783 Random seed for the noise. Add the world seed to a seed offset for world-unique noise.
784 In the case of `minetest.get_perlin()`, this value has the world seed automatically added.
787 Number of times the noise gradient is accumulated into the noise.
789 Increase this number to increase the amount of detail in the resulting noise.
791 A value of `6` is common.
794 Factor by which the effect of the noise gradient function changes with each successive octave.
796 Values less than `1` make the details of successive octaves' noise diminish, while values
797 greater than `1` make successive octaves stronger.
799 A value of `0.6` is common.
802 Factor by which the noise feature sizes change with each successive octave.
804 A value of `2.0` is common.
807 Leave this field unset for no special handling.
809 Currently supported are `defaults`, `eased` and `absvalue`.
812 Specify this if you would like to keep auto-selection of eased/not-eased while specifying
816 Maps noise gradient values onto a quintic S-curve before performing interpolation.
817 This results in smooth, rolling noise. Disable this (`noeased`) for sharp-looking noise.
818 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is not eased.
821 Accumulates the absolute value of each noise gradient result.
823 Noise parameters format example for 2D or 3D perlin noise or perlin noise maps:
827 spread = {x=500, y=500, z=500},
832 flags = "defaults, absvalue"
834 ^ A single noise parameter table can be used to get 2D or 3D noise,
835 when getting 2D noise spread.z is ignored.
840 These tell in what manner the ore is generated.
842 All default ores are of the uniformly-distributed scatter type.
845 Randomly chooses a location and generates a cluster of ore.
847 If `noise_params` is specified, the ore will be placed if the 3D perlin noise at
848 that point is greater than the `noise_threshold`, giving the ability to create
849 a non-equal distribution of ore.
852 Creates a sheet of ore in a blob shape according to the 2D perlin noise
853 described by `noise_params` and `noise_threshold`. This is essentially an
854 improved version of the so-called "stratus" ore seen in some unofficial mods.
856 This sheet consists of vertical columns of uniform randomly distributed height,
857 varying between the inclusive range `column_height_min` and `column_height_max`.
858 If `column_height_min` is not specified, this parameter defaults to 1.
859 If `column_height_max` is not specified, this parameter defaults to `clust_size`
860 for reverse compatibility. New code should prefer `column_height_max`.
862 The `column_midpoint_factor` parameter controls the position of the column at which
863 ore eminates from. If 1, columns grow upward. If 0, columns grow downward. If 0.5,
864 columns grow equally starting from each direction. `column_midpoint_factor` is a
865 decimal number ranging in value from 0 to 1. If this parameter is not specified,
868 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this ore type.
871 Creates a sheet of ore in a cloud-like puff shape.
873 As with the `sheet` ore type, the size and shape of puffs are described by
874 `noise_params` and `noise_threshold` and are placed at random vertical positions
875 within the currently generated chunk.
877 The vertical top and bottom displacement of each puff are determined by the noise
878 parameters `np_puff_top` and `np_puff_bottom`, respectively.
882 Creates a deformed sphere of ore according to 3d perlin noise described by
883 `noise_params`. The maximum size of the blob is `clust_size`, and
884 `clust_scarcity` has the same meaning as with the `scatter` type.
887 Creates veins of ore varying in density by according to the intersection of two
888 instances of 3d perlin noise with diffferent seeds, both described by
889 `noise_params`. `random_factor` varies the influence random chance has on
890 placement of an ore inside the vein, which is `1` by default. Note that
891 modifying this parameter may require adjusting `noise_threshold`.
892 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
893 by this ore type. This ore type is difficult to control since it is sensitive
894 to small changes. The following is a decent set of parameters to work from:
899 spread = {x=200, y=200, z=200},
905 noise_threshold = 1.6
907 WARNING: Use this ore type *very* sparingly since it is ~200x more
908 computationally expensive than any other ore.
912 See section "Flag Specifier Format".
914 Currently supported flags: `absheight`
917 Also produce this same ore between the height range of `-y_max` and `-y_min`.
919 Useful for having ore in sky realms without having to duplicate ore entries.
922 If set, puff ore generation will not taper down large differences in displacement
923 when approaching the edge of a puff. This flag has no effect for ore types other
926 ### `puff_additive_composition`
927 By default, when noise described by `np_puff_top` or `np_puff_bottom` results in a
928 negative displacement, the sub-column at that point is not generated. With this
929 attribute set, puff ore generation will instead generate the absolute difference in
930 noise displacement values. This flag has no effect for ore types other than `puff`.
934 The varying types of decorations that can be placed.
937 Creates a 1 times `H` times 1 column of a specified node (or a random node from
938 a list, if a decoration list is specified). Can specify a certain node it must
939 spawn next to, such as water or lava, for example. Can also generate a
940 decoration of random height between a specified lower and upper bound.
941 This type of decoration is intended for placement of grass, flowers, cacti,
942 papyri, waterlilies and so on.
945 Copies a box of `MapNodes` from a specified schematic file (or raw description).
946 Can specify a probability of a node randomly appearing when placed.
947 This decoration type is intended to be used for multi-node sized discrete
948 structures, such as trees, cave spikes, rocks, and so on.
953 A schematic specifier identifies a schematic by either a filename to a
954 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
955 in the form of a table. This table specifies the following fields:
957 * The `size` field is a 3D vector containing the dimensions of the provided schematic. (required)
958 * The `yslice_prob` field is a table of {ypos, prob} which sets the `ypos`th vertical slice
959 of the schematic to have a `prob / 256 * 100` chance of occuring. (default: 255)
960 * The `data` field is a flat table of MapNode tables making up the schematic,
961 in the order of `[z [y [x]]]`. (required)
962 Each MapNode table contains:
963 * `name`: the name of the map node to place (required)
964 * `prob` (alias `param1`): the probability of this node being placed (default: 255)
965 * `param2`: the raw param2 value of the node being placed onto the map (default: 0)
966 * `force_place`: boolean representing if the node should forcibly overwrite any
967 previous contents (default: false)
969 About probability values:
970 * A probability value of `0` or `1` means that node will never appear (0% chance).
971 * A probability value of `254` or `255` means the node will always appear (100% chance).
972 * If the probability value `p` is greater than `1`, then there is a
973 `(p / 256 * 100)` percent chance that node will appear when the schematic is
979 See section "Flag Specifier Format".
981 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
984 * `place_center_x`: Placement of this decoration is centered along the X axis.
985 * `place_center_y`: Placement of this decoration is centered along the Y axis.
986 * `place_center_z`: Placement of this decoration is centered along the Z axis.
987 * `force_placement`: Schematic nodes other than "ignore" will replace existing nodes.
992 The position field is used for all element types.
994 To account for differing resolutions, the position coordinates are the percentage
995 of the screen, ranging in value from `0` to `1`.
997 The name field is not yet used, but should contain a description of what the
998 HUD element represents. The direction field is the direction in which something
1001 `0` draws from left to right, `1` draws from right to left, `2` draws from
1002 top to bottom, and `3` draws from bottom to top.
1004 The `alignment` field specifies how the item will be aligned. It ranges from `-1` to `1`,
1005 with `0` being the center, `-1` is moved to the left/up, and `1` is to the right/down.
1006 Fractional values can be used.
1008 The `offset` field specifies a pixel offset from the position. Contrary to position,
1009 the offset is not scaled to screen size. This allows for some precisely-positioned
1012 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling factor!
1014 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
1016 **Note**: Future revisions to the HUD API may be incompatible; the HUD API is still
1017 in the experimental stages.
1020 Displays an image on the HUD.
1022 * `scale`: The scale of the image, with 1 being the original texture size.
1023 Only the X coordinate scale is used (positive values).
1024 Negative values represent that percentage of the screen it
1025 should take; e.g. `x=-100` means 100% (width).
1026 * `text`: The name of the texture that is displayed.
1027 * `alignment`: The alignment of the image.
1028 * `offset`: offset in pixels from position.
1031 Displays text on the HUD.
1033 * `scale`: Defines the bounding rectangle of the text.
1034 A value such as `{x=100, y=100}` should work.
1035 * `text`: The text to be displayed in the HUD element.
1036 * `number`: An integer containing the RGB value of the color used to draw the text.
1037 Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1038 * `alignment`: The alignment of the text.
1039 * `offset`: offset in pixels from position.
1042 Displays a horizontal bar made up of half-images.
1044 * `text`: The name of the texture that is used.
1045 * `number`: The number of half-textures that are displayed.
1046 If odd, will end with a vertically center-split texture.
1048 * `offset`: offset in pixels from position.
1049 * `size`: If used, will force full-image size to this value (override texture pack image size)
1052 * `text`: The name of the inventory list to be displayed.
1053 * `number`: Number of items in the inventory to be displayed.
1054 * `item`: Position of item that is selected.
1056 * `offset`: offset in pixels from position.
1059 Displays distance to selected world position.
1061 * `name`: The name of the waypoint.
1062 * `text`: Distance suffix. Can be blank.
1063 * `number:` An integer containing the RGB value of the color used to draw the text.
1064 * `world_pos`: World position of the waypoint.
1066 Representations of simple things
1067 --------------------------------
1071 {x=num, y=num, z=num}
1073 For helper functions see "Vector helpers".
1076 * `{type="nothing"}`
1077 * `{type="node", under=pos, above=pos}`
1078 * `{type="object", ref=ObjectRef}`
1080 Flag Specifier Format
1081 ---------------------
1082 Flags using the standardized flag specifier format can be specified in either of
1083 two ways, by string or table.
1085 The string format is a comma-delimited set of flag names; whitespace and
1086 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1087 flag, and specifying a flag prefixed by the string `"no"` explicitly
1088 clears the flag from whatever the default may be.
1090 In addition to the standard string flag format, the schematic flags field can
1091 also be a table of flag names to boolean values representing whether or not the
1092 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1093 is present, mapped to a boolean of any value, the specified flag is unset.
1095 E.g. A flag field of value
1097 {place_center_x = true, place_center_y=false, place_center_z=true}
1101 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1103 which is equivalent to
1105 "place_center_x, noplace_center_y, place_center_z"
1109 "place_center_x, place_center_z"
1111 since, by default, no schematic attributes are set.
1117 There are three kinds of items: nodes, tools and craftitems.
1119 * Node (`register_node`): A node from the world.
1120 * Tool (`register_tool`): A tool/weapon that can dig and damage
1121 things according to `tool_capabilities`.
1122 * Craftitem (`register_craftitem`): A miscellaneous item.
1125 Items and item stacks can exist in three formats: Serializes, table format
1129 This is called "stackstring" or "itemstring":
1131 * e.g. `'default:dirt 5'`
1132 * e.g. `'default:pick_wood 21323'`
1133 * e.g. `'default:apple'`
1140 {name="default:dirt", count=5, wear=0, metadata=""}
1142 A wooden pick about 1/3 worn out:
1144 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1148 {name="default:apple", count=1, wear=0, metadata=""}
1151 A native C++ format with many helper methods. Useful for converting
1152 between formats. See the Class reference section for details.
1154 When an item must be passed to a function, it can usually be in any of
1160 In a number of places, there is a group table. Groups define the
1161 properties of a thing (item, node, armor of entity, capabilities of
1162 tool) in such a way that the engine and other mods can can interact with
1163 the thing without actually knowing what the thing is.
1166 Groups are stored in a table, having the group names with keys and the
1167 group ratings as values. For example:
1169 groups = {crumbly=3, soil=1}
1172 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1173 -- ^ A more special dirt-kind of thing
1175 Groups always have a rating associated with them. If there is no
1176 useful meaning for a rating for an enabled group, it shall be `1`.
1178 When not defined, the rating of a group defaults to `0`. Thus when you
1179 read groups, you must interpret `nil` and `0` as the same value, `0`.
1181 You can read the rating of a group for an item or a node by using
1183 minetest.get_item_group(itemname, groupname)
1186 Groups of items can define what kind of an item it is (e.g. wool).
1189 In addition to the general item things, groups are used to define whether
1190 a node is destroyable and how long it takes to destroy by a tool.
1192 ### Groups of entities
1193 For entities, groups are, as of now, used only for calculating damage.
1194 The rating is the percentage of damage caused by tools with this damage group.
1195 See "Entity damage mechanism".
1197 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1198 object.set_armor_groups({fleshy=30, cracky=80})
1201 Groups in tools define which groups of nodes and entities they are
1204 ### Groups in crafting recipes
1205 An example: Make meat soup from any meat, any water and any bowl:
1208 output = 'food:meat_soup_raw',
1214 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1217 Another example: Make red wool from white wool and red dye:
1221 output = 'wool:red',
1222 recipe = {'wool:white', 'group:dye,basecolor_red'},
1226 * `immortal`: Disables the group damage system for an entity
1227 * `level`: Can be used to give an additional sense of progression in the game.
1228 * A larger level will cause e.g. a weapon of a lower level make much less
1229 damage, and get worn out much faster, or not be able to get drops
1230 from destroyed nodes.
1231 * `0` is something that is directly accessible at the start of gameplay
1232 * There is no upper limit
1233 * `dig_immediate`: (player can always pick up node without tool wear)
1234 * `2`: node is removed without tool wear after 0.5 seconds (rail, sign)
1235 * `3`: node is removed without tool wear after 0.15 seconds (torch)
1236 * `disable_jump`: Player (and possibly other things) cannot jump from node
1237 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1238 * `bouncy`: value is bounce speed in percent
1239 * `falling_node`: if there is no walkable block under the node it will fall
1240 * `attached_node`: if the node under it is not a walkable block the node will be
1241 dropped as an item. If the node is wallmounted the wallmounted direction is
1243 * `soil`: saplings will grow on nodes in this group
1244 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1245 connect to each other
1247 ### Known damage and digging time defining groups
1248 * `crumbly`: dirt, sand
1249 * `cracky`: tough but crackable stuff like stone.
1250 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1251 plants, wire, sheets of metal
1252 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1253 * `fleshy`: Living things like animals and the player. This could imply
1254 some blood effects when hitting.
1255 * `explody`: Especially prone to explosions
1256 * `oddly_breakable_by_hand`:
1257 Can be added to nodes that shouldn't logically be breakable by the
1258 hand but are. Somewhat similar to `dig_immediate`, but times are more
1259 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1260 speed of a tool if the tool can dig at a faster speed than this
1261 suggests for the hand.
1263 ### Examples of custom groups
1264 Item groups are often used for defining, well, _groups of items_.
1265 * `meat`: any meat-kind of a thing (rating might define the size or healing
1266 ability or be irrelevant -- it is not defined as of yet)
1267 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1269 * `flammable`: can be set on fire. Rating might define the intensity of the
1270 fire, affecting e.g. the speed of the spreading of an open fire.
1271 * `wool`: any wool (any origin, any color)
1272 * `metal`: any metal
1273 * `weapon`: any weapon
1274 * `heavy`: anything considerably heavy
1276 ### Digging time calculation specifics
1277 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1278 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1279 faster digging time.
1281 The `level` group is used to limit the toughness of nodes a tool can dig
1282 and to scale the digging times / damage to a greater extent.
1284 **Please do understand this**, otherwise you cannot use the system to it's
1287 Tools define their properties by a list of parameters for groups. They
1288 cannot dig other groups; thus it is important to use a standard bunch of
1289 groups to enable interaction with tools.
1291 #### Tools definition
1294 * Full punch interval
1295 * Maximum drop level
1296 * For an arbitrary list of groups:
1297 * Uses (until the tool breaks)
1298 * Maximum level (usually `0`, `1`, `2` or `3`)
1302 #### Full punch interval
1303 When used as a weapon, the tool will do full damage if this time is spent
1304 between punches. If e.g. half the time is spent, the tool will do half
1307 #### Maximum drop level
1308 Suggests the maximum level of node, when dug with the tool, that will drop
1309 it's useful item. (e.g. iron ore to drop a lump of iron).
1311 This is not automated; it is the responsibility of the node definition
1315 Determines how many uses the tool has when it is used for digging a node,
1316 of this group, of the maximum level. For lower leveled nodes, the use count
1317 is multiplied by `3^leveldiff`.
1319 * `uses=10, leveldiff=0`: actual uses: 10
1320 * `uses=10, leveldiff=1`: actual uses: 30
1321 * `uses=10, leveldiff=2`: actual uses: 90
1324 Tells what is the maximum level of a node of this group that the tool will
1328 List of digging times for different ratings of the group, for nodes of the
1331 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1332 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1333 for this group, and unable to dig the rating `1`, which is the toughest.
1334 Unless there is a matching group that enables digging otherwise.
1337 List of damage for groups of entities. See "Entity damage mechanism".
1339 #### Example definition of the capabilities of a tool
1341 tool_capabilities = {
1342 full_punch_interval=1.5,
1345 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1347 damage_groups = {fleshy=2},
1350 This makes the tool be able to dig nodes that fulfil both of these:
1352 * Have the `crumbly` group
1353 * Have a `level` group less or equal to `2`
1355 Table of resulting digging times:
1357 crumbly 0 1 2 3 4 <- level
1359 1 0.80 1.60 1.60 - -
1360 2 0.60 1.20 1.20 - -
1361 3 0.40 0.80 0.80 - -
1363 level diff: 2 1 0 -1 -2
1365 Table of resulting tool uses:
1374 * At `crumbly==0`, the node is not diggable.
1375 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1376 easy nodes to be quickly breakable.
1377 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1379 Entity damage mechanism
1380 -----------------------
1384 foreach group in cap.damage_groups:
1385 damage += cap.damage_groups[group] * limit(actual_interval /
1386 cap.full_punch_interval, 0.0, 1.0)
1387 * (object.armor_groups[group] / 100.0)
1388 -- Where object.armor_groups[group] is 0 for inexistent values
1391 Client predicts damage based on damage groups. Because of this, it is able to
1392 give an immediate response when an entity is damaged or dies; the response is
1393 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1395 Currently a smoke puff will appear when an entity dies.
1397 The group `immortal` completely disables normal damage.
1399 Entities can define a special armor group, which is `punch_operable`. This
1400 group disables the regular damage mechanism for players punching it by hand or
1401 a non-tool item, so that it can do something else than take damage.
1403 On the Lua side, every punch calls:
1405 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction, damage)
1407 This should never be called directly, because damage is usually not handled by
1410 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1411 accessed unless absolutely required, to encourage interoperability.
1412 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1413 * `tool_capabilities` can be `nil`.
1414 * `direction` is a unit vector, pointing from the source of the punch to
1416 * `damage` damage that will be done to entity
1417 Return value of this function will determin if damage is done by this function
1418 (retval true) or shall be done by engine (retval false)
1420 To punch an entity/object in Lua, call:
1422 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1424 * Return value is tool wear.
1425 * Parameters are equal to the above callback.
1426 * If `direction` equals `nil` and `puncher` does not equal `nil`,
1427 `direction` will be automatically filled in based on the location of `puncher`.
1431 The instance of a node in the world normally only contains the three values
1432 mentioned in "Nodes". However, it is possible to insert extra data into a
1433 node. It is called "node metadata"; See `NodeMetaRef`.
1435 Node metadata contains two things:
1440 Some of the values in the key-value store are handled specially:
1442 * `formspec`: Defines a right-click inventory menu. See "Formspec".
1443 * `infotext`: Text shown on the screen when the node is pointed at
1447 local meta = minetest.get_meta(pos)
1448 meta:set_string("formspec",
1450 "list[context;main;0,0;8,4;]"..
1451 "list[current_player;main;0,5;8,4;]")
1452 meta:set_string("infotext", "Chest");
1453 local inv = meta:get_inventory()
1454 inv:set_size("main", 8*4)
1455 print(dump(meta:to_table()))
1458 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1459 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1460 [10] = "", [11] = "", [12] = "", [13] = "",
1461 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1462 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1463 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1464 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1468 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1475 Item stacks can store metadata too. See `ItemStackMetaRef`.
1477 Item metadata only contains a key-value store.
1479 Some of the values in the key-value store are handled specially:
1481 * `description`: Set the itemstack's description. Defaults to idef.description
1482 * `color`: A `ColorString`, which sets the stack's color.
1483 * `palette_index`: If the item has a palette, this is used to get the
1484 current color from the palette.
1488 local meta = stack:get_meta()
1489 meta:set_string("key", "value")
1490 print(dump(meta:to_table()))
1494 Formspec defines a menu. Currently not much else than inventories are
1495 supported. It is a string, with a somewhat strange format.
1497 Spaces and newlines can be inserted between the blocks, as is used in the
1505 list[context;main;0,0;8,4;]
1506 list[current_player;main;0,5;8,4;]
1511 list[context;fuel;2,3;1,1;]
1512 list[context;src;2,1;1,1;]
1513 list[context;dst;5,1;2,2;]
1514 list[current_player;main;0,5;8,4;]
1516 #### Minecraft-like player inventory
1519 image[1,0.6;1,2;player.png]
1520 list[current_player;main;0,3.5;8,4;]
1521 list[current_player;craft;3,0;3,3;]
1522 list[current_player;craftpreview;7,1;1,1;]
1526 #### `size[<W>,<H>,<fixed_size>]`
1527 * Define the size of the menu in inventory slots
1528 * `fixed_size`: `true`/`false` (optional)
1529 * deprecated: `invsize[<W>,<H>;]`
1531 #### `position[<X>,<Y>]`
1532 * Define the position of the formspec
1533 * A value between 0.0 and 1.0 represents a position inside the screen
1534 * The default value is the center of the screen (0.5, 0.5)
1536 #### `anchor[<X>,<Y>]`
1537 * Define the anchor of the formspec
1538 * A value between 0.0 and 1.0 represents an anchor inside the formspec
1539 * The default value is the center of the formspec (0.5, 0.5)
1541 #### `container[<X>,<Y>]`
1542 * Start of a container block, moves all physical elements in the container by (X, Y)
1543 * Must have matching container_end
1544 * Containers can be nested, in which case the offsets are added
1545 (child containers are relative to parent containers)
1547 #### `container_end[]`
1548 * End of a container, following elements are no longer relative to this container
1550 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
1551 * Show an inventory list
1553 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
1554 * Show an inventory list
1556 #### `listring[<inventory location>;<list name>]`
1557 * Allows to create a ring of inventory lists
1558 * Shift-clicking on items in one element of the ring
1559 will send them to the next inventory list inside the ring
1560 * The first occurrence of an element inside the ring will
1561 determine the inventory where items will be sent to
1564 * Shorthand for doing `listring[<inventory location>;<list name>]`
1565 for the last two inventory lists added by list[...]
1567 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
1568 * Sets background color of slots as `ColorString`
1569 * Sets background color of slots on mouse hovering
1571 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
1572 * Sets background color of slots as `ColorString`
1573 * Sets background color of slots on mouse hovering
1574 * Sets color of slots border
1576 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
1577 * Sets background color of slots as `ColorString`
1578 * Sets background color of slots on mouse hovering
1579 * Sets color of slots border
1580 * Sets default background color of tooltips
1581 * Sets default font color of tooltips
1583 #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>,<fontcolor>]`
1584 * Adds tooltip for an element
1585 * `<bgcolor>` tooltip background color as `ColorString` (optional)
1586 * `<fontcolor>` tooltip font color as `ColorString` (optional)
1588 #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
1590 * Position and size units are inventory slots
1592 #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
1593 * Show an inventory image of registered item/node
1594 * Position and size units are inventory slots
1596 #### `bgcolor[<color>;<fullscreen>]`
1597 * Sets background color of formspec as `ColorString`
1598 * If `true`, the background color is drawn fullscreen (does not effect the size of the formspec)
1600 #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
1601 * Use a background. Inventory rectangles are not drawn then.
1602 * Position and size units are inventory slots
1603 * Example for formspec 8x4 in 16x resolution: image shall be sized
1604 8 times 16px times 4 times 16px.
1606 #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
1607 * Use a background. Inventory rectangles are not drawn then.
1608 * Position and size units are inventory slots
1609 * Example for formspec 8x4 in 16x resolution:
1610 image shall be sized 8 times 16px times 4 times 16px
1611 * If `true` the background is clipped to formspec size
1612 (`x` and `y` are used as offset values, `w` and `h` are ignored)
1614 #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
1615 * Textual password style field; will be sent to server when a button is clicked
1616 * When enter is pressed in field, fields.key_enter_field will be sent with the name
1618 * `x` and `y` position the field relative to the top left of the menu
1619 * `w` and `h` are the size of the field
1620 * Fields are a set height, but will be vertically centred on `h`
1621 * Position and size units are inventory slots
1622 * `name` is the name of the field as returned in fields to `on_receive_fields`
1623 * `label`, if not blank, will be text printed on the top left above the field
1624 * See field_close_on_enter to stop enter closing the formspec
1626 #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1627 * Textual field; will be sent to server when a button is clicked
1628 * When enter is pressed in field, fields.key_enter_field will be sent with the name
1630 * `x` and `y` position the field relative to the top left of the menu
1631 * `w` and `h` are the size of the field
1632 * Fields are a set height, but will be vertically centred on `h`
1633 * Position and size units are inventory slots
1634 * `name` is the name of the field as returned in fields to `on_receive_fields`
1635 * `label`, if not blank, will be text printed on the top left above the field
1636 * `default` is the default value of the field
1637 * `default` may contain variable references such as `${text}'` which
1638 will fill the value from the metadata value `text`
1639 * **Note**: no extra text or more than a single variable is supported ATM.
1640 * See field_close_on_enter to stop enter closing the formspec
1642 #### `field[<name>;<label>;<default>]`
1643 * As above, but without position/size units
1644 * When enter is pressed in field, fields.key_enter_field will be sent with the name
1646 * Special field for creating simple forms, such as sign text input
1647 * Must be used without a `size[]` element
1648 * A "Proceed" button will be added automatically
1649 * See field_close_on_enter to stop enter closing the formspec
1651 #### `field_close_on_enter[<name>;<close_on_enter>]`
1652 * <name> is the name of the field
1653 * if <close_on_enter> is false, pressing enter in the field will submit the form but not close it
1654 * defaults to true when not specified (ie: no tag for a field)
1656 #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1657 * Same as fields above, but with multi-line input
1659 #### `label[<X>,<Y>;<label>]`
1660 * `x` and `y` work as per field
1661 * `label` is the text on the label
1662 * Position and size units are inventory slots
1664 #### `vertlabel[<X>,<Y>;<label>]`
1665 * Textual label drawn vertically
1666 * `x` and `y` work as per field
1667 * `label` is the text on the label
1668 * Position and size units are inventory slots
1670 #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
1671 * Clickable button. When clicked, fields will be sent.
1672 * `x`, `y` and `name` work as per field
1673 * `w` and `h` are the size of the button
1674 * `label` is the text on the button
1675 * Position and size units are inventory slots
1677 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1678 * `x`, `y`, `w`, `h`, and `name` work as per button
1679 * `texture name` is the filename of an image
1680 * Position and size units are inventory slots
1682 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
1683 * `x`, `y`, `w`, `h`, and `name` work as per button
1684 * `texture name` is the filename of an image
1685 * Position and size units are inventory slots
1686 * `noclip=true` means the image button doesn't need to be within specified formsize
1687 * `drawborder`: draw button border or not
1688 * `pressed texture name` is the filename of an image on pressed state
1690 #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
1691 * `x`, `y`, `w`, `h`, `name` and `label` work as per button
1692 * `item name` is the registered name of an item/node,
1693 tooltip will be made out of its description
1694 to override it use tooltip element
1695 * Position and size units are inventory slots
1697 #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
1698 * When clicked, fields will be sent and the form will quit.
1700 #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1701 * When clicked, fields will be sent and the form will quit.
1703 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
1704 * Scrollable item list showing arbitrary text elements
1705 * `x` and `y` position the itemlist relative to the top left of the menu
1706 * `w` and `h` are the size of the itemlist
1707 * `name` fieldname sent to server on doubleclick value is current selected element
1708 * `listelements` can be prepended by #color in hexadecimal format RRGGBB (only),
1709 * if you want a listelement to start with "#" write "##".
1711 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
1712 * Scrollable itemlist showing arbitrary text elements
1713 * `x` and `y` position the item list relative to the top left of the menu
1714 * `w` and `h` are the size of the item list
1715 * `name` fieldname sent to server on doubleclick value is current selected element
1716 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
1717 * if you want a listelement to start with "#" write "##"
1718 * Index to be selected within textlist
1719 * `true`/`false`: draw transparent background
1720 * See also `minetest.explode_textlist_event` (main menu: `engine.explode_textlist_event`)
1722 #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
1723 * Show a tab**header** at specific position (ignores formsize)
1724 * `x` and `y` position the itemlist relative to the top left of the menu
1725 * `name` fieldname data is transferred to Lua
1726 * `caption 1`...: name shown on top of tab
1727 * `current_tab`: index of selected tab 1...
1728 * `transparent` (optional): show transparent
1729 * `draw_border` (optional): draw border
1731 #### `box[<X>,<Y>;<W>,<H>;<color>]`
1732 * Simple colored semitransparent box
1733 * `x` and `y` position the box relative to the top left of the menu
1734 * `w` and `h` are the size of box
1735 * `color` is color specified as a `ColorString`
1737 #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
1738 * Show a dropdown field
1739 * **Important note**: There are two different operation modes:
1740 1. handle directly on change (only changed dropdown is submitted)
1741 2. read the value on pressing a button (all dropdown values are available)
1742 * `x` and `y` position of dropdown
1744 * Fieldname data is transferred to Lua
1745 * Items to be shown in dropdown
1746 * Index of currently selected dropdown item
1748 #### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
1750 * `x` and `y`: position of checkbox
1751 * `name` fieldname data is transferred to Lua
1752 * `label` to be shown left of checkbox
1753 * `selected` (optional): `true`/`false`
1755 #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
1757 * There are two ways to use it:
1758 1. handle the changed event (only changed scrollbar is available)
1759 2. read the value on pressing a button (all scrollbars are available)
1760 * `x` and `y`: position of trackbar
1761 * `w` and `h`: width and height
1762 * `orientation`: `vertical`/`horizontal`
1763 * Fieldname data is transferred to Lua
1764 * Value this trackbar is set to (`0`-`1000`)
1765 * See also `minetest.explode_scrollbar_event` (main menu: `engine.explode_scrollbar_event`)
1767 #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
1768 * Show scrollable table using options defined by the previous `tableoptions[]`
1769 * Displays cells as defined by the previous `tablecolumns[]`
1770 * `x` and `y`: position the itemlist relative to the top left of the menu
1771 * `w` and `h` are the size of the itemlist
1772 * `name`: fieldname sent to server on row select or doubleclick
1773 * `cell 1`...`cell n`: cell contents given in row-major order
1774 * `selected idx`: index of row to be selected within table (first row = `1`)
1775 * See also `minetest.explode_table_event` (main menu: `engine.explode_table_event`)
1777 #### `tableoptions[<opt 1>;<opt 2>;...]`
1778 * Sets options for `table[]`
1780 * default text color (`ColorString`), defaults to `#FFFFFF`
1781 * `background=#RRGGBB`
1782 * table background color (`ColorString`), defaults to `#000000`
1783 * `border=<true/false>`
1784 * should the table be drawn with a border? (default: `true`)
1785 * `highlight=#RRGGBB`
1786 * highlight background color (`ColorString`), defaults to `#466432`
1787 * `highlight_text=#RRGGBB`
1788 * highlight text color (`ColorString`), defaults to `#FFFFFF`
1789 * `opendepth=<value>`
1790 * all subtrees up to `depth < value` are open (default value = `0`)
1791 * only useful when there is a column of type "tree"
1793 #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
1794 * Sets columns for `table[]`
1795 * Types: `text`, `image`, `color`, `indent`, `tree`
1796 * `text`: show cell contents as text
1797 * `image`: cell contents are an image index, use column options to define images
1798 * `color`: cell contents are a ColorString and define color of following cell
1799 * `indent`: cell contents are a number and define indentation of following cell
1800 * `tree`: same as indent, but user can open and close subtrees (treeview-like)
1803 * for `text` and `image`: content alignment within cells.
1804 Available values: `left` (default), `center`, `right`, `inline`
1806 * for `text` and `image`: minimum width in em (default: `0`)
1807 * for `indent` and `tree`: indent width in em (default: `1.5`)
1808 * `padding=<value>`: padding left of the column, in em (default `0.5`).
1809 Exception: defaults to 0 for indent columns
1810 * `tooltip=<value>`: tooltip text (default: empty)
1811 * `image` column options:
1812 * `0=<value>` sets image for image index 0
1813 * `1=<value>` sets image for image index 1
1814 * `2=<value>` sets image for image index 2
1815 * and so on; defined indices need not be contiguous empty or
1816 non-numeric cells are treated as `0`.
1817 * `color` column options:
1818 * `span=<value>`: number of following columns to affect (default: infinite)
1820 **Note**: do _not_ use a element name starting with `key_`; those names are reserved to
1821 pass key press events to formspec!
1825 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
1826 * `"current_player"`: Player to whom the menu is shown
1827 * `"player:<name>"`: Any player
1828 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
1829 * `"detached:<name>"`: A detached inventory
1831 Player Inventory lists
1832 ----------------------
1833 * `main`: list containing the default inventory
1834 * `craft`: list containing the craft input
1835 * `craftpreview`: list containing the craft output
1836 * `hand`: list containing an override for the empty hand
1840 `#RGB` defines a color in hexadecimal format.
1842 `#RGBA` defines a color in hexadecimal format and alpha channel.
1844 `#RRGGBB` defines a color in hexadecimal format.
1846 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
1848 Named colors are also supported and are equivalent to
1849 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
1850 To specify the value of the alpha channel, append `#AA` to the end of the color name
1851 (e.g. `colorname#08`). For named colors the hexadecimal string representing the alpha
1852 value must (always) be two hexadecimal digits.
1856 A ColorSpec specifies a 32-bit color. It can be written in either:
1857 table form, each element ranging from 0..255 (a, if absent, defaults to 255):
1858 `colorspec = {a=255, r=0, g=255, b=0}`
1859 numerical form, the raw integer value of an ARGB8 quad:
1860 `colorspec = 0xFF00FF00`
1861 or string form, a ColorString (defined above):
1862 `colorspec = "green"`
1866 Most text can contain escape sequences, that can for example color the text.
1867 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
1868 The following functions provide escape sequences:
1869 * `core.get_color_escape_sequence(color)`:
1870 * `color` is a ColorString
1871 * The escape sequence sets the text color to `color`
1872 * `core.colorize(color, message)`:
1874 `core.get_color_escape_sequence(color) ..
1876 core.get_color_escape_sequence("#ffffff")`
1877 * `color.get_background_escape_sequence(color)`
1878 * `color` is a ColorString
1879 * The escape sequence sets the background of the whole text element to
1880 `color`. Only defined for item descriptions and tooltips.
1881 * `color.strip_foreground_colors(str)`
1882 * Removes foreground colors added by `get_color_escape_sequence`.
1883 * `color.strip_background_colors(str)`
1884 * Removes background colors added by `get_background_escape_sequence`.
1885 * `color.strip_colors(str)`
1886 * Removes all color escape sequences.
1890 * `vector.new(a[, b, c])`: returns a vector:
1891 * A copy of `a` if `a` is a vector.
1892 * `{x = a, y = b, z = c}`, if all `a, b, c` are defined
1893 * `vector.direction(p1, p2)`: returns a vector
1894 * `vector.distance(p1, p2)`: returns a number
1895 * `vector.length(v)`: returns a number
1896 * `vector.normalize(v)`: returns a vector
1897 * `vector.floor(v)`: returns a vector, each dimension rounded down
1898 * `vector.round(v)`: returns a vector, each dimension rounded to nearest int
1899 * `vector.apply(v, func)`: returns a vector
1900 * `vector.equals(v1, v2)`: returns a boolean
1901 * `vector.sort(v1, v2)`: returns minp, maxp vectors of the cuboid defined by v1 and v2
1903 For the following functions `x` can be either a vector or a number:
1905 * `vector.add(v, x)`: returns a vector
1906 * `vector.subtract(v, x)`: returns a vector
1907 * `vector.multiply(v, x)`: returns a scaled vector or Schur product
1908 * `vector.divide(v, x)`: returns a scaled vector or Schur quotient
1912 * `dump2(obj, name="_", dumped={})`
1913 * Return object serialized as a string, handles reference loops
1914 * `dump(obj, dumped={})`
1915 * Return object serialized as a string
1916 * `math.hypot(x, y)`
1917 * Get the hypotenuse of a triangle with legs x and y.
1918 Useful for distance calculation.
1919 * `math.sign(x, tolerance)`
1920 * Get the sign of a number.
1921 Optional: Also returns `0` when the absolute value is within the tolerance (default: `0`)
1922 * `string.split(str, separator=",", include_empty=false, max_splits=-1,
1923 * sep_is_pattern=false)`
1924 * If `max_splits` is negative, do not limit splits.
1925 * `sep_is_pattern` specifies if separator is a plain string or a pattern (regex).
1926 * e.g. `string:split("a,b", ",") == {"a","b"}`
1928 * e.g. `string.trim("\n \t\tfoo bar\t ") == "foo bar"`
1929 * `minetest.pos_to_string({x=X,y=Y,z=Z}, decimal_places))`: returns `"(X,Y,Z)"`
1930 * Convert position to a printable string
1931 Optional: 'decimal_places' will round the x, y and z of the pos to the given decimal place.
1932 * `minetest.string_to_pos(string)`: returns a position
1933 * Same but in reverse. Returns `nil` if the string can't be parsed to a position.
1934 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
1935 * Converts a string representing an area box into two positions
1936 * `minetest.formspec_escape(string)`: returns a string
1937 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
1938 * `minetest.is_yes(arg)`
1939 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
1940 * `minetest.get_us_time()`
1941 * returns time with microsecond precision. May not return wall time.
1942 * `table.copy(table)`: returns a table
1943 * returns a deep copy of `table`
1944 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a position
1945 * returns the exact position on the surface of a pointed node
1947 `minetest` namespace reference
1948 ------------------------------
1952 * `minetest.get_current_modname()`: returns the currently loading mod's name, when we are loading a mod
1953 * `minetest.get_modpath(modname)`: returns e.g. `"/home/user/.minetest/usermods/modname"`
1954 * Useful for loading additional `.lua` modules or static data from mod
1955 * `minetest.get_modnames()`: returns a list of installed mods
1956 * Return a list of installed mods, sorted alphabetically
1957 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
1958 * Useful for storing custom data
1959 * `minetest.is_singleplayer()`
1960 * `minetest.features`: Table containing API feature flags
1962 glasslike_framed = true,
1963 nodebox_as_selectionbox = true,
1964 chat_send_player_param3 = true,
1965 get_all_craft_recipes_works = true,
1966 use_texture_alpha = true,
1967 -- ^ The transparency channel of textures can be used optionally
1968 no_legacy_abms = true,
1969 -- ^ Tree and grass ABMs are no longer done from C++
1970 texture_names_parens = true,
1971 -- ^ Texture grouping is possible using parentheses
1972 area_store_custom_ids = true,
1973 -- ^ Unique Area ID for AreaStore:insert_area
1974 add_entity_with_staticdata = true,
1975 -- ^ add_entity supports passing initial staticdata to on_activate
1976 no_chat_message_prediction = true,
1977 -- ^ Chat messages are no longer predicted
1979 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
1980 * `arg`: string or table in format `{foo=true, bar=true}`
1981 * `missing_features`: `{foo=true, bar=true}`
1982 * `minetest.get_player_information(player_name)`:
1983 * Returns a table containing information about a player
1984 Example return value:
1986 address = "127.0.0.1", -- IP address of client
1987 ip_version = 4, -- IPv4 / IPv6
1988 min_rtt = 0.01, -- minimum round trip time
1989 max_rtt = 0.2, -- maximum round trip time
1990 avg_rtt = 0.02, -- average round trip time
1991 min_jitter = 0.01, -- minimum packet time jitter
1992 max_jitter = 0.5, -- maximum packet time jitter
1993 avg_jitter = 0.03, -- average packet time jitter
1994 connection_uptime = 200, -- seconds since client connected
1996 -- following information is available on debug build only!!!
1997 -- DO NOT USE IN MODS
1998 --ser_vers = 26, -- serialization version used by client
1999 --prot_vers = 23, -- protocol version used by client
2000 --major = 0, -- major version number
2001 --minor = 4, -- minor version number
2002 --patch = 10, -- patch version number
2003 --vers_string = "0.4.9-git", -- full version string
2004 --state = "Active" -- current client state
2006 * `minetest.mkdir(path)`: returns success.
2007 * Creates a directory specified by `path`, creating parent directories
2008 if they don't exist.
2009 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
2011 * nil: return all entries,
2012 * true: return only subdirectory names, or
2013 * false: return only file names.
2014 * `minetest.get_version()`: returns a table containing components of the
2015 engine version. Components:
2016 * `project`: Name of the project, eg, "Minetest"
2017 * `string`: Simple version, eg, "1.2.3-dev"
2018 * `hash`: Full git version (only set if available), eg, "1.2.3-dev-01234567-dirty"
2019 Use this for informational purposes only. The information in the returned
2020 table does not represent the capabilities of the engine, nor is it
2021 reliable or verifyable. Compatible forks will have a different name and
2022 version entirely. To check for the presence of engine features, test
2023 whether the functions exported by the wanted features exist. For example:
2024 `if core.nodeupdate then ... end`.
2027 * `minetest.debug(...)`
2028 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
2029 * `minetest.log([level,] text)`
2030 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
2031 `"info"`, or `"verbose"`. Default is `"none"`.
2033 ### Registration functions
2034 Call these functions only at load time!
2036 * `minetest.register_entity(name, prototype table)`
2037 * `minetest.register_abm(abm definition)`
2038 * `minetest.register_lbm(lbm definition)`
2039 * `minetest.register_node(name, node definition)`
2040 * `minetest.register_tool(name, item definition)`
2041 * `minetest.register_craftitem(name, item definition)`
2042 * `minetest.unregister_item(name)`
2043 * `minetest.register_alias(name, convert_to)`
2044 * `minetest.register_alias_force(name, convert_to)`
2045 * `minetest.register_craft(recipe)`
2046 * Check recipe table syntax for different types below.
2047 * `minetest.clear_craft(recipe)`
2048 * Will erase existing craft based either on output item or on input recipe.
2049 * Specify either output or input only. If you specify both, input will be ignored. For input use the same recipe table
2050 syntax as for `minetest.register_craft(recipe)`. For output specify only the item, without a quantity.
2051 * If no erase candidate could be found, Lua exception will be thrown.
2052 * Warning! The type field ("shaped","cooking" or any other) will be ignored if the recipe
2053 contains output. Erasing is then done independently from the crafting method.
2054 * `minetest.register_ore(ore definition)`
2055 * `minetest.register_biome(biome definition)`
2056 * `minetest.register_decoration(decoration definition)`
2057 * `minetest.override_item(name, redefinition)`
2058 * Overrides fields of an item registered with register_node/tool/craftitem.
2059 * Note: Item must already be defined, (opt)depend on the mod defining it.
2060 * Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})`
2061 * `minetest.clear_registered_ores()`
2062 * `minetest.clear_registered_biomes()`
2063 * `minetest.clear_registered_decorations()`
2065 ### Global callback registration functions
2066 Call these functions only at load time!
2068 * `minetest.register_globalstep(func(dtime))`
2069 * Called every server step, usually interval of 0.1s
2070 * `minetest.register_on_shutdown(func())`
2071 * Called before server shutdown
2072 * **Warning**: If the server terminates abnormally (i.e. crashes), the registered
2073 callbacks **will likely not be run**. Data should be saved at
2074 semi-frequent intervals as well as on server shutdown.
2075 * `minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
2076 * Called when a node has been placed
2077 * If return `true` no item is taken from `itemstack`
2078 * **Not recommended**; use `on_construct` or `after_place_node` in node definition
2080 * `minetest.register_on_dignode(func(pos, oldnode, digger))`
2081 * Called when a node has been dug.
2082 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node definition
2084 * `minetest.register_on_punchnode(func(pos, node, puncher, pointed_thing))`
2085 * Called when a node is punched
2086 * `minetest.register_on_generated(func(minp, maxp, blockseed))`
2087 * Called after generating a piece of world. Modifying nodes inside the area
2088 is a bit faster than usually.
2089 * `minetest.register_on_newplayer(func(ObjectRef))`
2090 * Called after a new player has been created
2091 * `minetest.register_on_dieplayer(func(ObjectRef))`
2092 * Called when a player dies
2093 * `minetest.register_on_punchplayer(func(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
2094 * Called when a player is punched
2095 * `player` - ObjectRef - Player that was punched
2096 * `hitter` - ObjectRef - Player that hit
2097 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be nil)
2098 * `tool_capabilities`: capability table of used tool (can be nil)
2099 * `dir`: unit vector of direction of punch. Always defined. Points from
2100 the puncher to the punched.
2101 * `damage` - number that represents the damage calculated by the engine
2102 * should return `true` to prevent the default damage mechanism
2103 * `minetest.register_on_player_hpchange(func(player, hp_change), modifier)`
2104 * Called when the player gets damaged or healed
2105 * `player`: ObjectRef of the player
2106 * `hp_change`: the amount of change. Negative when it is damage.
2107 * `modifier`: when true, the function should return the actual hp_change.
2108 Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
2109 modifiers can return true as a second argument to stop the execution of further functions.
2110 Non-modifiers receive the final hp change calculated by the modifiers.
2111 * `minetest.register_on_respawnplayer(func(ObjectRef))`
2112 * Called when player is to be respawned
2113 * Called _before_ repositioning of player occurs
2114 * return true in func to disable regular player placement
2115 * `minetest.register_on_prejoinplayer(func(name, ip))`
2116 * Called before a player joins the game
2117 * If it returns a string, the player is disconnected with that string as reason
2118 * `minetest.register_on_joinplayer(func(ObjectRef))`
2119 * Called when a player joins the game
2120 * `minetest.register_on_leaveplayer(func(ObjectRef, timed_out))`
2121 * Called when a player leaves the game
2122 * `timed_out`: True for timeout, false for other reasons.
2123 * `minetest.register_on_cheat(func(ObjectRef, cheat))`
2124 * Called when a player cheats
2125 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
2127 * `interacted_too_far`
2128 * `interacted_while_dead`
2129 * `finished_unknown_dig`
2132 * `minetest.register_on_chat_message(func(name, message))`
2133 * Called always when a player says something
2134 * Return `true` to mark the message as handled, which means that it will not be sent to other players
2135 * `minetest.register_on_player_receive_fields(func(player, formname, fields))`
2136 * Called when a button is pressed in player's inventory form
2137 * Newest functions are called first
2138 * If function returns `true`, remaining functions are not called
2139 * `minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))`
2140 * Called when `player` crafts something
2141 * `itemstack` is the output
2142 * `old_craft_grid` contains the recipe (Note: the one in the inventory is cleared)
2143 * `craft_inv` is the inventory with the crafting grid
2144 * Return either an `ItemStack`, to replace the output, or `nil`, to not modify it
2145 * `minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))`
2146 * The same as before, except that it is called before the player crafts, to make
2147 craft prediction, and it should not change anything.
2148 * `minetest.register_on_protection_violation(func(pos, name))`
2149 * Called by `builtin` and mods when a player violates protection at a position
2150 (eg, digs a node or punches a protected entity).
2151 * The registered functions can be called using `minetest.record_protection_violation`
2152 * The provided function should check that the position is protected by the mod
2153 calling this function before it prints a message, if it does, to allow for
2154 multiple protection mods.
2155 * `minetest.register_on_item_eat(func(hp_change, replace_with_item, itemstack, user, pointed_thing))`
2156 * Called when an item is eaten, by `minetest.item_eat`
2157 * Return `true` or `itemstack` to cancel the default item eat response (i.e.: hp increase)
2159 ### Other registration functions
2160 * `minetest.register_chatcommand(cmd, chatcommand definition)`
2161 * Adds definition to minetest.registered_chatcommands
2162 * `minetest.override_chatcommand(name, redefinition)`
2163 * Overrides fields of a chatcommand registered with register_chatcommand.
2164 * `minetest.unregister_chatcommand(name)`
2165 * Unregisters a chatcommands registered with register_chatcommand.
2166 * `minetest.register_privilege(name, definition)`
2167 * `definition`: `"description text"`
2168 * `definition`: `{ description = "description text", give_to_singleplayer = boolean}`
2169 the default of `give_to_singleplayer` is true
2170 * To allow players with basic_privs to grant, see basic_privs minetest.conf setting.
2171 * `minetest.register_authentication_handler(handler)`
2172 * See `minetest.builtin_auth_handler` in `builtin.lua` for reference
2175 * `minetest.setting_set(name, value)`
2176 * Setting names can't contain whitespace or any of `="{}#`.
2177 * Setting values can't contain the sequence `\n"""`.
2178 * Setting names starting with "secure." can't be set.
2179 * `minetest.setting_get(name)`: returns string or `nil`
2180 * `minetest.setting_setbool(name, value)`
2181 * See documentation on `setting_set` for restrictions.
2182 * `minetest.setting_getbool(name)`: returns boolean or `nil`
2183 * `minetest.setting_get_pos(name)`: returns position or nil
2184 * `minetest.setting_save()`, returns `nil`, save all settings to config file
2187 * `minetest.notify_authentication_modified(name)`
2188 * Should be called by the authentication handler if privileges changes.
2189 * To report everybody, set `name=nil`.
2190 * `minetest.check_password_entry(name, entry, password)`
2191 * Returns true if the "db entry" for a player with name matches given
2192 * password, false otherwise.
2193 * The "db entry" is the usually player-individual value that is derived
2194 * from the player's chosen password and stored on the server in order to allow
2195 * authentication whenever the player desires to log in.
2196 * Only use this function for making it possible to log in via the password from
2197 * via protocols like IRC, other uses for inside the game are frowned upon.
2198 * `minetest.get_password_hash(name, raw_password)`
2199 * Convert a name-password pair to a password hash that Minetest can use.
2200 * The returned value alone is not a good basis for password checks based
2201 * on comparing the password hash in the database with the password hash
2202 * from the function, with an externally provided password, as the hash
2203 * in the db might use the new SRP verifier format.
2204 * For this purpose, use minetest.check_password_entry instead.
2205 * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
2206 * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
2207 * Convert between two privilege representations
2208 * `minetest.set_player_password(name, password_hash)`
2209 * `minetest.set_player_privs(name, {priv1=true,...})`
2210 * `minetest.get_player_privs(name) -> {priv1=true,...}`
2211 * `minetest.auth_reload()`
2212 * `minetest.check_player_privs(player_or_name, ...)`: returns `bool, missing_privs`
2213 * A quickhand for checking privileges.
2214 * `player_or_name`: Either a Player object or the name of a player.
2215 * `...` is either a list of strings, e.g. `"priva", "privb"` or
2216 a table, e.g. `{ priva = true, privb = true }`.
2217 * `minetest.get_player_ip(name)`: returns an IP address string
2219 `minetest.set_player_password`, `minetest_set_player_privs`, `minetest_get_player_privs`
2220 and `minetest.auth_reload` call the authetification handler.
2223 * `minetest.chat_send_all(text)`
2224 * `minetest.chat_send_player(name, text)`
2226 ### Environment access
2227 * `minetest.set_node(pos, node)`
2228 * `minetest.add_node(pos, node): alias set_node(pos, node)`
2229 * Set node at position (`node = {name="foo", param1=0, param2=0}`)
2230 * `minetest.swap_node(pos, node)`
2231 * Set node at position, but don't remove metadata
2232 * `minetest.remove_node(pos)`
2233 * Equivalent to `set_node(pos, "air")`
2234 * `minetest.get_node(pos)`
2235 * Returns the node at the given position as table in the format
2236 `{name="node_name", param1=0, param2=0}`, returns `{name="ignore", param1=0, param2=0}`
2238 * `minetest.get_node_or_nil(pos)`
2239 * Same as `get_node` but returns `nil` for unloaded areas.
2240 * `minetest.get_node_light(pos, timeofday)`
2241 * Gets the light value at the given position. Note that the light value
2242 "inside" the node at the given position is returned, so you usually want
2243 to get the light value of a neighbor.
2244 * `pos`: The position where to measure the light.
2245 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
2246 * Returns a number between `0` and `15` or `nil`
2247 * `minetest.place_node(pos, node)`
2248 * Place node with the same effects that a player would cause
2249 * `minetest.dig_node(pos)`
2250 * Dig node with the same effects that a player would cause
2251 * Returns `true` if successful, `false` on failure (e.g. protected location)
2252 * `minetest.punch_node(pos)`
2253 * Punch node with the same effects that a player would cause
2254 * `minetest.spawn_falling_node(pos)`
2255 * Change node into falling node
2256 * Returns `true` if successful, `false` on failure
2258 * `minetest.find_nodes_with_meta(pos1, pos2)`
2259 * Get a table of positions of nodes that have metadata within a region {pos1, pos2}
2260 * `minetest.get_meta(pos)`
2261 * Get a `NodeMetaRef` at that position
2262 * `minetest.get_node_timer(pos)`
2263 * Get `NodeTimerRef`
2265 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at position
2266 * Returns `ObjectRef`, or `nil` if failed
2267 * `minetest.add_item(pos, item)`: Spawn item
2268 * Returns `ObjectRef`, or `nil` if failed
2269 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
2270 * `minetest.get_objects_inside_radius(pos, radius)`
2271 * `radius`: using an euclidean metric
2272 * `minetest.set_timeofday(val)`
2273 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
2274 * `minetest.get_timeofday()`
2275 * `minetest.get_gametime()`: returns the time, in seconds, since the world was created
2276 * `minetest.get_day_count()`: returns number days elapsed since world was created,
2277 * accounting for time changes.
2278 * `minetest.find_node_near(pos, radius, nodenames)`: returns pos or `nil`
2279 * `radius`: using a maximum metric
2280 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2281 * `minetest.find_nodes_in_area(minp, maxp, nodenames)`: returns a list of positions
2282 * returns as second value a table with the count of the individual nodes found
2283 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2284 * `minetest.find_nodes_in_area_under_air(minp, maxp, nodenames)`: returns a list of positions
2285 * returned positions are nodes with a node air above
2286 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2287 * `minetest.get_perlin(noiseparams)`
2288 * `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
2289 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
2290 * `minetest.get_voxel_manip([pos1, pos2])`
2291 * Return voxel manipulator object.
2292 * Loads the manipulator from the map if positions are passed.
2293 * `minetest.set_gen_notify(flags, {deco_ids})`
2294 * Set the types of on-generate notifications that should be collected
2295 * `flags` is a flag field with the available flags: `dungeon`, `temple`, `cave_begin`,
2296 `cave_end`, `large_cave_begin`, `large_cave_end`, `decoration`
2297 * The second parameter is a list of IDS of decorations which notification is requested for
2298 * `get_gen_notify()`: returns a flagstring and a table with the deco_ids
2299 * `minetest.get_mapgen_object(objectname)`
2300 * Return requested mapgen object if available (see "Mapgen objects")
2301 * `minetest.get_biome_id(biome_name)`
2302 * Returns the biome id, as used in the biomemap Mapgen object, for a
2303 given biome_name string.
2304 * `minetest.get_mapgen_params()` Returns mapgen parameters, a table containing
2305 `mgname`, `seed`, `chunksize`, `water_level`, and `flags`.
2306 * Deprecated: use minetest.get_mapgen_setting(name) instead
2307 * `minetest.set_mapgen_params(MapgenParams)`
2308 * Deprecated: use minetest.set_mapgen_setting(name, value, override) instead
2309 * Set map generation parameters
2310 * Function cannot be called after the registration period; only initialization
2311 and `on_mapgen_init`
2312 * Takes a table as an argument with the fields `mgname`, `seed`, `water_level`,
2314 * Leave field unset to leave that parameter unchanged
2315 * `flags` contains a comma-delimited string of flags to set,
2316 or if the prefix `"no"` is attached, clears instead.
2317 * `flags` is in the same format and has the same options as `mg_flags` in `minetest.conf`
2318 * `minetest.get_mapgen_setting(name)`
2319 * Gets the *active* mapgen setting (or nil if none exists) in string format with the following
2320 order of precedence:
2321 1) Settings loaded from map_meta.txt or overrides set during mod execution
2322 2) Settings set by mods without a metafile override
2323 3) Settings explicitly set in the user config file, minetest.conf
2324 4) Settings set as the user config default
2325 * `minetest.get_mapgen_setting_noiseparams(name)`
2326 * Same as above, but returns the value as a NoiseParams table if the setting `name` exists
2327 and is a valid NoiseParams
2328 * `minetest.set_mapgen_setting(name, value, [override_meta])`
2329 * Sets a mapgen param to `value`, and will take effect if the corresponding mapgen setting
2330 is not already present in map_meta.txt.
2331 * `override_meta` is an optional boolean (default: `false`). If this is set to true,
2332 the setting will become the active setting regardless of the map metafile contents.
2333 * Note: to set the seed, use "seed", not "fixed_map_seed"
2334 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
2335 * Same as above, except value is a NoiseParams table.
2336 * `minetest.set_noiseparams(name, noiseparams, set_default)`
2337 * Sets the noiseparams setting of `name` to the noiseparams table specified in `noiseparams`.
2338 * `set_default` is an optional boolean (default: `true`) that specifies whether the setting
2339 should be applied to the default config or current active config
2340 * `minetest.get_noiseparams(name)`: returns a table of the noiseparams for name
2341 * `minetest.generate_ores(vm, pos1, pos2)`
2342 * Generate all registered ores within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
2343 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
2344 * `minetest.generate_decorations(vm, pos1, pos2)`
2345 * Generate all registered decorations within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
2346 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
2347 * `minetest.clear_objects([options])`
2348 * Clear all objects in the environment
2349 * Takes an optional table as an argument with the field `mode`.
2350 * mode = `"full"`: Load and go through every mapblock, clearing objects (default).
2351 * mode = `"quick"`: Clear objects immediately in loaded mapblocks;
2352 clear objects in unloaded mapblocks only when the mapblocks are next activated.
2353 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
2354 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be asynchronously
2355 * fetched from memory, loaded from disk, or if inexistent, generates them.
2356 * If `callback` is a valid Lua function, this will be called for each block emerged.
2357 * The function signature of callback is:
2358 * `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
2359 * - `blockpos` is the *block* coordinates of the block that had been emerged
2360 * - `action` could be one of the following constant values:
2361 * `core.EMERGE_CANCELLED`, `core.EMERGE_ERRORED`, `core.EMERGE_FROM_MEMORY`,
2362 * `core.EMERGE_FROM_DISK`, `core.EMERGE_GENERATED`
2363 * - `calls_remaining` is the number of callbacks to be expected after this one
2364 * - `param` is the user-defined parameter passed to emerge_area (or nil if the
2365 * parameter was absent)
2366 * `minetest.delete_area(pos1, pos2)`
2367 * delete all mapblocks in the area from pos1 to pos2, inclusive
2368 * `minetest.line_of_sight(pos1, pos2, stepsize)`: returns `boolean, pos`
2369 * Check if there is a direct line of sight between `pos1` and `pos2`
2370 * Returns the position of the blocking node when `false`
2371 * `pos1`: First position
2372 * `pos2`: Second position
2373 * `stepsize`: smaller gives more accurate results but requires more computing
2374 time. Default is `1`.
2375 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
2376 * returns table containing path
2377 * returns a table of 3D points representing a path from `pos1` to `pos2` or `nil`
2378 * `pos1`: start position
2379 * `pos2`: end position
2380 * `searchdistance`: number of blocks to search in each direction using a maximum metric
2381 * `max_jump`: maximum height difference to consider walkable
2382 * `max_drop`: maximum height difference to consider droppable
2383 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
2384 * `minetest.spawn_tree (pos, {treedef})`
2385 * spawns L-system tree at given `pos` with definition in `treedef` table
2386 * Warning: L-system generation currently creates lighting bugs in the form of mapblock-sized shadows.
2387 Often these bugs appear as subtle shadows in water.
2388 * `minetest.transforming_liquid_add(pos)`
2389 * add node to liquid update queue
2390 * `minetest.get_node_max_level(pos)`
2391 * get max available level for leveled node
2392 * `minetest.get_node_level(pos)`
2393 * get level of leveled node (water, snow)
2394 * `minetest.set_node_level(pos, level)`
2395 * set level of leveled node, default `level` equals `1`
2396 * if `totallevel > maxlevel`, returns rest (`total-max`).
2397 * `minetest.add_node_level(pos, level)`
2398 * increase level of leveled node by level, default `level` equals `1`
2399 * if `totallevel > maxlevel`, returns rest (`total-max`)
2400 * can be negative for decreasing
2401 * `core.check_single_for_falling(pos)`
2402 * causes an unsupported `group:falling_node` node to fall and causes an
2403 unattached `group:attached_node` node to fall.
2404 * does not spread these updates to neighbours.
2405 * `core.check_for_falling(pos)`
2406 * causes an unsupported `group:falling_node` node to fall and causes an
2407 unattached `group:attached_node` node to fall.
2408 * spread these updates to neighbours and can cause a cascade
2412 `minetest.get_inventory(location)`: returns an `InvRef`
2415 * `{type="player", name="celeron55"}`
2416 * `{type="node", pos={x=, y=, z=}}`
2417 * `{type="detached", name="creative"}`
2418 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns an `InvRef`
2419 * callbacks: See "Detached inventory callbacks"
2420 * player_name: Make detached inventory available to one player exclusively,
2421 by default they will be sent to every player (even if not used).
2422 Note that this parameter is mostly just a workaround and will be removed in future releases.
2423 * Creates a detached inventory. If it already exists, it is cleared.
2424 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
2425 returns left over ItemStack
2426 * See `minetest.item_eat` and `minetest.register_on_item_eat`
2429 * `minetest.show_formspec(playername, formname, formspec)`
2430 * `playername`: name of player to show formspec
2431 * `formname`: name passed to `on_player_receive_fields` callbacks.
2432 It should follow the `"modname:<whatever>"` naming convention
2433 * `formspec`: formspec to display
2434 * `minetest.close_formspec(playername, formname)`
2435 * `playername`: name of player to close formspec
2436 * `formname`: has to exactly match the one given in show_formspec, or the formspec will
2438 * calling show_formspec(playername, formname, "") is equal to this expression
2439 * to close a formspec regardless of the formname, call
2440 minetest.close_formspec(playername, ""). USE THIS ONLY WHEN ABSOLUTELY NECESSARY!
2441 * `minetest.formspec_escape(string)`: returns a string
2442 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
2443 * `minetest.explode_table_event(string)`: returns a table
2444 * returns e.g. `{type="CHG", row=1, column=2}`
2446 * `"INV"`: no row selected)
2447 * `"CHG"`: selected)
2448 * `"DCL"`: double-click
2449 * `minetest.explode_textlist_event(string)`: returns a table
2450 * returns e.g. `{type="CHG", index=1}`
2452 * `"INV"`: no row selected)
2453 * `"CHG"`: selected)
2454 * `"DCL"`: double-click
2455 * `minetest.explode_scrollbar_event(string)`: returns a table
2456 * returns e.g. `{type="CHG", value=500}`
2458 * `"INV"`: something failed
2459 * `"CHG"`: has been changed
2460 * `"VAL"`: not changed
2463 * `minetest.inventorycube(img1, img2, img3)`
2464 * Returns a string for making an image of a cube (useful as an item image)
2465 * `minetest.get_pointed_thing_position(pointed_thing, above)`
2466 * Get position of a `pointed_thing` (that you can get from somewhere)
2467 * `minetest.dir_to_facedir(dir, is6d)`
2468 * Convert a vector to a facedir value, used in `param2` for `paramtype2="facedir"`;
2469 * passing something non-`nil`/`false` for the optional second parameter causes it to
2470 take the y component into account
2471 * `minetest.facedir_to_dir(facedir)`
2472 * Convert a facedir back into a vector aimed directly out the "back" of a node
2473 * `minetest.dir_to_wallmounted(dir)`
2474 * Convert a vector to a wallmounted value, used for `paramtype2="wallmounted"`
2475 * `minetest.wallmounted_to_dir(wallmounted)`
2476 * Convert a wallmounted value back into a vector aimed directly out the "back" of a node
2477 * `minetest.dir_to_yaw(dir)`
2478 * Convert a vector into a yaw (angle)
2479 * `minetest.yaw_to_dir(yaw)`
2480 * Convert yaw (angle) to a vector
2481 * `minetest.get_node_drops(nodename, toolname)`
2482 * Returns list of item names.
2483 * **Note**: This will be removed or modified in a future version.
2484 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
2485 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2486 * `input.width` = for example `3`
2487 * `input.items` = for example
2488 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2489 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
2490 * `output.time` = a number, if unsuccessful: `0`
2491 * `output.replacements` = list of `ItemStack`s that couldn't be placed in
2492 `decremented_input.items`
2493 * `decremented_input` = like `input`
2494 * `minetest.get_craft_recipe(output)`: returns input
2495 * returns last registered recipe for output item (node)
2496 * `output` is a node or item type such as `"default:torch"`
2497 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2498 * `input.width` = for example `3`
2499 * `input.items` = for example
2500 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2501 * `input.items` = `nil` if no recipe found
2502 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
2503 * returns indexed table with all registered recipes for query item (node)
2504 or `nil` if no recipe was found
2505 * recipe entry table:
2507 method = 'normal' or 'cooking' or 'fuel'
2508 width = 0-3, 0 means shapeless recipe
2509 items = indexed [1-9] table with recipe items
2510 output = string with item name and quantity
2512 * Example query for `"default:gold_ingot"` will return table:
2514 [1]={type = "cooking", width = 3, output = "default:gold_ingot",
2515 items = {1 = "default:gold_lump"}},
2516 [2]={type = "normal", width = 1, output = "default:gold_ingot 9",
2517 items = {1 = "default:goldblock"}}
2519 * `minetest.handle_node_drops(pos, drops, digger)`
2520 * `drops`: list of itemstrings
2521 * Handles drops from nodes after digging: Default action is to put them into
2523 * Can be overridden to get different functionality (e.g. dropping items on
2527 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
2528 returns `{{actor, pos, time, oldnode, newnode}, ...}`
2529 * Find who has done something to a node, or near a node
2530 * `actor`: `"player:<name>"`, also `"liquid"`.
2531 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns `boolean, log_messages`
2532 * Revert latest actions of someone
2533 * `actor`: `"player:<name>"`, also `"liquid"`.
2535 ### Defaults for the `on_*` item definition functions
2536 These functions return the leftover itemstack.
2538 * `minetest.item_place_node(itemstack, placer, pointed_thing, param2)`
2539 * Place item as a node
2540 * `param2` overrides `facedir` and wallmounted `param2`
2541 * returns `itemstack, success`
2542 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
2544 * `minetest.item_place(itemstack, placer, pointed_thing, param2)`
2545 * Use one of the above based on what the item is.
2546 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
2547 * **Note**: is not called when wielded item overrides `on_place`
2548 * `param2` overrides `facedir` and wallmounted `param2`
2549 * returns `itemstack, success`
2550 * `minetest.item_drop(itemstack, dropper, pos)`
2552 * `minetest.item_eat(hp_change, replace_with_item)`
2554 * `replace_with_item` is the itemstring which is added to the inventory.
2555 If the player is eating a stack, then replace_with_item goes to a
2556 different spot. Can be `nil`
2557 * See `minetest.do_item_eat`
2559 ### Defaults for the `on_punch` and `on_dig` node definition callbacks
2560 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
2561 * Calls functions registered by `minetest.register_on_punchnode()`
2562 * `minetest.node_dig(pos, node, digger)`
2563 * Checks if node can be dug, puts item into inventory, removes node
2564 * Calls functions registered by `minetest.registered_on_dignodes()`
2567 * `minetest.sound_play(spec, parameters)`: returns a handle
2568 * `spec` is a `SimpleSoundSpec`
2569 * `parameters` is a sound parameter table
2570 * `minetest.sound_stop(handle)`
2573 * `minetest.after(time, func, ...)`
2574 * Call the function `func` after `time` seconds, may be fractional
2575 * Optional: Variable number of arguments that are passed to `func`
2578 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for server shutdown. Will display `message` to clients,
2579 `reconnect` == true displays a reconnect button,
2580 `delay` adds an optional delay (in seconds) before shutdown
2581 negative delay cancels the current active shutdown
2582 zero delay triggers an immediate shutdown.
2583 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
2584 * `minetest.get_server_status()`: returns server status string
2585 * `minetest.get_server_uptime()`: returns the server uptime in seconds
2588 * `minetest.get_ban_list()`: returns the ban list (same as `minetest.get_ban_description("")`)
2589 * `minetest.get_ban_description(ip_or_name)`: returns ban description (string)
2590 * `minetest.ban_player(name)`: ban a player
2591 * `minetest.unban_player_or_ip(name)`: unban player or IP address
2592 * `minetest.kick_player(name, [reason])`: disconnect a player with a optional reason
2595 * `minetest.add_particle(particle definition)`
2596 * Deprecated: `minetest.add_particle(pos, velocity, acceleration, expirationtime,
2597 size, collisiondetection, texture, playername)`
2599 * `minetest.add_particlespawner(particlespawner definition)`
2600 * Add a `ParticleSpawner`, an object that spawns an amount of particles over `time` seconds
2601 * Returns an `id`, and -1 if adding didn't succeed
2602 * `Deprecated: minetest.add_particlespawner(amount, time,
2606 minexptime, maxexptime,
2608 collisiondetection, texture, playername)`
2610 * `minetest.delete_particlespawner(id, player)``
2611 * Delete `ParticleSpawner` with `id` (return value from `minetest.add_particlespawner`)
2612 * If playername is specified, only deletes on the player's client,
2613 * otherwise on all clients
2616 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
2617 * Create a schematic from the volume of map specified by the box formed by p1 and p2.
2618 * Apply the specified probability values to the specified nodes in `probability_list`.
2619 * `probability_list` is an array of tables containing two fields, `pos` and `prob`.
2620 * `pos` is the 3D vector specifying the absolute coordinates of the
2621 node being modified,
2622 * `prob` is the integer value from `0` to `255` of the probability (see: Schematic specifier).
2623 * If there are two or more entries with the same pos value, the
2625 * If `pos` is not inside the box formed by `p1` and `p2`, it is ignored.
2626 * If `probability_list` equals `nil`, no probabilities are applied.
2627 * Slice probability works in the same manner, except takes a field
2628 called `ypos` instead which
2629 indicates the y position of the slice with a probability applied.
2630 * If slice probability list equals `nil`, no slice probabilities are applied.
2631 * Saves schematic in the Minetest Schematic format to filename.
2633 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement)`
2634 * Place the schematic specified by schematic (see: Schematic specifier) at `pos`.
2635 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
2636 * If the `rotation` parameter is omitted, the schematic is not rotated.
2637 * `replacements` = `{["old_name"] = "convert_to", ...}`
2638 * `force_placement` is a boolean indicating whether nodes other than `air` and
2639 `ignore` are replaced by the schematic
2640 * Returns nil if the schematic could not be loaded.
2642 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement)`:
2643 * This function is analagous to minetest.place_schematic, but places a schematic onto the
2644 specified VoxelManip object `vmanip` instead of the whole map.
2645 * Returns false if any part of the schematic was cut-off due to the VoxelManip not
2646 containing the full area required, and true if the whole schematic was able to fit.
2647 * Returns nil if the schematic could not be loaded.
2648 * After execution, any external copies of the VoxelManip contents are invalidated.
2650 * `minetest.serialize_schematic(schematic, format, options)`
2651 * Return the serialized schematic specified by schematic (see: Schematic specifier)
2652 * in the `format` of either "mts" or "lua".
2653 * "mts" - a string containing the binary MTS data used in the MTS file format
2654 * "lua" - a string containing Lua code representing the schematic in table format
2655 * `options` is a table containing the following optional parameters:
2656 * If `lua_use_comments` is true and `format` is "lua", the Lua code generated will have (X, Z)
2657 * position comments for every X row generated in the schematic data for easier reading.
2658 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua", the Lua code generated
2659 * will use that number of spaces as indentation instead of a tab character.
2662 * `minetest.request_http_api()`:
2663 * returns `HTTPApiTable` containing http functions if the calling mod has been granted
2664 access by being listed in the `secure.http_mods` or `secure.trusted_mods` setting,
2665 otherwise returns `nil`.
2666 * The returned table contains the functions `fetch`, `fetch_async` and `fetch_async_get`
2668 * Only works at init time and must be called from the mod's main scope (not from a function).
2669 * Function only exists if minetest server was built with cURL support.
2670 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
2672 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
2673 * Performs given request asynchronously and calls callback upon completion
2674 * callback: `function(HTTPRequestResult res)`
2675 * Use this HTTP function if you are unsure, the others are for advanced use.
2676 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
2677 * Performs given request asynchronously and returns handle for `HTTPApiTable.fetch_async_get`
2678 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
2679 * Return response data for given asynchronous HTTP request
2682 * `minetest.get_mod_storage()`:
2683 * returns reference to mod private `StorageRef`
2684 * must be called during mod load time
2687 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
2688 * `minetest.player_exists(name)`: boolean, whether player exists (regardless of online status)
2689 * `minetest.hud_replace_builtin(name, hud_definition)`
2690 * Replaces definition of a builtin hud element
2691 * `name`: `"breath"` or `"health"`
2692 * `hud_definition`: definition to replace builtin definition
2693 * `minetest.hash_node_position({x=,y=,z=})`: returns an 48-bit integer
2694 * Gives a unique hash number for a node position (16+16+16=48bit)
2695 * `minetest.get_position_from_hash(hash)`: returns a position
2696 * Inverse transform of `minetest.hash_node_position`
2697 * `minetest.get_item_group(name, group)`: returns a rating
2698 * Get rating of a group of an item. (`0` means: not in group)
2699 * `minetest.get_node_group(name, group)`: returns a rating
2700 * Deprecated: An alias for the former.
2701 * `minetest.raillike_group(name)`: returns a rating
2702 * Returns rating of the connect_to_raillike group corresponding to name
2703 * If name is not yet the name of a connect_to_raillike group, a new group id
2704 * is created, with that name
2705 * `minetest.get_content_id(name)`: returns an integer
2706 * Gets the internal content ID of `name`
2707 * `minetest.get_name_from_content_id(content_id)`: returns a string
2708 * Gets the name of the content with that content ID
2709 * `minetest.parse_json(string[, nullvalue])`: returns something
2710 * Convert a string containing JSON data into the Lua equivalent
2711 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
2712 * On success returns a table, a string, a number, a boolean or `nullvalue`
2713 * On failure outputs an error message and returns `nil`
2714 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
2715 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
2716 * Convert a Lua table into a JSON string
2717 * styled: Outputs in a human-readable format if this is set, defaults to false
2718 * Unserializable things like functions and userdata will cause an error.
2719 * **Warning**: JSON is more strict than the Lua table format.
2720 1. You can only use strings and positive integers of at least one as keys.
2721 2. You can not mix string and integer keys.
2722 This is due to the fact that JSON has two distinct array and object values.
2723 * Example: `write_json({10, {a = false}})`, returns `"[10, {\"a\": false}]"`
2724 * `minetest.serialize(table)`: returns a string
2725 * Convert a table containing tables, strings, numbers, booleans and `nil`s
2726 into string form readable by `minetest.deserialize`
2727 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
2728 * `minetest.deserialize(string)`: returns a table
2729 * Convert a string returned by `minetest.deserialize` into a table
2730 * `string` is loaded in an empty sandbox environment.
2731 * Will load functions, but they cannot access the global environment.
2732 * Example: `deserialize('return { ["foo"] = "bar" }')`, returns `{foo='bar'}`
2733 * Example: `deserialize('print("foo")')`, returns `nil` (function call fails)
2734 * `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
2735 * `minetest.compress(data, method, ...)`: returns `compressed_data`
2736 * Compress a string of data.
2737 * `method` is a string identifying the compression method to be used.
2738 * Supported compression methods:
2739 * Deflate (zlib): `"deflate"`
2740 * `...` indicates method-specific arguments. Currently defined arguments are:
2741 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
2742 * `minetest.decompress(compressed_data, method, ...)`: returns data
2743 * Decompress a string of data (using ZLib).
2744 * See documentation on `minetest.compress()` for supported compression methods.
2745 * currently supported.
2746 * `...` indicates method-specific arguments. Currently, no methods use this.
2747 * `minetest.encode_base64(string)`: returns string encoded in base64
2748 * Encodes a string in base64.
2749 * `minetest.decode_base64(string)`: returns string
2750 * Decodes a string encoded in base64.
2751 * `minetest.is_protected(pos, name)`: returns boolean
2752 * Returns true, if player `name` shouldn't be abled to dig at `pos` or do other
2753 actions, defineable by mods, due to some mod-defined ownership-like concept.
2754 Returns false or nil, if the player is allowed to do such actions.
2755 * This function should be overridden by protection mods and should be used to
2756 check if a player can interact at a position.
2757 * This function should call the old version of itself if the position is not
2758 protected by the mod.
2761 local old_is_protected = minetest.is_protected
2762 function minetest.is_protected(pos, name)
2763 if mymod:position_protected_from(pos, name) then
2766 return old_is_protected(pos, name)
2768 * `minetest.record_protection_violation(pos, name)`
2769 * This function calls functions registered with
2770 `minetest.register_on_protection_violation`.
2771 * `minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)`
2772 * Attempt to predict the desired orientation of the facedir-capable node
2773 defined by `itemstack`, and place it accordingly (on-wall, on the floor, or
2774 hanging from the ceiling). Stacks are handled normally if the `infinitestacks`
2775 field is false or omitted (else, the itemstack is not changed). `orient_flags`
2776 is an optional table containing extra tweaks to the placement code:
2777 * `invert_wall`: if `true`, place wall-orientation on the ground and ground-
2778 orientation on the wall.
2779 * `force_wall` : if `true`, always place the node in wall orientation.
2780 * `force_ceiling`: if `true`, always place on the ceiling.
2781 * `force_floor`: if `true`, always place the node on the floor.
2782 * `force_facedir`: if `true`, forcefully reset the facedir to north when placing on
2783 the floor or ceiling
2784 * The first four options are mutually-exclusive; the last in the list takes
2785 precedence over the first.
2786 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
2787 * calls `rotate_and_place()` with infinitestacks set according to the state of
2788 the creative mode setting, and checks for "sneak" to set the `invert_wall`
2791 * `minetest.forceload_block(pos[, transient])`
2792 * forceloads the position `pos`.
2793 * returns `true` if area could be forceloaded
2794 * If `transient` is `false` or absent, the forceload will be persistent
2795 (saved between server runs). If `true`, the forceload will be transient
2796 (not saved between server runs).
2798 * `minetest.forceload_free_block(pos[, transient])`
2799 * stops forceloading the position `pos`
2800 * If `transient` is `false` or absent, frees a persistent forceload.
2801 If `true`, frees a transient forceload.
2803 * `minetest.request_insecure_environment()`: returns an environment containing
2804 insecure functions if the calling mod has been listed as trusted in the
2805 `secure.trusted_mods` setting or security is disabled, otherwise returns `nil`.
2806 * Only works at init time and must be called from the mod's main scope (not from a function).
2807 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE IT IN
2810 * `minetest.global_exists(name)`
2811 * Checks if a global variable has been set, without triggering a warning.
2814 * `minetest.env`: `EnvRef` of the server environment and world.
2815 * Any function in the minetest namespace can be called using the syntax
2816 `minetest.env:somefunction(somearguments)`
2817 instead of `minetest.somefunction(somearguments)`
2818 * Deprecated, but support is not to be dropped soon
2821 * `minetest.registered_items`
2822 * Map of registered items, indexed by name
2823 * `minetest.registered_nodes`
2824 * Map of registered node definitions, indexed by name
2825 * `minetest.registered_craftitems`
2826 * Map of registered craft item definitions, indexed by name
2827 * `minetest.registered_tools`
2828 * Map of registered tool definitions, indexed by name
2829 * `minetest.registered_entities`
2830 * Map of registered entity prototypes, indexed by name
2831 * `minetest.object_refs`
2832 * Map of object references, indexed by active object id
2833 * `minetest.luaentities`
2834 * Map of Lua entities, indexed by active object id
2835 * `minetest.registered_chatcommands`
2836 * Map of registered chat command definitions, indexed by name
2837 * `minetest.registered_ores`
2838 * List of registered ore definitions.
2839 * `minetest.registered_biomes`
2840 * List of registered biome definitions.
2841 * `minetest.registered_decorations`
2842 * List of registered decoration definitions.
2848 See `StorageRef`, `NodeMetaRef` and `ItemStackMetaRef`.
2851 * `set_string(name, value)`
2852 * `get_string(name)`
2853 * `set_int(name, value)`
2855 * `set_float(name, value)`
2857 * `to_table()`: returns `nil` or a table with keys:
2858 * `fields`: key-value storage
2859 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
2860 * `from_table(nil or {})`
2861 * Any non-table value will clear the metadata
2862 * See "Node Metadata" for an example
2863 * returns `true` on success
2865 * returns `true` if this metadata has the same key-value pairs as `other`
2868 Node metadata: reference extra data and functionality stored in a node.
2869 Can be obtained via `minetest.get_meta(pos)`.
2872 * All methods in MetaDataRef
2873 * `get_inventory()`: returns `InvRef`
2875 ### `ItemStackMetaRef`
2876 ItemStack metadata: reference extra data and functionality stored in a stack.
2877 Can be obtained via `item:get_meta()`.
2880 * All methods in MetaDataRef
2883 Mod metadata: per mod metadata, saved automatically.
2884 Can be obtained via `minetest.get_mod_storage()` during load time.
2887 * All methods in MetaDataRef
2890 Node Timers: a high resolution persistent per-node timer.
2891 Can be gotten via `minetest.get_node_timer(pos)`.
2894 * `set(timeout,elapsed)`
2895 * set a timer's state
2896 * `timeout` is in seconds, and supports fractional values (0.1 etc)
2897 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
2898 * will trigger the node's `on_timer` function after `timeout`-elapsed seconds
2901 * equivalent to `set(timeout,0)`
2904 * `get_timeout()`: returns current timeout in seconds
2905 * if `timeout` equals `0`, timer is inactive
2906 * `get_elapsed()`: returns current elapsed time in seconds
2907 * the node's `on_timer` function will be called after `timeout`-elapsed seconds
2908 * `is_started()`: returns boolean state of timer
2909 * returns `true` if timer is started, otherwise `false`
2912 Moving things in the game are generally these.
2914 This is basically a reference to a C++ `ServerActiveObject`
2917 * `remove()`: remove object (after returning from Lua)
2918 * Note: Doesn't work on players, use minetest.kick_player instead
2919 * `get_pos()`: returns `{x=num, y=num, z=num}`
2920 * `set_pos(pos)`; `pos`=`{x=num, y=num, z=num}`
2921 * `move_to(pos, continuous=false)`: interpolated move
2922 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
2923 * `puncher` = another `ObjectRef`,
2924 * `time_from_last_punch` = time since last punch action of the puncher
2925 * `direction`: can be `nil`
2926 * `right_click(clicker)`; `clicker` is another `ObjectRef`
2927 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
2928 * `set_hp(hp)`: set number of hitpoints (2 * number of hearts)
2929 * `get_inventory()`: returns an `InvRef`
2930 * `get_wield_list()`: returns the name of the inventory list the wielded item is in
2931 * `get_wield_index()`: returns the index of the wielded item
2932 * `get_wielded_item()`: returns an `ItemStack`
2933 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if successful
2934 * `set_armor_groups({group1=rating, group2=rating, ...})`
2935 * `get_armor_groups()`: returns a table with the armor group ratings
2936 * `set_animation({x=1,y=1}, frame_speed=15, frame_blend=0, frame_loop=true)`
2937 * `get_animation()`: returns range, frame_speed, frame_blend and frame_loop
2938 * `set_attach(parent, bone, position, rotation)`
2940 * `position`: `{x=num, y=num, z=num}` (relative)
2941 * `rotation`: `{x=num, y=num, z=num}`
2942 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't attached
2944 * `set_bone_position(bone, position, rotation)`
2946 * `position`: `{x=num, y=num, z=num}` (relative)
2947 * `rotation`: `{x=num, y=num, z=num}`
2948 * `get_bone_position(bone)`: returns position and rotation of the bone
2949 * `set_properties(object property table)`
2950 * `get_properties()`: returns object property table
2951 * `is_player()`: returns true for players, false otherwise
2952 * `get_nametag_attributes()`
2953 * returns a table with the attributes of the nametag of an object
2955 color = {a=0..255, r=0..255, g=0..255, b=0..255},
2958 * `set_nametag_attributes(attributes)`
2959 * sets the attributes of the nametag of an object
2963 text = "My Nametag",
2966 ##### LuaEntitySAO-only (no-op for other objects)
2967 * `set_velocity({x=num, y=num, z=num})`
2968 * `get_velocity()`: returns `{x=num, y=num, z=num}`
2969 * `set_acceleration({x=num, y=num, z=num})`
2970 * `get_acceleration()`: returns `{x=num, y=num, z=num}`
2971 * `set_yaw(radians)`
2972 * `get_yaw()`: returns number in radians
2973 * `set_texture_mod(mod)`
2974 * `get_texture_mod()` returns current texture modifier
2975 * `set_sprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
2976 select_horiz_by_yawpitch=false)`
2977 * Select sprite from spritesheet with optional animation and DM-style
2978 texture selection based on yaw relative to camera
2979 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
2982 ##### Player-only (no-op for other objects)
2983 * `get_player_name()`: returns `""` if is not a player
2984 * `get_player_velocity()`: returns `nil` if is not a player, otherwise a
2985 table {x, y, z} representing the player's instantaneous velocity in nodes/s
2986 * `get_look_dir()`: get camera direction as a unit vector
2987 * `get_look_vertical()`: pitch in radians
2988 * Angle ranges between -pi/2 and pi/2, which are straight up and down respectively.
2989 * `get_look_horizontal()`: yaw in radians
2990 * Angle is counter-clockwise from the +z direction.
2991 * `set_look_vertical(radians)`: sets look pitch
2992 * radians - Angle from looking forward, where positive is downwards.
2993 * `set_look_horizontal(radians)`: sets look yaw
2994 * radians - Angle from the +z direction, where positive is counter-clockwise.
2995 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use get_look_vertical.
2996 * Angle ranges between -pi/2 and pi/2, which are straight down and up respectively.
2997 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use get_look_horizontal.
2998 * Angle is counter-clockwise from the +x direction.
2999 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use set_look_vertical.
3000 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use set_look_horizontal.
3001 * `get_breath()`: returns players breath
3002 * `set_breath(value)`: sets players breath
3004 * `0`: player is drowning,
3005 * `1`-`10`: remaining number of bubbles
3006 * `11`: bubbles bar is not shown
3007 * `set_attribute(attribute, value)`: sets an extra attribute with value on player
3008 * `get_attribute(attribute)`: returns value for extra attribute. Returns nil if no attribute found.
3009 * `set_inventory_formspec(formspec)`
3010 * Redefine player's inventory form
3011 * Should usually be called in on_joinplayer
3012 * `get_inventory_formspec()`: returns a formspec string
3013 * `get_player_control()`: returns table with player pressed keys
3014 * `{jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}`
3015 * `get_player_control_bits()`: returns integer with bit packed player pressed keys
3016 * bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
3017 * `set_physics_override(override_table)`
3018 * `override_table` is a table with the following fields:
3019 * `speed`: multiplier to default walking speed value (default: `1`)
3020 * `jump`: multiplier to default jump value (default: `1`)
3021 * `gravity`: multiplier to default gravity value (default: `1`)
3022 * `sneak`: whether player can sneak (default: `true`)
3023 * `sneak_glitch`: whether player can use the new move code replications
3024 of the old sneak side-effects: sneak ladders and 2 node sneak jump
3025 when next to a ledge 2 nodes up (default: `true`)
3026 * `new_move`: use new move/sneak code. When `false` the exact old code
3027 is used for the specific old sneak behaviour (default: `true`)
3028 * `get_physics_override()`: returns the table given to set_physics_override
3029 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
3031 * `hud_remove(id)`: remove the HUD element of the specified id
3032 * `hud_change(id, stat, value)`: change a value of a previously added HUD element
3033 * element `stat` values: `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
3034 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
3035 * `hud_set_flags(flags)`: sets specified HUD flags to `true`/`false`
3036 * `flags`: (is visible) `hotbar`, `healthbar`, `crosshair`, `wielditem`, `minimap`
3037 * pass a table containing a `true`/`false` value of each flag to be set or unset
3038 * if a flag equals `nil`, the flag is not modified
3039 * note that setting `minimap` modifies the client's permission to view the minimap -
3040 * the client may locally elect to not view the minimap
3041 * `hud_get_flags()`: returns a table containing status of hud flags
3042 * returns `{ hotbar=true, healthbar=true, crosshair=true, wielditem=true, breathbar=true, minimap=true }`
3043 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
3044 * `count`: number of items, must be between `1` and `23`
3045 * `hud_get_hotbar_itemcount`: returns number of visible items
3046 * `hud_set_hotbar_image(texturename)`
3047 * sets background image for hotbar
3048 * `hud_get_hotbar_image`: returns texturename
3049 * `hud_set_hotbar_selected_image(texturename)`
3050 * sets image for selected item of hotbar
3051 * `hud_get_hotbar_selected_image`: returns texturename
3052 * `set_sky(bgcolor, type, {texture names})`
3053 * `bgcolor`: ColorSpec, defaults to white
3055 * `"regular"`: Uses 0 textures, `bgcolor` ignored
3056 * `"skybox"`: Uses 6 textures, `bgcolor` used
3057 * `"plain"`: Uses 0 textures, `bgcolor` used
3058 * `get_sky()`: returns bgcolor, type and a table with the textures
3059 * `override_day_night_ratio(ratio or nil)`
3060 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific amount
3061 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
3062 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
3063 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`
3065 set animation for player model in third person view
3067 set_local_animation({x=0, y=79}, -- < stand/idle animation key frames
3068 {x=168, y=187}, -- < walk animation key frames
3069 {x=189, y=198}, -- < dig animation key frames
3070 {x=200, y=219}, -- < walk+dig animation key frames
3071 frame_speed=30): -- < animation frame speed
3072 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and frame_speed
3073 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for camera per player
3074 * in first person view
3075 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
3076 * `get_eye_offset()`: returns offset_first and offset_third
3079 An `InvRef` is a reference to an inventory.
3082 * `is_empty(listname)`: return `true` if list is empty
3083 * `get_size(listname)`: get size of a list
3084 * `set_size(listname, size)`: set size of a list
3085 * returns `false` on error (e.g. invalid `listname` or `size`)
3086 * `get_width(listname)`: get width of a list
3087 * `set_width(listname, width)`: set width of list; currently used for crafting
3088 * `get_stack(listname, i)`: get a copy of stack index `i` in list
3089 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
3090 * `get_list(listname)`: return full list
3091 * `set_list(listname, list)`: set full list (size will not change)
3092 * `get_lists()`: returns list of inventory lists
3093 * `set_lists(lists)`: sets inventory lists (size will not change)
3094 * `add_item(listname, stack)`: add item somewhere in list, returns leftover `ItemStack`
3095 * `room_for_item(listname, stack):` returns `true` if the stack of items
3096 can be fully added to the list
3097 * `contains_item(listname, stack)`: returns `true` if the stack of items
3098 can be fully taken from the list
3099 * `remove_item(listname, stack)`: take as many items as specified from the list,
3100 returns the items that were actually removed (as an `ItemStack`) -- note that
3101 any item metadata is ignored, so attempting to remove a specific unique
3102 item this way will likely remove the wrong one -- to do that use `set_stack`
3103 with an empty `ItemStack`
3104 * `get_location()`: returns a location compatible to `minetest.get_inventory(location)`
3105 * returns `{type="undefined"}` in case location is not known
3108 A fast access data structure to store areas, and find areas near a given position or area.
3109 Every area has a `data` string attribute to store additional information.
3110 You can create an empty `AreaStore` by calling `AreaStore()`, or `AreaStore(type_name)`.
3111 If you chose the parameter-less constructor, a fast implementation will be automatically
3115 * `get_area(id, include_borders, include_data)`: returns the area with the id `id`.
3116 (optional) Boolean values `include_borders` and `include_data` control what's copied.
3117 Returns nil if specified area id does not exist.
3118 * `get_areas_for_pos(pos, include_borders, include_data)`: returns all areas that contain
3119 the position `pos`. (optional) Boolean values `include_borders` and `include_data` control
3121 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`:
3122 returns all areas that contain all nodes inside the area specified by `edge1` and `edge2` (inclusive).
3123 If `accept_overlap` is true, also areas are returned that have nodes in common with the specified area.
3124 (optional) Boolean values `include_borders` and `include_data` control what's copied.
3125 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store. Returns the new area's ID,
3126 or nil if the insertion failed. The (inclusive) positions `edge1` and `edge2` describe the area.
3127 `data` is a string stored with the area. If passed, `id` will be used as the internal area ID,
3128 it must be a unique number between 0 and 2^32-2. If you use the `id` parameter you must always use it,
3129 or insertions are likely to fail due to conflicts.
3130 * `reserve(count)`: reserves resources for at most `count` many contained areas.
3131 Only needed for efficiency, and only some implementations profit.
3132 * `remove_area(id)`: removes the area with the given id from the store, returns success.
3133 * `set_cache_params(params)`: sets params for the included prefiltering cache.
3134 Calling invalidates the cache, so that its elements have to be newly generated.
3137 enabled = boolean, -- whether to enable, default true
3138 block_radius = number, -- the radius (in nodes) of the areas the cache generates
3139 prefiltered lists for, minimum 16, default 64
3140 limit = number, -- the cache's size, minimum 20, default 1000
3142 * `to_string()`: Experimental. Returns area store serialized as a (binary) string.
3143 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to a file.
3144 * `from_string(str)`: Experimental. Deserializes string and loads it into the AreaStore.
3145 Returns success and, optionally, an error message.
3146 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data from a file.
3149 An `ItemStack` is a stack of items.
3151 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
3152 an itemstring, a table or `nil`.
3155 * `is_empty()`: Returns `true` if stack is empty.
3156 * `get_name()`: Returns item name (e.g. `"default:stone"`).
3157 * `set_name(item_name)`: Returns boolean whether item was cleared
3158 * `get_count()`: Returns number of items on the stack.
3159 * `set_count(count)`: Returns boolean whether item was cleared
3160 * `get_wear()`: Returns tool wear (`0`-`65535`), `0` for non-tools.
3161 * `set_wear(wear)`: Returns boolean whether item was cleared
3162 * `get_meta()`: Returns ItemStackMetaRef. See section for more details
3163 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item stack).
3164 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
3165 * `clear()`: removes all items from the stack, making it empty.
3166 * `replace(item)`: replace the contents of this stack.
3167 * `item` can also be an itemstring or table.
3168 * `to_string()`: Returns the stack in itemstring form.
3169 * `to_table()`: Returns the stack in Lua table form.
3170 * `get_stack_max()`: Returns the maximum size of the stack (depends on the item).
3171 * `get_free_space()`: Returns `get_stack_max() - get_count()`.
3172 * `is_known()`: Returns `true` if the item name refers to a defined item type.
3173 * `get_definition()`: Returns the item definition table.
3174 * `get_tool_capabilities()`: Returns the digging properties of the item,
3175 or those of the hand if none are defined for this item type
3176 * `add_wear(amount)`: Increases wear by `amount` if the item is a tool.
3177 * `add_item(item)`: Put some item or stack onto this stack.
3178 Returns leftover `ItemStack`.
3179 * `item_fits(item)`: Returns `true` if item or stack can be fully added to
3181 * `take_item(n=1)`: Take (and remove) up to `n` items from this stack.
3182 Returns taken `ItemStack`.
3183 * `peek_item(n=1)`: copy (don't remove) up to `n` items from this stack.
3184 Returns taken `ItemStack`.
3187 A 16-bit pseudorandom number generator.
3188 Uses a well-known LCG algorithm introduced by K&R.
3190 It can be created via `PseudoRandom(seed)`.
3193 * `next()`: return next integer random number [`0`...`32767`]
3194 * `next(min, max)`: return next integer random number [`min`...`max`]
3195 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
3196 due to the simple implementation making bad distribution otherwise.
3199 A 32-bit pseudorandom number generator.
3200 Uses PCG32, an algorithm of the permuted congruential generator family, offering very strong randomness.
3202 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
3205 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
3206 * `next(min, max)`: return next integer random number [`min`...`max`]
3207 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed random number [`min`...`max`]
3208 * This is only a rough approximation of a normal distribution with:
3209 * mean = (max - min) / 2, and
3210 * variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)
3211 * Increasing num_trials improves accuracy of the approximation
3214 Interface for the operating system's crypto-secure PRNG.
3216 It can be created via `SecureRandom()`. The constructor returns nil if a secure random device cannot be
3217 be found on the system.
3220 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many random bytes, as a string.
3223 A perlin noise generator.
3224 It can be created via `PerlinNoise(seed, octaves, persistence, scale)`
3225 or `PerlinNoise(noiseparams)`.
3226 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
3227 or `minetest.get_perlin(noiseparams)`.
3230 * `get2d(pos)`: returns 2D noise value at `pos={x=,y=}`
3231 * `get3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
3233 ### `PerlinNoiseMap`
3234 A fast, bulk perlin noise generator.
3236 It can be created via `PerlinNoiseMap(noiseparams, size)` or
3237 `minetest.get_perlin_map(noiseparams, size)`.
3239 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` conponent is ommitted
3240 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
3243 For each of the functions with an optional `buffer` parameter: If `buffer` is not
3244 nil, this table will be used to store the result instead of creating a new table.
3248 * `get2dMap(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
3249 with values starting at `pos={x=,y=}`
3250 * `get3dMap(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>` 3D array
3251 of 3D noise with values starting at `pos={x=,y=,z=}`
3252 * `get2dMap_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element array of 2D noise
3253 with values starting at `pos={x=,y=}`
3254 * `get3dMap_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
3255 * `calc2dMap(pos)`: Calculates the 2d noise map starting at `pos`. The result is stored internally.
3256 * `calc3dMap(pos)`: Calculates the 3d noise map starting at `pos`. The result is stored internally.
3257 * `getMapSlice(slice_offset, slice_size, buffer)`: In the form of an array, returns a slice of the
3258 most recently computed noise results. The result slice begins at coordinates `slice_offset` and
3259 takes a chunk of `slice_size`.
3260 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer offset y = 20:
3261 `noisevals = noise:getMapSlice({y=20}, {y=2})`
3262 It is important to note that `slice_offset` offset coordinates begin at 1, and are relative to
3263 the starting position of the most recently calculated noise.
3264 To grab a single vertical column of noise starting at map coordinates x = 1023, y=1000, z = 1000:
3265 `noise:calc3dMap({x=1000, y=1000, z=1000})`
3266 `noisevals = noise:getMapSlice({x=24, z=1}, {x=1, z=1})`
3270 #### About VoxelManip
3271 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator' facility. The purpose of
3272 this object is for fast, low-level, bulk access to reading and writing Map content. As such, setting
3273 map nodes through VoxelManip will lack many of the higher level features and concepts you may be used
3274 to with other methods of setting nodes. For example, nodes will not have their construction and
3275 destruction callbacks run, and no rollback information is logged.
3277 It is important to note that VoxelManip is designed for speed, and *not* ease of use or flexibility.
3278 If your mod requires a map manipulation facility that will handle 100% of all edge cases, or the use
3279 of high level node placement features, perhaps minetest.set_node() is better suited for the job.
3281 In addition, VoxelManip might not be faster, or could even be slower, for your specific use case.
3282 VoxelManip is most effective when setting very large areas of map at once - for example, if only
3283 setting a 5x5x5 node area, a minetest.set_node() loop may be more optimal. Always profile code
3284 using both methods of map manipulation to determine which is most appropriate for your usage.
3286 #### Using VoxelManip
3287 A VoxelManip object can be created any time using either:
3288 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
3290 If the optional position parameters are present for either of these routines, the specified region
3291 will be pre-loaded into the VoxelManip object on creation. Otherwise, the area of map you wish to
3292 manipulate must first be loaded into the VoxelManip object using `VoxelManip:read_from_map()`.
3294 Note that `VoxelManip:read_from_map()` returns two position vectors. The region formed by these
3295 positions indicate the minimum and maximum (respectively) positions of the area actually loaded in
3296 the VoxelManip, which may be larger than the area requested. For convenience, the loaded area
3297 coordinates can also be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
3299 Now that the VoxelManip object is populated with map data, your mod can fetch a copy of this data
3300 using either of two methods. `VoxelManip:get_node_at()`, which retrieves an individual node in a
3301 MapNode formatted table at the position requested is the simplest method to use, but also the slowest.
3303 Nodes in a VoxelManip object may also be read in bulk to a flat array table using:
3304 `VoxelManip:get_data()` for node content (in Content ID form, see section 'Content IDs'),
3305 `VoxelManip:get_light_data()` for node light levels, and
3306 `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
3308 See section 'Flat array format' for more details.
3310 It is very important to understand that the tables returned by any of the above three functions
3311 represent a snapshot of the VoxelManip's internal state at the time of the call. This copy of the
3312 data will *not* magically update itself if another function modifies the internal VoxelManip state.
3313 Any functions that modify a VoxelManip's contents work on the VoxelManip's internal state unless
3314 otherwise explicitly stated.
3316 Once the bulk data has been edited to your liking, the internal VoxelManip state can be set using:
3317 `VoxelManip:set_data()` for node content (in Content ID form, see section 'Content IDs'),
3318 `VoxelManip:set_light_data()` for node light levels, and
3319 `VoxelManip:set_param2_data()` for the node type-dependent "param2" values.
3321 The parameter to each of the above three functions can use any table at all in the same flat array
3322 format as produced by get_data() et al. and is *not required* to be a table retrieved from get_data().
3324 Once the internal VoxelManip state has been modified to your liking, the changes can be committed back
3325 to the map by calling `VoxelManip:write_to_map()`.
3328 ##### Flat array format
3330 `Nx = p2.X - p1.X + 1`,
3331 `Ny = p2.Y - p1.Y + 1`, and
3332 `Nz = p2.Z - p1.Z + 1`.
3334 Then, for a loaded region of p1..p2, this array ranges from `1` up to and including the value of
3335 the expression `Nx * Ny * Nz`.
3337 Positions offset from p1 are present in the array with the format of:
3340 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
3341 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
3343 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
3344 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
3346 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
3348 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
3352 and the array index for a position p contained completely in p1..p2 is:
3354 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
3356 Note that this is the same "flat 3D array" format as `PerlinNoiseMap:get3dMap_flat()`.
3357 VoxelArea objects (see section 'VoxelArea') can be used to simplify calculation of the index
3358 for a single point in a flat VoxelManip array.
3361 A Content ID is a unique integer identifier for a specific node type. These IDs are used by VoxelManip
3362 in place of the node name string for `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
3363 `minetest.get_content_id()` to look up the Content ID for the specified node name, and
3364 `minetest.get_name_from_content_id()` to look up the node name string for a given Content ID.
3365 After registration of a node, its Content ID will remain the same throughout execution of the mod.
3366 Note that the node being queried needs to have already been been registered.
3368 The following builtin node types have their Content IDs defined as constants:
3370 core.CONTENT_UNKNOWN (ID for "unknown" nodes)
3371 core.CONTENT_AIR (ID for "air" nodes)
3372 core.CONTENT_IGNORE (ID for "ignore" nodes)
3375 ##### Mapgen VoxelManip objects
3376 Inside of `on_generated()` callbacks, it is possible to retrieve the same VoxelManip object used by the
3377 core's Map Generator (commonly abbreviated Mapgen). Most of the rules previously described still apply
3378 but with a few differences:
3380 * The Mapgen VoxelManip object is retrieved using: `minetest.get_mapgen_object("voxelmanip")`
3381 * This VoxelManip object already has the region of map just generated loaded into it; it's not necessary
3382 to call `VoxelManip:read_from_map()` before using a Mapgen VoxelManip.
3383 * The `on_generated()` callbacks of some mods may place individual nodes in the generated area using
3384 non-VoxelManip map modification methods. Because the same Mapgen VoxelManip object is passed through
3385 each `on_generated()` callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3386 consistency with the current map state. For this reason, calling any of the following functions:
3387 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3388 will also update the Mapgen VoxelManip object's internal state active on the current thread.
3389 * After modifying the Mapgen VoxelManip object's internal buffer, it may be necessary to update lighting
3390 information using either: `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3392 ##### Other API functions operating on a VoxelManip
3393 If any VoxelManip contents were set to a liquid node, `VoxelManip:update_liquids()` must be called
3394 for these liquid nodes to begin flowing. It is recommended to call this function only after having
3395 written all buffered data back to the VoxelManip object, save for special situations where the modder
3396 desires to only have certain liquid nodes begin flowing.
3398 The functions `minetest.generate_ores()` and `minetest.generate_decorations()` will generate all
3399 registered decorations and ores throughout the full area inside of the specified VoxelManip object.
3401 `minetest.place_schematic_on_vmanip()` is otherwise identical to `minetest.place_schematic()`,
3402 except instead of placing the specified schematic directly on the map at the specified position, it
3403 will place the schematic inside of the VoxelManip.
3406 * Attempting to read data from a VoxelManip object before map is read will result in a zero-length
3407 array table for `VoxelManip:get_data()`, and an "ignore" node at any position for
3408 `VoxelManip:get_node_at()`.
3409 * If either a region of map has not yet been generated or is out-of-bounds of the map, that region is
3410 filled with "ignore" nodes.
3411 * Other mods, or the core itself, could possibly modify the area of map currently loaded into a VoxelManip
3412 object. With the exception of Mapgen VoxelManips (see above section), the internal buffers are not
3413 updated. For this reason, it is strongly encouraged to complete the usage of a particular VoxelManip
3414 object in the same callback it had been created.
3415 * If a VoxelManip object will be used often, such as in an `on_generated()` callback, consider passing
3416 a file-scoped table as the optional parameter to `VoxelManip:get_data()`, which serves as a static
3417 buffer the function can use to write map data to instead of returning a new table each call. This
3418 greatly enhances performance by avoiding unnecessary memory allocations.
3421 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object containing
3422 the region formed by `p1` and `p2`.
3423 * returns actual emerged `pmin`, actual emerged `pmax`
3424 * `write_to_map()`: Writes the data loaded from the `VoxelManip` back to the map.
3425 * **important**: data must be set using `VoxelManip:set_data()` before calling this
3426 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
3427 the `VoxelManip` at that position
3428 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at that position
3429 * `get_data([buffer])`: Retrieves the node content data loaded into the `VoxelManip` object
3430 * returns raw node data in the form of an array of node content IDs
3431 * if the param `buffer` is present, this table will be used to store the result instead
3432 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
3433 * `update_map()`: Does nothing, kept for compatibility.
3434 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to a uniform value
3435 * `light` is a table, `{day=<0...15>, night=<0...15>}`
3436 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
3437 * (`p1`, `p2`) is the area in which lighting is set;
3438 defaults to the whole area if left out
3439 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
3440 * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
3441 * Each value is the bitwise combination of day and night light values (`0` to `15` each)
3442 * `light = day + (night * 16)`
3443 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
3445 * expects lighting data in the same format that `get_light_data()` returns
3446 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the `VoxelManip` object
3447 * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
3448 * If the param `buffer` is present, this table will be used to store the result instead
3449 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in the `VoxelManip`
3450 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the `VoxelManip`
3451 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
3452 * (`p1`, `p2`) is the area in which lighting is set; defaults to the whole area
3454 * `propagate_shadow` is an optional boolean deciding whether shadows in a generated
3455 mapchunk above are propagated down into the mapchunk; defaults to `true` if left out
3456 * `update_liquids()`: Update liquid flow
3457 * `was_modified()`: Returns `true` or `false` if the data in the voxel manipulator
3458 had been modified since the last read from map, due to a call to
3459 `minetest.set_data()` on the loaded area elsewhere
3460 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
3463 A helper class for voxel areas.
3464 It can be created via `VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}`.
3465 The coordinates are *inclusive*, like most other things in Minetest.
3468 * `getExtent()`: returns a 3D vector containing the size of the area formed by
3469 `MinEdge` and `MaxEdge`
3470 * `getVolume()`: returns the volume of the area formed by `MinEdge` and `MaxEdge`
3471 * `index(x, y, z)`: returns the index of an absolute position in a flat array starting at `1`
3472 * useful for things like `VoxelManip`, raw Schematic specifiers,
3473 `PerlinNoiseMap:get2d`/`3dMap`, and so on
3474 * `indexp(p)`: same as above, except takes a vector
3475 * `position(i)`: returns the absolute position vector corresponding to index `i`
3476 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by `MinEdge` and `MaxEdge`
3477 * `containsp(p)`: same as above, except takes a vector
3478 * `containsi(i)`: same as above, except takes an index `i`
3479 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns indices
3480 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of `[z [y [x]]]`
3481 * `iterp(minp, maxp)`: same as above, except takes a vector
3484 An interface to read config files in the format of `minetest.conf`.
3486 It can be created via `Settings(filename)`.
3489 * `get(key)`: returns a value
3490 * `get_bool(key)`: returns a boolean
3492 * `remove(key)`: returns a boolean (`true` for success)
3493 * `get_names()`: returns `{key1,...}`
3494 * `write()`: returns a boolean (`true` for success)
3495 * write changes to file
3496 * `to_table()`: returns `{[key1]=value1,...}`
3500 A mapgen object is a construct used in map generation. Mapgen objects can be used
3501 by an `on_generate` callback to speed up operations by avoiding unnecessary
3502 recalculations; these can be retrieved using the `minetest.get_mapgen_object()`
3503 function. If the requested Mapgen object is unavailable, or `get_mapgen_object()`
3504 was called outside of an `on_generate()` callback, `nil` is returned.
3506 The following Mapgen objects are currently available:
3509 This returns three values; the `VoxelManip` object to be used, minimum and maximum
3510 emerged position, in that order. All mapgens support this object.
3513 Returns an array containing the y coordinates of the ground levels of nodes in
3514 the most recently generated chunk by the current mapgen.
3517 Returns an array containing the biome IDs of nodes in the most recently
3518 generated chunk by the current mapgen.
3521 Returns an array containing the temperature values of nodes in the most
3522 recently generated chunk by the current mapgen.
3525 Returns an array containing the humidity values of nodes in the most recently
3526 generated chunk by the current mapgen.
3529 Returns a table mapping requested generation notification types to arrays of
3530 positions at which the corresponding generated structures are located at within
3531 the current chunk. To set the capture of positions of interest to be recorded
3532 on generate, use `minetest.set_gen_notify()`.
3534 Possible fields of the table returned are:
3540 * `large_cave_begin`
3544 Decorations have a key in the format of `"decoration#id"`, where `id` is the
3545 numeric unique decoration ID.
3549 * Functions receive a "luaentity" as `self`:
3550 * It has the member `.name`, which is the registered name `("mod:thing")`
3551 * It has the member `.object`, which is an `ObjectRef` pointing to the object
3552 * The original prototype stuff is visible directly via a metatable
3554 * `on_activate(self, staticdata, dtime_s)`
3555 * Called when the object is instantiated.
3556 * `dtime_s` is the time passed since the object was unloaded, which can
3557 be used for updating the entity state.
3558 * `on_step(self, dtime)`
3559 * Called on every server tick, after movement and collision processing.
3560 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
3562 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)`
3563 * Called when somebody punches the object.
3564 * Note that you probably want to handle most punches using the
3565 automatic armor group system.
3566 * `puncher`: an `ObjectRef` (can be `nil`)
3567 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be `nil`)
3568 * `tool_capabilities`: capability table of used tool (can be `nil`)
3569 * `dir`: unit vector of direction of punch. Always defined. Points from
3570 the puncher to the punched.
3571 * `on_rightclick(self, clicker)`
3572 * `get_staticdata(self)`
3573 * Should return a string that will be passed to `on_activate` when
3574 the object is instantiated the next time.
3579 L-system generation currently creates lighting bugs in the form of mapblock-sized shadows.
3580 Often these bugs appear as subtle shadows in water.
3585 axiom, --string initial tree axiom
3586 rules_a, --string rules set A
3587 rules_b, --string rules set B
3588 rules_c, --string rules set C
3589 rules_d, --string rules set D
3590 trunk, --string trunk node name
3591 leaves, --string leaves node name
3592 leaves2, --string secondary leaves node name
3593 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
3594 angle, --num angle in deg
3595 iterations, --num max # of iterations, usually 2 -5
3596 random_level, --num factor to lower nr of iterations, usually 0 - 3
3597 trunk_type, --string single/double/crossed) type of trunk: 1 node,
3598 -- 2x2 nodes or 3x3 in cross shape
3599 thin_branches, --boolean true -> use thin (1 node) branches
3600 fruit, --string fruit node name
3601 fruit_chance, --num chance (0-100) to replace leaves with fruit node
3602 seed, --num random seed; if no seed is provided, the engine will create one
3605 ### Key for Special L-System Symbols used in Axioms
3607 * `G`: move forward one unit with the pen up
3608 * `F`: move forward one unit with the pen down drawing trunks and branches
3609 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
3610 * `T`: move forward one unit with the pen down drawing trunks only
3611 * `R`: move forward one unit with the pen down placing fruit
3612 * `A`: replace with rules set A
3613 * `B`: replace with rules set B
3614 * `C`: replace with rules set C
3615 * `D`: replace with rules set D
3616 * `a`: replace with rules set A, chance 90%
3617 * `b`: replace with rules set B, chance 80%
3618 * `c`: replace with rules set C, chance 70%
3619 * `d`: replace with rules set D, chance 60%
3620 * `+`: yaw the turtle right by `angle` parameter
3621 * `-`: yaw the turtle left by `angle` parameter
3622 * `&`: pitch the turtle down by `angle` parameter
3623 * `^`: pitch the turtle up by `angle` parameter
3624 * `/`: roll the turtle to the right by `angle` parameter
3625 * `*`: roll the turtle to the left by `angle` parameter
3626 * `[`: save in stack current state info
3627 * `]`: recover from stack state info
3630 Spawn a small apple tree:
3632 pos = {x=230,y=20,z=4}
3635 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
3636 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
3637 trunk="default:tree",
3638 leaves="default:leaves",
3642 trunk_type="single",
3645 fruit="default:apple"
3647 minetest.spawn_tree(pos,apple_tree)
3652 ### Object Properties
3657 collide_with_objects = true, -- collide with other objects if physical=true
3659 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
3660 visual = "cube"/"sprite"/"upright_sprite"/"mesh"/"wielditem",
3661 visual_size = {x=1, y=1},
3663 textures = {}, -- number of required textures depends on visual
3664 colors = {}, -- number of required colors depends on visual
3665 spritediv = {x=1, y=1},
3666 initial_sprite_basepos = {x=0, y=0},
3668 makes_footstep_sound = false,
3669 automatic_rotate = false,
3671 automatic_face_movement_dir = 0.0,
3672 -- ^ automatically set yaw to movement direction; offset in degrees; false to disable
3673 automatic_face_movement_max_rotation_per_sec = -1,
3674 -- ^ limit automatic rotation to this value in degrees per second. values < 0 no limit
3675 backface_culling = true, -- false to disable backface_culling for model
3676 nametag = "", -- by default empty, for players their name is shown if empty
3677 nametag_color = <color>, -- sets color of nametag as ColorSpec
3678 infotext = "", -- by default empty, text to be shown when pointed at object
3681 ### Entity definition (`register_entity`)
3684 -- Deprecated: Everything in object properties is read directly from here
3686 initial_properties = --[[<initial object properties>]],
3688 on_activate = function(self, staticdata, dtime_s),
3689 on_step = function(self, dtime),
3690 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
3691 on_rightclick = function(self, clicker),
3692 get_staticdata = function(self),
3693 -- ^ Called sometimes; the string returned is passed to on_activate when
3694 -- the entity is re-activated from static state
3696 -- Also you can define arbitrary member variables here (see item definition for
3698 _custom_field = whatever,
3701 ### ABM (ActiveBlockModifier) definition (`register_abm`)
3704 label = "Lava cooling",
3705 -- ^ Descriptive label for profiling purposes (optional).
3706 -- Definitions with identical labels will be listed as one.
3707 -- In the following two fields, also group:groupname will work.
3708 nodenames = {"default:lava_source"},
3709 neighbors = {"default:water_source", "default:water_flowing"}, -- Any of these --[[
3710 ^ If left out or empty, any neighbor will do ]]
3711 interval = 1.0, -- Operation interval in seconds
3712 chance = 1, -- Chance of trigger per-node per-interval is 1.0 / this
3713 catch_up = true, -- If true, catch-up behaviour is enabled --[[
3714 ^ The chance value is temporarily reduced when returning to
3715 an area to simulate time lost by the area being unattended.
3716 ^ Note chance value can often be reduced to 1 ]]
3717 action = func(pos, node, active_object_count, active_object_count_wider),
3720 ### LBM (LoadingBlockModifier) definition (`register_lbm`)
3723 label = "Upgrade legacy doors",
3724 -- ^ Descriptive label for profiling purposes (optional).
3725 -- Definitions with identical labels will be listed as one.
3726 name = "modname:replace_legacy_door",
3727 nodenames = {"default:lava_source"},
3728 -- ^ List of node names to trigger the LBM on.
3729 -- Also non-registered nodes will work.
3730 -- Groups (as of group:groupname) will work as well.
3731 run_at_every_load = false,
3732 -- ^ Whether to run the LBM's action every time a block gets loaded,
3733 -- and not just for blocks that were saved last time before LBMs were
3734 -- introduced to the world.
3735 action = func(pos, node),
3738 ### Item definition (`register_node`, `register_craftitem`, `register_tool`)
3741 description = "Steel Axe",
3742 groups = {}, -- key = name, value = rating; rating = 1..3.
3743 if rating not applicable, use 1.
3744 e.g. {wool = 1, fluffy = 3}
3745 {soil = 2, outerspace = 1, crumbly = 1}
3746 {bendy = 2, snappy = 1},
3747 {hard = 1, metal = 1, spikes = 1}
3748 inventory_image = "default_tool_steelaxe.png",
3752 ^ An image file containing the palette of a node.
3753 ^ You can set the currently used color as the
3754 ^ "palette_index" field of the item stack metadata.
3755 ^ The palette is always stretched to fit indices
3756 ^ between 0 and 255, to ensure compatibility with
3757 ^ "colorfacedir" and "colorwallmounted" nodes.
3759 color = "0xFFFFFFFF",
3761 ^ The color of the item. The palette overrides this.
3763 wield_scale = {x = 1, y = 1, z = 1},
3766 liquids_pointable = false,
3767 tool_capabilities = {
3768 full_punch_interval = 1.0,
3772 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00}, uses = 20, maxlevel = 2},
3774 damage_groups = {groupname = damage},
3776 node_placement_prediction = nil,
3778 ^ If nil and item is node, prediction is made automatically
3779 ^ If nil and item is not a node, no prediction is made
3780 ^ If "" and item is anything, no prediction is made
3781 ^ Otherwise should be name of node which the client immediately places
3782 on ground when the player places the item. Server will always update
3783 actual result to client in a short moment.
3786 breaks = "default_tool_break", -- tools only
3787 place = --[[<SimpleSoundSpec>]],
3790 on_place = func(itemstack, placer, pointed_thing),
3792 ^ Shall place item and return the leftover itemstack
3793 ^ The placer may be any ObjectRef or nil.
3794 ^ default: minetest.item_place ]]
3795 on_secondary_use = func(itemstack, user, pointed_thing),
3797 ^ Same as on_place but called when pointing at nothing.
3798 ^ The user may be any ObjectRef or nil.
3799 ^ pointed_thing : always { type = "nothing" }
3801 on_drop = func(itemstack, dropper, pos),
3803 ^ Shall drop item and return the leftover itemstack
3804 ^ The dropper may be any ObjectRef or nil.
3805 ^ default: minetest.item_drop ]]
3806 on_use = func(itemstack, user, pointed_thing),
3809 ^ Function must return either nil if no item shall be removed from
3810 inventory, or an itemstack to replace the original itemstack.
3811 e.g. itemstack:take_item(); return itemstack
3812 ^ Otherwise, the function is free to do what it wants.
3813 ^ The user may be any ObjectRef or nil.
3814 ^ The default functions handle regular use cases.
3816 after_use = func(itemstack, user, node, digparams),
3819 ^ If defined, should return an itemstack and will be called instead of
3820 wearing out the tool. If returns nil, does nothing.
3821 If after_use doesn't exist, it is the same as:
3822 function(itemstack, user, node, digparams)
3823 itemstack:add_wear(digparams.wear)
3826 ^ The user may be any ObjectRef or nil.
3828 _custom_field = whatever,
3830 ^ Add your own custom fields. By convention, all custom field names
3831 should start with `_` to avoid naming collisions with future engine
3838 * `{name="image.png", animation={Tile Animation definition}}`
3839 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
3840 tileable_horizontal=bool}`
3841 * backface culling enabled by default for most nodes
3842 * tileable flags are info for shaders, how they should treat texture
3843 when displacement mapping is used
3844 Directions are from the point of view of the tile texture,
3845 not the node it's on
3846 * `{name="image.png", color=ColorSpec}`
3847 * the texture's color will be multiplied with this color.
3848 * the tile's color overrides the owning node's color in all cases.
3849 * deprecated, yet still supported field names:
3852 ### Tile animation definition
3855 type = "vertical_frames",
3857 -- ^ specify width of a frame in pixels
3859 -- ^ specify height of a frame in pixels
3861 -- ^ specify full loop length
3867 -- ^ specify width in number of frames
3869 -- ^ specify height in number of frames
3871 -- ^ specify length of a single frame
3874 ### Node definition (`register_node`)
3877 -- <all fields allowed in item definitions>,
3879 drawtype = "normal", -- See "Node drawtypes"
3880 visual_scale = 1.0, --[[
3881 ^ Supported for drawtypes "plantlike", "signlike", "torchlike",
3882 ^ "firelike", "mesh".
3883 ^ For plantlike and firelike, the image will start at the bottom of the
3884 ^ node, for the other drawtypes the image will be centered on the node.
3885 ^ Note that positioning for "torchlike" may still change. ]]
3886 tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
3887 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
3888 ^ List can be shortened to needed length ]]
3889 special_tiles = {tile definition 1, Tile definition 2}, --[[
3890 ^ Special textures of node; used rarely (old field name: special_materials)
3891 ^ List can be shortened to needed length ]]
3892 color = ColorSpec, --[[
3893 ^ The node's original color will be multiplied with this color.
3894 ^ If the node has a palette, then this setting only has an effect
3895 ^ in the inventory and on the wield item. ]]
3896 use_texture_alpha = false, -- Use texture's alpha channel
3897 palette = "palette.png", --[[
3898 ^ The node's `param2` is used to select a pixel from the image
3899 ^ (pixels are arranged from left to right and from top to bottom).
3900 ^ The node's color will be multiplied with the selected pixel's
3901 ^ color. Tiles can override this behavior.
3902 ^ Only when `paramtype2` supports palettes. ]]
3903 post_effect_color = "green#0F", -- If player is inside node, see "ColorSpec"
3904 paramtype = "none", -- See "Nodes" --[[
3905 ^ paramtype = "light" allows light to propagate from or through the node with light value
3906 ^ falling by 1 per node. This line is essential for a light source node to spread its light. ]]
3907 paramtype2 = "none", -- See "Nodes"
3908 place_param2 = nil, -- Force value for param2 when player places node
3909 is_ground_content = true, -- If false, the cave generator will not carve through this
3910 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
3911 walkable = true, -- If true, objects collide with node
3912 pointable = true, -- If true, can be pointed at
3913 diggable = true, -- If false, can never be dug
3914 climbable = false, -- If true, can be climbed on (ladder)
3915 buildable_to = false, -- If true, placed nodes can replace this node
3916 floodable = false, -- If true, liquids flow into and replace this node
3917 liquidtype = "none", -- "none"/"source"/"flowing"
3918 liquid_alternative_flowing = "", -- Flowing version of source liquid
3919 liquid_alternative_source = "", -- Source version of flowing liquid
3920 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
3921 liquid_renewable = true, --[[
3922 ^ If true, a new liquid source can be created by placing two or more sources nearby ]]
3924 ^ Block contains level in param2. Value is default level, used for snow.
3925 ^ Don't forget to use "leveled" type nodebox. ]]
3926 liquid_range = 8, -- number of flowing nodes around source (max. 8)
3927 drowning = 0, -- Player will take this amount of damage if no bubbles are left
3928 light_source = 0, --[[
3929 ^ Amount of light emitted by node.
3930 ^ To set the maximum (currently 14), use the value 'minetest.LIGHT_MAX'.
3931 ^ A value outside the range 0 to minetest.LIGHT_MAX causes undefined behavior.]]
3932 damage_per_second = 0, -- If player is inside node, this damage is caused
3933 node_box = {type="regular"}, -- See "Node boxes"
3934 connects_to = nodenames, --[[
3935 * Used for nodebox nodes with the type == "connected"
3936 * Specifies to what neighboring nodes connections will be drawn
3937 * e.g. `{"group:fence", "default:wood"}` or `"default:stone"` ]]
3938 connect_sides = { "top", "bottom", "front", "left", "back", "right" }, --[[
3939 ^ Tells connected nodebox nodes to connect only to these sides of this node. ]]
3941 selection_box = {type="regular"}, -- See "Node boxes" --[[
3942 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used. ]]
3943 legacy_facedir_simple = false, -- Support maps made in and before January 2012
3944 legacy_wallmounted = false, -- Support maps made in and before January 2012
3946 footstep = <SimpleSoundSpec>,
3947 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
3948 dug = <SimpleSoundSpec>,
3949 place = <SimpleSoundSpec>,
3950 place_failed = <SimpleSoundSpec>,
3952 drop = "", -- Name of dropped node when dug. Default is the node itself.
3955 max_items = 1, -- Maximum number of items to drop.
3956 items = { -- Choose max_items randomly from this list.
3958 items = {"foo:bar", "baz:frob"}, -- Items to drop.
3959 rarity = 1, -- Probability of dropping is 1 / rarity.
3964 on_construct = func(pos), --[[
3965 ^ Node constructor; called after adding node
3966 ^ Can set up metadata and stuff like that
3967 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3969 on_destruct = func(pos), --[[
3970 ^ Node destructor; called before removing node
3971 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3973 after_destruct = func(pos, oldnode), --[[
3974 ^ Node destructor; called after removing node
3975 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3978 after_place_node = func(pos, placer, itemstack, pointed_thing) --[[
3979 ^ Called after constructing node when node was placed using
3980 minetest.item_place_node / minetest.place_node
3981 ^ If return true no item is taken from itemstack
3983 after_dig_node = func(pos, oldnode, oldmetadata, digger), --[[
3984 ^ oldmetadata is in table format
3985 ^ Called after destructing node when node was dug using
3986 minetest.node_dig / minetest.dig_node
3988 can_dig = function(pos, [player]) --[[
3989 ^ returns true if node can be dug, or false if not
3992 on_punch = func(pos, node, puncher, pointed_thing), --[[
3993 ^ default: minetest.node_punch
3994 ^ By default: Calls minetest.register_on_punchnode callbacks ]]
3995 on_rightclick = func(pos, node, clicker, itemstack, pointed_thing), --[[
3997 ^ if defined, itemstack will hold clicker's wielded item
3998 ^ Shall return the leftover itemstack
3999 ^ Note: pointed_thing can be nil, if a mod calls this function ]]
4001 on_dig = func(pos, node, digger), --[[
4002 ^ default: minetest.node_dig
4003 ^ By default: checks privileges, wears out tool and removes node ]]
4005 on_timer = function(pos,elapsed), --[[
4007 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
4008 ^ elapsed is the total time passed since the timer was started
4009 ^ return true to run the timer for another cycle with the same timeout value ]]
4011 on_receive_fields = func(pos, formname, fields, sender), --[[
4012 ^ fields = {name1 = value1, name2 = value2, ...}
4013 ^ Called when an UI form (e.g. sign text input) returns data
4016 allow_metadata_inventory_move = func(pos, from_list, from_index,
4017 to_list, to_index, count, player), --[[
4018 ^ Called when a player wants to move items inside the inventory
4019 ^ Return value: number of items allowed to move ]]
4021 allow_metadata_inventory_put = func(pos, listname, index, stack, player), --[[
4022 ^ Called when a player wants to put something into the inventory
4023 ^ Return value: number of items allowed to put
4024 ^ Return value: -1: Allow and don't modify item count in inventory ]]
4026 allow_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
4027 ^ Called when a player wants to take something out of the inventory
4028 ^ Return value: number of items allowed to take
4029 ^ Return value: -1: Allow and don't modify item count in inventory ]]
4031 on_metadata_inventory_move = func(pos, from_list, from_index,
4032 to_list, to_index, count, player),
4033 on_metadata_inventory_put = func(pos, listname, index, stack, player),
4034 on_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
4035 ^ Called after the actual action has happened, according to what was allowed.
4036 ^ No return value ]]
4038 on_blast = func(pos, intensity), --[[
4039 ^ intensity: 1.0 = mid range of regular TNT
4040 ^ If defined, called when an explosion touches the node, instead of
4041 removing the node ]]
4044 ### Recipe for `register_craft` (shaped)
4047 output = 'default:pick_stone',
4049 {'default:cobble', 'default:cobble', 'default:cobble'},
4050 {'', 'default:stick', ''},
4051 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
4053 replacements = --[[<optional list of item pairs,
4054 replace one input item with another item on crafting>]]
4057 ### Recipe for `register_craft` (shapeless)
4061 output = 'mushrooms:mushroom_stew',
4064 "mushrooms:mushroom_brown",
4065 "mushrooms:mushroom_red",
4067 replacements = --[[<optional list of item pairs,
4068 replace one input item with another item on crafting>]]
4071 ### Recipe for `register_craft` (tool repair)
4074 type = "toolrepair",
4075 additional_wear = -0.02,
4078 ### Recipe for `register_craft` (cooking)
4082 output = "default:glass",
4083 recipe = "default:sand",
4087 ### Recipe for `register_craft` (furnace fuel)
4091 recipe = "default:leaves",
4095 ### Ore definition (`register_ore`)
4098 ore_type = "scatter", -- See "Ore types"
4099 ore = "default:stone_with_coal",
4100 wherein = "default:stone",
4101 -- ^ a list of nodenames is supported too
4102 clust_scarcity = 8*8*8,
4103 -- ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
4104 -- ^ This value should be *MUCH* higher than your intuition might tell you!
4106 -- ^ Number of ores in a cluster
4108 -- ^ Size of the bounding box of the cluster
4109 -- ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
4113 -- ^ Attributes for this ore generation
4114 noise_threshold = 0.5,
4115 -- ^ If noise is above this threshold, ore is placed. Not needed for a uniform distribution
4116 noise_params = {offset=0, scale=1, spread={x=100, y=100, z=100}, seed=23, octaves=3, persist=0.70}
4117 -- ^ NoiseParams structure describing the perlin noise used for ore distribution.
4118 -- ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
4119 random_factor = 1.0,
4120 -- ^ Multiplier of the randomness contribution to the noise value at any
4121 -- given point to decide if ore should be placed. Set to 0 for solid veins.
4122 -- ^ This parameter is only valid for ore_type == "vein".
4123 biomes = {"desert", "rainforest"}
4124 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
4125 -- ^ and ignored if the Mapgen being used does not support biomes.
4126 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
4129 ### Biome definition (`register_biome`)
4132 The Biome API is still in an experimental phase and subject to change.
4136 node_dust = "default:snow",
4137 -- ^ Node dropped onto upper surface after all else is generated.
4138 node_top = "default:dirt_with_snow",
4140 -- ^ Node forming surface layer of biome and thickness of this layer.
4141 node_filler = "default:permafrost",
4143 -- ^ Node forming lower layer of biome and thickness of this layer.
4144 node_stone = "default:bluestone",
4145 -- ^ Node that replaces all stone nodes between roughly y_min and y_max.
4146 node_water_top = "default:ice",
4147 depth_water_top = 10,
4148 -- ^ Node forming a surface layer in seawater with the defined thickness.
4150 -- ^ Node that replaces all seawater nodes not in the defined surface layer.
4151 node_river_water = "default:ice",
4152 -- ^ Node that replaces river water in mapgens that use default:river_water.
4153 node_riverbed = "default:gravel",
4155 -- ^ Node placed under river water and thickness of this layer.
4158 -- ^ Lower and upper limits for biome.
4159 -- ^ Because biome is not recalculated for every node in a node column
4160 -- ^ some biome materials can exceed their limits, especially stone.
4161 -- ^ For each node column in a mapchunk, biome is only recalculated at column
4162 -- ^ top and at each of these surfaces:
4163 -- ^ Ground below air, water below air, ground below water.
4164 -- ^ The selected biome then stays in effect for all nodes below until
4165 -- ^ column base or the next biome recalculation.
4167 humidity_point = 50,
4168 -- ^ Characteristic average temperature and humidity for the biome.
4169 -- ^ These values create 'biome points' on a voronoi diagram that has heat
4170 -- ^ and humidity as axes. The resulting voronoi cells determine which
4171 -- ^ heat/humidity points belong to which biome, and therefore determine
4172 -- ^ the area and location of each biome in the world.
4173 -- ^ The biome points need to be carefully and evenly spaced on the voronoi
4174 -- ^ diagram to result in roughly equal size biomes.
4175 -- ^ Heat and humidity have average values of 50, vary mostly between
4176 -- ^ 0 and 100 but also often exceed these values.
4177 -- ^ Heat is not in degrees celcius, both values are abstract.
4180 ### Decoration definition (`register_decoration`)
4183 deco_type = "simple", -- See "Decoration types"
4184 place_on = "default:dirt_with_grass",
4185 -- ^ Node (or list of nodes) that the decoration can be placed on
4187 -- ^ Size of divisions made in the chunk being generated.
4188 -- ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
4190 -- ^ Ratio of the area to be uniformly filled by the decoration.
4191 -- ^ Used only if noise_params is not specified.
4192 noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
4193 -- ^ NoiseParams structure describing the perlin noise used for decoration distribution.
4194 -- ^ The result of this is multiplied by the 2d area of the division being decorated.
4195 biomes = {"Oceanside", "Hills", "Plains"},
4196 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
4197 -- ^ and ignored if the Mapgen being used does not support biomes.
4198 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
4201 -- ^ Minimum and maximum `y` positions these decorations can be generated at.
4202 -- ^ This parameter refers to the `y` position of the decoration base, so
4203 -- the actual maximum height would be `height_max + size.Y`.
4204 spawn_by = "default:water",
4205 -- ^ Node (or list of nodes) that the decoration only spawns next to.
4206 -- ^ Checks two horizontal planes of neighbouring nodes (including diagonal neighbours),
4207 -- ^ one plane at Y = surface and one plane at Y = surface = + 1.
4209 -- ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
4210 -- ^ If absent or -1, decorations occur next to any nodes.
4211 flags = "liquid_surface, force_placement",
4212 -- ^ Flags for all decoration types.
4213 -- ^ "liquid_surface": Instead of placement on the highest solid surface
4214 -- ^ in a mapchunk column, placement is on the highest liquid surface.
4215 -- ^ Placement is disabled if solid nodes are found above the liquid surface.
4216 -- ^ "force_placement": Nodes other than "air" and "ignore" are replaced by the decoration.
4218 ----- Simple-type parameters
4219 decoration = "default:grass",
4220 -- ^ The node name used as the decoration.
4221 -- ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
4223 -- ^ Number of nodes high the decoration is made.
4224 -- ^ If height_max is not 0, this is the lower bound of the randomly selected height.
4226 -- ^ Number of nodes the decoration can be at maximum.
4227 -- ^ If absent, the parameter 'height' is used as a constant.
4229 -- ^ Param2 value of placed decoration node.
4231 ----- Schematic-type parameters
4232 schematic = "foobar.mts",
4233 -- ^ If schematic is a string, it is the filepath relative to the current working directory of the
4234 -- ^ specified Minetest schematic file.
4235 -- ^ - OR -, could be the ID of a previously registered schematic
4236 -- ^ - OR -, could instead be a table containing two mandatory fields, size and data,
4237 -- ^ and an optional table yslice_prob:
4239 size = {x=4, y=6, z=4},
4241 {name="default:cobble", param1=255, param2=0},
4242 {name="default:dirt_with_grass", param1=255, param2=0},
4243 {name="ignore", param1=255, param2=0},
4244 {name="air", param1=255, param2=0},
4253 -- ^ See 'Schematic specifier' for details.
4254 replacements = {["oldname"] = "convert_to", ...},
4255 flags = "place_center_x, place_center_y, place_center_z",
4256 -- ^ Flags for schematic decorations. See 'Schematic attributes'.
4257 rotation = "90" -- rotate schematic 90 degrees on placement
4258 -- ^ Rotation can be "0", "90", "180", "270", or "random".
4261 ### Chat command definition (`register_chatcommand`)
4264 params = "<name> <privilege>", -- Short parameter description
4265 description = "Remove privilege from player", -- Full description
4266 privs = {privs=true}, -- Require the "privs" privilege to run
4267 func = function(name, param), -- Called when command is run.
4268 -- Returns boolean success and text output.
4271 ### Detached inventory callbacks
4274 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
4275 -- ^ Called when a player wants to move items inside the inventory
4276 -- ^ Return value: number of items allowed to move
4278 allow_put = func(inv, listname, index, stack, player),
4279 -- ^ Called when a player wants to put something into the inventory
4280 -- ^ Return value: number of items allowed to put
4281 -- ^ Return value: -1: Allow and don't modify item count in inventory
4283 allow_take = func(inv, listname, index, stack, player),
4284 -- ^ Called when a player wants to take something out of the inventory
4285 -- ^ Return value: number of items allowed to take
4286 -- ^ Return value: -1: Allow and don't modify item count in inventory
4288 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
4289 on_put = func(inv, listname, index, stack, player),
4290 on_take = func(inv, listname, index, stack, player),
4291 -- ^ Called after the actual action has happened, according to what was allowed.
4292 -- ^ No return value
4295 ### HUD Definition (`hud_add`, `hud_get`)
4298 hud_elem_type = "image", -- see HUD element types
4299 -- ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
4300 position = {x=0.5, y=0.5},
4301 -- ^ Left corner position of element
4307 -- ^ Selected item in inventory. 0 for no item selected.
4309 -- ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
4310 alignment = {x=0, y=0},
4311 -- ^ See "HUD Element Types"
4312 offset = {x=0, y=0},
4313 -- ^ See "HUD Element Types"
4314 size = { x=100, y=100 },
4315 -- ^ Size of element in pixels
4318 ### Particle definition (`add_particle`)
4321 pos = {x=0, y=0, z=0},
4322 velocity = {x=0, y=0, z=0},
4323 acceleration = {x=0, y=0, z=0},
4324 -- ^ Spawn particle at pos with velocity and acceleration
4326 -- ^ Disappears after expirationtime seconds
4328 collisiondetection = false,
4329 -- ^ collisiondetection: if true collides with physical objects
4330 collision_removal = false,
4331 -- ^ collision_removal: if true then particle is removed when it collides,
4332 -- ^ requires collisiondetection = true to have any effect
4334 -- ^ vertical: if true faces player using y axis only
4335 texture = "image.png",
4336 -- ^ Uses texture (string)
4337 playername = "singleplayer",
4338 -- ^ optional, if specified spawns particle only on the player's client
4339 animation = {Tile Animation definition},
4340 -- ^ optional, specifies how to animate the particle texture
4342 -- ^ optional, specify particle self-luminescence in darkness
4346 ### `ParticleSpawner` definition (`add_particlespawner`)
4351 -- ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
4352 minpos = {x=0, y=0, z=0},
4353 maxpos = {x=0, y=0, z=0},
4354 minvel = {x=0, y=0, z=0},
4355 maxvel = {x=0, y=0, z=0},
4356 minacc = {x=0, y=0, z=0},
4357 maxacc = {x=0, y=0, z=0},
4362 -- ^ The particle's properties are random values in between the bounds:
4363 -- ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
4364 -- ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
4365 collisiondetection = false,
4366 -- ^ collisiondetection: if true uses collision detection
4367 collision_removal = false,
4368 -- ^ collision_removal: if true then particle is removed when it collides,
4369 -- ^ requires collisiondetection = true to have any effect
4370 attached = ObjectRef,
4371 -- ^ attached: if defined, particle positions, velocities and accelerations
4372 -- ^ are relative to this object's position and yaw.
4374 -- ^ vertical: if true faces player using y axis only
4375 texture = "image.png",
4376 -- ^ Uses texture (string)
4377 playername = "singleplayer"
4378 -- ^ Playername is optional, if specified spawns particle only on the player's client
4381 ### `HTTPRequest` definition (`HTTPApiTable.fetch_async`, `HTTPApiTable.fetch_async`)
4384 url = "http://example.org",
4386 -- ^ Timeout for connection in seconds. Default is 3 seconds.
4387 post_data = "Raw POST request data string" OR { field1 = "data1", field2 = "data2" },
4388 -- ^ Optional, if specified a POST request with post_data is performed.
4389 -- ^ Accepts both a string and a table. If a table is specified, encodes table
4390 -- ^ as x-www-form-urlencoded key-value pairs.
4391 -- ^ If post_data ist not specified, a GET request is performed instead.
4392 user_agent = "ExampleUserAgent",
4393 -- ^ Optional, if specified replaces the default minetest user agent with given string
4394 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
4395 -- ^ Optional, if specified adds additional headers to the HTTP request. You must make sure
4396 -- ^ that the header strings follow HTTP specification ("Key: Value").
4398 -- ^ Optional, if true performs a multipart HTTP request. Default is false.
4401 ### `HTTPRequestResult` definition (`HTTPApiTable.fetch` callback, `HTTPApiTable.fetch_async_get`)
4405 -- ^ If true, the request has finished (either succeeded, failed or timed out)
4407 -- ^ If true, the request was succesful
4409 -- ^ If true, the request timed out
4411 -- ^ HTTP status code