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
424 Only Ogg Vorbis files are supported.
426 For positional playing of sounds, only single-channel (mono) files are
427 supported. Otherwise OpenAL will play them non-positionally.
429 Mods should generally prefix their sounds with `modname_`, e.g. given
430 the mod name "`foomod`", a sound could be called:
434 Sounds are referred to by their name with a dot, a single digit and the
435 file extension stripped out. When a sound is played, the actual sound file
436 is chosen randomly from the matching sounds.
438 When playing the sound `foomod_foosound`, the sound is chosen randomly
439 from the available ones of the following files:
441 * `foomod_foosound.ogg`
442 * `foomod_foosound.0.ogg`
443 * `foomod_foosound.1.ogg`
445 * `foomod_foosound.9.ogg`
447 Examples of sound parameter tables:
449 -- Play locationless on all clients
451 gain = 1.0, -- default
453 -- Play locationless to one player
456 gain = 1.0, -- default
458 -- Play locationless to one player, looped
461 gain = 1.0, -- default
464 -- Play in a location
466 pos = {x = 1, y = 2, z = 3},
467 gain = 1.0, -- default
468 max_hear_distance = 32, -- default, uses an euclidean metric
470 -- Play connected to an object, looped
472 object = <an ObjectRef>,
473 gain = 1.0, -- default
474 max_hear_distance = 32, -- default, uses an euclidean metric
478 Looped sounds must either be connected to an object or played locationless to
479 one player using `to_player = name,`
481 ### `SimpleSoundSpec`
483 * e.g. `"default_place_node"`
485 * e.g. `{name = "default_place_node"}`
486 * e.g. `{name = "default_place_node", gain = 1.0}`
488 Registered definitions of stuff
489 -------------------------------
490 Anything added using certain `minetest.register_*` functions get added to
491 the global `minetest.registered_*` tables.
493 * `minetest.register_entity(name, prototype table)`
494 * added to `minetest.registered_entities[name]`
496 * `minetest.register_node(name, node definition)`
497 * added to `minetest.registered_items[name]`
498 * added to `minetest.registered_nodes[name]`
500 * `minetest.register_tool(name, item definition)`
501 * added to `minetest.registered_items[name]`
503 * `minetest.register_craftitem(name, item definition)`
504 * added to `minetest.registered_items[name]`
506 * `minetest.unregister_item(name)`
507 * Unregisters the item name from engine, and deletes the entry with key
508 * `name` from `minetest.registered_items` and from the associated item
509 * table according to its nature: minetest.registered_nodes[] etc
511 * `minetest.register_biome(biome definition)`
512 * returns an integer uniquely identifying the registered biome
513 * added to `minetest.registered_biome` with the key of `biome.name`
514 * if `biome.name` is nil, the key is the returned ID
516 * `minetest.register_ore(ore definition)`
517 * returns an integer uniquely identifying the registered ore
518 * added to `minetest.registered_ores` with the key of `ore.name`
519 * if `ore.name` is nil, the key is the returned ID
521 * `minetest.register_decoration(decoration definition)`
522 * returns an integer uniquely identifying the registered decoration
523 * added to `minetest.registered_decorations` with the key of `decoration.name`
524 * if `decoration.name` is nil, the key is the returned ID
526 * `minetest.register_schematic(schematic definition)`
527 * returns an integer uniquely identifying the registered schematic
528 * added to `minetest.registered_schematic` with the key of `schematic.name`
529 * if `schematic.name` is nil, the key is the returned ID
530 * if the schematic is loaded from a file, schematic.name is set to the filename
531 * if the function is called when loading the mod, and schematic.name is a relative
532 path, then the current mod path will be prepended to the schematic filename
534 * `minetest.clear_registered_biomes()`
535 * clears all biomes currently registered
537 * `minetest.clear_registered_ores()`
538 * clears all ores currently registered
540 * `minetest.clear_registered_decorations()`
541 * clears all decorations currently registered
543 * `minetest.clear_registered_schematics()`
544 * clears all schematics currently registered
546 Note that in some cases you will stumble upon things that are not contained
547 in these tables (e.g. when a mod has been removed). Always check for
548 existence before trying to access the fields.
550 Example: If you want to check the drawtype of a node, you could do:
552 local function get_nodedef_field(nodename, fieldname)
553 if not minetest.registered_nodes[nodename] then
556 return minetest.registered_nodes[nodename][fieldname]
558 local drawtype = get_nodedef_field(nodename, "drawtype")
560 Example: `minetest.get_item_group(name, group)` has been implemented as:
562 function minetest.get_item_group(name, group)
563 if not minetest.registered_items[name] or not
564 minetest.registered_items[name].groups[group] then
567 return minetest.registered_items[name].groups[group]
572 Nodes are the bulk data of the world: cubes and other things that take the
573 space of a cube. Huge amounts of them are handled efficiently, but they
576 The definition of a node is stored and can be accessed by name in
578 minetest.registered_nodes[node.name]
580 See "Registered definitions of stuff".
582 Nodes are passed by value between Lua and the engine.
583 They are represented by a table:
585 {name="name", param1=num, param2=num}
587 `param1` and `param2` are 8-bit integers. The engine uses them for certain
588 automated functions. If you don't use these functions, you can use them to
589 store arbitrary values.
591 The functions of `param1` and `param2` are determined by certain fields in the
594 `param1` is reserved for the engine when `paramtype != "none"`:
597 ^ The value stores light with and without sun in its upper and lower 4 bits
598 respectively. Allows light to propagate from or through the node with
599 light value falling by 1 per node. This is essential for a light source
600 node to spread its light.
602 `param2` is reserved for the engine when any of these are used:
604 liquidtype == "flowing"
605 ^ The level and some flags of the liquid is stored in param2
606 drawtype == "flowingliquid"
607 ^ The drawn liquid level is read from param2
608 drawtype == "torchlike"
609 drawtype == "signlike"
610 paramtype2 == "wallmounted"
611 ^ The rotation of the node is stored in param2. You can make this value
612 by using minetest.dir_to_wallmounted().
613 paramtype2 == "facedir"
614 ^ The rotation of the node is stored in param2. Furnaces and chests are
615 rotated this way. Can be made by using minetest.dir_to_facedir().
617 facedir / 4 = axis direction:
618 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
619 facedir modulo 4 = rotation around that axis
620 paramtype2 == "leveled"
621 paramtype2 == "degrotate"
622 ^ The rotation of this node is stored in param2. Plants are rotated this way.
623 Values range 0 - 179. The value stored in param2 is multiplied by two to
624 get the actual rotation of the node.
625 paramtype2 == "meshoptions"
626 ^ Only valid for "plantlike". The value of param2 becomes a bitfield which can
627 be used to change how the client draws plantlike nodes. Bits 0, 1 and 2 form
628 a mesh selector. Currently the following meshes are choosable:
629 0 = a "x" shaped plant (ordinary plant)
630 1 = a "+" shaped plant (just rotated 45 degrees)
631 2 = a "*" shaped plant with 3 faces instead of 2
632 3 = a "#" shaped plant with 4 faces instead of 2
633 4 = a "#" shaped plant with 4 faces that lean outwards
634 5-7 are unused and reserved for future meshes.
635 Bits 3 through 7 are optional flags that can be combined and give these
637 bit 3 (0x08) - Makes the plant slightly vary placement horizontally
638 bit 4 (0x10) - Makes the plant mesh 1.4x larger
639 bit 5 (0x20) - Moves each face randomly a small bit down (1/8 max)
640 bits 6-7 are reserved for future use.
641 paramtype2 == "color"
642 ^ `param2` tells which color is picked from the palette.
643 The palette should have 256 pixels.
644 paramtype2 == "colorfacedir"
645 ^ Same as `facedir`, but with colors.
646 The first three bits of `param2` tells which color
647 is picked from the palette.
648 The palette should have 8 pixels.
649 paramtype2 == "colorwallmounted"
650 ^ Same as `wallmounted`, but with colors.
651 The first five bits of `param2` tells which color
652 is picked from the palette.
653 The palette should have 32 pixels.
657 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
660 ^ defines list of collision boxes for the node. If empty, collision boxes
661 will be the same as nodeboxes, in case of any other nodes will be full cube
662 as in the example above.
664 Nodes can also contain extra data. See "Node Metadata".
668 There are a bunch of different looking node types.
670 Look for examples in `games/minimal` or `games/minetest_game`.
678 * `glasslike_framed_optional`
680 * `allfaces_optional`
687 * `nodebox` -- See below. (**Experimental!**)
688 * `mesh` -- use models for nodes
690 `*_optional` drawtypes need less rendering time if deactivated (always client side).
694 Node selection boxes are defined using "node boxes"
696 The `nodebox` node drawtype allows defining visual of nodes consisting of
697 arbitrary number of boxes. It allows defining stuff like stairs. Only the
698 `fixed` and `leveled` box type is supported for these.
700 Please note that this is still experimental, and may be incompatibly
701 changed in the future.
703 A nodebox is defined as any of:
706 -- A normal cube; the default in most things
710 -- A fixed box (facedir param2 is used, if applicable)
712 fixed = box OR {box1, box2, ...}
715 -- A box like the selection box for torches
716 -- (wallmounted param2 is used, if applicable)
717 type = "wallmounted",
723 -- A node that has optional boxes depending on neighbouring nodes'
724 -- presence and type. See also `connects_to`.
726 fixed = box OR {box1, box2, ...}
727 connect_top = box OR {box1, box2, ...}
728 connect_bottom = box OR {box1, box2, ...}
729 connect_front = box OR {box1, box2, ...}
730 connect_left = box OR {box1, box2, ...}
731 connect_back = box OR {box1, box2, ...}
732 connect_right = box OR {box1, box2, ...}
735 A `box` is defined as:
737 {x1, y1, z1, x2, y2, z2}
739 A box of a regular node would look like:
741 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
743 `type = "leveled"` is same as `type = "fixed"`, but `y2` will be automatically
744 set to level from `param2`.
749 If drawtype `mesh` is used, tiles should hold model materials textures.
750 Only static meshes are implemented.
751 For supported model formats see Irrlicht engine documentation.
756 Noise Parameters, or commonly called "`NoiseParams`", define the properties of
760 Offset that the noise is translated by (i.e. added) after calculation.
763 Factor that the noise is scaled by (i.e. multiplied) after calculation.
766 Vector containing values by which each coordinate is divided by before calculation.
767 Higher spread values result in larger noise features.
769 A value of `{x=250, y=250, z=250}` is common.
772 Random seed for the noise. Add the world seed to a seed offset for world-unique noise.
773 In the case of `minetest.get_perlin()`, this value has the world seed automatically added.
776 Number of times the noise gradient is accumulated into the noise.
778 Increase this number to increase the amount of detail in the resulting noise.
780 A value of `6` is common.
783 Factor by which the effect of the noise gradient function changes with each successive octave.
785 Values less than `1` make the details of successive octaves' noise diminish, while values
786 greater than `1` make successive octaves stronger.
788 A value of `0.6` is common.
791 Factor by which the noise feature sizes change with each successive octave.
793 A value of `2.0` is common.
796 Leave this field unset for no special handling.
798 Currently supported are `defaults`, `eased` and `absvalue`.
801 Specify this if you would like to keep auto-selection of eased/not-eased while specifying
805 Maps noise gradient values onto a quintic S-curve before performing interpolation.
806 This results in smooth, rolling noise. Disable this (`noeased`) for sharp-looking noise.
807 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is not eased.
810 Accumulates the absolute value of each noise gradient result.
812 Noise parameters format example for 2D or 3D perlin noise or perlin noise maps:
816 spread = {x=500, y=500, z=500},
821 flags = "defaults, absvalue"
823 ^ A single noise parameter table can be used to get 2D or 3D noise,
824 when getting 2D noise spread.z is ignored.
829 These tell in what manner the ore is generated.
831 All default ores are of the uniformly-distributed scatter type.
834 Randomly chooses a location and generates a cluster of ore.
836 If `noise_params` is specified, the ore will be placed if the 3D perlin noise at
837 that point is greater than the `noise_threshold`, giving the ability to create
838 a non-equal distribution of ore.
841 Creates a sheet of ore in a blob shape according to the 2D perlin noise
842 described by `noise_params` and `noise_threshold`. This is essentially an
843 improved version of the so-called "stratus" ore seen in some unofficial mods.
845 This sheet consists of vertical columns of uniform randomly distributed height,
846 varying between the inclusive range `column_height_min` and `column_height_max`.
847 If `column_height_min` is not specified, this parameter defaults to 1.
848 If `column_height_max` is not specified, this parameter defaults to `clust_size`
849 for reverse compatibility. New code should prefer `column_height_max`.
851 The `column_midpoint_factor` parameter controls the position of the column at which
852 ore eminates from. If 1, columns grow upward. If 0, columns grow downward. If 0.5,
853 columns grow equally starting from each direction. `column_midpoint_factor` is a
854 decimal number ranging in value from 0 to 1. If this parameter is not specified,
857 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this ore type.
860 Creates a sheet of ore in a cloud-like puff shape.
862 As with the `sheet` ore type, the size and shape of puffs are described by
863 `noise_params` and `noise_threshold` and are placed at random vertical positions
864 within the currently generated chunk.
866 The vertical top and bottom displacement of each puff are determined by the noise
867 parameters `np_puff_top` and `np_puff_bottom`, respectively.
871 Creates a deformed sphere of ore according to 3d perlin noise described by
872 `noise_params`. The maximum size of the blob is `clust_size`, and
873 `clust_scarcity` has the same meaning as with the `scatter` type.
876 Creates veins of ore varying in density by according to the intersection of two
877 instances of 3d perlin noise with diffferent seeds, both described by
878 `noise_params`. `random_factor` varies the influence random chance has on
879 placement of an ore inside the vein, which is `1` by default. Note that
880 modifying this parameter may require adjusting `noise_threshold`.
881 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
882 by this ore type. This ore type is difficult to control since it is sensitive
883 to small changes. The following is a decent set of parameters to work from:
888 spread = {x=200, y=200, z=200},
894 noise_threshold = 1.6
896 WARNING: Use this ore type *very* sparingly since it is ~200x more
897 computationally expensive than any other ore.
901 See section "Flag Specifier Format".
903 Currently supported flags: `absheight`
906 Also produce this same ore between the height range of `-y_max` and `-y_min`.
908 Useful for having ore in sky realms without having to duplicate ore entries.
911 If set, puff ore generation will not taper down large differences in displacement
912 when approaching the edge of a puff. This flag has no effect for ore types other
915 ### `puff_additive_composition`
916 By default, when noise described by `np_puff_top` or `np_puff_bottom` results in a
917 negative displacement, the sub-column at that point is not generated. With this
918 attribute set, puff ore generation will instead generate the absolute difference in
919 noise displacement values. This flag has no effect for ore types other than `puff`.
923 The varying types of decorations that can be placed.
926 Creates a 1 times `H` times 1 column of a specified node (or a random node from
927 a list, if a decoration list is specified). Can specify a certain node it must
928 spawn next to, such as water or lava, for example. Can also generate a
929 decoration of random height between a specified lower and upper bound.
930 This type of decoration is intended for placement of grass, flowers, cacti,
931 papyri, waterlilies and so on.
934 Copies a box of `MapNodes` from a specified schematic file (or raw description).
935 Can specify a probability of a node randomly appearing when placed.
936 This decoration type is intended to be used for multi-node sized discrete
937 structures, such as trees, cave spikes, rocks, and so on.
942 A schematic specifier identifies a schematic by either a filename to a
943 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
944 in the form of a table. This table specifies the following fields:
946 * The `size` field is a 3D vector containing the dimensions of the provided schematic. (required)
947 * The `yslice_prob` field is a table of {ypos, prob} which sets the `ypos`th vertical slice
948 of the schematic to have a `prob / 256 * 100` chance of occuring. (default: 255)
949 * The `data` field is a flat table of MapNode tables making up the schematic,
950 in the order of `[z [y [x]]]`. (required)
951 Each MapNode table contains:
952 * `name`: the name of the map node to place (required)
953 * `prob` (alias `param1`): the probability of this node being placed (default: 255)
954 * `param2`: the raw param2 value of the node being placed onto the map (default: 0)
955 * `force_place`: boolean representing if the node should forcibly overwrite any
956 previous contents (default: false)
958 About probability values:
959 * A probability value of `0` or `1` means that node will never appear (0% chance).
960 * A probability value of `254` or `255` means the node will always appear (100% chance).
961 * If the probability value `p` is greater than `1`, then there is a
962 `(p / 256 * 100)` percent chance that node will appear when the schematic is
968 See section "Flag Specifier Format".
970 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
973 * `place_center_x`: Placement of this decoration is centered along the X axis.
974 * `place_center_y`: Placement of this decoration is centered along the Y axis.
975 * `place_center_z`: Placement of this decoration is centered along the Z axis.
976 * `force_placement`: Schematic nodes other than "ignore" will replace existing nodes.
981 The position field is used for all element types.
983 To account for differing resolutions, the position coordinates are the percentage
984 of the screen, ranging in value from `0` to `1`.
986 The name field is not yet used, but should contain a description of what the
987 HUD element represents. The direction field is the direction in which something
990 `0` draws from left to right, `1` draws from right to left, `2` draws from
991 top to bottom, and `3` draws from bottom to top.
993 The `alignment` field specifies how the item will be aligned. It ranges from `-1` to `1`,
994 with `0` being the center, `-1` is moved to the left/up, and `1` is to the right/down.
995 Fractional values can be used.
997 The `offset` field specifies a pixel offset from the position. Contrary to position,
998 the offset is not scaled to screen size. This allows for some precisely-positioned
1001 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling factor!
1003 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
1005 **Note**: Future revisions to the HUD API may be incompatible; the HUD API is still
1006 in the experimental stages.
1009 Displays an image on the HUD.
1011 * `scale`: The scale of the image, with 1 being the original texture size.
1012 Only the X coordinate scale is used (positive values).
1013 Negative values represent that percentage of the screen it
1014 should take; e.g. `x=-100` means 100% (width).
1015 * `text`: The name of the texture that is displayed.
1016 * `alignment`: The alignment of the image.
1017 * `offset`: offset in pixels from position.
1020 Displays text on the HUD.
1022 * `scale`: Defines the bounding rectangle of the text.
1023 A value such as `{x=100, y=100}` should work.
1024 * `text`: The text to be displayed in the HUD element.
1025 * `number`: An integer containing the RGB value of the color used to draw the text.
1026 Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1027 * `alignment`: The alignment of the text.
1028 * `offset`: offset in pixels from position.
1031 Displays a horizontal bar made up of half-images.
1033 * `text`: The name of the texture that is used.
1034 * `number`: The number of half-textures that are displayed.
1035 If odd, will end with a vertically center-split texture.
1037 * `offset`: offset in pixels from position.
1038 * `size`: If used, will force full-image size to this value (override texture pack image size)
1041 * `text`: The name of the inventory list to be displayed.
1042 * `number`: Number of items in the inventory to be displayed.
1043 * `item`: Position of item that is selected.
1045 * `offset`: offset in pixels from position.
1048 Displays distance to selected world position.
1050 * `name`: The name of the waypoint.
1051 * `text`: Distance suffix. Can be blank.
1052 * `number:` An integer containing the RGB value of the color used to draw the text.
1053 * `world_pos`: World position of the waypoint.
1055 Representations of simple things
1056 --------------------------------
1060 {x=num, y=num, z=num}
1062 For helper functions see "Vector helpers".
1065 * `{type="nothing"}`
1066 * `{type="node", under=pos, above=pos}`
1067 * `{type="object", ref=ObjectRef}`
1069 Flag Specifier Format
1070 ---------------------
1071 Flags using the standardized flag specifier format can be specified in either of
1072 two ways, by string or table.
1074 The string format is a comma-delimited set of flag names; whitespace and
1075 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1076 flag, and specifying a flag prefixed by the string `"no"` explicitly
1077 clears the flag from whatever the default may be.
1079 In addition to the standard string flag format, the schematic flags field can
1080 also be a table of flag names to boolean values representing whether or not the
1081 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1082 is present, mapped to a boolean of any value, the specified flag is unset.
1084 E.g. A flag field of value
1086 {place_center_x = true, place_center_y=false, place_center_z=true}
1090 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1092 which is equivalent to
1094 "place_center_x, noplace_center_y, place_center_z"
1098 "place_center_x, place_center_z"
1100 since, by default, no schematic attributes are set.
1106 There are three kinds of items: nodes, tools and craftitems.
1108 * Node (`register_node`): A node from the world.
1109 * Tool (`register_tool`): A tool/weapon that can dig and damage
1110 things according to `tool_capabilities`.
1111 * Craftitem (`register_craftitem`): A miscellaneous item.
1114 Items and item stacks can exist in three formats: Serializes, table format
1118 This is called "stackstring" or "itemstring":
1120 * e.g. `'default:dirt 5'`
1121 * e.g. `'default:pick_wood 21323'`
1122 * e.g. `'default:apple'`
1129 {name="default:dirt", count=5, wear=0, metadata=""}
1131 A wooden pick about 1/3 worn out:
1133 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1137 {name="default:apple", count=1, wear=0, metadata=""}
1140 A native C++ format with many helper methods. Useful for converting
1141 between formats. See the Class reference section for details.
1143 When an item must be passed to a function, it can usually be in any of
1149 In a number of places, there is a group table. Groups define the
1150 properties of a thing (item, node, armor of entity, capabilities of
1151 tool) in such a way that the engine and other mods can can interact with
1152 the thing without actually knowing what the thing is.
1155 Groups are stored in a table, having the group names with keys and the
1156 group ratings as values. For example:
1158 groups = {crumbly=3, soil=1}
1161 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1162 -- ^ A more special dirt-kind of thing
1164 Groups always have a rating associated with them. If there is no
1165 useful meaning for a rating for an enabled group, it shall be `1`.
1167 When not defined, the rating of a group defaults to `0`. Thus when you
1168 read groups, you must interpret `nil` and `0` as the same value, `0`.
1170 You can read the rating of a group for an item or a node by using
1172 minetest.get_item_group(itemname, groupname)
1175 Groups of items can define what kind of an item it is (e.g. wool).
1178 In addition to the general item things, groups are used to define whether
1179 a node is destroyable and how long it takes to destroy by a tool.
1181 ### Groups of entities
1182 For entities, groups are, as of now, used only for calculating damage.
1183 The rating is the percentage of damage caused by tools with this damage group.
1184 See "Entity damage mechanism".
1186 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1187 object.set_armor_groups({fleshy=30, cracky=80})
1190 Groups in tools define which groups of nodes and entities they are
1193 ### Groups in crafting recipes
1194 An example: Make meat soup from any meat, any water and any bowl:
1197 output = 'food:meat_soup_raw',
1203 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1206 Another example: Make red wool from white wool and red dye:
1210 output = 'wool:red',
1211 recipe = {'wool:white', 'group:dye,basecolor_red'},
1215 * `immortal`: Disables the group damage system for an entity
1216 * `level`: Can be used to give an additional sense of progression in the game.
1217 * A larger level will cause e.g. a weapon of a lower level make much less
1218 damage, and get worn out much faster, or not be able to get drops
1219 from destroyed nodes.
1220 * `0` is something that is directly accessible at the start of gameplay
1221 * There is no upper limit
1222 * `dig_immediate`: (player can always pick up node without tool wear)
1223 * `2`: node is removed without tool wear after 0.5 seconds or so
1225 * `3`: node is removed without tool wear immediately (torch)
1226 * `disable_jump`: Player (and possibly other things) cannot jump from node
1227 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1228 * `bouncy`: value is bounce speed in percent
1229 * `falling_node`: if there is no walkable block under the node it will fall
1230 * `attached_node`: if the node under it is not a walkable block the node will be
1231 dropped as an item. If the node is wallmounted the wallmounted direction is
1233 * `soil`: saplings will grow on nodes in this group
1234 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1235 connect to each other
1237 ### Known damage and digging time defining groups
1238 * `crumbly`: dirt, sand
1239 * `cracky`: tough but crackable stuff like stone.
1240 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1241 plants, wire, sheets of metal
1242 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1243 * `fleshy`: Living things like animals and the player. This could imply
1244 some blood effects when hitting.
1245 * `explody`: Especially prone to explosions
1246 * `oddly_breakable_by_hand`:
1247 Can be added to nodes that shouldn't logically be breakable by the
1248 hand but are. Somewhat similar to `dig_immediate`, but times are more
1249 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1250 speed of a tool if the tool can dig at a faster speed than this
1251 suggests for the hand.
1253 ### Examples of custom groups
1254 Item groups are often used for defining, well, _groups of items_.
1255 * `meat`: any meat-kind of a thing (rating might define the size or healing
1256 ability or be irrelevant -- it is not defined as of yet)
1257 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1259 * `flammable`: can be set on fire. Rating might define the intensity of the
1260 fire, affecting e.g. the speed of the spreading of an open fire.
1261 * `wool`: any wool (any origin, any color)
1262 * `metal`: any metal
1263 * `weapon`: any weapon
1264 * `heavy`: anything considerably heavy
1266 ### Digging time calculation specifics
1267 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1268 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1269 faster digging time.
1271 The `level` group is used to limit the toughness of nodes a tool can dig
1272 and to scale the digging times / damage to a greater extent.
1274 **Please do understand this**, otherwise you cannot use the system to it's
1277 Tools define their properties by a list of parameters for groups. They
1278 cannot dig other groups; thus it is important to use a standard bunch of
1279 groups to enable interaction with tools.
1281 #### Tools definition
1284 * Full punch interval
1285 * Maximum drop level
1286 * For an arbitrary list of groups:
1287 * Uses (until the tool breaks)
1288 * Maximum level (usually `0`, `1`, `2` or `3`)
1292 #### Full punch interval
1293 When used as a weapon, the tool will do full damage if this time is spent
1294 between punches. If e.g. half the time is spent, the tool will do half
1297 #### Maximum drop level
1298 Suggests the maximum level of node, when dug with the tool, that will drop
1299 it's useful item. (e.g. iron ore to drop a lump of iron).
1301 This is not automated; it is the responsibility of the node definition
1305 Determines how many uses the tool has when it is used for digging a node,
1306 of this group, of the maximum level. For lower leveled nodes, the use count
1307 is multiplied by `3^leveldiff`.
1309 * `uses=10, leveldiff=0`: actual uses: 10
1310 * `uses=10, leveldiff=1`: actual uses: 30
1311 * `uses=10, leveldiff=2`: actual uses: 90
1314 Tells what is the maximum level of a node of this group that the tool will
1318 List of digging times for different ratings of the group, for nodes of the
1321 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1322 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1323 for this group, and unable to dig the rating `1`, which is the toughest.
1324 Unless there is a matching group that enables digging otherwise.
1327 List of damage for groups of entities. See "Entity damage mechanism".
1329 #### Example definition of the capabilities of a tool
1331 tool_capabilities = {
1332 full_punch_interval=1.5,
1335 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1337 damage_groups = {fleshy=2},
1340 This makes the tool be able to dig nodes that fulfil both of these:
1342 * Have the `crumbly` group
1343 * Have a `level` group less or equal to `2`
1345 Table of resulting digging times:
1347 crumbly 0 1 2 3 4 <- level
1349 1 0.80 1.60 1.60 - -
1350 2 0.60 1.20 1.20 - -
1351 3 0.40 0.80 0.80 - -
1353 level diff: 2 1 0 -1 -2
1355 Table of resulting tool uses:
1364 * At `crumbly==0`, the node is not diggable.
1365 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1366 easy nodes to be quickly breakable.
1367 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1369 Entity damage mechanism
1370 -----------------------
1374 foreach group in cap.damage_groups:
1375 damage += cap.damage_groups[group] * limit(actual_interval /
1376 cap.full_punch_interval, 0.0, 1.0)
1377 * (object.armor_groups[group] / 100.0)
1378 -- Where object.armor_groups[group] is 0 for inexistent values
1381 Client predicts damage based on damage groups. Because of this, it is able to
1382 give an immediate response when an entity is damaged or dies; the response is
1383 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1385 Currently a smoke puff will appear when an entity dies.
1387 The group `immortal` completely disables normal damage.
1389 Entities can define a special armor group, which is `punch_operable`. This
1390 group disables the regular damage mechanism for players punching it by hand or
1391 a non-tool item, so that it can do something else than take damage.
1393 On the Lua side, every punch calls:
1395 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction)
1397 This should never be called directly, because damage is usually not handled by
1400 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1401 accessed unless absolutely required, to encourage interoperability.
1402 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1403 * `tool_capabilities` can be `nil`.
1404 * `direction` is a unit vector, pointing from the source of the punch to
1407 To punch an entity/object in Lua, call:
1409 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1411 * Return value is tool wear.
1412 * Parameters are equal to the above callback.
1413 * If `direction` equals `nil` and `puncher` does not equal `nil`,
1414 `direction` will be automatically filled in based on the location of `puncher`.
1418 The instance of a node in the world normally only contains the three values
1419 mentioned in "Nodes". However, it is possible to insert extra data into a
1420 node. It is called "node metadata"; See "`NodeMetaRef`".
1422 Metadata contains two things:
1427 Some of the values in the key-value store are handled specially:
1429 * `formspec`: Defines a right-click inventory menu. See "Formspec".
1430 * `infotext`: Text shown on the screen when the node is pointed at
1434 local meta = minetest.get_meta(pos)
1435 meta:set_string("formspec",
1437 "list[context;main;0,0;8,4;]"..
1438 "list[current_player;main;0,5;8,4;]")
1439 meta:set_string("infotext", "Chest");
1440 local inv = meta:get_inventory()
1441 inv:set_size("main", 8*4)
1442 print(dump(meta:to_table()))
1445 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1446 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1447 [10] = "", [11] = "", [12] = "", [13] = "",
1448 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1449 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1450 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1451 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1455 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1462 Formspec defines a menu. Currently not much else than inventories are
1463 supported. It is a string, with a somewhat strange format.
1465 Spaces and newlines can be inserted between the blocks, as is used in the
1473 list[context;main;0,0;8,4;]
1474 list[current_player;main;0,5;8,4;]
1479 list[context;fuel;2,3;1,1;]
1480 list[context;src;2,1;1,1;]
1481 list[context;dst;5,1;2,2;]
1482 list[current_player;main;0,5;8,4;]
1484 #### Minecraft-like player inventory
1487 image[1,0.6;1,2;player.png]
1488 list[current_player;main;0,3.5;8,4;]
1489 list[current_player;craft;3,0;3,3;]
1490 list[current_player;craftpreview;7,1;1,1;]
1494 #### `size[<W>,<H>,<fixed_size>]`
1495 * Define the size of the menu in inventory slots
1496 * `fixed_size`: `true`/`false` (optional)
1497 * deprecated: `invsize[<W>,<H>;]`
1499 #### `container[<X>,<Y>]`
1500 * Start of a container block, moves all physical elements in the container by (X, Y)
1501 * Must have matching container_end
1502 * Containers can be nested, in which case the offsets are added
1503 (child containers are relative to parent containers)
1505 #### `container_end[]`
1506 * End of a container, following elements are no longer relative to this container
1508 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
1509 * Show an inventory list
1511 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
1512 * Show an inventory list
1514 #### `listring[<inventory location>;<list name>]`
1515 * Allows to create a ring of inventory lists
1516 * Shift-clicking on items in one element of the ring
1517 will send them to the next inventory list inside the ring
1518 * The first occurrence of an element inside the ring will
1519 determine the inventory where items will be sent to
1522 * Shorthand for doing `listring[<inventory location>;<list name>]`
1523 for the last two inventory lists added by list[...]
1525 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
1526 * Sets background color of slots as `ColorString`
1527 * Sets background color of slots on mouse hovering
1529 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
1530 * Sets background color of slots as `ColorString`
1531 * Sets background color of slots on mouse hovering
1532 * Sets color of slots border
1534 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
1535 * Sets background color of slots as `ColorString`
1536 * Sets background color of slots on mouse hovering
1537 * Sets color of slots border
1538 * Sets default background color of tooltips
1539 * Sets default font color of tooltips
1541 #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>,<fontcolor>]`
1542 * Adds tooltip for an element
1543 * `<bgcolor>` tooltip background color as `ColorString` (optional)
1544 * `<fontcolor>` tooltip font color as `ColorString` (optional)
1546 #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
1548 * Position and size units are inventory slots
1550 #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
1551 * Show an inventory image of registered item/node
1552 * Position and size units are inventory slots
1554 #### `bgcolor[<color>;<fullscreen>]`
1555 * Sets background color of formspec as `ColorString`
1556 * If `true`, the background color is drawn fullscreen (does not effect the size of the formspec)
1558 #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
1559 * Use a background. Inventory rectangles are not drawn then.
1560 * Position and size units are inventory slots
1561 * Example for formspec 8x4 in 16x resolution: image shall be sized
1562 8 times 16px times 4 times 16px.
1564 #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
1565 * Use a background. Inventory rectangles are not drawn then.
1566 * Position and size units are inventory slots
1567 * Example for formspec 8x4 in 16x resolution:
1568 image shall be sized 8 times 16px times 4 times 16px
1569 * If `true` the background is clipped to formspec size
1570 (`x` and `y` are used as offset values, `w` and `h` are ignored)
1572 #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
1573 * Textual password style field; will be sent to server when a button is clicked
1574 * When enter is pressed in field, fields.key_enter_field will be sent with the name
1576 * `x` and `y` position the field relative to the top left of the menu
1577 * `w` and `h` are the size of the field
1578 * Fields are a set height, but will be vertically centred on `h`
1579 * Position and size units are inventory slots
1580 * `name` is the name of the field as returned in fields to `on_receive_fields`
1581 * `label`, if not blank, will be text printed on the top left above the field
1582 * See field_close_on_enter to stop enter closing the formspec
1584 #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1585 * Textual field; will be sent to server when a button is clicked
1586 * When enter is pressed in field, fields.key_enter_field will be sent with the name
1588 * `x` and `y` position the field relative to the top left of the menu
1589 * `w` and `h` are the size of the field
1590 * Fields are a set height, but will be vertically centred on `h`
1591 * Position and size units are inventory slots
1592 * `name` is the name of the field as returned in fields to `on_receive_fields`
1593 * `label`, if not blank, will be text printed on the top left above the field
1594 * `default` is the default value of the field
1595 * `default` may contain variable references such as `${text}'` which
1596 will fill the value from the metadata value `text`
1597 * **Note**: no extra text or more than a single variable is supported ATM.
1598 * See field_close_on_enter to stop enter closing the formspec
1600 #### `field[<name>;<label>;<default>]`
1601 * As above, but without position/size units
1602 * When enter is pressed in field, fields.key_enter_field will be sent with the name
1604 * Special field for creating simple forms, such as sign text input
1605 * Must be used without a `size[]` element
1606 * A "Proceed" button will be added automatically
1607 * See field_close_on_enter to stop enter closing the formspec
1609 #### `field_close_on_enter[<name>;<close_on_enter>]`
1610 * <name> is the name of the field
1611 * if <close_on_enter> is false, pressing enter in the field will submit the form but not close it
1612 * defaults to true when not specified (ie: no tag for a field)
1614 #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1615 * Same as fields above, but with multi-line input
1617 #### `label[<X>,<Y>;<label>]`
1618 * `x` and `y` work as per field
1619 * `label` is the text on the label
1620 * Position and size units are inventory slots
1622 #### `vertlabel[<X>,<Y>;<label>]`
1623 * Textual label drawn vertically
1624 * `x` and `y` work as per field
1625 * `label` is the text on the label
1626 * Position and size units are inventory slots
1628 #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
1629 * Clickable button. When clicked, fields will be sent.
1630 * `x`, `y` and `name` work as per field
1631 * `w` and `h` are the size of the button
1632 * `label` is the text on the button
1633 * Position and size units are inventory slots
1635 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1636 * `x`, `y`, `w`, `h`, and `name` work as per button
1637 * `texture name` is the filename of an image
1638 * Position and size units are inventory slots
1640 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
1641 * `x`, `y`, `w`, `h`, and `name` work as per button
1642 * `texture name` is the filename of an image
1643 * Position and size units are inventory slots
1644 * `noclip=true` means the image button doesn't need to be within specified formsize
1645 * `drawborder`: draw button border or not
1646 * `pressed texture name` is the filename of an image on pressed state
1648 #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
1649 * `x`, `y`, `w`, `h`, `name` and `label` work as per button
1650 * `item name` is the registered name of an item/node,
1651 tooltip will be made out of its description
1652 to override it use tooltip element
1653 * Position and size units are inventory slots
1655 #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
1656 * When clicked, fields will be sent and the form will quit.
1658 #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1659 * When clicked, fields will be sent and the form will quit.
1661 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
1662 * Scrollable item list showing arbitrary text elements
1663 * `x` and `y` position the itemlist relative to the top left of the menu
1664 * `w` and `h` are the size of the itemlist
1665 * `name` fieldname sent to server on doubleclick value is current selected element
1666 * `listelements` can be prepended by #color in hexadecimal format RRGGBB (only),
1667 * if you want a listelement to start with "#" write "##".
1669 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
1670 * Scrollable itemlist showing arbitrary text elements
1671 * `x` and `y` position the item list relative to the top left of the menu
1672 * `w` and `h` are the size of the item list
1673 * `name` fieldname sent to server on doubleclick value is current selected element
1674 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
1675 * if you want a listelement to start with "#" write "##"
1676 * Index to be selected within textlist
1677 * `true`/`false`: draw transparent background
1678 * See also `minetest.explode_textlist_event` (main menu: `engine.explode_textlist_event`)
1680 #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
1681 * Show a tab**header** at specific position (ignores formsize)
1682 * `x` and `y` position the itemlist relative to the top left of the menu
1683 * `name` fieldname data is transferred to Lua
1684 * `caption 1`...: name shown on top of tab
1685 * `current_tab`: index of selected tab 1...
1686 * `transparent` (optional): show transparent
1687 * `draw_border` (optional): draw border
1689 #### `box[<X>,<Y>;<W>,<H>;<color>]`
1690 * Simple colored semitransparent box
1691 * `x` and `y` position the box relative to the top left of the menu
1692 * `w` and `h` are the size of box
1693 * `color` is color specified as a `ColorString`
1695 #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
1696 * Show a dropdown field
1697 * **Important note**: There are two different operation modes:
1698 1. handle directly on change (only changed dropdown is submitted)
1699 2. read the value on pressing a button (all dropdown values are available)
1700 * `x` and `y` position of dropdown
1702 * Fieldname data is transferred to Lua
1703 * Items to be shown in dropdown
1704 * Index of currently selected dropdown item
1706 #### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
1708 * `x` and `y`: position of checkbox
1709 * `name` fieldname data is transferred to Lua
1710 * `label` to be shown left of checkbox
1711 * `selected` (optional): `true`/`false`
1713 #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
1715 * There are two ways to use it:
1716 1. handle the changed event (only changed scrollbar is available)
1717 2. read the value on pressing a button (all scrollbars are available)
1718 * `x` and `y`: position of trackbar
1719 * `w` and `h`: width and height
1720 * `orientation`: `vertical`/`horizontal`
1721 * Fieldname data is transferred to Lua
1722 * Value this trackbar is set to (`0`-`1000`)
1723 * See also `minetest.explode_scrollbar_event` (main menu: `engine.explode_scrollbar_event`)
1725 #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
1726 * Show scrollable table using options defined by the previous `tableoptions[]`
1727 * Displays cells as defined by the previous `tablecolumns[]`
1728 * `x` and `y`: position the itemlist relative to the top left of the menu
1729 * `w` and `h` are the size of the itemlist
1730 * `name`: fieldname sent to server on row select or doubleclick
1731 * `cell 1`...`cell n`: cell contents given in row-major order
1732 * `selected idx`: index of row to be selected within table (first row = `1`)
1733 * See also `minetest.explode_table_event` (main menu: `engine.explode_table_event`)
1735 #### `tableoptions[<opt 1>;<opt 2>;...]`
1736 * Sets options for `table[]`
1738 * default text color (`ColorString`), defaults to `#FFFFFF`
1739 * `background=#RRGGBB`
1740 * table background color (`ColorString`), defaults to `#000000`
1741 * `border=<true/false>`
1742 * should the table be drawn with a border? (default: `true`)
1743 * `highlight=#RRGGBB`
1744 * highlight background color (`ColorString`), defaults to `#466432`
1745 * `highlight_text=#RRGGBB`
1746 * highlight text color (`ColorString`), defaults to `#FFFFFF`
1747 * `opendepth=<value>`
1748 * all subtrees up to `depth < value` are open (default value = `0`)
1749 * only useful when there is a column of type "tree"
1751 #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
1752 * Sets columns for `table[]`
1753 * Types: `text`, `image`, `color`, `indent`, `tree`
1754 * `text`: show cell contents as text
1755 * `image`: cell contents are an image index, use column options to define images
1756 * `color`: cell contents are a ColorString and define color of following cell
1757 * `indent`: cell contents are a number and define indentation of following cell
1758 * `tree`: same as indent, but user can open and close subtrees (treeview-like)
1761 * for `text` and `image`: content alignment within cells.
1762 Available values: `left` (default), `center`, `right`, `inline`
1764 * for `text` and `image`: minimum width in em (default: `0`)
1765 * for `indent` and `tree`: indent width in em (default: `1.5`)
1766 * `padding=<value>`: padding left of the column, in em (default `0.5`).
1767 Exception: defaults to 0 for indent columns
1768 * `tooltip=<value>`: tooltip text (default: empty)
1769 * `image` column options:
1770 * `0=<value>` sets image for image index 0
1771 * `1=<value>` sets image for image index 1
1772 * `2=<value>` sets image for image index 2
1773 * and so on; defined indices need not be contiguous empty or
1774 non-numeric cells are treated as `0`.
1775 * `color` column options:
1776 * `span=<value>`: number of following columns to affect (default: infinite)
1778 **Note**: do _not_ use a element name starting with `key_`; those names are reserved to
1779 pass key press events to formspec!
1783 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
1784 * `"current_player"`: Player to whom the menu is shown
1785 * `"player:<name>"`: Any player
1786 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
1787 * `"detached:<name>"`: A detached inventory
1789 Player Inventory lists
1790 ----------------------
1791 * `main`: list containing the default inventory
1792 * `craft`: list containing the craft input
1793 * `craftpreview`: list containing the craft output
1794 * `hand`: list containing an override for the empty hand
1798 `#RGB` defines a color in hexadecimal format.
1800 `#RGBA` defines a color in hexadecimal format and alpha channel.
1802 `#RRGGBB` defines a color in hexadecimal format.
1804 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
1806 Named colors are also supported and are equivalent to
1807 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
1808 To specify the value of the alpha channel, append `#AA` to the end of the color name
1809 (e.g. `colorname#08`). For named colors the hexadecimal string representing the alpha
1810 value must (always) be two hexadecimal digits.
1814 A ColorSpec specifies a 32-bit color. It can be written in either:
1815 table form, each element ranging from 0..255 (a, if absent, defaults to 255):
1816 `colorspec = {a=255, r=0, g=255, b=0}`
1817 numerical form, the raw integer value of an ARGB8 quad:
1818 `colorspec = 0xFF00FF00`
1819 or string form, a ColorString (defined above):
1820 `colorspec = "green"`
1824 Most text can contain escape sequences, that can for example color the text.
1825 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
1826 The following functions provide escape sequences:
1827 * `core.get_color_escape_sequence(color)`:
1828 * `color` is a ColorString
1829 * The escape sequence sets the text color to `color`
1830 * `core.colorize(color, message)`:
1832 `core.get_color_escape_sequence(color) ..
1834 core.get_color_escape_sequence("#ffffff")`
1835 * `color.get_background_escape_sequence(color)`
1836 * `color` is a ColorString
1837 * The escape sequence sets the background of the whole text element to
1838 `color`. Only defined for item descriptions and tooltips.
1842 * `vector.new(a[, b, c])`: returns a vector:
1843 * A copy of `a` if `a` is a vector.
1844 * `{x = a, y = b, z = c}`, if all `a, b, c` are defined
1845 * `vector.direction(p1, p2)`: returns a vector
1846 * `vector.distance(p1, p2)`: returns a number
1847 * `vector.length(v)`: returns a number
1848 * `vector.normalize(v)`: returns a vector
1849 * `vector.floor(v)`: returns a vector, each dimension rounded down
1850 * `vector.round(v)`: returns a vector, each dimension rounded to nearest int
1851 * `vector.apply(v, func)`: returns a vector
1852 * `vector.equals(v1, v2)`: returns a boolean
1853 * `vector.sort(v1, v2)`: returns minp, maxp vectors of the cuboid defined by v1 and v2
1855 For the following functions `x` can be either a vector or a number:
1857 * `vector.add(v, x)`: returns a vector
1858 * `vector.subtract(v, x)`: returns a vector
1859 * `vector.multiply(v, x)`: returns a scaled vector or Schur product
1860 * `vector.divide(v, x)`: returns a scaled vector or Schur quotient
1864 * `dump2(obj, name="_", dumped={})`
1865 * Return object serialized as a string, handles reference loops
1866 * `dump(obj, dumped={})`
1867 * Return object serialized as a string
1868 * `math.hypot(x, y)`
1869 * Get the hypotenuse of a triangle with legs x and y.
1870 Useful for distance calculation.
1871 * `math.sign(x, tolerance)`
1872 * Get the sign of a number.
1873 Optional: Also returns `0` when the absolute value is within the tolerance (default: `0`)
1874 * `string.split(str, separator=",", include_empty=false, max_splits=-1,
1875 * sep_is_pattern=false)`
1876 * If `max_splits` is negative, do not limit splits.
1877 * `sep_is_pattern` specifies if separator is a plain string or a pattern (regex).
1878 * e.g. `string:split("a,b", ",") == {"a","b"}`
1880 * e.g. `string.trim("\n \t\tfoo bar\t ") == "foo bar"`
1881 * `minetest.pos_to_string({x=X,y=Y,z=Z}, decimal_places))`: returns `"(X,Y,Z)"`
1882 * Convert position to a printable string
1883 Optional: 'decimal_places' will round the x, y and z of the pos to the given decimal place.
1884 * `minetest.string_to_pos(string)`: returns a position
1885 * Same but in reverse. Returns `nil` if the string can't be parsed to a position.
1886 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
1887 * Converts a string representing an area box into two positions
1888 * `minetest.formspec_escape(string)`: returns a string
1889 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
1890 * `minetest.is_yes(arg)`
1891 * returns whether `arg` can be interpreted as yes
1892 * `minetest.get_us_time()`
1893 * returns time with microsecond precision. May not return wall time.
1894 * `table.copy(table)`: returns a table
1895 * returns a deep copy of `table`
1897 `minetest` namespace reference
1898 ------------------------------
1902 * `minetest.get_current_modname()`: returns the currently loading mod's name, when we are loading a mod
1903 * `minetest.get_modpath(modname)`: returns e.g. `"/home/user/.minetest/usermods/modname"`
1904 * Useful for loading additional `.lua` modules or static data from mod
1905 * `minetest.get_modnames()`: returns a list of installed mods
1906 * Return a list of installed mods, sorted alphabetically
1907 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
1908 * Useful for storing custom data
1909 * `minetest.is_singleplayer()`
1910 * `minetest.features`
1911 * Table containing API feature flags: `{foo=true, bar=true}`
1912 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
1913 * `arg`: string or table in format `{foo=true, bar=true}`
1914 * `missing_features`: `{foo=true, bar=true}`
1915 * `minetest.get_player_information(player_name)`: returns a table containing
1916 information about player. Example return value:
1918 address = "127.0.0.1", -- IP address of client
1919 ip_version = 4, -- IPv4 / IPv6
1920 min_rtt = 0.01, -- minimum round trip time
1921 max_rtt = 0.2, -- maximum round trip time
1922 avg_rtt = 0.02, -- average round trip time
1923 min_jitter = 0.01, -- minimum packet time jitter
1924 max_jitter = 0.5, -- maximum packet time jitter
1925 avg_jitter = 0.03, -- average packet time jitter
1926 connection_uptime = 200, -- seconds since client connected
1928 -- following information is available on debug build only!!!
1929 -- DO NOT USE IN MODS
1930 --ser_vers = 26, -- serialization version used by client
1931 --prot_vers = 23, -- protocol version used by client
1932 --major = 0, -- major version number
1933 --minor = 4, -- minor version number
1934 --patch = 10, -- patch version number
1935 --vers_string = "0.4.9-git", -- full version string
1936 --state = "Active" -- current client state
1938 * `minetest.mkdir(path)`: returns success.
1939 * Creates a directory specified by `path`, creating parent directories
1940 if they don't exist.
1941 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
1943 * nil: return all entries,
1944 * true: return only subdirectory names, or
1945 * false: return only file names.
1946 * `minetest.get_version()`: returns a table containing components of the
1947 engine version. Components:
1948 * `project`: Name of the project, eg, "Minetest"
1949 * `string`: Simple version, eg, "1.2.3-dev"
1950 * `hash`: Full git version (only set if available), eg, "1.2.3-dev-01234567-dirty"
1951 Use this for informational purposes only. The information in the returned
1952 table does not represent the capabilities of the engine, nor is it
1953 reliable or verifyable. Compatible forks will have a different name and
1954 version entirely. To check for the presence of engine features, test
1955 whether the functions exported by the wanted features exist. For example:
1956 `if core.nodeupdate then ... end`.
1959 * `minetest.debug(...)`
1960 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
1961 * `minetest.log([level,] text)`
1962 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
1963 `"info"`, or `"verbose"`. Default is `"none"`.
1965 ### Registration functions
1966 Call these functions only at load time!
1968 * `minetest.register_entity(name, prototype table)`
1969 * `minetest.register_abm(abm definition)`
1970 * `minetest.register_lbm(lbm definition)`
1971 * `minetest.register_node(name, node definition)`
1972 * `minetest.register_tool(name, item definition)`
1973 * `minetest.register_craftitem(name, item definition)`
1974 * `minetest.unregister_item(name)`
1975 * `minetest.register_alias(name, convert_to)`
1976 * `minetest.register_alias_force(name, convert_to)`
1977 * `minetest.register_craft(recipe)`
1978 * Check recipe table syntax for different types below.
1979 * `minetest.clear_craft(recipe)`
1980 * Will erase existing craft based either on output item or on input recipe.
1981 * Specify either output or input only. If you specify both, input will be ignored. For input use the same recipe table
1982 syntax as for `minetest.register_craft(recipe)`. For output specify only the item, without a quantity.
1983 * If no erase candidate could be found, Lua exception will be thrown.
1984 * Warning! The type field ("shaped","cooking" or any other) will be ignored if the recipe
1985 contains output. Erasing is then done independently from the crafting method.
1986 * `minetest.register_ore(ore definition)`
1987 * `minetest.register_biome(biome definition)`
1988 * `minetest.register_decoration(decoration definition)`
1989 * `minetest.override_item(name, redefinition)`
1990 * Overrides fields of an item registered with register_node/tool/craftitem.
1991 * Note: Item must already be defined, (opt)depend on the mod defining it.
1992 * Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})`
1993 * `minetest.clear_registered_ores()`
1994 * `minetest.clear_registered_biomes()`
1995 * `minetest.clear_registered_decorations()`
1997 ### Global callback registration functions
1998 Call these functions only at load time!
2000 * `minetest.register_globalstep(func(dtime))`
2001 * Called every server step, usually interval of 0.1s
2002 * `minetest.register_on_shutdown(func())`
2003 * Called before server shutdown
2004 * **Warning**: If the server terminates abnormally (i.e. crashes), the registered
2005 callbacks **will likely not be run**. Data should be saved at
2006 semi-frequent intervals as well as on server shutdown.
2007 * `minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
2008 * Called when a node has been placed
2009 * If return `true` no item is taken from `itemstack`
2010 * **Not recommended**; use `on_construct` or `after_place_node` in node definition
2012 * `minetest.register_on_dignode(func(pos, oldnode, digger))`
2013 * Called when a node has been dug.
2014 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node definition
2016 * `minetest.register_on_punchnode(func(pos, node, puncher, pointed_thing))`
2017 * Called when a node is punched
2018 * `minetest.register_on_generated(func(minp, maxp, blockseed))`
2019 * Called after generating a piece of world. Modifying nodes inside the area
2020 is a bit faster than usually.
2021 * `minetest.register_on_newplayer(func(ObjectRef))`
2022 * Called after a new player has been created
2023 * `minetest.register_on_dieplayer(func(ObjectRef))`
2024 * Called when a player dies
2025 * `minetest.register_on_punchplayer(func(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
2026 * Called when a player is punched
2027 * `player` - ObjectRef - Player that was punched
2028 * `hitter` - ObjectRef - Player that hit
2029 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be nil)
2030 * `tool_capabilities`: capability table of used tool (can be nil)
2031 * `dir`: unit vector of direction of punch. Always defined. Points from
2032 the puncher to the punched.
2033 * `damage` - number that represents the damage calculated by the engine
2034 * should return `true` to prevent the default damage mechanism
2035 * `minetest.register_on_player_hpchange(func(player, hp_change), modifier)`
2036 * Called when the player gets damaged or healed
2037 * `player`: ObjectRef of the player
2038 * `hp_change`: the amount of change. Negative when it is damage.
2039 * `modifier`: when true, the function should return the actual hp_change.
2040 Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
2041 modifiers can return true as a second argument to stop the execution of further functions.
2042 Non-modifiers receive the final hp change calculated by the modifiers.
2043 * `minetest.register_on_respawnplayer(func(ObjectRef))`
2044 * Called when player is to be respawned
2045 * Called _before_ repositioning of player occurs
2046 * return true in func to disable regular player placement
2047 * `minetest.register_on_prejoinplayer(func(name, ip))`
2048 * Called before a player joins the game
2049 * If it returns a string, the player is disconnected with that string as reason
2050 * `minetest.register_on_joinplayer(func(ObjectRef))`
2051 * Called when a player joins the game
2052 * `minetest.register_on_leaveplayer(func(ObjectRef, timed_out))`
2053 * Called when a player leaves the game
2054 * `timed_out`: True for timeout, false for other reasons.
2055 * `minetest.register_on_cheat(func(ObjectRef, cheat))`
2056 * Called when a player cheats
2057 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
2059 * `interacted_too_far`
2060 * `interacted_while_dead`
2061 * `finished_unknown_dig`
2064 * `minetest.register_on_chat_message(func(name, message))`
2065 * Called always when a player says something
2066 * Return `true` to mark the message as handled, which means that it will not be sent to other players
2067 * `minetest.register_on_player_receive_fields(func(player, formname, fields))`
2068 * Called when a button is pressed in player's inventory form
2069 * Newest functions are called first
2070 * If function returns `true`, remaining functions are not called
2071 * `minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))`
2072 * Called when `player` crafts something
2073 * `itemstack` is the output
2074 * `old_craft_grid` contains the recipe (Note: the one in the inventory is cleared)
2075 * `craft_inv` is the inventory with the crafting grid
2076 * Return either an `ItemStack`, to replace the output, or `nil`, to not modify it
2077 * `minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))`
2078 * The same as before, except that it is called before the player crafts, to make
2079 craft prediction, and it should not change anything.
2080 * `minetest.register_on_protection_violation(func(pos, name))`
2081 * Called by `builtin` and mods when a player violates protection at a position
2082 (eg, digs a node or punches a protected entity).
2083 * The registered functions can be called using `minetest.record_protection_violation`
2084 * The provided function should check that the position is protected by the mod
2085 calling this function before it prints a message, if it does, to allow for
2086 multiple protection mods.
2087 * `minetest.register_on_item_eat(func(hp_change, replace_with_item, itemstack, user, pointed_thing))`
2088 * Called when an item is eaten, by `minetest.item_eat`
2089 * Return `true` or `itemstack` to cancel the default item eat response (i.e.: hp increase)
2091 ### Other registration functions
2092 * `minetest.register_chatcommand(cmd, chatcommand definition)`
2093 * Adds definition to minetest.registered_chatcommands
2094 * `minetest.override_chatcommand(name, redefinition)`
2095 * Overrides fields of a chatcommand registered with register_chatcommand.
2096 * `minetest.unregister_chatcommand(name)`
2097 * Unregisters a chatcommands registered with register_chatcommand.
2098 * `minetest.register_privilege(name, definition)`
2099 * `definition`: `"description text"`
2100 * `definition`: `{ description = "description text", give_to_singleplayer = boolean}`
2101 the default of `give_to_singleplayer` is true
2102 * To allow players with basic_privs to grant, see basic_privs minetest.conf setting.
2103 * `minetest.register_authentication_handler(handler)`
2104 * See `minetest.builtin_auth_handler` in `builtin.lua` for reference
2107 * `minetest.setting_set(name, value)`
2108 * Setting names can't contain whitespace or any of `="{}#`.
2109 * Setting values can't contain the sequence `\n"""`.
2110 * Setting names starting with "secure." can't be set.
2111 * `minetest.setting_get(name)`: returns string or `nil`
2112 * `minetest.setting_setbool(name, value)`
2113 * See documentation on `setting_set` for restrictions.
2114 * `minetest.setting_getbool(name)`: returns boolean or `nil`
2115 * `minetest.setting_get_pos(name)`: returns position or nil
2116 * `minetest.setting_save()`, returns `nil`, save all settings to config file
2119 * `minetest.notify_authentication_modified(name)`
2120 * Should be called by the authentication handler if privileges changes.
2121 * To report everybody, set `name=nil`.
2122 * `minetest.check_password_entry(name, entry, password)`
2123 * Returns true if the "db entry" for a player with name matches given
2124 * password, false otherwise.
2125 * The "db entry" is the usually player-individual value that is derived
2126 * from the player's chosen password and stored on the server in order to allow
2127 * authentication whenever the player desires to log in.
2128 * Only use this function for making it possible to log in via the password from
2129 * via protocols like IRC, other uses for inside the game are frowned upon.
2130 * `minetest.get_password_hash(name, raw_password)`
2131 * Convert a name-password pair to a password hash that Minetest can use.
2132 * The returned value alone is not a good basis for password checks based
2133 * on comparing the password hash in the database with the password hash
2134 * from the function, with an externally provided password, as the hash
2135 * in the db might use the new SRP verifier format.
2136 * For this purpose, use minetest.check_password_entry instead.
2137 * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
2138 * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
2139 * Convert between two privilege representations
2140 * `minetest.set_player_password(name, password_hash)`
2141 * `minetest.set_player_privs(name, {priv1=true,...})`
2142 * `minetest.get_player_privs(name) -> {priv1=true,...}`
2143 * `minetest.auth_reload()`
2144 * `minetest.check_player_privs(player_or_name, ...)`: returns `bool, missing_privs`
2145 * A quickhand for checking privileges.
2146 * `player_or_name`: Either a Player object or the name of a player.
2147 * `...` is either a list of strings, e.g. `"priva", "privb"` or
2148 a table, e.g. `{ priva = true, privb = true }`.
2149 * `minetest.get_player_ip(name)`: returns an IP address string
2151 `minetest.set_player_password`, `minetest_set_player_privs`, `minetest_get_player_privs`
2152 and `minetest.auth_reload` call the authetification handler.
2155 * `minetest.chat_send_all(text)`
2156 * `minetest.chat_send_player(name, text)`
2158 ### Environment access
2159 * `minetest.set_node(pos, node)`
2160 * `minetest.add_node(pos, node): alias set_node(pos, node)`
2161 * Set node at position (`node = {name="foo", param1=0, param2=0}`)
2162 * `minetest.swap_node(pos, node)`
2163 * Set node at position, but don't remove metadata
2164 * `minetest.remove_node(pos)`
2165 * Equivalent to `set_node(pos, "air")`
2166 * `minetest.get_node(pos)`
2167 * Returns the node at the given position as table in the format
2168 `{name="node_name", param1=0, param2=0}`, returns `{name="ignore", param1=0, param2=0}`
2170 * `minetest.get_node_or_nil(pos)`
2171 * Same as `get_node` but returns `nil` for unloaded areas.
2172 * `minetest.get_node_light(pos, timeofday)`
2173 * Gets the light value at the given position. Note that the light value
2174 "inside" the node at the given position is returned, so you usually want
2175 to get the light value of a neighbor.
2176 * `pos`: The position where to measure the light.
2177 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
2178 * Returns a number between `0` and `15` or `nil`
2179 * `minetest.place_node(pos, node)`
2180 * Place node with the same effects that a player would cause
2181 * `minetest.dig_node(pos)`
2182 * Dig node with the same effects that a player would cause
2183 * Returns `true` if successful, `false` on failure (e.g. protected location)
2184 * `minetest.punch_node(pos)`
2185 * Punch node with the same effects that a player would cause
2187 * `minetest.find_nodes_with_meta(pos1, pos2)`
2188 * Get a table of positions of nodes that have metadata within a region {pos1, pos2}
2189 * `minetest.get_meta(pos)`
2190 * Get a `NodeMetaRef` at that position
2191 * `minetest.get_node_timer(pos)`
2192 * Get `NodeTimerRef`
2194 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at position
2195 * Returns `ObjectRef`, or `nil` if failed
2196 * `minetest.add_item(pos, item)`: Spawn item
2197 * Returns `ObjectRef`, or `nil` if failed
2198 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
2199 * `minetest.get_objects_inside_radius(pos, radius)`
2200 * `radius`: using an euclidean metric
2201 * `minetest.set_timeofday(val)`
2202 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
2203 * `minetest.get_timeofday()`
2204 * `minetest.get_gametime()`: returns the time, in seconds, since the world was created
2205 * `minetest.get_day_count()`: returns number days elapsed since world was created,
2206 * accounting for time changes.
2207 * `minetest.find_node_near(pos, radius, nodenames)`: returns pos or `nil`
2208 * `radius`: using a maximum metric
2209 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2210 * `minetest.find_nodes_in_area(minp, maxp, nodenames)`: returns a list of positions
2211 * returns as second value a table with the count of the individual nodes found
2212 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2213 * `minetest.find_nodes_in_area_under_air(minp, maxp, nodenames)`: returns a list of positions
2214 * returned positions are nodes with a node air above
2215 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2216 * `minetest.get_perlin(noiseparams)`
2217 * `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
2218 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
2219 * `minetest.get_voxel_manip([pos1, pos2])`
2220 * Return voxel manipulator object.
2221 * Loads the manipulator from the map if positions are passed.
2222 * `minetest.set_gen_notify(flags, {deco_ids})`
2223 * Set the types of on-generate notifications that should be collected
2224 * `flags` is a flag field with the available flags: `dungeon`, `temple`, `cave_begin`,
2225 `cave_end`, `large_cave_begin`, `large_cave_end`, `decoration`
2226 * The second parameter is a list of IDS of decorations which notification is requested for
2227 * `get_gen_notify()`: returns a flagstring and a table with the deco_ids
2228 * `minetest.get_mapgen_object(objectname)`
2229 * Return requested mapgen object if available (see "Mapgen objects")
2230 * `minetest.get_biome_id(biome_name)`
2231 * Returns the biome id, as used in the biomemap Mapgen object, for a
2232 given biome_name string.
2233 * `minetest.get_mapgen_params()` Returns mapgen parameters, a table containing
2234 `mgname`, `seed`, `chunksize`, `water_level`, and `flags`.
2235 * Deprecated: use minetest.get_mapgen_setting(name) instead
2236 * `minetest.set_mapgen_params(MapgenParams)`
2237 * Deprecated: use minetest.set_mapgen_setting(name, value, override) instead
2238 * Set map generation parameters
2239 * Function cannot be called after the registration period; only initialization
2240 and `on_mapgen_init`
2241 * Takes a table as an argument with the fields `mgname`, `seed`, `water_level`,
2243 * Leave field unset to leave that parameter unchanged
2244 * `flags` contains a comma-delimited string of flags to set,
2245 or if the prefix `"no"` is attached, clears instead.
2246 * `flags` is in the same format and has the same options as `mg_flags` in `minetest.conf`
2247 * `minetest.get_mapgen_setting(name)`
2248 * Gets the *active* mapgen setting (or nil if none exists) in string format with the following
2249 order of precedence:
2250 1) Settings loaded from map_meta.txt or overrides set during mod execution
2251 2) Settings set by mods without a metafile override
2252 3) Settings explicitly set in the user config file, minetest.conf
2253 4) Settings set as the user config default
2254 * `minetest.get_mapgen_setting_noiseparams(name)`
2255 * Same as above, but returns the value as a NoiseParams table if the setting `name` exists
2256 and is a valid NoiseParams
2257 * `minetest.set_mapgen_setting(name, value, [override_meta])`
2258 * Sets a mapgen param to `value`, and will take effect if the corresponding mapgen setting
2259 is not already present in map_meta.txt.
2260 * `override_meta` is an optional boolean (default: `false`). If this is set to true,
2261 the setting will become the active setting regardless of the map metafile contents.
2262 * Note: to set the seed, use "seed", not "fixed_map_seed"
2263 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
2264 * Same as above, except value is a NoiseParams table.
2265 * `minetest.set_noiseparams(name, noiseparams, set_default)`
2266 * Sets the noiseparams setting of `name` to the noiseparams table specified in `noiseparams`.
2267 * `set_default` is an optional boolean (default: `true`) that specifies whether the setting
2268 should be applied to the default config or current active config
2269 * `minetest.get_noiseparams(name)`: returns a table of the noiseparams for name
2270 * `minetest.generate_ores(vm, pos1, pos2)`
2271 * Generate all registered ores within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
2272 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
2273 * `minetest.generate_decorations(vm, pos1, pos2)`
2274 * Generate all registered decorations within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
2275 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
2276 * `minetest.clear_objects([options])`
2277 * Clear all objects in the environment
2278 * Takes an optional table as an argument with the field `mode`.
2279 * mode = `"full"`: Load and go through every mapblock, clearing objects (default).
2280 * mode = `"quick"`: Clear objects immediately in loaded mapblocks;
2281 clear objects in unloaded mapblocks only when the mapblocks are next activated.
2282 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
2283 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be asynchronously
2284 * fetched from memory, loaded from disk, or if inexistent, generates them.
2285 * If `callback` is a valid Lua function, this will be called for each block emerged.
2286 * The function signature of callback is:
2287 * `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
2288 * - `blockpos` is the *block* coordinates of the block that had been emerged
2289 * - `action` could be one of the following constant values:
2290 * `core.EMERGE_CANCELLED`, `core.EMERGE_ERRORED`, `core.EMERGE_FROM_MEMORY`,
2291 * `core.EMERGE_FROM_DISK`, `core.EMERGE_GENERATED`
2292 * - `calls_remaining` is the number of callbacks to be expected after this one
2293 * - `param` is the user-defined parameter passed to emerge_area (or nil if the
2294 * parameter was absent)
2295 * `minetest.delete_area(pos1, pos2)`
2296 * delete all mapblocks in the area from pos1 to pos2, inclusive
2297 * `minetest.line_of_sight(pos1, pos2, stepsize)`: returns `boolean, pos`
2298 * Check if there is a direct line of sight between `pos1` and `pos2`
2299 * Returns the position of the blocking node when `false`
2300 * `pos1`: First position
2301 * `pos2`: Second position
2302 * `stepsize`: smaller gives more accurate results but requires more computing
2303 time. Default is `1`.
2304 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
2305 * returns table containing path
2306 * returns a table of 3D points representing a path from `pos1` to `pos2` or `nil`
2307 * `pos1`: start position
2308 * `pos2`: end position
2309 * `searchdistance`: number of blocks to search in each direction using a maximum metric
2310 * `max_jump`: maximum height difference to consider walkable
2311 * `max_drop`: maximum height difference to consider droppable
2312 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
2313 * `minetest.spawn_tree (pos, {treedef})`
2314 * spawns L-system tree at given `pos` with definition in `treedef` table
2315 * Warning: L-system generation currently creates lighting bugs in the form of mapblock-sized shadows.
2316 Often these bugs appear as subtle shadows in water.
2317 * `minetest.transforming_liquid_add(pos)`
2318 * add node to liquid update queue
2319 * `minetest.get_node_max_level(pos)`
2320 * get max available level for leveled node
2321 * `minetest.get_node_level(pos)`
2322 * get level of leveled node (water, snow)
2323 * `minetest.set_node_level(pos, level)`
2324 * set level of leveled node, default `level` equals `1`
2325 * if `totallevel > maxlevel`, returns rest (`total-max`).
2326 * `minetest.add_node_level(pos, level)`
2327 * increase level of leveled node by level, default `level` equals `1`
2328 * if `totallevel > maxlevel`, returns rest (`total-max`)
2329 * can be negative for decreasing
2330 * `core.check_single_for_falling(pos)`
2331 * causes an unsupported `group:falling_node` node to fall and causes an
2332 unattached `group:attached_node` node to fall.
2333 * does not spread these updates to neighbours.
2334 * `core.check_for_falling(pos)`
2335 * causes an unsupported `group:falling_node` node to fall and causes an
2336 unattached `group:attached_node` node to fall.
2337 * spread these updates to neighbours and can cause a cascade
2341 `minetest.get_inventory(location)`: returns an `InvRef`
2344 * `{type="player", name="celeron55"}`
2345 * `{type="node", pos={x=, y=, z=}}`
2346 * `{type="detached", name="creative"}`
2347 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns an `InvRef`
2348 * callbacks: See "Detached inventory callbacks"
2349 * player_name: Make detached inventory available to one player exclusively,
2350 by default they will be sent to every player (even if not used).
2351 Note that this parameter is mostly just a workaround and will be removed in future releases.
2352 * Creates a detached inventory. If it already exists, it is cleared.
2353 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
2354 returns left over ItemStack
2355 * See `minetest.item_eat` and `minetest.register_on_item_eat`
2358 * `minetest.show_formspec(playername, formname, formspec)`
2359 * `playername`: name of player to show formspec
2360 * `formname`: name passed to `on_player_receive_fields` callbacks.
2361 It should follow the `"modname:<whatever>"` naming convention
2362 * `formspec`: formspec to display
2363 * `minetest.close_formspec(playername, formname)`
2364 * `playername`: name of player to close formspec
2365 * `formname`: has to exactly match the one given in show_formspec, or the formspec will
2367 * calling show_formspec(playername, formname, "") is equal to this expression
2368 * to close a formspec regardless of the formname, call
2369 minetest.close_formspec(playername, ""). USE THIS ONLY WHEN ABSOLUTELY NECESSARY!
2370 * `minetest.formspec_escape(string)`: returns a string
2371 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
2372 * `minetest.explode_table_event(string)`: returns a table
2373 * returns e.g. `{type="CHG", row=1, column=2}`
2375 * `"INV"`: no row selected)
2376 * `"CHG"`: selected)
2377 * `"DCL"`: double-click
2378 * `minetest.explode_textlist_event(string)`: returns a table
2379 * returns e.g. `{type="CHG", index=1}`
2381 * `"INV"`: no row selected)
2382 * `"CHG"`: selected)
2383 * `"DCL"`: double-click
2384 * `minetest.explode_scrollbar_event(string)`: returns a table
2385 * returns e.g. `{type="CHG", value=500}`
2387 * `"INV"`: something failed
2388 * `"CHG"`: has been changed
2389 * `"VAL"`: not changed
2392 * `minetest.inventorycube(img1, img2, img3)`
2393 * Returns a string for making an image of a cube (useful as an item image)
2394 * `minetest.get_pointed_thing_position(pointed_thing, above)`
2395 * Get position of a `pointed_thing` (that you can get from somewhere)
2396 * `minetest.dir_to_facedir(dir, is6d)`
2397 * Convert a vector to a facedir value, used in `param2` for `paramtype2="facedir"`;
2398 * passing something non-`nil`/`false` for the optional second parameter causes it to
2399 take the y component into account
2400 * `minetest.facedir_to_dir(facedir)`
2401 * Convert a facedir back into a vector aimed directly out the "back" of a node
2402 * `minetest.dir_to_wallmounted(dir)`
2403 * Convert a vector to a wallmounted value, used for `paramtype2="wallmounted"`
2404 * `minetest.wallmounted_to_dir(wallmounted)`
2405 * Convert a wallmounted value back into a vector aimed directly out the "back" of a node
2406 * `minetest.dir_to_yaw(dir)`
2407 * Convert a vector into a yaw (angle)
2408 * `minetest.yaw_to_dir(yaw)`
2409 * Convert yaw (angle) to a vector
2410 * `minetest.get_node_drops(nodename, toolname)`
2411 * Returns list of item names.
2412 * **Note**: This will be removed or modified in a future version.
2413 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
2414 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2415 * `input.width` = for example `3`
2416 * `input.items` = for example
2417 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2418 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
2419 * `output.time` = a number, if unsuccessful: `0`
2420 * `output.replacements` = list of `ItemStack`s that couldn't be placed in
2421 `decremented_input.items`
2422 * `decremented_input` = like `input`
2423 * `minetest.get_craft_recipe(output)`: returns input
2424 * returns last registered recipe for output item (node)
2425 * `output` is a node or item type such as `"default:torch"`
2426 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2427 * `input.width` = for example `3`
2428 * `input.items` = for example
2429 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2430 * `input.items` = `nil` if no recipe found
2431 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
2432 * returns indexed table with all registered recipes for query item (node)
2433 or `nil` if no recipe was found
2434 * recipe entry table:
2436 method = 'normal' or 'cooking' or 'fuel'
2437 width = 0-3, 0 means shapeless recipe
2438 items = indexed [1-9] table with recipe items
2439 output = string with item name and quantity
2441 * Example query for `"default:gold_ingot"` will return table:
2443 [1]={type = "cooking", width = 3, output = "default:gold_ingot",
2444 items = {1 = "default:gold_lump"}},
2445 [2]={type = "normal", width = 1, output = "default:gold_ingot 9",
2446 items = {1 = "default:goldblock"}}
2448 * `minetest.handle_node_drops(pos, drops, digger)`
2449 * `drops`: list of itemstrings
2450 * Handles drops from nodes after digging: Default action is to put them into
2452 * Can be overridden to get different functionality (e.g. dropping items on
2456 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
2457 returns `{{actor, pos, time, oldnode, newnode}, ...}`
2458 * Find who has done something to a node, or near a node
2459 * `actor`: `"player:<name>"`, also `"liquid"`.
2460 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns `boolean, log_messages`
2461 * Revert latest actions of someone
2462 * `actor`: `"player:<name>"`, also `"liquid"`.
2464 ### Defaults for the `on_*` item definition functions
2465 These functions return the leftover itemstack.
2467 * `minetest.item_place_node(itemstack, placer, pointed_thing, param2)`
2468 * Place item as a node
2469 * `param2` overrides `facedir` and wallmounted `param2`
2470 * returns `itemstack, success`
2471 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
2473 * `minetest.item_place(itemstack, placer, pointed_thing, param2)`
2474 * Use one of the above based on what the item is.
2475 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
2476 * **Note**: is not called when wielded item overrides `on_place`
2477 * `param2` overrides `facedir` and wallmounted `param2`
2478 * returns `itemstack, success`
2479 * `minetest.item_drop(itemstack, dropper, pos)`
2481 * `minetest.item_eat(hp_change, replace_with_item)`
2483 * `replace_with_item` is the itemstring which is added to the inventory.
2484 If the player is eating a stack, then replace_with_item goes to a
2485 different spot. Can be `nil`
2486 * See `minetest.do_item_eat`
2488 ### Defaults for the `on_punch` and `on_dig` node definition callbacks
2489 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
2490 * Calls functions registered by `minetest.register_on_punchnode()`
2491 * `minetest.node_dig(pos, node, digger)`
2492 * Checks if node can be dug, puts item into inventory, removes node
2493 * Calls functions registered by `minetest.registered_on_dignodes()`
2496 * `minetest.sound_play(spec, parameters)`: returns a handle
2497 * `spec` is a `SimpleSoundSpec`
2498 * `parameters` is a sound parameter table
2499 * `minetest.sound_stop(handle)`
2502 * `minetest.after(time, func, ...)`
2503 * Call the function `func` after `time` seconds, may be fractional
2504 * Optional: Variable number of arguments that are passed to `func`
2507 * `minetest.request_shutdown([message],[reconnect])`: request for server shutdown. Will display `message` to clients,
2508 and `reconnect` == true displays a reconnect button.
2509 * `minetest.get_server_status()`: returns server status string
2510 * `minetest.get_server_uptime()`: returns the server uptime in seconds
2513 * `minetest.get_ban_list()`: returns the ban list (same as `minetest.get_ban_description("")`)
2514 * `minetest.get_ban_description(ip_or_name)`: returns ban description (string)
2515 * `minetest.ban_player(name)`: ban a player
2516 * `minetest.unban_player_or_ip(name)`: unban player or IP address
2517 * `minetest.kick_player(name, [reason])`: disconnect a player with a optional reason
2520 * `minetest.add_particle(particle definition)`
2521 * Deprecated: `minetest.add_particle(pos, velocity, acceleration, expirationtime,
2522 size, collisiondetection, texture, playername)`
2524 * `minetest.add_particlespawner(particlespawner definition)`
2525 * Add a `ParticleSpawner`, an object that spawns an amount of particles over `time` seconds
2526 * Returns an `id`, and -1 if adding didn't succeed
2527 * `Deprecated: minetest.add_particlespawner(amount, time,
2531 minexptime, maxexptime,
2533 collisiondetection, texture, playername)`
2535 * `minetest.delete_particlespawner(id, player)``
2536 * Delete `ParticleSpawner` with `id` (return value from `minetest.add_particlespawner`)
2537 * If playername is specified, only deletes on the player's client,
2538 * otherwise on all clients
2541 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
2542 * Create a schematic from the volume of map specified by the box formed by p1 and p2.
2543 * Apply the specified probability values to the specified nodes in `probability_list`.
2544 * `probability_list` is an array of tables containing two fields, `pos` and `prob`.
2545 * `pos` is the 3D vector specifying the absolute coordinates of the
2546 node being modified,
2547 * `prob` is the integer value from `0` to `255` of the probability (see: Schematic specifier).
2548 * If there are two or more entries with the same pos value, the
2550 * If `pos` is not inside the box formed by `p1` and `p2`, it is ignored.
2551 * If `probability_list` equals `nil`, no probabilities are applied.
2552 * Slice probability works in the same manner, except takes a field
2553 called `ypos` instead which
2554 indicates the y position of the slice with a probability applied.
2555 * If slice probability list equals `nil`, no slice probabilities are applied.
2556 * Saves schematic in the Minetest Schematic format to filename.
2558 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement)`
2559 * Place the schematic specified by schematic (see: Schematic specifier) at `pos`.
2560 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
2561 * If the `rotation` parameter is omitted, the schematic is not rotated.
2562 * `replacements` = `{["old_name"] = "convert_to", ...}`
2563 * `force_placement` is a boolean indicating whether nodes other than `air` and
2564 `ignore` are replaced by the schematic
2565 * Returns nil if the schematic could not be loaded.
2567 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement)`:
2568 * This function is analagous to minetest.place_schematic, but places a schematic onto the
2569 specified VoxelManip object `vmanip` instead of the whole map.
2570 * Returns false if any part of the schematic was cut-off due to the VoxelManip not
2571 containing the full area required, and true if the whole schematic was able to fit.
2572 * Returns nil if the schematic could not be loaded.
2573 * After execution, any external copies of the VoxelManip contents are invalidated.
2575 * `minetest.serialize_schematic(schematic, format, options)`
2576 * Return the serialized schematic specified by schematic (see: Schematic specifier)
2577 * in the `format` of either "mts" or "lua".
2578 * "mts" - a string containing the binary MTS data used in the MTS file format
2579 * "lua" - a string containing Lua code representing the schematic in table format
2580 * `options` is a table containing the following optional parameters:
2581 * If `lua_use_comments` is true and `format` is "lua", the Lua code generated will have (X, Z)
2582 * position comments for every X row generated in the schematic data for easier reading.
2583 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua", the Lua code generated
2584 * will use that number of spaces as indentation instead of a tab character.
2587 * `minetest.request_http_api()`:
2588 * returns `HTTPApiTable` containing http functions if the calling mod has been granted
2589 access by being listed in the `secure.http_mods` or `secure.trusted_mods` setting,
2590 otherwise returns `nil`.
2591 * The returned table contains the functions `fetch`, `fetch_async` and `fetch_async_get`
2593 * Only works at init time and must be called from the mod's main scope (not from a function).
2594 * Function only exists if minetest server was built with cURL support.
2595 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
2597 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
2598 * Performs given request asynchronously and calls callback upon completion
2599 * callback: `function(HTTPRequestResult res)`
2600 * Use this HTTP function if you are unsure, the others are for advanced use.
2601 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
2602 * Performs given request asynchronously and returns handle for `HTTPApiTable.fetch_async_get`
2603 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
2604 * Return response data for given asynchronous HTTP request
2607 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
2608 * `minetest.player_exists(name)`: boolean, whether player exists (regardless of online status)
2609 * `minetest.hud_replace_builtin(name, hud_definition)`
2610 * Replaces definition of a builtin hud element
2611 * `name`: `"breath"` or `"health"`
2612 * `hud_definition`: definition to replace builtin definition
2613 * `minetest.hash_node_position({x=,y=,z=})`: returns an 48-bit integer
2614 * Gives a unique hash number for a node position (16+16+16=48bit)
2615 * `minetest.get_position_from_hash(hash)`: returns a position
2616 * Inverse transform of `minetest.hash_node_position`
2617 * `minetest.get_item_group(name, group)`: returns a rating
2618 * Get rating of a group of an item. (`0` means: not in group)
2619 * `minetest.get_node_group(name, group)`: returns a rating
2620 * Deprecated: An alias for the former.
2621 * `minetest.raillike_group(name)`: returns a rating
2622 * Returns rating of the connect_to_raillike group corresponding to name
2623 * If name is not yet the name of a connect_to_raillike group, a new group id
2624 * is created, with that name
2625 * `minetest.get_content_id(name)`: returns an integer
2626 * Gets the internal content ID of `name`
2627 * `minetest.get_name_from_content_id(content_id)`: returns a string
2628 * Gets the name of the content with that content ID
2629 * `minetest.parse_json(string[, nullvalue])`: returns something
2630 * Convert a string containing JSON data into the Lua equivalent
2631 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
2632 * On success returns a table, a string, a number, a boolean or `nullvalue`
2633 * On failure outputs an error message and returns `nil`
2634 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
2635 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
2636 * Convert a Lua table into a JSON string
2637 * styled: Outputs in a human-readable format if this is set, defaults to false
2638 * Unserializable things like functions and userdata are saved as null.
2639 * **Warning**: JSON is more strict than the Lua table format.
2640 1. You can only use strings and positive integers of at least one as keys.
2641 2. You can not mix string and integer keys.
2642 This is due to the fact that JSON has two distinct array and object values.
2643 * Example: `write_json({10, {a = false}})`, returns `"[10, {\"a\": false}]"`
2644 * `minetest.serialize(table)`: returns a string
2645 * Convert a table containing tables, strings, numbers, booleans and `nil`s
2646 into string form readable by `minetest.deserialize`
2647 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
2648 * `minetest.deserialize(string)`: returns a table
2649 * Convert a string returned by `minetest.deserialize` into a table
2650 * `string` is loaded in an empty sandbox environment.
2651 * Will load functions, but they cannot access the global environment.
2652 * Example: `deserialize('return { ["foo"] = "bar" }')`, returns `{foo='bar'}`
2653 * Example: `deserialize('print("foo")')`, returns `nil` (function call fails)
2654 * `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
2655 * `minetest.compress(data, method, ...)`: returns `compressed_data`
2656 * Compress a string of data.
2657 * `method` is a string identifying the compression method to be used.
2658 * Supported compression methods:
2659 * Deflate (zlib): `"deflate"`
2660 * `...` indicates method-specific arguments. Currently defined arguments are:
2661 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
2662 * `minetest.decompress(compressed_data, method, ...)`: returns data
2663 * Decompress a string of data (using ZLib).
2664 * See documentation on `minetest.compress()` for supported compression methods.
2665 * currently supported.
2666 * `...` indicates method-specific arguments. Currently, no methods use this.
2667 * `minetest.encode_base64(string)`: returns string encoded in base64
2668 * Encodes a string in base64.
2669 * `minetest.decode_base64(string)`: returns string
2670 * Decodes a string encoded in base64.
2671 * `minetest.is_protected(pos, name)`: returns boolean
2672 * Returns true, if player `name` shouldn't be abled to dig at `pos` or do other
2673 actions, defineable by mods, due to some mod-defined ownership-like concept.
2674 Returns false or nil, if the player is allowed to do such actions.
2675 * This function should be overridden by protection mods and should be used to
2676 check if a player can interact at a position.
2677 * This function should call the old version of itself if the position is not
2678 protected by the mod.
2681 local old_is_protected = minetest.is_protected
2682 function minetest.is_protected(pos, name)
2683 if mymod:position_protected_from(pos, name) then
2686 return old_is_protected(pos, name)
2688 * `minetest.record_protection_violation(pos, name)`
2689 * This function calls functions registered with
2690 `minetest.register_on_protection_violation`.
2691 * `minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)`
2692 * Attempt to predict the desired orientation of the facedir-capable node
2693 defined by `itemstack`, and place it accordingly (on-wall, on the floor, or
2694 hanging from the ceiling). Stacks are handled normally if the `infinitestacks`
2695 field is false or omitted (else, the itemstack is not changed). `orient_flags`
2696 is an optional table containing extra tweaks to the placement code:
2697 * `invert_wall`: if `true`, place wall-orientation on the ground and ground-
2698 orientation on the wall.
2699 * `force_wall` : if `true`, always place the node in wall orientation.
2700 * `force_ceiling`: if `true`, always place on the ceiling.
2701 * `force_floor`: if `true`, always place the node on the floor.
2702 * `force_facedir`: if `true`, forcefully reset the facedir to north when placing on
2703 the floor or ceiling
2704 * The first four options are mutually-exclusive; the last in the list takes
2705 precedence over the first.
2706 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
2707 * calls `rotate_and_place()` with infinitestacks set according to the state of
2708 the creative mode setting, and checks for "sneak" to set the `invert_wall`
2711 * `minetest.forceload_block(pos[, transient])`
2712 * forceloads the position `pos`.
2713 * returns `true` if area could be forceloaded
2714 * If `transient` is `false` or absent, the forceload will be persistent
2715 (saved between server runs). If `true`, the forceload will be transient
2716 (not saved between server runs).
2718 * `minetest.forceload_free_block(pos[, transient])`
2719 * stops forceloading the position `pos`
2720 * If `transient` is `false` or absent, frees a persistent forceload.
2721 If `true`, frees a transient forceload.
2723 * `minetest.request_insecure_environment()`: returns an environment containing
2724 insecure functions if the calling mod has been listed as trusted in the
2725 `secure.trusted_mods` setting or security is disabled, otherwise returns `nil`.
2726 * Only works at init time and must be called from the mod's main scope (not from a function).
2727 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE IT IN
2730 * `minetest.global_exists(name)`
2731 * Checks if a global variable has been set, without triggering a warning.
2734 * `minetest.env`: `EnvRef` of the server environment and world.
2735 * Any function in the minetest namespace can be called using the syntax
2736 `minetest.env:somefunction(somearguments)`
2737 instead of `minetest.somefunction(somearguments)`
2738 * Deprecated, but support is not to be dropped soon
2741 * `minetest.registered_items`
2742 * Map of registered items, indexed by name
2743 * `minetest.registered_nodes`
2744 * Map of registered node definitions, indexed by name
2745 * `minetest.registered_craftitems`
2746 * Map of registered craft item definitions, indexed by name
2747 * `minetest.registered_tools`
2748 * Map of registered tool definitions, indexed by name
2749 * `minetest.registered_entities`
2750 * Map of registered entity prototypes, indexed by name
2751 * `minetest.object_refs`
2752 * Map of object references, indexed by active object id
2753 * `minetest.luaentities`
2754 * Map of Lua entities, indexed by active object id
2755 * `minetest.registered_chatcommands`
2756 * Map of registered chat command definitions, indexed by name
2757 * `minetest.registered_ores`
2758 * List of registered ore definitions.
2759 * `minetest.registered_biomes`
2760 * List of registered biome definitions.
2761 * `minetest.registered_decorations`
2762 * List of registered decoration definitions.
2768 Node metadata: reference extra data and functionality stored in a node.
2769 Can be gotten via `minetest.get_meta(pos)`.
2772 * `set_string(name, value)`
2773 * `get_string(name)`
2774 * `set_int(name, value)`
2776 * `set_float(name, value)`
2778 * `get_inventory()`: returns `InvRef`
2779 * `to_table()`: returns `nil` or `{fields = {...}, inventory = {list1 = {}, ...}}`
2780 * `from_table(nil or {})`
2781 * to clear metadata, use from_table(nil)
2782 * See "Node Metadata"
2785 Node Timers: a high resolution persistent per-node timer.
2786 Can be gotten via `minetest.get_node_timer(pos)`.
2789 * `set(timeout,elapsed)`
2790 * set a timer's state
2791 * `timeout` is in seconds, and supports fractional values (0.1 etc)
2792 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
2793 * will trigger the node's `on_timer` function after `timeout`-elapsed seconds
2796 * equivalent to `set(timeout,0)`
2799 * `get_timeout()`: returns current timeout in seconds
2800 * if `timeout` equals `0`, timer is inactive
2801 * `get_elapsed()`: returns current elapsed time in seconds
2802 * the node's `on_timer` function will be called after `timeout`-elapsed seconds
2803 * `is_started()`: returns boolean state of timer
2804 * returns `true` if timer is started, otherwise `false`
2807 Moving things in the game are generally these.
2809 This is basically a reference to a C++ `ServerActiveObject`
2812 * `remove()`: remove object (after returning from Lua)
2813 * Note: Doesn't work on players, use minetest.kick_player instead
2814 * `get_pos()`: returns `{x=num, y=num, z=num}`
2815 * `set_pos(pos)`; `pos`=`{x=num, y=num, z=num}`
2816 * `move_to(pos, continuous=false)`: interpolated move
2817 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
2818 * `puncher` = another `ObjectRef`,
2819 * `time_from_last_punch` = time since last punch action of the puncher
2820 * `direction`: can be `nil`
2821 * `right_click(clicker)`; `clicker` is another `ObjectRef`
2822 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
2823 * `set_hp(hp)`: set number of hitpoints (2 * number of hearts)
2824 * `get_inventory()`: returns an `InvRef`
2825 * `get_wield_list()`: returns the name of the inventory list the wielded item is in
2826 * `get_wield_index()`: returns the index of the wielded item
2827 * `get_wielded_item()`: returns an `ItemStack`
2828 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if successful
2829 * `set_armor_groups({group1=rating, group2=rating, ...})`
2830 * `get_armor_groups()`: returns a table with the armor group ratings
2831 * `set_animation({x=1,y=1}, frame_speed=15, frame_blend=0, frame_loop=true)`
2832 * `get_animation()`: returns range, frame_speed, frame_blend and frame_loop
2833 * `set_attach(parent, bone, position, rotation)`
2835 * `position`: `{x=num, y=num, z=num}` (relative)
2836 * `rotation`: `{x=num, y=num, z=num}`
2837 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't attached
2839 * `set_bone_position(bone, position, rotation)`
2841 * `position`: `{x=num, y=num, z=num}` (relative)
2842 * `rotation`: `{x=num, y=num, z=num}`
2843 * `get_bone_position(bone)`: returns position and rotation of the bone
2844 * `set_properties(object property table)`
2845 * `get_properties()`: returns object property table
2846 * `is_player()`: returns true for players, false otherwise
2847 * `get_nametag_attributes()`
2848 * returns a table with the attributes of the nametag of an object
2850 color = {a=0..255, r=0..255, g=0..255, b=0..255},
2853 * `set_nametag_attributes(attributes)`
2854 * sets the attributes of the nametag of an object
2858 text = "My Nametag",
2861 ##### LuaEntitySAO-only (no-op for other objects)
2862 * `set_velocity({x=num, y=num, z=num})`
2863 * `get_velocity()`: returns `{x=num, y=num, z=num}`
2864 * `set_acceleration({x=num, y=num, z=num})`
2865 * `get_acceleration()`: returns `{x=num, y=num, z=num}`
2866 * `set_yaw(radians)`
2867 * `get_yaw()`: returns number in radians
2868 * `set_texture_mod(mod)`
2869 * `get_texture_mod()` returns current texture modifier
2870 * `set_sprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
2871 select_horiz_by_yawpitch=false)`
2872 * Select sprite from spritesheet with optional animation and DM-style
2873 texture selection based on yaw relative to camera
2874 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
2877 ##### Player-only (no-op for other objects)
2878 * `get_player_name()`: returns `""` if is not a player
2879 * `get_player_velocity()`: returns `nil` if is not a player, otherwise a
2880 table {x, y, z} representing the player's instantaneous velocity in nodes/s
2881 * `get_look_dir()`: get camera direction as a unit vector
2882 * `get_look_vertical()`: pitch in radians
2883 * Angle ranges between -pi/2 and pi/2, which are straight up and down respectively.
2884 * `get_look_horizontal()`: yaw in radians
2885 * Angle is counter-clockwise from the +z direction.
2886 * `set_look_vertical(radians)`: sets look pitch
2887 * radians - Angle from looking forward, where positive is downwards.
2888 * `set_look_horizontal(radians)`: sets look yaw
2889 * radians - Angle from the +z direction, where positive is counter-clockwise.
2890 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use get_look_vertical.
2891 * Angle ranges between -pi/2 and pi/2, which are straight down and up respectively.
2892 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use get_look_horizontal.
2893 * Angle is counter-clockwise from the +x direction.
2894 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use set_look_vertical.
2895 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use set_look_horizontal.
2896 * `get_breath()`: returns players breath
2897 * `set_breath(value)`: sets players breath
2899 * `0`: player is drowning,
2900 * `1`-`10`: remaining number of bubbles
2901 * `11`: bubbles bar is not shown
2902 * `set_inventory_formspec(formspec)`
2903 * Redefine player's inventory form
2904 * Should usually be called in on_joinplayer
2905 * `get_inventory_formspec()`: returns a formspec string
2906 * `get_player_control()`: returns table with player pressed keys
2907 * `{jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}`
2908 * `get_player_control_bits()`: returns integer with bit packed player pressed keys
2909 * bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
2910 * `set_physics_override(override_table)`
2911 * `override_table` is a table with the following fields:
2912 * `speed`: multiplier to default walking speed value (default: `1`)
2913 * `jump`: multiplier to default jump value (default: `1`)
2914 * `gravity`: multiplier to default gravity value (default: `1`)
2915 * `sneak`: whether player can sneak (default: `true`)
2916 * `sneak_glitch`: whether player can use the sneak glitch (default: `true`)
2917 * `get_physics_override()`: returns the table given to set_physics_override
2918 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
2920 * `hud_remove(id)`: remove the HUD element of the specified id
2921 * `hud_change(id, stat, value)`: change a value of a previously added HUD element
2922 * element `stat` values: `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
2923 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
2924 * `hud_set_flags(flags)`: sets specified HUD flags to `true`/`false`
2925 * `flags`: (is visible) `hotbar`, `healthbar`, `crosshair`, `wielditem`, `minimap`
2926 * pass a table containing a `true`/`false` value of each flag to be set or unset
2927 * if a flag equals `nil`, the flag is not modified
2928 * note that setting `minimap` modifies the client's permission to view the minimap -
2929 * the client may locally elect to not view the minimap
2930 * `hud_get_flags()`: returns a table containing status of hud flags
2931 * returns `{ hotbar=true, healthbar=true, crosshair=true, wielditem=true, breathbar=true, minimap=true }`
2932 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
2933 * `count`: number of items, must be between `1` and `23`
2934 * `hud_get_hotbar_itemcount`: returns number of visible items
2935 * `hud_set_hotbar_image(texturename)`
2936 * sets background image for hotbar
2937 * `hud_get_hotbar_image`: returns texturename
2938 * `hud_set_hotbar_selected_image(texturename)`
2939 * sets image for selected item of hotbar
2940 * `hud_get_hotbar_selected_image`: returns texturename
2941 * `set_sky(bgcolor, type, {texture names})`
2942 * `bgcolor`: ColorSpec, defaults to white
2944 * `"regular"`: Uses 0 textures, `bgcolor` ignored
2945 * `"skybox"`: Uses 6 textures, `bgcolor` used
2946 * `"plain"`: Uses 0 textures, `bgcolor` used
2947 * `get_sky()`: returns bgcolor, type and a table with the textures
2948 * `override_day_night_ratio(ratio or nil)`
2949 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific amount
2950 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
2951 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
2952 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`
2954 set animation for player model in third person view
2956 set_local_animation({x=0, y=79}, -- < stand/idle animation key frames
2957 {x=168, y=187}, -- < walk animation key frames
2958 {x=189, y=198}, -- < dig animation key frames
2959 {x=200, y=219}, -- < walk+dig animation key frames
2960 frame_speed=30): -- < animation frame speed
2961 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and frame_speed
2962 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for camera per player
2963 * in first person view
2964 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
2965 * `get_eye_offset()`: returns offset_first and offset_third
2968 An `InvRef` is a reference to an inventory.
2971 * `is_empty(listname)`: return `true` if list is empty
2972 * `get_size(listname)`: get size of a list
2973 * `set_size(listname, size)`: set size of a list
2974 * returns `false` on error (e.g. invalid `listname` or `size`)
2975 * `get_width(listname)`: get width of a list
2976 * `set_width(listname, width)`: set width of list; currently used for crafting
2977 * `get_stack(listname, i)`: get a copy of stack index `i` in list
2978 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
2979 * `get_list(listname)`: return full list
2980 * `set_list(listname, list)`: set full list (size will not change)
2981 * `get_lists()`: returns list of inventory lists
2982 * `set_lists(lists)`: sets inventory lists (size will not change)
2983 * `add_item(listname, stack)`: add item somewhere in list, returns leftover `ItemStack`
2984 * `room_for_item(listname, stack):` returns `true` if the stack of items
2985 can be fully added to the list
2986 * `contains_item(listname, stack)`: returns `true` if the stack of items
2987 can be fully taken from the list
2988 * `remove_item(listname, stack)`: take as many items as specified from the list,
2989 returns the items that were actually removed (as an `ItemStack`) -- note that
2990 any item metadata is ignored, so attempting to remove a specific unique
2991 item this way will likely remove the wrong one -- to do that use `set_stack`
2992 with an empty `ItemStack`
2993 * `get_location()`: returns a location compatible to `minetest.get_inventory(location)`
2994 * returns `{type="undefined"}` in case location is not known
2997 A fast access data structure to store areas, and find areas near a given position or area.
2998 Every area has a `data` string attribute to store additional information.
2999 You can create an empty `AreaStore` by calling `AreaStore()`, or `AreaStore(type_name)`.
3000 If you chose the parameter-less constructor, a fast implementation will be automatically
3004 * `get_area(id, include_borders, include_data)`: returns the area with the id `id`.
3005 (optional) Boolean values `include_borders` and `include_data` control what's copied.
3006 Returns nil if specified area id does not exist.
3007 * `get_areas_for_pos(pos, include_borders, include_data)`: returns all areas that contain
3008 the position `pos`. (optional) Boolean values `include_borders` and `include_data` control
3010 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`:
3011 returns all areas that contain all nodes inside the area specified by `edge1` and `edge2` (inclusive).
3012 If `accept_overlap` is true, also areas are returned that have nodes in common with the specified area.
3013 (optional) Boolean values `include_borders` and `include_data` control what's copied.
3014 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store. Returns the new area's ID,
3015 or nil if the insertion failed. The (inclusive) positions `edge1` and `edge2` describe the area.
3016 `data` is a string stored with the area. If passed, `id` will be used as the internal area ID,
3017 it must be a unique number between 0 and 2^32-2. If you use the `id` parameter you must always use it,
3018 or insertions are likely to fail due to conflicts.
3019 * `reserve(count)`: reserves resources for at most `count` many contained areas.
3020 Only needed for efficiency, and only some implementations profit.
3021 * `remove_area(id)`: removes the area with the given id from the store, returns success.
3022 * `set_cache_params(params)`: sets params for the included prefiltering cache.
3023 Calling invalidates the cache, so that its elements have to be newly generated.
3026 enabled = boolean, -- whether to enable, default true
3027 block_radius = number, -- the radius (in nodes) of the areas the cache generates
3028 prefiltered lists for, minimum 16, default 64
3029 limit = number, -- the cache's size, minimum 20, default 1000
3031 * `to_string()`: Experimental. Returns area store serialized as a (binary) string.
3032 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to a file.
3033 * `from_string(str)`: Experimental. Deserializes string and loads it into the AreaStore.
3034 Returns success and, optionally, an error message.
3035 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data from a file.
3038 An `ItemStack` is a stack of items.
3040 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
3041 an itemstring, a table or `nil`.
3044 * `is_empty()`: Returns `true` if stack is empty.
3045 * `get_name()`: Returns item name (e.g. `"default:stone"`).
3046 * `set_name(item_name)`: Returns boolean whether item was cleared
3047 * `get_count()`: Returns number of items on the stack.
3048 * `set_count(count)`: Returns boolean whether item was cleared
3049 * `get_wear()`: Returns tool wear (`0`-`65535`), `0` for non-tools.
3050 * `set_wear(wear)`: Returns boolean whether item was cleared
3051 * `get_metadata()`: Returns metadata (a string attached to an item stack).
3052 * `set_metadata(metadata)`: Returns true.
3053 * `clear()`: removes all items from the stack, making it empty.
3054 * `replace(item)`: replace the contents of this stack.
3055 * `item` can also be an itemstring or table.
3056 * `to_string()`: Returns the stack in itemstring form.
3057 * `to_table()`: Returns the stack in Lua table form.
3058 * `get_stack_max()`: Returns the maximum size of the stack (depends on the item).
3059 * `get_free_space()`: Returns `get_stack_max() - get_count()`.
3060 * `is_known()`: Returns `true` if the item name refers to a defined item type.
3061 * `get_definition()`: Returns the item definition table.
3062 * `get_tool_capabilities()`: Returns the digging properties of the item,
3063 or those of the hand if none are defined for this item type
3064 * `add_wear(amount)`: Increases wear by `amount` if the item is a tool.
3065 * `add_item(item)`: Put some item or stack onto this stack.
3066 Returns leftover `ItemStack`.
3067 * `item_fits(item)`: Returns `true` if item or stack can be fully added to
3069 * `take_item(n=1)`: Take (and remove) up to `n` items from this stack.
3070 Returns taken `ItemStack`.
3071 * `peek_item(n=1)`: copy (don't remove) up to `n` items from this stack.
3072 Returns taken `ItemStack`.
3075 A 16-bit pseudorandom number generator.
3076 Uses a well-known LCG algorithm introduced by K&R.
3078 It can be created via `PseudoRandom(seed)`.
3081 * `next()`: return next integer random number [`0`...`32767`]
3082 * `next(min, max)`: return next integer random number [`min`...`max`]
3083 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
3084 due to the simple implementation making bad distribution otherwise.
3087 A 32-bit pseudorandom number generator.
3088 Uses PCG32, an algorithm of the permuted congruential generator family, offering very strong randomness.
3090 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
3093 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
3094 * `next(min, max)`: return next integer random number [`min`...`max`]
3095 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed random number [`min`...`max`]
3096 * This is only a rough approximation of a normal distribution with:
3097 * mean = (max - min) / 2, and
3098 * variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)
3099 * Increasing num_trials improves accuracy of the approximation
3102 Interface for the operating system's crypto-secure PRNG.
3104 It can be created via `SecureRandom()`. The constructor returns nil if a secure random device cannot be
3105 be found on the system.
3108 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many random bytes, as a string.
3111 A perlin noise generator.
3112 It can be created via `PerlinNoise(seed, octaves, persistence, scale)`
3113 or `PerlinNoise(noiseparams)`.
3114 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
3115 or `minetest.get_perlin(noiseparams)`.
3118 * `get2d(pos)`: returns 2D noise value at `pos={x=,y=}`
3119 * `get3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
3121 ### `PerlinNoiseMap`
3122 A fast, bulk perlin noise generator.
3124 It can be created via `PerlinNoiseMap(noiseparams, size)` or
3125 `minetest.get_perlin_map(noiseparams, size)`.
3127 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` conponent is ommitted
3128 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
3131 For each of the functions with an optional `buffer` parameter: If `buffer` is not
3132 nil, this table will be used to store the result instead of creating a new table.
3136 * `get2dMap(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
3137 with values starting at `pos={x=,y=}`
3138 * `get3dMap(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>` 3D array
3139 of 3D noise with values starting at `pos={x=,y=,z=}`
3140 * `get2dMap_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element array of 2D noise
3141 with values starting at `pos={x=,y=}`
3142 * `get3dMap_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
3143 * `calc2dMap(pos)`: Calculates the 2d noise map starting at `pos`. The result is stored internally.
3144 * `calc3dMap(pos)`: Calculates the 3d noise map starting at `pos`. The result is stored internally.
3145 * `getMapSlice(slice_offset, slice_size, buffer)`: In the form of an array, returns a slice of the
3146 most recently computed noise results. The result slice begins at coordinates `slice_offset` and
3147 takes a chunk of `slice_size`.
3148 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer offset y = 20:
3149 `noisevals = noise:getMapSlice({y=20}, {y=2})`
3150 It is important to note that `slice_offset` offset coordinates begin at 1, and are relative to
3151 the starting position of the most recently calculated noise.
3152 To grab a single vertical column of noise starting at map coordinates x = 1023, y=1000, z = 1000:
3153 `noise:calc3dMap({x=1000, y=1000, z=1000})`
3154 `noisevals = noise:getMapSlice({x=24, z=1}, {x=1, z=1})`
3158 #### About VoxelManip
3159 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator' facility. The purpose of
3160 this object is for fast, low-level, bulk access to reading and writing Map content. As such, setting
3161 map nodes through VoxelManip will lack many of the higher level features and concepts you may be used
3162 to with other methods of setting nodes. For example, nodes will not have their construction and
3163 destruction callbacks run, and no rollback information is logged.
3165 It is important to note that VoxelManip is designed for speed, and *not* ease of use or flexibility.
3166 If your mod requires a map manipulation facility that will handle 100% of all edge cases, or the use
3167 of high level node placement features, perhaps minetest.set_node() is better suited for the job.
3169 In addition, VoxelManip might not be faster, or could even be slower, for your specific use case.
3170 VoxelManip is most effective when setting very large areas of map at once - for example, if only
3171 setting a 5x5x5 node area, a minetest.set_node() loop may be more optimal. Always profile code
3172 using both methods of map manipulation to determine which is most appropriate for your usage.
3174 #### Using VoxelManip
3175 A VoxelManip object can be created any time using either:
3176 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
3178 If the optional position parameters are present for either of these routines, the specified region
3179 will be pre-loaded into the VoxelManip object on creation. Otherwise, the area of map you wish to
3180 manipulate must first be loaded into the VoxelManip object using `VoxelManip:read_from_map()`.
3182 Note that `VoxelManip:read_from_map()` returns two position vectors. The region formed by these
3183 positions indicate the minimum and maximum (respectively) positions of the area actually loaded in
3184 the VoxelManip, which may be larger than the area requested. For convenience, the loaded area
3185 coordinates can also be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
3187 Now that the VoxelManip object is populated with map data, your mod can fetch a copy of this data
3188 using either of two methods. `VoxelManip:get_node_at()`, which retrieves an individual node in a
3189 MapNode formatted table at the position requested is the simplest method to use, but also the slowest.
3191 Nodes in a VoxelManip object may also be read in bulk to a flat array table using:
3192 `VoxelManip:get_data()` for node content (in Content ID form, see section 'Content IDs'),
3193 `VoxelManip:get_light_data()` for node light levels, and
3194 `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
3196 See section 'Flat array format' for more details.
3198 It is very important to understand that the tables returned by any of the above three functions
3199 represent a snapshot of the VoxelManip's internal state at the time of the call. This copy of the
3200 data will *not* magically update itself if another function modifies the internal VoxelManip state.
3201 Any functions that modify a VoxelManip's contents work on the VoxelManip's internal state unless
3202 otherwise explicitly stated.
3204 Once the bulk data has been edited to your liking, the internal VoxelManip state can be set using:
3205 `VoxelManip:set_data()` for node content (in Content ID form, see section 'Content IDs'),
3206 `VoxelManip:set_light_data()` for node light levels, and
3207 `VoxelManip:set_param2_data()` for the node type-dependent "param2" values.
3209 The parameter to each of the above three functions can use any table at all in the same flat array
3210 format as produced by get_data() et al. and is *not required* to be a table retrieved from get_data().
3212 Once the internal VoxelManip state has been modified to your liking, the changes can be committed back
3213 to the map by calling `VoxelManip:write_to_map()`.
3215 Finally, a call to `VoxelManip:update_map()` is required to re-calculate lighting and set the blocks
3216 as being modified so that connected clients are sent the updated parts of map.
3219 ##### Flat array format
3221 `Nx = p2.X - p1.X + 1`,
3222 `Ny = p2.Y - p1.Y + 1`, and
3223 `Nz = p2.Z - p1.Z + 1`.
3225 Then, for a loaded region of p1..p2, this array ranges from `1` up to and including the value of
3226 the expression `Nx * Ny * Nz`.
3228 Positions offset from p1 are present in the array with the format of:
3231 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
3232 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
3234 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
3235 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
3237 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
3239 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
3243 and the array index for a position p contained completely in p1..p2 is:
3245 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
3247 Note that this is the same "flat 3D array" format as `PerlinNoiseMap:get3dMap_flat()`.
3248 VoxelArea objects (see section 'VoxelArea') can be used to simplify calculation of the index
3249 for a single point in a flat VoxelManip array.
3252 A Content ID is a unique integer identifier for a specific node type. These IDs are used by VoxelManip
3253 in place of the node name string for `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
3254 `minetest.get_content_id()` to look up the Content ID for the specified node name, and
3255 `minetest.get_name_from_content_id()` to look up the node name string for a given Content ID.
3256 After registration of a node, its Content ID will remain the same throughout execution of the mod.
3257 Note that the node being queried needs to have already been been registered.
3259 The following builtin node types have their Content IDs defined as constants:
3261 core.CONTENT_UNKNOWN (ID for "unknown" nodes)
3262 core.CONTENT_AIR (ID for "air" nodes)
3263 core.CONTENT_IGNORE (ID for "ignore" nodes)
3266 ##### Mapgen VoxelManip objects
3267 Inside of `on_generated()` callbacks, it is possible to retrieve the same VoxelManip object used by the
3268 core's Map Generator (commonly abbreviated Mapgen). Most of the rules previously described still apply
3269 but with a few differences:
3271 * The Mapgen VoxelManip object is retrieved using: `minetest.get_mapgen_object("voxelmanip")`
3272 * This VoxelManip object already has the region of map just generated loaded into it; it's not necessary
3273 to call `VoxelManip:read_from_map()` before using a Mapgen VoxelManip.
3274 * The `on_generated()` callbacks of some mods may place individual nodes in the generated area using
3275 non-VoxelManip map modification methods. Because the same Mapgen VoxelManip object is passed through
3276 each `on_generated()` callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3277 consistency with the current map state. For this reason, calling any of the following functions:
3278 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3279 will also update the Mapgen VoxelManip object's internal state active on the current thread.
3280 * After modifying the Mapgen VoxelManip object's internal buffer, it may be necessary to update lighting
3281 information using either: `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3282 * `VoxelManip:update_map()` does not need to be called after `write_to_map()`. The map update is performed
3283 automatically after all on_generated callbacks have been run for that generated block.
3285 ##### Other API functions operating on a VoxelManip
3286 If any VoxelManip contents were set to a liquid node, `VoxelManip:update_liquids()` must be called
3287 for these liquid nodes to begin flowing. It is recommended to call this function only after having
3288 written all buffered data back to the VoxelManip object, save for special situations where the modder
3289 desires to only have certain liquid nodes begin flowing.
3291 The functions `minetest.generate_ores()` and `minetest.generate_decorations()` will generate all
3292 registered decorations and ores throughout the full area inside of the specified VoxelManip object.
3294 `minetest.place_schematic_on_vmanip()` is otherwise identical to `minetest.place_schematic()`,
3295 except instead of placing the specified schematic directly on the map at the specified position, it
3296 will place the schematic inside of the VoxelManip.
3299 * Attempting to read data from a VoxelManip object before map is read will result in a zero-length
3300 array table for `VoxelManip:get_data()`, and an "ignore" node at any position for
3301 `VoxelManip:get_node_at()`.
3302 * If either a region of map has not yet been generated or is out-of-bounds of the map, that region is
3303 filled with "ignore" nodes.
3304 * Other mods, or the core itself, could possibly modify the area of map currently loaded into a VoxelManip
3305 object. With the exception of Mapgen VoxelManips (see above section), the internal buffers are not
3306 updated. For this reason, it is strongly encouraged to complete the usage of a particular VoxelManip
3307 object in the same callback it had been created.
3308 * If a VoxelManip object will be used often, such as in an `on_generated()` callback, consider passing
3309 a file-scoped table as the optional parameter to `VoxelManip:get_data()`, which serves as a static
3310 buffer the function can use to write map data to instead of returning a new table each call. This
3311 greatly enhances performance by avoiding unnecessary memory allocations.
3314 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object containing
3315 the region formed by `p1` and `p2`.
3316 * returns actual emerged `pmin`, actual emerged `pmax`
3317 * `write_to_map()`: Writes the data loaded from the `VoxelManip` back to the map.
3318 * **important**: data must be set using `VoxelManip:set_data()` before calling this
3319 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
3320 the `VoxelManip` at that position
3321 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at that position
3322 * `get_data([buffer])`: Retrieves the node content data loaded into the `VoxelManip` object
3323 * returns raw node data in the form of an array of node content IDs
3324 * if the param `buffer` is present, this table will be used to store the result instead
3325 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
3326 * `update_map()`: Update map after writing chunk back to map.
3327 * To be used only by `VoxelManip` objects created by the mod itself;
3328 not a `VoxelManip` that was retrieved from `minetest.get_mapgen_object`
3329 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to a uniform value
3330 * `light` is a table, `{day=<0...15>, night=<0...15>}`
3331 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
3332 * (`p1`, `p2`) is the area in which lighting is set;
3333 defaults to the whole area if left out
3334 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
3335 * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
3336 * Each value is the bitwise combination of day and night light values (`0` to `15` each)
3337 * `light = day + (night * 16)`
3338 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
3340 * expects lighting data in the same format that `get_light_data()` returns
3341 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the `VoxelManip` object
3342 * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
3343 * If the param `buffer` is present, this table will be used to store the result instead
3344 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in the `VoxelManip`
3345 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the `VoxelManip`
3346 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
3347 * (`p1`, `p2`) is the area in which lighting is set; defaults to the whole area
3349 * `propagate_shadow` is an optional boolean deciding whether shadows in a generated
3350 mapchunk above are propagated down into the mapchunk; defaults to `true` if left out
3351 * `update_liquids()`: Update liquid flow
3352 * `was_modified()`: Returns `true` or `false` if the data in the voxel manipulator
3353 had been modified since the last read from map, due to a call to
3354 `minetest.set_data()` on the loaded area elsewhere
3355 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
3358 A helper class for voxel areas.
3359 It can be created via `VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}`.
3360 The coordinates are *inclusive*, like most other things in Minetest.
3363 * `getExtent()`: returns a 3D vector containing the size of the area formed by
3364 `MinEdge` and `MaxEdge`
3365 * `getVolume()`: returns the volume of the area formed by `MinEdge` and `MaxEdge`
3366 * `index(x, y, z)`: returns the index of an absolute position in a flat array starting at `1`
3367 * useful for things like `VoxelManip`, raw Schematic specifiers,
3368 `PerlinNoiseMap:get2d`/`3dMap`, and so on
3369 * `indexp(p)`: same as above, except takes a vector
3370 * `position(i)`: returns the absolute position vector corresponding to index `i`
3371 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by `MinEdge` and `MaxEdge`
3372 * `containsp(p)`: same as above, except takes a vector
3373 * `containsi(i)`: same as above, except takes an index `i`
3374 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns indices
3375 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of `[z [y [x]]]`
3376 * `iterp(minp, maxp)`: same as above, except takes a vector
3379 An interface to read config files in the format of `minetest.conf`.
3381 It can be created via `Settings(filename)`.
3384 * `get(key)`: returns a value
3385 * `get_bool(key)`: returns a boolean
3387 * `remove(key)`: returns a boolean (`true` for success)
3388 * `get_names()`: returns `{key1,...}`
3389 * `write()`: returns a boolean (`true` for success)
3390 * write changes to file
3391 * `to_table()`: returns `{[key1]=value1,...}`
3395 A mapgen object is a construct used in map generation. Mapgen objects can be used
3396 by an `on_generate` callback to speed up operations by avoiding unnecessary
3397 recalculations; these can be retrieved using the `minetest.get_mapgen_object()`
3398 function. If the requested Mapgen object is unavailable, or `get_mapgen_object()`
3399 was called outside of an `on_generate()` callback, `nil` is returned.
3401 The following Mapgen objects are currently available:
3404 This returns three values; the `VoxelManip` object to be used, minimum and maximum
3405 emerged position, in that order. All mapgens support this object.
3408 Returns an array containing the y coordinates of the ground levels of nodes in
3409 the most recently generated chunk by the current mapgen.
3412 Returns an array containing the biome IDs of nodes in the most recently
3413 generated chunk by the current mapgen.
3416 Returns an array containing the temperature values of nodes in the most
3417 recently generated chunk by the current mapgen.
3420 Returns an array containing the humidity values of nodes in the most recently
3421 generated chunk by the current mapgen.
3424 Returns a table mapping requested generation notification types to arrays of
3425 positions at which the corresponding generated structures are located at within
3426 the current chunk. To set the capture of positions of interest to be recorded
3427 on generate, use `minetest.set_gen_notify()`.
3429 Possible fields of the table returned are:
3435 * `large_cave_begin`
3439 Decorations have a key in the format of `"decoration#id"`, where `id` is the
3440 numeric unique decoration ID.
3444 * Functions receive a "luaentity" as `self`:
3445 * It has the member `.name`, which is the registered name `("mod:thing")`
3446 * It has the member `.object`, which is an `ObjectRef` pointing to the object
3447 * The original prototype stuff is visible directly via a metatable
3449 * `on_activate(self, staticdata, dtime_s)`
3450 * Called when the object is instantiated.
3451 * `dtime_s` is the time passed since the object was unloaded, which can
3452 be used for updating the entity state.
3453 * `on_step(self, dtime)`
3454 * Called on every server tick, after movement and collision processing.
3455 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
3457 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)`
3458 * Called when somebody punches the object.
3459 * Note that you probably want to handle most punches using the
3460 automatic armor group system.
3461 * `puncher`: an `ObjectRef` (can be `nil`)
3462 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be `nil`)
3463 * `tool_capabilities`: capability table of used tool (can be `nil`)
3464 * `dir`: unit vector of direction of punch. Always defined. Points from
3465 the puncher to the punched.
3466 * `on_rightclick(self, clicker)`
3467 * `get_staticdata(self)`
3468 * Should return a string that will be passed to `on_activate` when
3469 the object is instantiated the next time.
3474 L-system generation currently creates lighting bugs in the form of mapblock-sized shadows.
3475 Often these bugs appear as subtle shadows in water.
3480 axiom, --string initial tree axiom
3481 rules_a, --string rules set A
3482 rules_b, --string rules set B
3483 rules_c, --string rules set C
3484 rules_d, --string rules set D
3485 trunk, --string trunk node name
3486 leaves, --string leaves node name
3487 leaves2, --string secondary leaves node name
3488 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
3489 angle, --num angle in deg
3490 iterations, --num max # of iterations, usually 2 -5
3491 random_level, --num factor to lower nr of iterations, usually 0 - 3
3492 trunk_type, --string single/double/crossed) type of trunk: 1 node,
3493 -- 2x2 nodes or 3x3 in cross shape
3494 thin_branches, --boolean true -> use thin (1 node) branches
3495 fruit, --string fruit node name
3496 fruit_chance, --num chance (0-100) to replace leaves with fruit node
3497 seed, --num random seed; if no seed is provided, the engine will create one
3500 ### Key for Special L-System Symbols used in Axioms
3502 * `G`: move forward one unit with the pen up
3503 * `F`: move forward one unit with the pen down drawing trunks and branches
3504 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
3505 * `T`: move forward one unit with the pen down drawing trunks only
3506 * `R`: move forward one unit with the pen down placing fruit
3507 * `A`: replace with rules set A
3508 * `B`: replace with rules set B
3509 * `C`: replace with rules set C
3510 * `D`: replace with rules set D
3511 * `a`: replace with rules set A, chance 90%
3512 * `b`: replace with rules set B, chance 80%
3513 * `c`: replace with rules set C, chance 70%
3514 * `d`: replace with rules set D, chance 60%
3515 * `+`: yaw the turtle right by `angle` parameter
3516 * `-`: yaw the turtle left by `angle` parameter
3517 * `&`: pitch the turtle down by `angle` parameter
3518 * `^`: pitch the turtle up by `angle` parameter
3519 * `/`: roll the turtle to the right by `angle` parameter
3520 * `*`: roll the turtle to the left by `angle` parameter
3521 * `[`: save in stack current state info
3522 * `]`: recover from stack state info
3525 Spawn a small apple tree:
3527 pos = {x=230,y=20,z=4}
3530 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
3531 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
3532 trunk="default:tree",
3533 leaves="default:leaves",
3537 trunk_type="single",
3540 fruit="default:apple"
3542 minetest.spawn_tree(pos,apple_tree)
3547 ### Object Properties
3552 collide_with_objects = true, -- collide with other objects if physical=true
3554 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
3555 visual = "cube"/"sprite"/"upright_sprite"/"mesh"/"wielditem",
3556 visual_size = {x=1, y=1},
3558 textures = {}, -- number of required textures depends on visual
3559 colors = {}, -- number of required colors depends on visual
3560 spritediv = {x=1, y=1},
3561 initial_sprite_basepos = {x=0, y=0},
3563 makes_footstep_sound = false,
3564 automatic_rotate = false,
3566 automatic_face_movement_dir = 0.0,
3567 -- ^ automatically set yaw to movement direction; offset in degrees; false to disable
3568 automatic_face_movement_max_rotation_per_sec = -1,
3569 -- ^ limit automatic rotation to this value in degrees per second. values < 0 no limit
3570 backface_culling = true, -- false to disable backface_culling for model
3571 nametag = "", -- by default empty, for players their name is shown if empty
3572 nametag_color = <color>, -- sets color of nametag as ColorSpec
3573 infotext = "", -- by default empty, text to be shown when pointed at object
3576 ### Entity definition (`register_entity`)
3579 -- Deprecated: Everything in object properties is read directly from here
3581 initial_properties = --[[<initial object properties>]],
3583 on_activate = function(self, staticdata, dtime_s),
3584 on_step = function(self, dtime),
3585 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
3586 on_rightclick = function(self, clicker),
3587 get_staticdata = function(self),
3588 -- ^ Called sometimes; the string returned is passed to on_activate when
3589 -- the entity is re-activated from static state
3591 -- Also you can define arbitrary member variables here (see item definition for
3593 _custom_field = whatever,
3596 ### ABM (ActiveBlockModifier) definition (`register_abm`)
3599 label = "Lava cooling",
3600 -- ^ Descriptive label for profiling purposes (optional).
3601 -- Definitions with identical labels will be listed as one.
3602 -- In the following two fields, also group:groupname will work.
3603 nodenames = {"default:lava_source"},
3604 neighbors = {"default:water_source", "default:water_flowing"}, -- Any of these --[[
3605 ^ If left out or empty, any neighbor will do ]]
3606 interval = 1.0, -- Operation interval in seconds
3607 chance = 1, -- Chance of trigger per-node per-interval is 1.0 / this
3608 catch_up = true, -- If true, catch-up behaviour is enabled --[[
3609 ^ The chance value is temporarily reduced when returning to
3610 an area to simulate time lost by the area being unattended.
3611 ^ Note chance value can often be reduced to 1 ]]
3612 action = func(pos, node, active_object_count, active_object_count_wider),
3615 ### LBM (LoadingBlockModifier) definition (`register_lbm`)
3618 label = "Upgrade legacy doors",
3619 -- ^ Descriptive label for profiling purposes (optional).
3620 -- Definitions with identical labels will be listed as one.
3621 name = "modname:replace_legacy_door",
3622 nodenames = {"default:lava_source"},
3623 -- ^ List of node names to trigger the LBM on.
3624 -- Also non-registered nodes will work.
3625 -- Groups (as of group:groupname) will work as well.
3626 run_at_every_load = false,
3627 -- ^ Whether to run the LBM's action every time a block gets loaded,
3628 -- and not just for blocks that were saved last time before LBMs were
3629 -- introduced to the world.
3630 action = func(pos, node),
3633 ### Item definition (`register_node`, `register_craftitem`, `register_tool`)
3636 description = "Steel Axe",
3637 groups = {}, -- key = name, value = rating; rating = 1..3.
3638 if rating not applicable, use 1.
3639 e.g. {wool = 1, fluffy = 3}
3640 {soil = 2, outerspace = 1, crumbly = 1}
3641 {bendy = 2, snappy = 1},
3642 {hard = 1, metal = 1, spikes = 1}
3643 inventory_image = "default_tool_steelaxe.png",
3645 wield_scale = {x = 1, y = 1, z = 1},
3648 liquids_pointable = false,
3649 tool_capabilities = {
3650 full_punch_interval = 1.0,
3654 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00}, uses = 20, maxlevel = 2},
3656 damage_groups = {groupname = damage},
3658 node_placement_prediction = nil,
3660 ^ If nil and item is node, prediction is made automatically
3661 ^ If nil and item is not a node, no prediction is made
3662 ^ If "" and item is anything, no prediction is made
3663 ^ Otherwise should be name of node which the client immediately places
3664 on ground when the player places the item. Server will always update
3665 actual result to client in a short moment.
3668 breaks = "default_tool_break", -- tools only
3669 place = --[[<SimpleSoundSpec>]],
3672 on_place = func(itemstack, placer, pointed_thing),
3674 ^ Shall place item and return the leftover itemstack
3675 ^ The placer may be any ObjectRef or nil.
3676 ^ default: minetest.item_place ]]
3677 on_secondary_use = func(itemstack, user, pointed_thing),
3679 ^ Same as on_place but called when pointing at nothing.
3680 ^ The user may be any ObjectRef or nil.
3681 ^ pointed_thing : always { type = "nothing" }
3683 on_drop = func(itemstack, dropper, pos),
3685 ^ Shall drop item and return the leftover itemstack
3686 ^ The dropper may be any ObjectRef or nil.
3687 ^ default: minetest.item_drop ]]
3688 on_use = func(itemstack, user, pointed_thing),
3691 ^ Function must return either nil if no item shall be removed from
3692 inventory, or an itemstack to replace the original itemstack.
3693 e.g. itemstack:take_item(); return itemstack
3694 ^ Otherwise, the function is free to do what it wants.
3695 ^ The user may be any ObjectRef or nil.
3696 ^ The default functions handle regular use cases.
3698 after_use = func(itemstack, user, node, digparams),
3701 ^ If defined, should return an itemstack and will be called instead of
3702 wearing out the tool. If returns nil, does nothing.
3703 If after_use doesn't exist, it is the same as:
3704 function(itemstack, user, node, digparams)
3705 itemstack:add_wear(digparams.wear)
3708 ^ The user may be any ObjectRef or nil.
3710 _custom_field = whatever,
3712 ^ Add your own custom fields. By convention, all custom field names
3713 should start with `_` to avoid naming collisions with future engine
3720 * `{name="image.png", animation={Tile Animation definition}}`
3721 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
3722 tileable_horizontal=bool}`
3723 * backface culling enabled by default for most nodes
3724 * tileable flags are info for shaders, how they should treat texture
3725 when displacement mapping is used
3726 Directions are from the point of view of the tile texture,
3727 not the node it's on
3728 * `{name="image.png", color=ColorSpec}`
3729 * the texture's color will be multiplied with this color.
3730 * the tile's color overrides the owning node's color in all cases.
3731 * deprecated, yet still supported field names:
3734 ### Tile animation definition
3737 type = "vertical_frames",
3739 -- ^ specify width of a frame in pixels
3741 -- ^ specify height of a frame in pixels
3743 -- ^ specify full loop length
3749 -- ^ specify width in number of frames
3751 -- ^ specify height in number of frames
3753 -- ^ specify length of a single frame
3756 ### Node definition (`register_node`)
3759 -- <all fields allowed in item definitions>,
3761 drawtype = "normal", -- See "Node drawtypes"
3762 visual_scale = 1.0, --[[
3763 ^ Supported for drawtypes "plantlike", "signlike", "torchlike", "mesh".
3764 ^ For plantlike, the image will start at the bottom of the node; for the
3765 ^ other drawtypes, the image will be centered on the node.
3766 ^ Note that positioning for "torchlike" may still change. ]]
3767 tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
3768 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
3769 ^ List can be shortened to needed length ]]
3770 special_tiles = {tile definition 1, Tile definition 2}, --[[
3771 ^ Special textures of node; used rarely (old field name: special_materials)
3772 ^ List can be shortened to needed length ]]
3773 color = ColorSpec, --[[
3774 ^ The node's original color will be multiplied with this color.
3775 ^ If the node has a palette, then this setting only has an effect
3776 ^ in the inventory and on the wield item. ]]
3777 use_texture_alpha = false, -- Use texture's alpha channel
3778 palette = "palette.png", --[[
3779 ^ The node's `param2` is used to select a pixel from the image
3780 ^ (pixels are arranged from left to right and from top to bottom).
3781 ^ The node's color will be multiplied with the selected pixel's
3782 ^ color. Tiles can override this behavior.
3783 ^ Only when `paramtype2` supports palettes. ]]
3784 post_effect_color = "green#0F", -- If player is inside node, see "ColorSpec"
3785 paramtype = "none", -- See "Nodes" --[[
3786 ^ paramtype = "light" allows light to propagate from or through the node with light value
3787 ^ falling by 1 per node. This line is essential for a light source node to spread its light. ]]
3788 paramtype2 = "none", -- See "Nodes"
3789 place_param2 = nil, -- Force value for param2 when player places node
3790 is_ground_content = true, -- If false, the cave generator will not carve through this
3791 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
3792 walkable = true, -- If true, objects collide with node
3793 pointable = true, -- If true, can be pointed at
3794 diggable = true, -- If false, can never be dug
3795 climbable = false, -- If true, can be climbed on (ladder)
3796 buildable_to = false, -- If true, placed nodes can replace this node
3797 floodable = false, -- If true, liquids flow into and replace this node
3798 liquidtype = "none", -- "none"/"source"/"flowing"
3799 liquid_alternative_flowing = "", -- Flowing version of source liquid
3800 liquid_alternative_source = "", -- Source version of flowing liquid
3801 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
3802 liquid_renewable = true, --[[
3803 ^ If true, a new liquid source can be created by placing two or more sources nearby ]]
3805 ^ Block contains level in param2. Value is default level, used for snow.
3806 ^ Don't forget to use "leveled" type nodebox. ]]
3807 liquid_range = 8, -- number of flowing nodes around source (max. 8)
3808 drowning = 0, -- Player will take this amount of damage if no bubbles are left
3809 light_source = 0, --[[
3810 ^ Amount of light emitted by node.
3811 ^ To set the maximum (currently 14), use the value 'minetest.LIGHT_MAX'.
3812 ^ A value outside the range 0 to minetest.LIGHT_MAX causes undefined behavior.]]
3813 damage_per_second = 0, -- If player is inside node, this damage is caused
3814 node_box = {type="regular"}, -- See "Node boxes"
3815 connects_to = nodenames, --[[
3816 * Used for nodebox nodes with the type == "connected"
3817 * Specifies to what neighboring nodes connections will be drawn
3818 * e.g. `{"group:fence", "default:wood"}` or `"default:stone"` ]]
3819 connect_sides = { "top", "bottom", "front", "left", "back", "right" }, --[[
3820 ^ Tells connected nodebox nodes to connect only to these sides of this node. ]]
3822 selection_box = {type="regular"}, -- See "Node boxes" --[[
3823 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used. ]]
3824 legacy_facedir_simple = false, -- Support maps made in and before January 2012
3825 legacy_wallmounted = false, -- Support maps made in and before January 2012
3827 footstep = <SimpleSoundSpec>,
3828 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
3829 dug = <SimpleSoundSpec>,
3830 place = <SimpleSoundSpec>,
3831 place_failed = <SimpleSoundSpec>,
3833 drop = "", -- Name of dropped node when dug. Default is the node itself.
3836 max_items = 1, -- Maximum number of items to drop.
3837 items = { -- Choose max_items randomly from this list.
3839 items = {"foo:bar", "baz:frob"}, -- Items to drop.
3840 rarity = 1, -- Probability of dropping is 1 / rarity.
3845 on_construct = func(pos), --[[
3846 ^ Node constructor; called after adding node
3847 ^ Can set up metadata and stuff like that
3848 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3850 on_destruct = func(pos), --[[
3851 ^ Node destructor; called before removing node
3852 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3854 after_destruct = func(pos, oldnode), --[[
3855 ^ Node destructor; called after removing node
3856 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3859 after_place_node = func(pos, placer, itemstack, pointed_thing) --[[
3860 ^ Called after constructing node when node was placed using
3861 minetest.item_place_node / minetest.place_node
3862 ^ If return true no item is taken from itemstack
3864 after_dig_node = func(pos, oldnode, oldmetadata, digger), --[[
3865 ^ oldmetadata is in table format
3866 ^ Called after destructing node when node was dug using
3867 minetest.node_dig / minetest.dig_node
3869 can_dig = function(pos, [player]) --[[
3870 ^ returns true if node can be dug, or false if not
3873 on_punch = func(pos, node, puncher, pointed_thing), --[[
3874 ^ default: minetest.node_punch
3875 ^ By default: Calls minetest.register_on_punchnode callbacks ]]
3876 on_rightclick = func(pos, node, clicker, itemstack, pointed_thing), --[[
3878 ^ if defined, itemstack will hold clicker's wielded item
3879 ^ Shall return the leftover itemstack
3880 ^ Note: pointed_thing can be nil, if a mod calls this function ]]
3882 on_dig = func(pos, node, digger), --[[
3883 ^ default: minetest.node_dig
3884 ^ By default: checks privileges, wears out tool and removes node ]]
3886 on_timer = function(pos,elapsed), --[[
3888 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
3889 ^ elapsed is the total time passed since the timer was started
3890 ^ return true to run the timer for another cycle with the same timeout value ]]
3892 on_receive_fields = func(pos, formname, fields, sender), --[[
3893 ^ fields = {name1 = value1, name2 = value2, ...}
3894 ^ Called when an UI form (e.g. sign text input) returns data
3897 allow_metadata_inventory_move = func(pos, from_list, from_index,
3898 to_list, to_index, count, player), --[[
3899 ^ Called when a player wants to move items inside the inventory
3900 ^ Return value: number of items allowed to move ]]
3902 allow_metadata_inventory_put = func(pos, listname, index, stack, player), --[[
3903 ^ Called when a player wants to put something into the inventory
3904 ^ Return value: number of items allowed to put
3905 ^ Return value: -1: Allow and don't modify item count in inventory ]]
3907 allow_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
3908 ^ Called when a player wants to take something out of the inventory
3909 ^ Return value: number of items allowed to take
3910 ^ Return value: -1: Allow and don't modify item count in inventory ]]
3912 on_metadata_inventory_move = func(pos, from_list, from_index,
3913 to_list, to_index, count, player),
3914 on_metadata_inventory_put = func(pos, listname, index, stack, player),
3915 on_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
3916 ^ Called after the actual action has happened, according to what was allowed.
3917 ^ No return value ]]
3919 on_blast = func(pos, intensity), --[[
3920 ^ intensity: 1.0 = mid range of regular TNT
3921 ^ If defined, called when an explosion touches the node, instead of
3922 removing the node ]]
3925 ### Recipe for `register_craft` (shaped)
3928 output = 'default:pick_stone',
3930 {'default:cobble', 'default:cobble', 'default:cobble'},
3931 {'', 'default:stick', ''},
3932 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
3934 replacements = --[[<optional list of item pairs,
3935 replace one input item with another item on crafting>]]
3938 ### Recipe for `register_craft` (shapeless)
3942 output = 'mushrooms:mushroom_stew',
3945 "mushrooms:mushroom_brown",
3946 "mushrooms:mushroom_red",
3948 replacements = --[[<optional list of item pairs,
3949 replace one input item with another item on crafting>]]
3952 ### Recipe for `register_craft` (tool repair)
3955 type = "toolrepair",
3956 additional_wear = -0.02,
3959 ### Recipe for `register_craft` (cooking)
3963 output = "default:glass",
3964 recipe = "default:sand",
3968 ### Recipe for `register_craft` (furnace fuel)
3972 recipe = "default:leaves",
3976 ### Ore definition (`register_ore`)
3979 ore_type = "scatter", -- See "Ore types"
3980 ore = "default:stone_with_coal",
3981 wherein = "default:stone",
3982 -- ^ a list of nodenames is supported too
3983 clust_scarcity = 8*8*8,
3984 -- ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
3985 -- ^ This value should be *MUCH* higher than your intuition might tell you!
3987 -- ^ Number of ores in a cluster
3989 -- ^ Size of the bounding box of the cluster
3990 -- ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
3994 -- ^ Attributes for this ore generation
3995 noise_threshold = 0.5,
3996 -- ^ If noise is above this threshold, ore is placed. Not needed for a uniform distribution
3997 noise_params = {offset=0, scale=1, spread={x=100, y=100, z=100}, seed=23, octaves=3, persist=0.70}
3998 -- ^ NoiseParams structure describing the perlin noise used for ore distribution.
3999 -- ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
4000 random_factor = 1.0,
4001 -- ^ Multiplier of the randomness contribution to the noise value at any
4002 -- given point to decide if ore should be placed. Set to 0 for solid veins.
4003 -- ^ This parameter is only valid for ore_type == "vein".
4004 biomes = {"desert", "rainforest"}
4005 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
4006 -- ^ and ignored if the Mapgen being used does not support biomes.
4007 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
4010 ### Biome definition (`register_biome`)
4013 The Biome API is still in an experimental phase and subject to change.
4017 node_dust = "default:snow",
4018 -- ^ Node dropped onto upper surface after all else is generated.
4019 node_top = "default:dirt_with_snow",
4021 -- ^ Node forming surface layer of biome and thickness of this layer.
4022 node_filler = "default:permafrost",
4024 -- ^ Node forming lower layer of biome and thickness of this layer.
4025 node_stone = "default:bluestone",
4026 -- ^ Node that replaces all stone nodes between roughly y_min and y_max.
4027 node_water_top = "default:ice",
4028 depth_water_top = 10,
4029 -- ^ Node forming a surface layer in seawater with the defined thickness.
4031 -- ^ Node that replaces all seawater nodes not in the defined surface layer.
4032 node_river_water = "default:ice",
4033 -- ^ Node that replaces river water in mapgens that use default:river_water.
4034 node_riverbed = "default:gravel",
4036 -- ^ Node placed under river water and thickness of this layer.
4039 -- ^ Lower and upper limits for biome.
4040 -- ^ Because biome is not recalculated for every node in a node column
4041 -- ^ some biome materials can exceed their limits, especially stone.
4042 -- ^ For each node column in a mapchunk, biome is only recalculated at column
4043 -- ^ top and at each of these surfaces:
4044 -- ^ Ground below air, water below air, ground below water.
4045 -- ^ The selected biome then stays in effect for all nodes below until
4046 -- ^ column base or the next biome recalculation.
4048 humidity_point = 50,
4049 -- ^ Characteristic average temperature and humidity for the biome.
4050 -- ^ These values create 'biome points' on a voronoi diagram that has heat
4051 -- ^ and humidity as axes. The resulting voronoi cells determine which
4052 -- ^ heat/humidity points belong to which biome, and therefore determine
4053 -- ^ the area and location of each biome in the world.
4054 -- ^ The biome points need to be carefully and evenly spaced on the voronoi
4055 -- ^ diagram to result in roughly equal size biomes.
4056 -- ^ Heat and humidity have average values of 50, vary mostly between
4057 -- ^ 0 and 100 but also often exceed these values.
4058 -- ^ Heat is not in degrees celcius, both values are abstract.
4061 ### Decoration definition (`register_decoration`)
4064 deco_type = "simple", -- See "Decoration types"
4065 place_on = "default:dirt_with_grass",
4066 -- ^ Node (or list of nodes) that the decoration can be placed on
4068 -- ^ Size of divisions made in the chunk being generated.
4069 -- ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
4071 -- ^ Ratio of the area to be uniformly filled by the decoration.
4072 -- ^ Used only if noise_params is not specified.
4073 noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
4074 -- ^ NoiseParams structure describing the perlin noise used for decoration distribution.
4075 -- ^ The result of this is multiplied by the 2d area of the division being decorated.
4076 biomes = {"Oceanside", "Hills", "Plains"},
4077 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
4078 -- ^ and ignored if the Mapgen being used does not support biomes.
4079 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
4082 -- ^ Minimum and maximum `y` positions these decorations can be generated at.
4083 -- ^ This parameter refers to the `y` position of the decoration base, so
4084 -- the actual maximum height would be `height_max + size.Y`.
4085 spawn_by = "default:water",
4086 -- ^ Node (or list of nodes) that the decoration only spawns next to.
4087 -- ^ Checks two horizontal planes of neighbouring nodes (including diagonal neighbours),
4088 -- ^ one plane at Y = surface and one plane at Y = surface = + 1.
4090 -- ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
4091 -- ^ If absent or -1, decorations occur next to any nodes.
4092 flags = "liquid_surface, force_placement",
4093 -- ^ Flags for all decoration types.
4094 -- ^ "liquid_surface": Instead of placement on the highest solid surface
4095 -- ^ in a mapchunk column, placement is on the highest liquid surface.
4096 -- ^ Placement is disabled if solid nodes are found above the liquid surface.
4097 -- ^ "force_placement": Nodes other than "air" and "ignore" are replaced by the decoration.
4099 ----- Simple-type parameters
4100 decoration = "default:grass",
4101 -- ^ The node name used as the decoration.
4102 -- ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
4104 -- ^ Number of nodes high the decoration is made.
4105 -- ^ If height_max is not 0, this is the lower bound of the randomly selected height.
4107 -- ^ Number of nodes the decoration can be at maximum.
4108 -- ^ If absent, the parameter 'height' is used as a constant.
4110 -- ^ Param2 value of placed decoration node.
4112 ----- Schematic-type parameters
4113 schematic = "foobar.mts",
4114 -- ^ If schematic is a string, it is the filepath relative to the current working directory of the
4115 -- ^ specified Minetest schematic file.
4116 -- ^ - OR -, could be the ID of a previously registered schematic
4117 -- ^ - OR -, could instead be a table containing two mandatory fields, size and data,
4118 -- ^ and an optional table yslice_prob:
4120 size = {x=4, y=6, z=4},
4122 {name="default:cobble", param1=255, param2=0},
4123 {name="default:dirt_with_grass", param1=255, param2=0},
4124 {name="ignore", param1=255, param2=0},
4125 {name="air", param1=255, param2=0},
4134 -- ^ See 'Schematic specifier' for details.
4135 replacements = {["oldname"] = "convert_to", ...},
4136 flags = "place_center_x, place_center_y, place_center_z",
4137 -- ^ Flags for schematic decorations. See 'Schematic attributes'.
4138 rotation = "90" -- rotate schematic 90 degrees on placement
4139 -- ^ Rotation can be "0", "90", "180", "270", or "random".
4142 ### Chat command definition (`register_chatcommand`)
4145 params = "<name> <privilege>", -- Short parameter description
4146 description = "Remove privilege from player", -- Full description
4147 privs = {privs=true}, -- Require the "privs" privilege to run
4148 func = function(name, param), -- Called when command is run.
4149 -- Returns boolean success and text output.
4152 ### Detached inventory callbacks
4155 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
4156 -- ^ Called when a player wants to move items inside the inventory
4157 -- ^ Return value: number of items allowed to move
4159 allow_put = func(inv, listname, index, stack, player),
4160 -- ^ Called when a player wants to put something into the inventory
4161 -- ^ Return value: number of items allowed to put
4162 -- ^ Return value: -1: Allow and don't modify item count in inventory
4164 allow_take = func(inv, listname, index, stack, player),
4165 -- ^ Called when a player wants to take something out of the inventory
4166 -- ^ Return value: number of items allowed to take
4167 -- ^ Return value: -1: Allow and don't modify item count in inventory
4169 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
4170 on_put = func(inv, listname, index, stack, player),
4171 on_take = func(inv, listname, index, stack, player),
4172 -- ^ Called after the actual action has happened, according to what was allowed.
4173 -- ^ No return value
4176 ### HUD Definition (`hud_add`, `hud_get`)
4179 hud_elem_type = "image", -- see HUD element types
4180 -- ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
4181 position = {x=0.5, y=0.5},
4182 -- ^ Left corner position of element
4188 -- ^ Selected item in inventory. 0 for no item selected.
4190 -- ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
4191 alignment = {x=0, y=0},
4192 -- ^ See "HUD Element Types"
4193 offset = {x=0, y=0},
4194 -- ^ See "HUD Element Types"
4195 size = { x=100, y=100 },
4196 -- ^ Size of element in pixels
4199 ### Particle definition (`add_particle`)
4202 pos = {x=0, y=0, z=0},
4203 velocity = {x=0, y=0, z=0},
4204 acceleration = {x=0, y=0, z=0},
4205 -- ^ Spawn particle at pos with velocity and acceleration
4207 -- ^ Disappears after expirationtime seconds
4209 collisiondetection = false,
4210 -- ^ collisiondetection: if true collides with physical objects
4211 collision_removal = false,
4212 -- ^ collision_removal: if true then particle is removed when it collides,
4213 -- ^ requires collisiondetection = true to have any effect
4215 -- ^ vertical: if true faces player using y axis only
4216 texture = "image.png",
4217 -- ^ Uses texture (string)
4218 playername = "singleplayer",
4219 -- ^ optional, if specified spawns particle only on the player's client
4220 animation = {Tile Animation definition},
4221 -- ^ optional, specifies how to animate the particle texture
4223 -- ^ optional, specify particle self-luminescence in darkness
4227 ### `ParticleSpawner` definition (`add_particlespawner`)
4232 -- ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
4233 minpos = {x=0, y=0, z=0},
4234 maxpos = {x=0, y=0, z=0},
4235 minvel = {x=0, y=0, z=0},
4236 maxvel = {x=0, y=0, z=0},
4237 minacc = {x=0, y=0, z=0},
4238 maxacc = {x=0, y=0, z=0},
4243 -- ^ The particle's properties are random values in between the bounds:
4244 -- ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
4245 -- ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
4246 collisiondetection = false,
4247 -- ^ collisiondetection: if true uses collision detection
4248 collision_removal = false,
4249 -- ^ collision_removal: if true then particle is removed when it collides,
4250 -- ^ requires collisiondetection = true to have any effect
4251 attached = ObjectRef,
4252 -- ^ attached: if defined, particle positions, velocities and accelerations
4253 -- ^ are relative to this object's position and yaw.
4255 -- ^ vertical: if true faces player using y axis only
4256 texture = "image.png",
4257 -- ^ Uses texture (string)
4258 playername = "singleplayer"
4259 -- ^ Playername is optional, if specified spawns particle only on the player's client
4262 ### `HTTPRequest` definition (`HTTPApiTable.fetch_async`, `HTTPApiTable.fetch_async`)
4265 url = "http://example.org",
4267 -- ^ Timeout for connection in seconds. Default is 3 seconds.
4268 post_data = "Raw POST request data string" OR { field1 = "data1", field2 = "data2" },
4269 -- ^ Optional, if specified a POST request with post_data is performed.
4270 -- ^ Accepts both a string and a table. If a table is specified, encodes table
4271 -- ^ as x-www-form-urlencoded key-value pairs.
4272 -- ^ If post_data ist not specified, a GET request is performed instead.
4273 user_agent = "ExampleUserAgent",
4274 -- ^ Optional, if specified replaces the default minetest user agent with given string
4275 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
4276 -- ^ Optional, if specified adds additional headers to the HTTP request. You must make sure
4277 -- ^ that the header strings follow HTTP specification ("Key: Value").
4279 -- ^ Optional, if true performs a multipart HTTP request. Default is false.
4282 ### `HTTPRequestResult` definition (`HTTPApiTable.fetch` callback, `HTTPApiTable.fetch_async_get`)
4286 -- ^ If true, the request has finished (either succeeded, failed or timed out)
4288 -- ^ If true, the request was succesful
4290 -- ^ If true, the request timed out
4292 -- ^ HTTP status code