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.
644 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
647 ^ defines list of collision boxes for the node. If empty, collision boxes
648 will be the same as nodeboxes, in case of any other nodes will be full cube
649 as in the example above.
651 Nodes can also contain extra data. See "Node Metadata".
655 There are a bunch of different looking node types.
657 Look for examples in `games/minimal` or `games/minetest_game`.
665 * `glasslike_framed_optional`
667 * `allfaces_optional`
674 * `nodebox` -- See below. (**Experimental!**)
675 * `mesh` -- use models for nodes
677 `*_optional` drawtypes need less rendering time if deactivated (always client side).
681 Node selection boxes are defined using "node boxes"
683 The `nodebox` node drawtype allows defining visual of nodes consisting of
684 arbitrary number of boxes. It allows defining stuff like stairs. Only the
685 `fixed` and `leveled` box type is supported for these.
687 Please note that this is still experimental, and may be incompatibly
688 changed in the future.
690 A nodebox is defined as any of:
693 -- A normal cube; the default in most things
697 -- A fixed box (facedir param2 is used, if applicable)
699 fixed = box OR {box1, box2, ...}
702 -- A box like the selection box for torches
703 -- (wallmounted param2 is used, if applicable)
704 type = "wallmounted",
710 -- A node that has optional boxes depending on neighbouring nodes'
711 -- presence and type. See also `connects_to`.
713 fixed = box OR {box1, box2, ...}
714 connect_top = box OR {box1, box2, ...}
715 connect_bottom = box OR {box1, box2, ...}
716 connect_front = box OR {box1, box2, ...}
717 connect_left = box OR {box1, box2, ...}
718 connect_back = box OR {box1, box2, ...}
719 connect_right = box OR {box1, box2, ...}
722 A `box` is defined as:
724 {x1, y1, z1, x2, y2, z2}
726 A box of a regular node would look like:
728 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
730 `type = "leveled"` is same as `type = "fixed"`, but `y2` will be automatically
731 set to level from `param2`.
736 If drawtype `mesh` is used, tiles should hold model materials textures.
737 Only static meshes are implemented.
738 For supported model formats see Irrlicht engine documentation.
743 Noise Parameters, or commonly called "`NoiseParams`", define the properties of
747 Offset that the noise is translated by (i.e. added) after calculation.
750 Factor that the noise is scaled by (i.e. multiplied) after calculation.
753 Vector containing values by which each coordinate is divided by before calculation.
754 Higher spread values result in larger noise features.
756 A value of `{x=250, y=250, z=250}` is common.
759 Random seed for the noise. Add the world seed to a seed offset for world-unique noise.
760 In the case of `minetest.get_perlin()`, this value has the world seed automatically added.
763 Number of times the noise gradient is accumulated into the noise.
765 Increase this number to increase the amount of detail in the resulting noise.
767 A value of `6` is common.
770 Factor by which the effect of the noise gradient function changes with each successive octave.
772 Values less than `1` make the details of successive octaves' noise diminish, while values
773 greater than `1` make successive octaves stronger.
775 A value of `0.6` is common.
778 Factor by which the noise feature sizes change with each successive octave.
780 A value of `2.0` is common.
783 Leave this field unset for no special handling.
785 Currently supported are `defaults`, `eased` and `absvalue`.
788 Specify this if you would like to keep auto-selection of eased/not-eased while specifying
792 Maps noise gradient values onto a quintic S-curve before performing interpolation.
793 This results in smooth, rolling noise. Disable this (`noeased`) for sharp-looking noise.
794 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is not eased.
797 Accumulates the absolute value of each noise gradient result.
799 Noise parameters format example for 2D or 3D perlin noise or perlin noise maps:
803 spread = {x=500, y=500, z=500},
808 flags = "defaults, absvalue"
810 ^ A single noise parameter table can be used to get 2D or 3D noise,
811 when getting 2D noise spread.z is ignored.
816 These tell in what manner the ore is generated.
818 All default ores are of the uniformly-distributed scatter type.
821 Randomly chooses a location and generates a cluster of ore.
823 If `noise_params` is specified, the ore will be placed if the 3D perlin noise at
824 that point is greater than the `noise_threshold`, giving the ability to create
825 a non-equal distribution of ore.
828 Creates a sheet of ore in a blob shape according to the 2D perlin noise
829 described by `noise_params` and `noise_threshold`. This is essentially an
830 improved version of the so-called "stratus" ore seen in some unofficial mods.
832 This sheet consists of vertical columns of uniform randomly distributed height,
833 varying between the inclusive range `column_height_min` and `column_height_max`.
834 If `column_height_min` is not specified, this parameter defaults to 1.
835 If `column_height_max` is not specified, this parameter defaults to `clust_size`
836 for reverse compatibility. New code should prefer `column_height_max`.
838 The `column_midpoint_factor` parameter controls the position of the column at which
839 ore eminates from. If 1, columns grow upward. If 0, columns grow downward. If 0.5,
840 columns grow equally starting from each direction. `column_midpoint_factor` is a
841 decimal number ranging in value from 0 to 1. If this parameter is not specified,
844 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this ore type.
847 Creates a sheet of ore in a cloud-like puff shape.
849 As with the `sheet` ore type, the size and shape of puffs are described by
850 `noise_params` and `noise_threshold` and are placed at random vertical positions
851 within the currently generated chunk.
853 The vertical top and bottom displacement of each puff are determined by the noise
854 parameters `np_puff_top` and `np_puff_bottom`, respectively.
858 Creates a deformed sphere of ore according to 3d perlin noise described by
859 `noise_params`. The maximum size of the blob is `clust_size`, and
860 `clust_scarcity` has the same meaning as with the `scatter` type.
863 Creates veins of ore varying in density by according to the intersection of two
864 instances of 3d perlin noise with diffferent seeds, both described by
865 `noise_params`. `random_factor` varies the influence random chance has on
866 placement of an ore inside the vein, which is `1` by default. Note that
867 modifying this parameter may require adjusting `noise_threshold`.
868 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
869 by this ore type. This ore type is difficult to control since it is sensitive
870 to small changes. The following is a decent set of parameters to work from:
875 spread = {x=200, y=200, z=200},
881 noise_threshold = 1.6
883 WARNING: Use this ore type *very* sparingly since it is ~200x more
884 computationally expensive than any other ore.
888 See section "Flag Specifier Format".
890 Currently supported flags: `absheight`
893 Also produce this same ore between the height range of `-y_max` and `-y_min`.
895 Useful for having ore in sky realms without having to duplicate ore entries.
898 If set, puff ore generation will not taper down large differences in displacement
899 when approaching the edge of a puff. This flag has no effect for ore types other
902 ### `puff_additive_composition`
903 By default, when noise described by `np_puff_top` or `np_puff_bottom` results in a
904 negative displacement, the sub-column at that point is not generated. With this
905 attribute set, puff ore generation will instead generate the absolute difference in
906 noise displacement values. This flag has no effect for ore types other than `puff`.
910 The varying types of decorations that can be placed.
913 Creates a 1 times `H` times 1 column of a specified node (or a random node from
914 a list, if a decoration list is specified). Can specify a certain node it must
915 spawn next to, such as water or lava, for example. Can also generate a
916 decoration of random height between a specified lower and upper bound.
917 This type of decoration is intended for placement of grass, flowers, cacti,
918 papyri, waterlilies and so on.
921 Copies a box of `MapNodes` from a specified schematic file (or raw description).
922 Can specify a probability of a node randomly appearing when placed.
923 This decoration type is intended to be used for multi-node sized discrete
924 structures, such as trees, cave spikes, rocks, and so on.
929 A schematic specifier identifies a schematic by either a filename to a
930 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
931 in the form of a table. This table specifies the following fields:
933 * The `size` field is a 3D vector containing the dimensions of the provided schematic. (required)
934 * The `yslice_prob` field is a table of {ypos, prob} which sets the `ypos`th vertical slice
935 of the schematic to have a `prob / 256 * 100` chance of occuring. (default: 255)
936 * The `data` field is a flat table of MapNode tables making up the schematic,
937 in the order of `[z [y [x]]]`. (required)
938 Each MapNode table contains:
939 * `name`: the name of the map node to place (required)
940 * `prob` (alias `param1`): the probability of this node being placed (default: 255)
941 * `param2`: the raw param2 value of the node being placed onto the map (default: 0)
942 * `force_place`: boolean representing if the node should forcibly overwrite any
943 previous contents (default: false)
945 About probability values:
946 * A probability value of `0` or `1` means that node will never appear (0% chance).
947 * A probability value of `254` or `255` means the node will always appear (100% chance).
948 * If the probability value `p` is greater than `1`, then there is a
949 `(p / 256 * 100)` percent chance that node will appear when the schematic is
955 See section "Flag Specifier Format".
957 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
960 * `place_center_x`: Placement of this decoration is centered along the X axis.
961 * `place_center_y`: Placement of this decoration is centered along the Y axis.
962 * `place_center_z`: Placement of this decoration is centered along the Z axis.
963 * `force_placement`: Schematic nodes other than "ignore" will replace existing nodes.
968 The position field is used for all element types.
970 To account for differing resolutions, the position coordinates are the percentage
971 of the screen, ranging in value from `0` to `1`.
973 The name field is not yet used, but should contain a description of what the
974 HUD element represents. The direction field is the direction in which something
977 `0` draws from left to right, `1` draws from right to left, `2` draws from
978 top to bottom, and `3` draws from bottom to top.
980 The `alignment` field specifies how the item will be aligned. It ranges from `-1` to `1`,
981 with `0` being the center, `-1` is moved to the left/up, and `1` is to the right/down.
982 Fractional values can be used.
984 The `offset` field specifies a pixel offset from the position. Contrary to position,
985 the offset is not scaled to screen size. This allows for some precisely-positioned
988 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling factor!
990 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
992 **Note**: Future revisions to the HUD API may be incompatible; the HUD API is still
993 in the experimental stages.
996 Displays an image on the HUD.
998 * `scale`: The scale of the image, with 1 being the original texture size.
999 Only the X coordinate scale is used (positive values).
1000 Negative values represent that percentage of the screen it
1001 should take; e.g. `x=-100` means 100% (width).
1002 * `text`: The name of the texture that is displayed.
1003 * `alignment`: The alignment of the image.
1004 * `offset`: offset in pixels from position.
1007 Displays text on the HUD.
1009 * `scale`: Defines the bounding rectangle of the text.
1010 A value such as `{x=100, y=100}` should work.
1011 * `text`: The text to be displayed in the HUD element.
1012 * `number`: An integer containing the RGB value of the color used to draw the text.
1013 Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1014 * `alignment`: The alignment of the text.
1015 * `offset`: offset in pixels from position.
1018 Displays a horizontal bar made up of half-images.
1020 * `text`: The name of the texture that is used.
1021 * `number`: The number of half-textures that are displayed.
1022 If odd, will end with a vertically center-split texture.
1024 * `offset`: offset in pixels from position.
1025 * `size`: If used, will force full-image size to this value (override texture pack image size)
1028 * `text`: The name of the inventory list to be displayed.
1029 * `number`: Number of items in the inventory to be displayed.
1030 * `item`: Position of item that is selected.
1032 * `offset`: offset in pixels from position.
1035 Displays distance to selected world position.
1037 * `name`: The name of the waypoint.
1038 * `text`: Distance suffix. Can be blank.
1039 * `number:` An integer containing the RGB value of the color used to draw the text.
1040 * `world_pos`: World position of the waypoint.
1042 Representations of simple things
1043 --------------------------------
1047 {x=num, y=num, z=num}
1049 For helper functions see "Vector helpers".
1052 * `{type="nothing"}`
1053 * `{type="node", under=pos, above=pos}`
1054 * `{type="object", ref=ObjectRef}`
1056 Flag Specifier Format
1057 ---------------------
1058 Flags using the standardized flag specifier format can be specified in either of
1059 two ways, by string or table.
1061 The string format is a comma-delimited set of flag names; whitespace and
1062 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1063 flag, and specifying a flag prefixed by the string `"no"` explicitly
1064 clears the flag from whatever the default may be.
1066 In addition to the standard string flag format, the schematic flags field can
1067 also be a table of flag names to boolean values representing whether or not the
1068 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1069 is present, mapped to a boolean of any value, the specified flag is unset.
1071 E.g. A flag field of value
1073 {place_center_x = true, place_center_y=false, place_center_z=true}
1077 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1079 which is equivalent to
1081 "place_center_x, noplace_center_y, place_center_z"
1085 "place_center_x, place_center_z"
1087 since, by default, no schematic attributes are set.
1093 There are three kinds of items: nodes, tools and craftitems.
1095 * Node (`register_node`): A node from the world.
1096 * Tool (`register_tool`): A tool/weapon that can dig and damage
1097 things according to `tool_capabilities`.
1098 * Craftitem (`register_craftitem`): A miscellaneous item.
1101 Items and item stacks can exist in three formats: Serializes, table format
1105 This is called "stackstring" or "itemstring":
1107 * e.g. `'default:dirt 5'`
1108 * e.g. `'default:pick_wood 21323'`
1109 * e.g. `'default:apple'`
1116 {name="default:dirt", count=5, wear=0, metadata=""}
1118 A wooden pick about 1/3 worn out:
1120 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1124 {name="default:apple", count=1, wear=0, metadata=""}
1127 A native C++ format with many helper methods. Useful for converting
1128 between formats. See the Class reference section for details.
1130 When an item must be passed to a function, it can usually be in any of
1136 In a number of places, there is a group table. Groups define the
1137 properties of a thing (item, node, armor of entity, capabilities of
1138 tool) in such a way that the engine and other mods can can interact with
1139 the thing without actually knowing what the thing is.
1142 Groups are stored in a table, having the group names with keys and the
1143 group ratings as values. For example:
1145 groups = {crumbly=3, soil=1}
1148 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1149 -- ^ A more special dirt-kind of thing
1151 Groups always have a rating associated with them. If there is no
1152 useful meaning for a rating for an enabled group, it shall be `1`.
1154 When not defined, the rating of a group defaults to `0`. Thus when you
1155 read groups, you must interpret `nil` and `0` as the same value, `0`.
1157 You can read the rating of a group for an item or a node by using
1159 minetest.get_item_group(itemname, groupname)
1162 Groups of items can define what kind of an item it is (e.g. wool).
1165 In addition to the general item things, groups are used to define whether
1166 a node is destroyable and how long it takes to destroy by a tool.
1168 ### Groups of entities
1169 For entities, groups are, as of now, used only for calculating damage.
1170 The rating is the percentage of damage caused by tools with this damage group.
1171 See "Entity damage mechanism".
1173 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1174 object.set_armor_groups({fleshy=30, cracky=80})
1177 Groups in tools define which groups of nodes and entities they are
1180 ### Groups in crafting recipes
1181 An example: Make meat soup from any meat, any water and any bowl:
1184 output = 'food:meat_soup_raw',
1190 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1193 Another example: Make red wool from white wool and red dye:
1197 output = 'wool:red',
1198 recipe = {'wool:white', 'group:dye,basecolor_red'},
1202 * `immortal`: Disables the group damage system for an entity
1203 * `level`: Can be used to give an additional sense of progression in the game.
1204 * A larger level will cause e.g. a weapon of a lower level make much less
1205 damage, and get worn out much faster, or not be able to get drops
1206 from destroyed nodes.
1207 * `0` is something that is directly accessible at the start of gameplay
1208 * There is no upper limit
1209 * `dig_immediate`: (player can always pick up node without tool wear)
1210 * `2`: node is removed without tool wear after 0.5 seconds or so
1212 * `3`: node is removed without tool wear immediately (torch)
1213 * `disable_jump`: Player (and possibly other things) cannot jump from node
1214 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1215 * `bouncy`: value is bounce speed in percent
1216 * `falling_node`: if there is no walkable block under the node it will fall
1217 * `attached_node`: if the node under it is not a walkable block the node will be
1218 dropped as an item. If the node is wallmounted the wallmounted direction is
1220 * `soil`: saplings will grow on nodes in this group
1221 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1222 connect to each other
1224 ### Known damage and digging time defining groups
1225 * `crumbly`: dirt, sand
1226 * `cracky`: tough but crackable stuff like stone.
1227 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1228 plants, wire, sheets of metal
1229 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1230 * `fleshy`: Living things like animals and the player. This could imply
1231 some blood effects when hitting.
1232 * `explody`: Especially prone to explosions
1233 * `oddly_breakable_by_hand`:
1234 Can be added to nodes that shouldn't logically be breakable by the
1235 hand but are. Somewhat similar to `dig_immediate`, but times are more
1236 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1237 speed of a tool if the tool can dig at a faster speed than this
1238 suggests for the hand.
1240 ### Examples of custom groups
1241 Item groups are often used for defining, well, _groups of items_.
1242 * `meat`: any meat-kind of a thing (rating might define the size or healing
1243 ability or be irrelevant -- it is not defined as of yet)
1244 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1246 * `flammable`: can be set on fire. Rating might define the intensity of the
1247 fire, affecting e.g. the speed of the spreading of an open fire.
1248 * `wool`: any wool (any origin, any color)
1249 * `metal`: any metal
1250 * `weapon`: any weapon
1251 * `heavy`: anything considerably heavy
1253 ### Digging time calculation specifics
1254 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1255 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1256 faster digging time.
1258 The `level` group is used to limit the toughness of nodes a tool can dig
1259 and to scale the digging times / damage to a greater extent.
1261 **Please do understand this**, otherwise you cannot use the system to it's
1264 Tools define their properties by a list of parameters for groups. They
1265 cannot dig other groups; thus it is important to use a standard bunch of
1266 groups to enable interaction with tools.
1268 #### Tools definition
1271 * Full punch interval
1272 * Maximum drop level
1273 * For an arbitrary list of groups:
1274 * Uses (until the tool breaks)
1275 * Maximum level (usually `0`, `1`, `2` or `3`)
1279 #### Full punch interval
1280 When used as a weapon, the tool will do full damage if this time is spent
1281 between punches. If e.g. half the time is spent, the tool will do half
1284 #### Maximum drop level
1285 Suggests the maximum level of node, when dug with the tool, that will drop
1286 it's useful item. (e.g. iron ore to drop a lump of iron).
1288 This is not automated; it is the responsibility of the node definition
1292 Determines how many uses the tool has when it is used for digging a node,
1293 of this group, of the maximum level. For lower leveled nodes, the use count
1294 is multiplied by `3^leveldiff`.
1296 * `uses=10, leveldiff=0`: actual uses: 10
1297 * `uses=10, leveldiff=1`: actual uses: 30
1298 * `uses=10, leveldiff=2`: actual uses: 90
1301 Tells what is the maximum level of a node of this group that the tool will
1305 List of digging times for different ratings of the group, for nodes of the
1308 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1309 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1310 for this group, and unable to dig the rating `1`, which is the toughest.
1311 Unless there is a matching group that enables digging otherwise.
1314 List of damage for groups of entities. See "Entity damage mechanism".
1316 #### Example definition of the capabilities of a tool
1318 tool_capabilities = {
1319 full_punch_interval=1.5,
1322 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1324 damage_groups = {fleshy=2},
1327 This makes the tool be able to dig nodes that fulfil both of these:
1329 * Have the `crumbly` group
1330 * Have a `level` group less or equal to `2`
1332 Table of resulting digging times:
1334 crumbly 0 1 2 3 4 <- level
1336 1 0.80 1.60 1.60 - -
1337 2 0.60 1.20 1.20 - -
1338 3 0.40 0.80 0.80 - -
1340 level diff: 2 1 0 -1 -2
1342 Table of resulting tool uses:
1351 * At `crumbly==0`, the node is not diggable.
1352 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1353 easy nodes to be quickly breakable.
1354 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1356 Entity damage mechanism
1357 -----------------------
1361 foreach group in cap.damage_groups:
1362 damage += cap.damage_groups[group] * limit(actual_interval /
1363 cap.full_punch_interval, 0.0, 1.0)
1364 * (object.armor_groups[group] / 100.0)
1365 -- Where object.armor_groups[group] is 0 for inexistent values
1368 Client predicts damage based on damage groups. Because of this, it is able to
1369 give an immediate response when an entity is damaged or dies; the response is
1370 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1372 Currently a smoke puff will appear when an entity dies.
1374 The group `immortal` completely disables normal damage.
1376 Entities can define a special armor group, which is `punch_operable`. This
1377 group disables the regular damage mechanism for players punching it by hand or
1378 a non-tool item, so that it can do something else than take damage.
1380 On the Lua side, every punch calls:
1382 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction)
1384 This should never be called directly, because damage is usually not handled by
1387 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1388 accessed unless absolutely required, to encourage interoperability.
1389 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1390 * `tool_capabilities` can be `nil`.
1391 * `direction` is a unit vector, pointing from the source of the punch to
1394 To punch an entity/object in Lua, call:
1396 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1398 * Return value is tool wear.
1399 * Parameters are equal to the above callback.
1400 * If `direction` equals `nil` and `puncher` does not equal `nil`,
1401 `direction` will be automatically filled in based on the location of `puncher`.
1405 The instance of a node in the world normally only contains the three values
1406 mentioned in "Nodes". However, it is possible to insert extra data into a
1407 node. It is called "node metadata"; See "`NodeMetaRef`".
1409 Metadata contains two things:
1414 Some of the values in the key-value store are handled specially:
1416 * `formspec`: Defines a right-click inventory menu. See "Formspec".
1417 * `infotext`: Text shown on the screen when the node is pointed at
1421 local meta = minetest.get_meta(pos)
1422 meta:set_string("formspec",
1424 "list[context;main;0,0;8,4;]"..
1425 "list[current_player;main;0,5;8,4;]")
1426 meta:set_string("infotext", "Chest");
1427 local inv = meta:get_inventory()
1428 inv:set_size("main", 8*4)
1429 print(dump(meta:to_table()))
1432 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1433 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1434 [10] = "", [11] = "", [12] = "", [13] = "",
1435 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1436 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1437 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1438 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1442 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1449 Formspec defines a menu. Currently not much else than inventories are
1450 supported. It is a string, with a somewhat strange format.
1452 Spaces and newlines can be inserted between the blocks, as is used in the
1460 list[context;main;0,0;8,4;]
1461 list[current_player;main;0,5;8,4;]
1466 list[context;fuel;2,3;1,1;]
1467 list[context;src;2,1;1,1;]
1468 list[context;dst;5,1;2,2;]
1469 list[current_player;main;0,5;8,4;]
1471 #### Minecraft-like player inventory
1474 image[1,0.6;1,2;player.png]
1475 list[current_player;main;0,3.5;8,4;]
1476 list[current_player;craft;3,0;3,3;]
1477 list[current_player;craftpreview;7,1;1,1;]
1481 #### `size[<W>,<H>,<fixed_size>]`
1482 * Define the size of the menu in inventory slots
1483 * `fixed_size`: `true`/`false` (optional)
1484 * deprecated: `invsize[<W>,<H>;]`
1486 #### `container[<X>,<Y>]`
1487 * Start of a container block, moves all physical elements in the container by (X, Y)
1488 * Must have matching container_end
1489 * Containers can be nested, in which case the offsets are added
1490 (child containers are relative to parent containers)
1492 #### `container_end[]`
1493 * End of a container, following elements are no longer relative to this container
1495 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
1496 * Show an inventory list
1498 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
1499 * Show an inventory list
1501 #### `listring[<inventory location>;<list name>]`
1502 * Allows to create a ring of inventory lists
1503 * Shift-clicking on items in one element of the ring
1504 will send them to the next inventory list inside the ring
1505 * The first occurrence of an element inside the ring will
1506 determine the inventory where items will be sent to
1509 * Shorthand for doing `listring[<inventory location>;<list name>]`
1510 for the last two inventory lists added by list[...]
1512 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
1513 * Sets background color of slots as `ColorString`
1514 * Sets background color of slots on mouse hovering
1516 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
1517 * Sets background color of slots as `ColorString`
1518 * Sets background color of slots on mouse hovering
1519 * Sets color of slots border
1521 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
1522 * Sets background color of slots as `ColorString`
1523 * Sets background color of slots on mouse hovering
1524 * Sets color of slots border
1525 * Sets default background color of tooltips
1526 * Sets default font color of tooltips
1528 #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>,<fontcolor>]`
1529 * Adds tooltip for an element
1530 * `<bgcolor>` tooltip background color as `ColorString` (optional)
1531 * `<fontcolor>` tooltip font color as `ColorString` (optional)
1533 #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
1535 * Position and size units are inventory slots
1537 #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
1538 * Show an inventory image of registered item/node
1539 * Position and size units are inventory slots
1541 #### `bgcolor[<color>;<fullscreen>]`
1542 * Sets background color of formspec as `ColorString`
1543 * If `true`, the background color is drawn fullscreen (does not effect the size of the formspec)
1545 #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
1546 * Use a background. Inventory rectangles are not drawn then.
1547 * Position and size units are inventory slots
1548 * Example for formspec 8x4 in 16x resolution: image shall be sized
1549 8 times 16px times 4 times 16px.
1551 #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
1552 * Use a background. Inventory rectangles are not drawn then.
1553 * Position and size units are inventory slots
1554 * Example for formspec 8x4 in 16x resolution:
1555 image shall be sized 8 times 16px times 4 times 16px
1556 * If `true` the background is clipped to formspec size
1557 (`x` and `y` are used as offset values, `w` and `h` are ignored)
1559 #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
1560 * Textual password style field; will be sent to server when a button is clicked
1561 * When enter is pressed in field, fields.key_enter_field will be sent with the name
1563 * `x` and `y` position the field relative to the top left of the menu
1564 * `w` and `h` are the size of the field
1565 * Fields are a set height, but will be vertically centred on `h`
1566 * Position and size units are inventory slots
1567 * `name` is the name of the field as returned in fields to `on_receive_fields`
1568 * `label`, if not blank, will be text printed on the top left above the field
1569 * See field_close_on_enter to stop enter closing the formspec
1571 #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1572 * Textual field; will be sent to server when a button is clicked
1573 * When enter is pressed in field, fields.key_enter_field will be sent with the name
1575 * `x` and `y` position the field relative to the top left of the menu
1576 * `w` and `h` are the size of the field
1577 * Fields are a set height, but will be vertically centred on `h`
1578 * Position and size units are inventory slots
1579 * `name` is the name of the field as returned in fields to `on_receive_fields`
1580 * `label`, if not blank, will be text printed on the top left above the field
1581 * `default` is the default value of the field
1582 * `default` may contain variable references such as `${text}'` which
1583 will fill the value from the metadata value `text`
1584 * **Note**: no extra text or more than a single variable is supported ATM.
1585 * See field_close_on_enter to stop enter closing the formspec
1587 #### `field[<name>;<label>;<default>]`
1588 * As above, but without position/size units
1589 * When enter is pressed in field, fields.key_enter_field will be sent with the name
1591 * Special field for creating simple forms, such as sign text input
1592 * Must be used without a `size[]` element
1593 * A "Proceed" button will be added automatically
1594 * See field_close_on_enter to stop enter closing the formspec
1596 #### `field_close_on_enter[<name>;<close_on_enter>]`
1597 * <name> is the name of the field
1598 * if <close_on_enter> is false, pressing enter in the field will submit the form but not close it
1599 * defaults to true when not specified (ie: no tag for a field)
1601 #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1602 * Same as fields above, but with multi-line input
1604 #### `label[<X>,<Y>;<label>]`
1605 * `x` and `y` work as per field
1606 * `label` is the text on the label
1607 * Position and size units are inventory slots
1609 #### `vertlabel[<X>,<Y>;<label>]`
1610 * Textual label drawn vertically
1611 * `x` and `y` work as per field
1612 * `label` is the text on the label
1613 * Position and size units are inventory slots
1615 #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
1616 * Clickable button. When clicked, fields will be sent.
1617 * `x`, `y` and `name` work as per field
1618 * `w` and `h` are the size of the button
1619 * `label` is the text on the button
1620 * Position and size units are inventory slots
1622 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1623 * `x`, `y`, `w`, `h`, and `name` work as per button
1624 * `texture name` is the filename of an image
1625 * Position and size units are inventory slots
1627 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
1628 * `x`, `y`, `w`, `h`, and `name` work as per button
1629 * `texture name` is the filename of an image
1630 * Position and size units are inventory slots
1631 * `noclip=true` means the image button doesn't need to be within specified formsize
1632 * `drawborder`: draw button border or not
1633 * `pressed texture name` is the filename of an image on pressed state
1635 #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
1636 * `x`, `y`, `w`, `h`, `name` and `label` work as per button
1637 * `item name` is the registered name of an item/node,
1638 tooltip will be made out of its description
1639 to override it use tooltip element
1640 * Position and size units are inventory slots
1642 #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
1643 * When clicked, fields will be sent and the form will quit.
1645 #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1646 * When clicked, fields will be sent and the form will quit.
1648 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
1649 * Scrollable item list showing arbitrary text elements
1650 * `x` and `y` position the itemlist relative to the top left of the menu
1651 * `w` and `h` are the size of the itemlist
1652 * `name` fieldname sent to server on doubleclick value is current selected element
1653 * `listelements` can be prepended by #color in hexadecimal format RRGGBB (only),
1654 * if you want a listelement to start with "#" write "##".
1656 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
1657 * Scrollable itemlist showing arbitrary text elements
1658 * `x` and `y` position the item list relative to the top left of the menu
1659 * `w` and `h` are the size of the item list
1660 * `name` fieldname sent to server on doubleclick value is current selected element
1661 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
1662 * if you want a listelement to start with "#" write "##"
1663 * Index to be selected within textlist
1664 * `true`/`false`: draw transparent background
1665 * See also `minetest.explode_textlist_event` (main menu: `engine.explode_textlist_event`)
1667 #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
1668 * Show a tab**header** at specific position (ignores formsize)
1669 * `x` and `y` position the itemlist relative to the top left of the menu
1670 * `name` fieldname data is transferred to Lua
1671 * `caption 1`...: name shown on top of tab
1672 * `current_tab`: index of selected tab 1...
1673 * `transparent` (optional): show transparent
1674 * `draw_border` (optional): draw border
1676 #### `box[<X>,<Y>;<W>,<H>;<color>]`
1677 * Simple colored semitransparent box
1678 * `x` and `y` position the box relative to the top left of the menu
1679 * `w` and `h` are the size of box
1680 * `color` is color specified as a `ColorString`
1682 #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
1683 * Show a dropdown field
1684 * **Important note**: There are two different operation modes:
1685 1. handle directly on change (only changed dropdown is submitted)
1686 2. read the value on pressing a button (all dropdown values are available)
1687 * `x` and `y` position of dropdown
1689 * Fieldname data is transferred to Lua
1690 * Items to be shown in dropdown
1691 * Index of currently selected dropdown item
1693 #### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
1695 * `x` and `y`: position of checkbox
1696 * `name` fieldname data is transferred to Lua
1697 * `label` to be shown left of checkbox
1698 * `selected` (optional): `true`/`false`
1700 #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
1702 * There are two ways to use it:
1703 1. handle the changed event (only changed scrollbar is available)
1704 2. read the value on pressing a button (all scrollbars are available)
1705 * `x` and `y`: position of trackbar
1706 * `w` and `h`: width and height
1707 * `orientation`: `vertical`/`horizontal`
1708 * Fieldname data is transferred to Lua
1709 * Value this trackbar is set to (`0`-`1000`)
1710 * See also `minetest.explode_scrollbar_event` (main menu: `engine.explode_scrollbar_event`)
1712 #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
1713 * Show scrollable table using options defined by the previous `tableoptions[]`
1714 * Displays cells as defined by the previous `tablecolumns[]`
1715 * `x` and `y`: position the itemlist relative to the top left of the menu
1716 * `w` and `h` are the size of the itemlist
1717 * `name`: fieldname sent to server on row select or doubleclick
1718 * `cell 1`...`cell n`: cell contents given in row-major order
1719 * `selected idx`: index of row to be selected within table (first row = `1`)
1720 * See also `minetest.explode_table_event` (main menu: `engine.explode_table_event`)
1722 #### `tableoptions[<opt 1>;<opt 2>;...]`
1723 * Sets options for `table[]`
1725 * default text color (`ColorString`), defaults to `#FFFFFF`
1726 * `background=#RRGGBB`
1727 * table background color (`ColorString`), defaults to `#000000`
1728 * `border=<true/false>`
1729 * should the table be drawn with a border? (default: `true`)
1730 * `highlight=#RRGGBB`
1731 * highlight background color (`ColorString`), defaults to `#466432`
1732 * `highlight_text=#RRGGBB`
1733 * highlight text color (`ColorString`), defaults to `#FFFFFF`
1734 * `opendepth=<value>`
1735 * all subtrees up to `depth < value` are open (default value = `0`)
1736 * only useful when there is a column of type "tree"
1738 #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
1739 * Sets columns for `table[]`
1740 * Types: `text`, `image`, `color`, `indent`, `tree`
1741 * `text`: show cell contents as text
1742 * `image`: cell contents are an image index, use column options to define images
1743 * `color`: cell contents are a ColorString and define color of following cell
1744 * `indent`: cell contents are a number and define indentation of following cell
1745 * `tree`: same as indent, but user can open and close subtrees (treeview-like)
1748 * for `text` and `image`: content alignment within cells.
1749 Available values: `left` (default), `center`, `right`, `inline`
1751 * for `text` and `image`: minimum width in em (default: `0`)
1752 * for `indent` and `tree`: indent width in em (default: `1.5`)
1753 * `padding=<value>`: padding left of the column, in em (default `0.5`).
1754 Exception: defaults to 0 for indent columns
1755 * `tooltip=<value>`: tooltip text (default: empty)
1756 * `image` column options:
1757 * `0=<value>` sets image for image index 0
1758 * `1=<value>` sets image for image index 1
1759 * `2=<value>` sets image for image index 2
1760 * and so on; defined indices need not be contiguous empty or
1761 non-numeric cells are treated as `0`.
1762 * `color` column options:
1763 * `span=<value>`: number of following columns to affect (default: infinite)
1765 **Note**: do _not_ use a element name starting with `key_`; those names are reserved to
1766 pass key press events to formspec!
1770 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
1771 * `"current_player"`: Player to whom the menu is shown
1772 * `"player:<name>"`: Any player
1773 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
1774 * `"detached:<name>"`: A detached inventory
1776 Player Inventory lists
1777 ----------------------
1778 * `main`: list containing the default inventory
1779 * `craft`: list containing the craft input
1780 * `craftpreview`: list containing the craft output
1781 * `hand`: list containing an override for the empty hand
1785 `#RGB` defines a color in hexadecimal format.
1787 `#RGBA` defines a color in hexadecimal format and alpha channel.
1789 `#RRGGBB` defines a color in hexadecimal format.
1791 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
1793 Named colors are also supported and are equivalent to
1794 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
1795 To specify the value of the alpha channel, append `#AA` to the end of the color name
1796 (e.g. `colorname#08`). For named colors the hexadecimal string representing the alpha
1797 value must (always) be two hexadecimal digits.
1801 A ColorSpec specifies a 32-bit color. It can be written in either:
1802 table form, each element ranging from 0..255 (a, if absent, defaults to 255):
1803 `colorspec = {a=255, r=0, g=255, b=0}`
1804 numerical form, the raw integer value of an ARGB8 quad:
1805 `colorspec = 0xFF00FF00`
1806 or string form, a ColorString (defined above):
1807 `colorspec = "green"`
1811 Most text can contain escape sequences, that can for example color the text.
1812 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
1813 The following functions provide escape sequences:
1814 * `core.get_color_escape_sequence(color)`:
1815 * `color` is a ColorString
1816 * The escape sequence sets the text color to `color`
1817 * `core.colorize(color, message)`:
1819 `core.get_color_escape_sequence(color) ..
1821 core.get_color_escape_sequence("#ffffff")`
1822 * `color.get_background_escape_sequence(color)`
1823 * `color` is a ColorString
1824 * The escape sequence sets the background of the whole text element to
1825 `color`. Only defined for item descriptions and tooltips.
1829 * `vector.new(a[, b, c])`: returns a vector:
1830 * A copy of `a` if `a` is a vector.
1831 * `{x = a, y = b, z = c}`, if all `a, b, c` are defined
1832 * `vector.direction(p1, p2)`: returns a vector
1833 * `vector.distance(p1, p2)`: returns a number
1834 * `vector.length(v)`: returns a number
1835 * `vector.normalize(v)`: returns a vector
1836 * `vector.floor(v)`: returns a vector, each dimension rounded down
1837 * `vector.round(v)`: returns a vector, each dimension rounded to nearest int
1838 * `vector.apply(v, func)`: returns a vector
1839 * `vector.equals(v1, v2)`: returns a boolean
1841 For the following functions `x` can be either a vector or a number:
1843 * `vector.add(v, x)`: returns a vector
1844 * `vector.subtract(v, x)`: returns a vector
1845 * `vector.multiply(v, x)`: returns a scaled vector or Schur product
1846 * `vector.divide(v, x)`: returns a scaled vector or Schur quotient
1850 * `dump2(obj, name="_", dumped={})`
1851 * Return object serialized as a string, handles reference loops
1852 * `dump(obj, dumped={})`
1853 * Return object serialized as a string
1854 * `math.hypot(x, y)`
1855 * Get the hypotenuse of a triangle with legs x and y.
1856 Useful for distance calculation.
1857 * `math.sign(x, tolerance)`
1858 * Get the sign of a number.
1859 Optional: Also returns `0` when the absolute value is within the tolerance (default: `0`)
1860 * `string.split(str, separator=",", include_empty=false, max_splits=-1,
1861 * sep_is_pattern=false)`
1862 * If `max_splits` is negative, do not limit splits.
1863 * `sep_is_pattern` specifies if separator is a plain string or a pattern (regex).
1864 * e.g. `string:split("a,b", ",") == {"a","b"}`
1866 * e.g. `string.trim("\n \t\tfoo bar\t ") == "foo bar"`
1867 * `minetest.pos_to_string({x=X,y=Y,z=Z}, decimal_places))`: returns `"(X,Y,Z)"`
1868 * Convert position to a printable string
1869 Optional: 'decimal_places' will round the x, y and z of the pos to the given decimal place.
1870 * `minetest.string_to_pos(string)`: returns a position
1871 * Same but in reverse. Returns `nil` if the string can't be parsed to a position.
1872 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
1873 * Converts a string representing an area box into two positions
1874 * `minetest.formspec_escape(string)`: returns a string
1875 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
1876 * `minetest.is_yes(arg)`
1877 * returns whether `arg` can be interpreted as yes
1878 * `minetest.get_us_time()`
1879 * returns time with microsecond precision. May not return wall time.
1880 * `table.copy(table)`: returns a table
1881 * returns a deep copy of `table`
1883 `minetest` namespace reference
1884 ------------------------------
1888 * `minetest.get_current_modname()`: returns the currently loading mod's name, when we are loading a mod
1889 * `minetest.get_modpath(modname)`: returns e.g. `"/home/user/.minetest/usermods/modname"`
1890 * Useful for loading additional `.lua` modules or static data from mod
1891 * `minetest.get_modnames()`: returns a list of installed mods
1892 * Return a list of installed mods, sorted alphabetically
1893 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
1894 * Useful for storing custom data
1895 * `minetest.is_singleplayer()`
1896 * `minetest.features`
1897 * Table containing API feature flags: `{foo=true, bar=true}`
1898 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
1899 * `arg`: string or table in format `{foo=true, bar=true}`
1900 * `missing_features`: `{foo=true, bar=true}`
1901 * `minetest.get_player_information(player_name)`: returns a table containing
1902 information about player. Example return value:
1904 address = "127.0.0.1", -- IP address of client
1905 ip_version = 4, -- IPv4 / IPv6
1906 min_rtt = 0.01, -- minimum round trip time
1907 max_rtt = 0.2, -- maximum round trip time
1908 avg_rtt = 0.02, -- average round trip time
1909 min_jitter = 0.01, -- minimum packet time jitter
1910 max_jitter = 0.5, -- maximum packet time jitter
1911 avg_jitter = 0.03, -- average packet time jitter
1912 connection_uptime = 200, -- seconds since client connected
1914 -- following information is available on debug build only!!!
1915 -- DO NOT USE IN MODS
1916 --ser_vers = 26, -- serialization version used by client
1917 --prot_vers = 23, -- protocol version used by client
1918 --major = 0, -- major version number
1919 --minor = 4, -- minor version number
1920 --patch = 10, -- patch version number
1921 --vers_string = "0.4.9-git", -- full version string
1922 --state = "Active" -- current client state
1924 * `minetest.mkdir(path)`: returns success.
1925 * Creates a directory specified by `path`, creating parent directories
1926 if they don't exist.
1927 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
1929 * nil: return all entries,
1930 * true: return only subdirectory names, or
1931 * false: return only file names.
1932 * `minetest.get_version()`: returns a table containing components of the
1933 engine version. Components:
1934 * `project`: Name of the project, eg, "Minetest"
1935 * `string`: Simple version, eg, "1.2.3-dev"
1936 * `hash`: Full git version (only set if available), eg, "1.2.3-dev-01234567-dirty"
1937 Use this for informational purposes only. The information in the returned
1938 table does not represent the capabilities of the engine, nor is it
1939 reliable or verifyable. Compatible forks will have a different name and
1940 version entirely. To check for the presence of engine features, test
1941 whether the functions exported by the wanted features exist. For example:
1942 `if core.nodeupdate then ... end`.
1945 * `minetest.debug(...)`
1946 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
1947 * `minetest.log([level,] text)`
1948 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
1949 `"info"`, or `"verbose"`. Default is `"none"`.
1951 ### Registration functions
1952 Call these functions only at load time!
1954 * `minetest.register_entity(name, prototype table)`
1955 * `minetest.register_abm(abm definition)`
1956 * `minetest.register_lbm(lbm definition)`
1957 * `minetest.register_node(name, node definition)`
1958 * `minetest.register_tool(name, item definition)`
1959 * `minetest.register_craftitem(name, item definition)`
1960 * `minetest.unregister_item(name)`
1961 * `minetest.register_alias(name, convert_to)`
1962 * `minetest.register_alias_force(name, convert_to)`
1963 * `minetest.register_craft(recipe)`
1964 * Check recipe table syntax for different types below.
1965 * `minetest.clear_craft(recipe)`
1966 * Will erase existing craft based either on output item or on input recipe.
1967 * Specify either output or input only. If you specify both, input will be ignored. For input use the same recipe table
1968 syntax as for `minetest.register_craft(recipe)`. For output specify only the item, without a quantity.
1969 * If no erase candidate could be found, Lua exception will be thrown.
1970 * Warning! The type field ("shaped","cooking" or any other) will be ignored if the recipe
1971 contains output. Erasing is then done independently from the crafting method.
1972 * `minetest.register_ore(ore definition)`
1973 * `minetest.register_biome(biome definition)`
1974 * `minetest.register_decoration(decoration definition)`
1975 * `minetest.override_item(name, redefinition)`
1976 * Overrides fields of an item registered with register_node/tool/craftitem.
1977 * Note: Item must already be defined, (opt)depend on the mod defining it.
1978 * Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})`
1979 * `minetest.clear_registered_ores()`
1980 * `minetest.clear_registered_biomes()`
1981 * `minetest.clear_registered_decorations()`
1983 ### Global callback registration functions
1984 Call these functions only at load time!
1986 * `minetest.register_globalstep(func(dtime))`
1987 * Called every server step, usually interval of 0.1s
1988 * `minetest.register_on_shutdown(func())`
1989 * Called before server shutdown
1990 * **Warning**: If the server terminates abnormally (i.e. crashes), the registered
1991 callbacks **will likely not be run**. Data should be saved at
1992 semi-frequent intervals as well as on server shutdown.
1993 * `minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
1994 * Called when a node has been placed
1995 * If return `true` no item is taken from `itemstack`
1996 * **Not recommended**; use `on_construct` or `after_place_node` in node definition
1998 * `minetest.register_on_dignode(func(pos, oldnode, digger))`
1999 * Called when a node has been dug.
2000 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node definition
2002 * `minetest.register_on_punchnode(func(pos, node, puncher, pointed_thing))`
2003 * Called when a node is punched
2004 * `minetest.register_on_generated(func(minp, maxp, blockseed))`
2005 * Called after generating a piece of world. Modifying nodes inside the area
2006 is a bit faster than usually.
2007 * `minetest.register_on_newplayer(func(ObjectRef))`
2008 * Called after a new player has been created
2009 * `minetest.register_on_dieplayer(func(ObjectRef))`
2010 * Called when a player dies
2011 * `minetest.register_on_punchplayer(func(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
2012 * Called when a player is punched
2013 * `player` - ObjectRef - Player that was punched
2014 * `hitter` - ObjectRef - Player that hit
2015 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be nil)
2016 * `tool_capabilities`: capability table of used tool (can be nil)
2017 * `dir`: unit vector of direction of punch. Always defined. Points from
2018 the puncher to the punched.
2019 * `damage` - number that represents the damage calculated by the engine
2020 * should return `true` to prevent the default damage mechanism
2021 * `minetest.register_on_player_hpchange(func(player, hp_change), modifier)`
2022 * Called when the player gets damaged or healed
2023 * `player`: ObjectRef of the player
2024 * `hp_change`: the amount of change. Negative when it is damage.
2025 * `modifier`: when true, the function should return the actual hp_change.
2026 Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
2027 modifiers can return true as a second argument to stop the execution of further functions.
2028 Non-modifiers receive the final hp change calculated by the modifiers.
2029 * `minetest.register_on_respawnplayer(func(ObjectRef))`
2030 * Called when player is to be respawned
2031 * Called _before_ repositioning of player occurs
2032 * return true in func to disable regular player placement
2033 * `minetest.register_on_prejoinplayer(func(name, ip))`
2034 * Called before a player joins the game
2035 * If it returns a string, the player is disconnected with that string as reason
2036 * `minetest.register_on_joinplayer(func(ObjectRef))`
2037 * Called when a player joins the game
2038 * `minetest.register_on_leaveplayer(func(ObjectRef, timed_out))`
2039 * Called when a player leaves the game
2040 * `timed_out`: True for timeout, false for other reasons.
2041 * `minetest.register_on_cheat(func(ObjectRef, cheat))`
2042 * Called when a player cheats
2043 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
2045 * `interacted_too_far`
2046 * `interacted_while_dead`
2047 * `finished_unknown_dig`
2050 * `minetest.register_on_chat_message(func(name, message))`
2051 * Called always when a player says something
2052 * Return `true` to mark the message as handled, which means that it will not be sent to other players
2053 * `minetest.register_on_player_receive_fields(func(player, formname, fields))`
2054 * Called when a button is pressed in player's inventory form
2055 * Newest functions are called first
2056 * If function returns `true`, remaining functions are not called
2057 * `minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))`
2058 * Called when `player` crafts something
2059 * `itemstack` is the output
2060 * `old_craft_grid` contains the recipe (Note: the one in the inventory is cleared)
2061 * `craft_inv` is the inventory with the crafting grid
2062 * Return either an `ItemStack`, to replace the output, or `nil`, to not modify it
2063 * `minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))`
2064 * The same as before, except that it is called before the player crafts, to make
2065 craft prediction, and it should not change anything.
2066 * `minetest.register_on_protection_violation(func(pos, name))`
2067 * Called by `builtin` and mods when a player violates protection at a position
2068 (eg, digs a node or punches a protected entity).
2069 * The registered functions can be called using `minetest.record_protection_violation`
2070 * The provided function should check that the position is protected by the mod
2071 calling this function before it prints a message, if it does, to allow for
2072 multiple protection mods.
2073 * `minetest.register_on_item_eat(func(hp_change, replace_with_item, itemstack, user, pointed_thing))`
2074 * Called when an item is eaten, by `minetest.item_eat`
2075 * Return `true` or `itemstack` to cancel the default item eat response (i.e.: hp increase)
2077 ### Other registration functions
2078 * `minetest.register_chatcommand(cmd, chatcommand definition)`
2079 * `minetest.register_privilege(name, definition)`
2080 * `definition`: `"description text"`
2081 * `definition`: `{ description = "description text", give_to_singleplayer = boolean}`
2082 the default of `give_to_singleplayer` is true
2083 * To allow players with basic_privs to grant, see basic_privs minetest.conf setting.
2084 * `minetest.register_authentication_handler(handler)`
2085 * See `minetest.builtin_auth_handler` in `builtin.lua` for reference
2088 * `minetest.setting_set(name, value)`
2089 * Setting names can't contain whitespace or any of `="{}#`.
2090 * Setting values can't contain the sequence `\n"""`.
2091 * Setting names starting with "secure." can't be set.
2092 * `minetest.setting_get(name)`: returns string or `nil`
2093 * `minetest.setting_setbool(name, value)`
2094 * See documentation on `setting_set` for restrictions.
2095 * `minetest.setting_getbool(name)`: returns boolean or `nil`
2096 * `minetest.setting_get_pos(name)`: returns position or nil
2097 * `minetest.setting_save()`, returns `nil`, save all settings to config file
2100 * `minetest.notify_authentication_modified(name)`
2101 * Should be called by the authentication handler if privileges changes.
2102 * To report everybody, set `name=nil`.
2103 * `minetest.check_password_entry(name, entry, password)`
2104 * Returns true if the "db entry" for a player with name matches given
2105 * password, false otherwise.
2106 * The "db entry" is the usually player-individual value that is derived
2107 * from the player's chosen password and stored on the server in order to allow
2108 * authentication whenever the player desires to log in.
2109 * Only use this function for making it possible to log in via the password from
2110 * via protocols like IRC, other uses for inside the game are frowned upon.
2111 * `minetest.get_password_hash(name, raw_password)`
2112 * Convert a name-password pair to a password hash that Minetest can use.
2113 * The returned value alone is not a good basis for password checks based
2114 * on comparing the password hash in the database with the password hash
2115 * from the function, with an externally provided password, as the hash
2116 * in the db might use the new SRP verifier format.
2117 * For this purpose, use minetest.check_password_entry instead.
2118 * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
2119 * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
2120 * Convert between two privilege representations
2121 * `minetest.set_player_password(name, password_hash)`
2122 * `minetest.set_player_privs(name, {priv1=true,...})`
2123 * `minetest.get_player_privs(name) -> {priv1=true,...}`
2124 * `minetest.auth_reload()`
2125 * `minetest.check_player_privs(player_or_name, ...)`: returns `bool, missing_privs`
2126 * A quickhand for checking privileges.
2127 * `player_or_name`: Either a Player object or the name of a player.
2128 * `...` is either a list of strings, e.g. `"priva", "privb"` or
2129 a table, e.g. `{ priva = true, privb = true }`.
2130 * `minetest.get_player_ip(name)`: returns an IP address string
2132 `minetest.set_player_password`, `minetest_set_player_privs`, `minetest_get_player_privs`
2133 and `minetest.auth_reload` call the authetification handler.
2136 * `minetest.chat_send_all(text)`
2137 * `minetest.chat_send_player(name, text)`
2139 ### Environment access
2140 * `minetest.set_node(pos, node)`
2141 * `minetest.add_node(pos, node): alias set_node(pos, node)`
2142 * Set node at position (`node = {name="foo", param1=0, param2=0}`)
2143 * `minetest.swap_node(pos, node)`
2144 * Set node at position, but don't remove metadata
2145 * `minetest.remove_node(pos)`
2146 * Equivalent to `set_node(pos, "air")`
2147 * `minetest.get_node(pos)`
2148 * Returns the node at the given position as table in the format
2149 `{name="node_name", param1=0, param2=0}`, returns `{name="ignore", param1=0, param2=0}`
2151 * `minetest.get_node_or_nil(pos)`
2152 * Same as `get_node` but returns `nil` for unloaded areas.
2153 * `minetest.get_node_light(pos, timeofday)`
2154 * Gets the light value at the given position. Note that the light value
2155 "inside" the node at the given position is returned, so you usually want
2156 to get the light value of a neighbor.
2157 * `pos`: The position where to measure the light.
2158 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
2159 * Returns a number between `0` and `15` or `nil`
2160 * `minetest.place_node(pos, node)`
2161 * Place node with the same effects that a player would cause
2162 * `minetest.dig_node(pos)`
2163 * Dig node with the same effects that a player would cause
2164 * Returns `true` if successful, `false` on failure (e.g. protected location)
2165 * `minetest.punch_node(pos)`
2166 * Punch node with the same effects that a player would cause
2168 * `minetest.find_nodes_with_meta(pos1, pos2)`
2169 * Get a table of positions of nodes that have metadata within a region {pos1, pos2}
2170 * `minetest.get_meta(pos)`
2171 * Get a `NodeMetaRef` at that position
2172 * `minetest.get_node_timer(pos)`
2173 * Get `NodeTimerRef`
2175 * `minetest.add_entity(pos, name)`: Spawn Lua-defined entity at position
2176 * Returns `ObjectRef`, or `nil` if failed
2177 * `minetest.add_item(pos, item)`: Spawn item
2178 * Returns `ObjectRef`, or `nil` if failed
2179 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
2180 * `minetest.get_objects_inside_radius(pos, radius)`
2181 * `radius`: using an euclidean metric
2182 * `minetest.set_timeofday(val)`
2183 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
2184 * `minetest.get_timeofday()`
2185 * `minetest.get_gametime()`: returns the time, in seconds, since the world was created
2186 * `minetest.get_day_count()`: returns number days elapsed since world was created,
2187 * accounting for time changes.
2188 * `minetest.find_node_near(pos, radius, nodenames)`: returns pos or `nil`
2189 * `radius`: using a maximum metric
2190 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2191 * `minetest.find_nodes_in_area(minp, maxp, nodenames)`: returns a list of positions
2192 * returns as second value a table with the count of the individual nodes found
2193 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2194 * `minetest.find_nodes_in_area_under_air(minp, maxp, nodenames)`: returns a list of positions
2195 * returned positions are nodes with a node air above
2196 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2197 * `minetest.get_perlin(noiseparams)`
2198 * `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
2199 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
2200 * `minetest.get_voxel_manip([pos1, pos2])`
2201 * Return voxel manipulator object.
2202 * Loads the manipulator from the map if positions are passed.
2203 * `minetest.set_gen_notify(flags, {deco_ids})`
2204 * Set the types of on-generate notifications that should be collected
2205 * `flags` is a flag field with the available flags: `dungeon`, `temple`, `cave_begin`,
2206 `cave_end`, `large_cave_begin`, `large_cave_end`, `decoration`
2207 * The second parameter is a list of IDS of decorations which notification is requested for
2208 * `get_gen_notify()`: returns a flagstring and a table with the deco_ids
2209 * `minetest.get_mapgen_object(objectname)`
2210 * Return requested mapgen object if available (see "Mapgen objects")
2211 * `minetest.get_biome_id(biome_name)`
2212 * Returns the biome id, as used in the biomemap Mapgen object, for a
2213 given biome_name string.
2214 * `minetest.get_mapgen_params()` Returns mapgen parameters, a table containing
2215 `mgname`, `seed`, `chunksize`, `water_level`, and `flags`.
2216 * Deprecated: use minetest.get_mapgen_setting(name) instead
2217 * `minetest.set_mapgen_params(MapgenParams)`
2218 * Deprecated: use minetest.set_mapgen_setting(name, value, override) instead
2219 * Set map generation parameters
2220 * Function cannot be called after the registration period; only initialization
2221 and `on_mapgen_init`
2222 * Takes a table as an argument with the fields `mgname`, `seed`, `water_level`,
2224 * Leave field unset to leave that parameter unchanged
2225 * `flags` contains a comma-delimited string of flags to set,
2226 or if the prefix `"no"` is attached, clears instead.
2227 * `flags` is in the same format and has the same options as `mg_flags` in `minetest.conf`
2228 * `minetest.get_mapgen_setting(name)`
2229 * Gets the *active* mapgen setting (or nil if none exists) in string format with the following
2230 order of precedence:
2231 1) Settings loaded from map_meta.txt or overrides set during mod execution
2232 2) Settings set by mods without a metafile override
2233 3) Settings explicitly set in the user config file, minetest.conf
2234 4) Settings set as the user config default
2235 * `minetest.get_mapgen_setting_noiseparams(name)`
2236 * Same as above, but returns the value as a NoiseParams table if the setting `name` exists
2237 and is a valid NoiseParams
2238 * `minetest.set_mapgen_setting(name, value, [override_meta])`
2239 * Sets a mapgen param to `value`, and will take effect if the corresponding mapgen setting
2240 is not already present in map_meta.txt.
2241 * `override_meta` is an optional boolean (default: `false`). If this is set to true,
2242 the setting will become the active setting regardless of the map metafile contents.
2243 * Note: to set the seed, use "seed", not "fixed_map_seed"
2244 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
2245 * Same as above, except value is a NoiseParams table.
2246 * `minetest.set_noiseparams(name, noiseparams, set_default)`
2247 * Sets the noiseparams setting of `name` to the noiseparams table specified in `noiseparams`.
2248 * `set_default` is an optional boolean (default: `true`) that specifies whether the setting
2249 should be applied to the default config or current active config
2250 * `minetest.get_noiseparams(name)`: returns a table of the noiseparams for name
2251 * `minetest.generate_ores(vm, pos1, pos2)`
2252 * Generate all registered ores within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
2253 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
2254 * `minetest.generate_decorations(vm, pos1, pos2)`
2255 * Generate all registered decorations within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
2256 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
2257 * `minetest.clear_objects([options])`
2258 * Clear all objects in the environment
2259 * Takes an optional table as an argument with the field `mode`.
2260 * mode = `"full"`: Load and go through every mapblock, clearing objects (default).
2261 * mode = `"quick"`: Clear objects immediately in loaded mapblocks;
2262 clear objects in unloaded mapblocks only when the mapblocks are next activated.
2263 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
2264 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be asynchronously
2265 * fetched from memory, loaded from disk, or if inexistent, generates them.
2266 * If `callback` is a valid Lua function, this will be called for each block emerged.
2267 * The function signature of callback is:
2268 * `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
2269 * - `blockpos` is the *block* coordinates of the block that had been emerged
2270 * - `action` could be one of the following constant values:
2271 * `core.EMERGE_CANCELLED`, `core.EMERGE_ERRORED`, `core.EMERGE_FROM_MEMORY`,
2272 * `core.EMERGE_FROM_DISK`, `core.EMERGE_GENERATED`
2273 * - `calls_remaining` is the number of callbacks to be expected after this one
2274 * - `param` is the user-defined parameter passed to emerge_area (or nil if the
2275 * parameter was absent)
2276 * `minetest.delete_area(pos1, pos2)`
2277 * delete all mapblocks in the area from pos1 to pos2, inclusive
2278 * `minetest.line_of_sight(pos1, pos2, stepsize)`: returns `boolean, pos`
2279 * Check if there is a direct line of sight between `pos1` and `pos2`
2280 * Returns the position of the blocking node when `false`
2281 * `pos1`: First position
2282 * `pos2`: Second position
2283 * `stepsize`: smaller gives more accurate results but requires more computing
2284 time. Default is `1`.
2285 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
2286 * returns table containing path
2287 * returns a table of 3D points representing a path from `pos1` to `pos2` or `nil`
2288 * `pos1`: start position
2289 * `pos2`: end position
2290 * `searchdistance`: number of blocks to search in each direction using a maximum metric
2291 * `max_jump`: maximum height difference to consider walkable
2292 * `max_drop`: maximum height difference to consider droppable
2293 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
2294 * `minetest.spawn_tree (pos, {treedef})`
2295 * spawns L-system tree at given `pos` with definition in `treedef` table
2296 * Warning: L-system generation currently creates lighting bugs in the form of mapblock-sized shadows.
2297 Often these bugs appear as subtle shadows in water.
2298 * `minetest.transforming_liquid_add(pos)`
2299 * add node to liquid update queue
2300 * `minetest.get_node_max_level(pos)`
2301 * get max available level for leveled node
2302 * `minetest.get_node_level(pos)`
2303 * get level of leveled node (water, snow)
2304 * `minetest.set_node_level(pos, level)`
2305 * set level of leveled node, default `level` equals `1`
2306 * if `totallevel > maxlevel`, returns rest (`total-max`).
2307 * `minetest.add_node_level(pos, level)`
2308 * increase level of leveled node by level, default `level` equals `1`
2309 * if `totallevel > maxlevel`, returns rest (`total-max`)
2310 * can be negative for decreasing
2311 * `core.check_single_for_falling(pos)`
2312 * causes an unsupported `group:falling_node` node to fall and causes an
2313 unattached `group:attached_node` node to fall.
2314 * does not spread these updates to neighbours.
2315 * `core.check_for_falling(pos)`
2316 * causes an unsupported `group:falling_node` node to fall and causes an
2317 unattached `group:attached_node` node to fall.
2318 * spread these updates to neighbours and can cause a cascade
2322 `minetest.get_inventory(location)`: returns an `InvRef`
2325 * `{type="player", name="celeron55"}`
2326 * `{type="node", pos={x=, y=, z=}}`
2327 * `{type="detached", name="creative"}`
2328 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns an `InvRef`
2329 * callbacks: See "Detached inventory callbacks"
2330 * player_name: Make detached inventory available to one player exclusively,
2331 by default they will be sent to every player (even if not used).
2332 Note that this parameter is mostly just a workaround and will be removed in future releases.
2333 * Creates a detached inventory. If it already exists, it is cleared.
2334 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
2335 returns left over ItemStack
2336 * See `minetest.item_eat` and `minetest.register_on_item_eat`
2339 * `minetest.show_formspec(playername, formname, formspec)`
2340 * `playername`: name of player to show formspec
2341 * `formname`: name passed to `on_player_receive_fields` callbacks.
2342 It should follow the `"modname:<whatever>"` naming convention
2343 * `formspec`: formspec to display
2344 * `minetest.close_formspec(playername, formname)`
2345 * `playername`: name of player to close formspec
2346 * `formname`: has to exactly match the one given in show_formspec, or the formspec will
2348 * calling show_formspec(playername, formname, "") is equal to this expression
2349 * to close a formspec regardless of the formname, call
2350 minetest.close_formspec(playername, ""). USE THIS ONLY WHEN ABSOLUTELY NECESSARY!
2351 * `minetest.formspec_escape(string)`: returns a string
2352 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
2353 * `minetest.explode_table_event(string)`: returns a table
2354 * returns e.g. `{type="CHG", row=1, column=2}`
2356 * `"INV"`: no row selected)
2357 * `"CHG"`: selected)
2358 * `"DCL"`: double-click
2359 * `minetest.explode_textlist_event(string)`: returns a table
2360 * returns e.g. `{type="CHG", index=1}`
2362 * `"INV"`: no row selected)
2363 * `"CHG"`: selected)
2364 * `"DCL"`: double-click
2365 * `minetest.explode_scrollbar_event(string)`: returns a table
2366 * returns e.g. `{type="CHG", value=500}`
2368 * `"INV"`: something failed
2369 * `"CHG"`: has been changed
2370 * `"VAL"`: not changed
2373 * `minetest.inventorycube(img1, img2, img3)`
2374 * Returns a string for making an image of a cube (useful as an item image)
2375 * `minetest.get_pointed_thing_position(pointed_thing, above)`
2376 * Get position of a `pointed_thing` (that you can get from somewhere)
2377 * `minetest.dir_to_facedir(dir, is6d)`
2378 * Convert a vector to a facedir value, used in `param2` for `paramtype2="facedir"`;
2379 * passing something non-`nil`/`false` for the optional second parameter causes it to
2380 take the y component into account
2381 * `minetest.facedir_to_dir(facedir)`
2382 * Convert a facedir back into a vector aimed directly out the "back" of a node
2383 * `minetest.dir_to_wallmounted(dir)`
2384 * Convert a vector to a wallmounted value, used for `paramtype2="wallmounted"`
2385 * `minetest.wallmounted_to_dir(wallmounted)`
2386 * Convert a wallmounted value back into a vector aimed directly out the "back" of a node
2387 * `minetest.get_node_drops(nodename, toolname)`
2388 * Returns list of item names.
2389 * **Note**: This will be removed or modified in a future version.
2390 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
2391 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2392 * `input.width` = for example `3`
2393 * `input.items` = for example
2394 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2395 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
2396 * `output.time` = a number, if unsuccessful: `0`
2397 * `output.replacements` = list of `ItemStack`s that couldn't be placed in
2398 `decremented_input.items`
2399 * `decremented_input` = like `input`
2400 * `minetest.get_craft_recipe(output)`: returns input
2401 * returns last registered recipe for output item (node)
2402 * `output` is a node or item type such as `"default:torch"`
2403 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2404 * `input.width` = for example `3`
2405 * `input.items` = for example
2406 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2407 * `input.items` = `nil` if no recipe found
2408 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
2409 * returns indexed table with all registered recipes for query item (node)
2410 or `nil` if no recipe was found
2411 * recipe entry table:
2413 method = 'normal' or 'cooking' or 'fuel'
2414 width = 0-3, 0 means shapeless recipe
2415 items = indexed [1-9] table with recipe items
2416 output = string with item name and quantity
2418 * Example query for `"default:gold_ingot"` will return table:
2420 [1]={type = "cooking", width = 3, output = "default:gold_ingot",
2421 items = {1 = "default:gold_lump"}},
2422 [2]={type = "normal", width = 1, output = "default:gold_ingot 9",
2423 items = {1 = "default:goldblock"}}
2425 * `minetest.handle_node_drops(pos, drops, digger)`
2426 * `drops`: list of itemstrings
2427 * Handles drops from nodes after digging: Default action is to put them into
2429 * Can be overridden to get different functionality (e.g. dropping items on
2433 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
2434 returns `{{actor, pos, time, oldnode, newnode}, ...}`
2435 * Find who has done something to a node, or near a node
2436 * `actor`: `"player:<name>"`, also `"liquid"`.
2437 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns `boolean, log_messages`
2438 * Revert latest actions of someone
2439 * `actor`: `"player:<name>"`, also `"liquid"`.
2441 ### Defaults for the `on_*` item definition functions
2442 These functions return the leftover itemstack.
2444 * `minetest.item_place_node(itemstack, placer, pointed_thing, param2)`
2445 * Place item as a node
2446 * `param2` overrides `facedir` and wallmounted `param2`
2447 * returns `itemstack, success`
2448 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
2450 * `minetest.item_place(itemstack, placer, pointed_thing, param2)`
2451 * Use one of the above based on what the item is.
2452 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
2453 * **Note**: is not called when wielded item overrides `on_place`
2454 * `param2` overrides `facedir` and wallmounted `param2`
2455 * returns `itemstack, success`
2456 * `minetest.item_drop(itemstack, dropper, pos)`
2458 * `minetest.item_eat(hp_change, replace_with_item)`
2460 * `replace_with_item` is the itemstring which is added to the inventory.
2461 If the player is eating a stack, then replace_with_item goes to a
2462 different spot. Can be `nil`
2463 * See `minetest.do_item_eat`
2465 ### Defaults for the `on_punch` and `on_dig` node definition callbacks
2466 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
2467 * Calls functions registered by `minetest.register_on_punchnode()`
2468 * `minetest.node_dig(pos, node, digger)`
2469 * Checks if node can be dug, puts item into inventory, removes node
2470 * Calls functions registered by `minetest.registered_on_dignodes()`
2473 * `minetest.sound_play(spec, parameters)`: returns a handle
2474 * `spec` is a `SimpleSoundSpec`
2475 * `parameters` is a sound parameter table
2476 * `minetest.sound_stop(handle)`
2479 * `minetest.after(time, func, ...)`
2480 * Call the function `func` after `time` seconds, may be fractional
2481 * Optional: Variable number of arguments that are passed to `func`
2484 * `minetest.request_shutdown([message],[reconnect])`: request for server shutdown. Will display `message` to clients,
2485 and `reconnect` == true displays a reconnect button.
2486 * `minetest.get_server_status()`: returns server status string
2487 * `minetest.get_server_uptime()`: returns the server uptime in seconds
2490 * `minetest.get_ban_list()`: returns the ban list (same as `minetest.get_ban_description("")`)
2491 * `minetest.get_ban_description(ip_or_name)`: returns ban description (string)
2492 * `minetest.ban_player(name)`: ban a player
2493 * `minetest.unban_player_or_ip(name)`: unban player or IP address
2494 * `minetest.kick_player(name, [reason])`: disconnect a player with a optional reason
2497 * `minetest.add_particle(particle definition)`
2498 * Deprecated: `minetest.add_particle(pos, velocity, acceleration, expirationtime,
2499 size, collisiondetection, texture, playername)`
2501 * `minetest.add_particlespawner(particlespawner definition)`
2502 * Add a `ParticleSpawner`, an object that spawns an amount of particles over `time` seconds
2503 * Returns an `id`, and -1 if adding didn't succeed
2504 * `Deprecated: minetest.add_particlespawner(amount, time,
2508 minexptime, maxexptime,
2510 collisiondetection, texture, playername)`
2512 * `minetest.delete_particlespawner(id, player)``
2513 * Delete `ParticleSpawner` with `id` (return value from `minetest.add_particlespawner`)
2514 * If playername is specified, only deletes on the player's client,
2515 * otherwise on all clients
2518 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
2519 * Create a schematic from the volume of map specified by the box formed by p1 and p2.
2520 * Apply the specified probability values to the specified nodes in `probability_list`.
2521 * `probability_list` is an array of tables containing two fields, `pos` and `prob`.
2522 * `pos` is the 3D vector specifying the absolute coordinates of the
2523 node being modified,
2524 * `prob` is the integer value from `0` to `255` of the probability (see: Schematic specifier).
2525 * If there are two or more entries with the same pos value, the
2527 * If `pos` is not inside the box formed by `p1` and `p2`, it is ignored.
2528 * If `probability_list` equals `nil`, no probabilities are applied.
2529 * Slice probability works in the same manner, except takes a field
2530 called `ypos` instead which
2531 indicates the y position of the slice with a probability applied.
2532 * If slice probability list equals `nil`, no slice probabilities are applied.
2533 * Saves schematic in the Minetest Schematic format to filename.
2535 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement)`
2536 * Place the schematic specified by schematic (see: Schematic specifier) at `pos`.
2537 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
2538 * If the `rotation` parameter is omitted, the schematic is not rotated.
2539 * `replacements` = `{["old_name"] = "convert_to", ...}`
2540 * `force_placement` is a boolean indicating whether nodes other than `air` and
2541 `ignore` are replaced by the schematic
2542 * Returns nil if the schematic could not be loaded.
2544 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement)`:
2545 * This function is analagous to minetest.place_schematic, but places a schematic onto the
2546 specified VoxelManip object `vmanip` instead of the whole map.
2547 * Returns false if any part of the schematic was cut-off due to the VoxelManip not
2548 containing the full area required, and true if the whole schematic was able to fit.
2549 * Returns nil if the schematic could not be loaded.
2550 * After execution, any external copies of the VoxelManip contents are invalidated.
2552 * `minetest.serialize_schematic(schematic, format, options)`
2553 * Return the serialized schematic specified by schematic (see: Schematic specifier)
2554 * in the `format` of either "mts" or "lua".
2555 * "mts" - a string containing the binary MTS data used in the MTS file format
2556 * "lua" - a string containing Lua code representing the schematic in table format
2557 * `options` is a table containing the following optional parameters:
2558 * If `lua_use_comments` is true and `format` is "lua", the Lua code generated will have (X, Z)
2559 * position comments for every X row generated in the schematic data for easier reading.
2560 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua", the Lua code generated
2561 * will use that number of spaces as indentation instead of a tab character.
2564 * `minetest.request_http_api()`:
2565 * returns `HTTPApiTable` containing http functions if the calling mod has been granted
2566 access by being listed in the `secure.http_mods` or `secure.trusted_mods` setting,
2567 otherwise returns `nil`.
2568 * The returned table contains the functions `fetch`, `fetch_async` and `fetch_async_get`
2570 * Only works at init time and must be called from the mod's main scope (not from a function).
2571 * Function only exists if minetest server was built with cURL support.
2572 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
2574 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
2575 * Performs given request asynchronously and calls callback upon completion
2576 * callback: `function(HTTPRequestResult res)`
2577 * Use this HTTP function if you are unsure, the others are for advanced use.
2578 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
2579 * Performs given request asynchronously and returns handle for `HTTPApiTable.fetch_async_get`
2580 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
2581 * Return response data for given asynchronous HTTP request
2584 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
2585 * `minetest.hud_replace_builtin(name, hud_definition)`
2586 * Replaces definition of a builtin hud element
2587 * `name`: `"breath"` or `"health"`
2588 * `hud_definition`: definition to replace builtin definition
2589 * `minetest.hash_node_position({x=,y=,z=})`: returns an 48-bit integer
2590 * Gives a unique hash number for a node position (16+16+16=48bit)
2591 * `minetest.get_position_from_hash(hash)`: returns a position
2592 * Inverse transform of `minetest.hash_node_position`
2593 * `minetest.get_item_group(name, group)`: returns a rating
2594 * Get rating of a group of an item. (`0` means: not in group)
2595 * `minetest.get_node_group(name, group)`: returns a rating
2596 * Deprecated: An alias for the former.
2597 * `minetest.raillike_group(name)`: returns a rating
2598 * Returns rating of the connect_to_raillike group corresponding to name
2599 * If name is not yet the name of a connect_to_raillike group, a new group id
2600 * is created, with that name
2601 * `minetest.get_content_id(name)`: returns an integer
2602 * Gets the internal content ID of `name`
2603 * `minetest.get_name_from_content_id(content_id)`: returns a string
2604 * Gets the name of the content with that content ID
2605 * `minetest.parse_json(string[, nullvalue])`: returns something
2606 * Convert a string containing JSON data into the Lua equivalent
2607 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
2608 * On success returns a table, a string, a number, a boolean or `nullvalue`
2609 * On failure outputs an error message and returns `nil`
2610 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
2611 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
2612 * Convert a Lua table into a JSON string
2613 * styled: Outputs in a human-readable format if this is set, defaults to false
2614 * Unserializable things like functions and userdata are saved as null.
2615 * **Warning**: JSON is more strict than the Lua table format.
2616 1. You can only use strings and positive integers of at least one as keys.
2617 2. You can not mix string and integer keys.
2618 This is due to the fact that JSON has two distinct array and object values.
2619 * Example: `write_json({10, {a = false}})`, returns `"[10, {\"a\": false}]"`
2620 * `minetest.serialize(table)`: returns a string
2621 * Convert a table containing tables, strings, numbers, booleans and `nil`s
2622 into string form readable by `minetest.deserialize`
2623 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
2624 * `minetest.deserialize(string)`: returns a table
2625 * Convert a string returned by `minetest.deserialize` into a table
2626 * `string` is loaded in an empty sandbox environment.
2627 * Will load functions, but they cannot access the global environment.
2628 * Example: `deserialize('return { ["foo"] = "bar" }')`, returns `{foo='bar'}`
2629 * Example: `deserialize('print("foo")')`, returns `nil` (function call fails)
2630 * `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
2631 * `minetest.compress(data, method, ...)`: returns `compressed_data`
2632 * Compress a string of data.
2633 * `method` is a string identifying the compression method to be used.
2634 * Supported compression methods:
2635 * Deflate (zlib): `"deflate"`
2636 * `...` indicates method-specific arguments. Currently defined arguments are:
2637 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
2638 * `minetest.decompress(compressed_data, method, ...)`: returns data
2639 * Decompress a string of data (using ZLib).
2640 * See documentation on `minetest.compress()` for supported compression methods.
2641 * currently supported.
2642 * `...` indicates method-specific arguments. Currently, no methods use this.
2643 * `minetest.encode_base64(string)`: returns string encoded in base64
2644 * Encodes a string in base64.
2645 * `minetest.decode_base64(string)`: returns string
2646 * Decodes a string encoded in base64.
2647 * `minetest.is_protected(pos, name)`: returns boolean
2648 * Returns true, if player `name` shouldn't be abled to dig at `pos` or do other
2649 actions, defineable by mods, due to some mod-defined ownership-like concept.
2650 Returns false or nil, if the player is allowed to do such actions.
2651 * This function should be overridden by protection mods and should be used to
2652 check if a player can interact at a position.
2653 * This function should call the old version of itself if the position is not
2654 protected by the mod.
2657 local old_is_protected = minetest.is_protected
2658 function minetest.is_protected(pos, name)
2659 if mymod:position_protected_from(pos, name) then
2662 return old_is_protected(pos, name)
2664 * `minetest.record_protection_violation(pos, name)`
2665 * This function calls functions registered with
2666 `minetest.register_on_protection_violation`.
2667 * `minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)`
2668 * Attempt to predict the desired orientation of the facedir-capable node
2669 defined by `itemstack`, and place it accordingly (on-wall, on the floor, or
2670 hanging from the ceiling). Stacks are handled normally if the `infinitestacks`
2671 field is false or omitted (else, the itemstack is not changed). `orient_flags`
2672 is an optional table containing extra tweaks to the placement code:
2673 * `invert_wall`: if `true`, place wall-orientation on the ground and ground-
2674 orientation on the wall.
2675 * `force_wall` : if `true`, always place the node in wall orientation.
2676 * `force_ceiling`: if `true`, always place on the ceiling.
2677 * `force_floor`: if `true`, always place the node on the floor.
2678 * `force_facedir`: if `true`, forcefully reset the facedir to north when placing on
2679 the floor or ceiling
2680 * The first four options are mutually-exclusive; the last in the list takes
2681 precedence over the first.
2682 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
2683 * calls `rotate_and_place()` with infinitestacks set according to the state of
2684 the creative mode setting, and checks for "sneak" to set the `invert_wall`
2687 * `minetest.forceload_block(pos[, transient])`
2688 * forceloads the position `pos`.
2689 * returns `true` if area could be forceloaded
2690 * If `transient` is `false` or absent, the forceload will be persistent
2691 (saved between server runs). If `true`, the forceload will be transient
2692 (not saved between server runs).
2694 * `minetest.forceload_free_block(pos[, transient])`
2695 * stops forceloading the position `pos`
2696 * If `transient` is `false` or absent, frees a persistent forceload.
2697 If `true`, frees a transient forceload.
2699 * `minetest.request_insecure_environment()`: returns an environment containing
2700 insecure functions if the calling mod has been listed as trusted in the
2701 `secure.trusted_mods` setting or security is disabled, otherwise returns `nil`.
2702 * Only works at init time and must be called from the mod's main scope (not from a function).
2703 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE IT IN
2706 * `minetest.global_exists(name)`
2707 * Checks if a global variable has been set, without triggering a warning.
2710 * `minetest.env`: `EnvRef` of the server environment and world.
2711 * Any function in the minetest namespace can be called using the syntax
2712 `minetest.env:somefunction(somearguments)`
2713 instead of `minetest.somefunction(somearguments)`
2714 * Deprecated, but support is not to be dropped soon
2717 * `minetest.registered_items`
2718 * Map of registered items, indexed by name
2719 * `minetest.registered_nodes`
2720 * Map of registered node definitions, indexed by name
2721 * `minetest.registered_craftitems`
2722 * Map of registered craft item definitions, indexed by name
2723 * `minetest.registered_tools`
2724 * Map of registered tool definitions, indexed by name
2725 * `minetest.registered_entities`
2726 * Map of registered entity prototypes, indexed by name
2727 * `minetest.object_refs`
2728 * Map of object references, indexed by active object id
2729 * `minetest.luaentities`
2730 * Map of Lua entities, indexed by active object id
2731 * `minetest.registered_ores`
2732 * List of registered ore definitions.
2733 * `minetest.registered_biomes`
2734 * List of registered biome definitions.
2735 * `minetest.registered_decorations`
2736 * List of registered decoration definitions.
2742 Node metadata: reference extra data and functionality stored in a node.
2743 Can be gotten via `minetest.get_meta(pos)`.
2746 * `set_string(name, value)`
2747 * `get_string(name)`
2748 * `set_int(name, value)`
2750 * `set_float(name, value)`
2752 * `get_inventory()`: returns `InvRef`
2753 * `to_table()`: returns `nil` or `{fields = {...}, inventory = {list1 = {}, ...}}`
2754 * `from_table(nil or {})`
2755 * to clear metadata, use from_table(nil)
2756 * See "Node Metadata"
2759 Node Timers: a high resolution persistent per-node timer.
2760 Can be gotten via `minetest.get_node_timer(pos)`.
2763 * `set(timeout,elapsed)`
2764 * set a timer's state
2765 * `timeout` is in seconds, and supports fractional values (0.1 etc)
2766 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
2767 * will trigger the node's `on_timer` function after `timeout`-elapsed seconds
2770 * equivalent to `set(timeout,0)`
2773 * `get_timeout()`: returns current timeout in seconds
2774 * if `timeout` equals `0`, timer is inactive
2775 * `get_elapsed()`: returns current elapsed time in seconds
2776 * the node's `on_timer` function will be called after `timeout`-elapsed seconds
2777 * `is_started()`: returns boolean state of timer
2778 * returns `true` if timer is started, otherwise `false`
2781 Moving things in the game are generally these.
2783 This is basically a reference to a C++ `ServerActiveObject`
2786 * `remove()`: remove object (after returning from Lua)
2787 * Note: Doesn't work on players, use minetest.kick_player instead
2788 * `getpos()`: returns `{x=num, y=num, z=num}`
2789 * `setpos(pos)`; `pos`=`{x=num, y=num, z=num}`
2790 * `moveto(pos, continuous=false)`: interpolated move
2791 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
2792 * `puncher` = another `ObjectRef`,
2793 * `time_from_last_punch` = time since last punch action of the puncher
2794 * `direction`: can be `nil`
2795 * `right_click(clicker)`; `clicker` is another `ObjectRef`
2796 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
2797 * `set_hp(hp)`: set number of hitpoints (2 * number of hearts)
2798 * `get_inventory()`: returns an `InvRef`
2799 * `get_wield_list()`: returns the name of the inventory list the wielded item is in
2800 * `get_wield_index()`: returns the index of the wielded item
2801 * `get_wielded_item()`: returns an `ItemStack`
2802 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if successful
2803 * `set_armor_groups({group1=rating, group2=rating, ...})`
2804 * `get_armor_groups()`: returns a table with the armor group ratings
2805 * `set_animation({x=1,y=1}, frame_speed=15, frame_blend=0, frame_loop=true)`
2806 * `get_animation()`: returns range, frame_speed, frame_blend and frame_loop
2807 * `set_attach(parent, bone, position, rotation)`
2809 * `position`: `{x=num, y=num, z=num}` (relative)
2810 * `rotation`: `{x=num, y=num, z=num}`
2811 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't attached
2813 * `set_bone_position(bone, position, rotation)`
2815 * `position`: `{x=num, y=num, z=num}` (relative)
2816 * `rotation`: `{x=num, y=num, z=num}`
2817 * `get_bone_position(bone)`: returns position and rotation of the bone
2818 * `set_properties(object property table)`
2819 * `get_properties()`: returns object property table
2820 * `is_player()`: returns true for players, false otherwise
2821 * `get_nametag_attributes()`
2822 * returns a table with the attributes of the nametag of an object
2824 color = {a=0..255, r=0..255, g=0..255, b=0..255},
2827 * `set_nametag_attributes(attributes)`
2828 * sets the attributes of the nametag of an object
2832 text = "My Nametag",
2835 ##### LuaEntitySAO-only (no-op for other objects)
2836 * `setvelocity({x=num, y=num, z=num})`
2837 * `getvelocity()`: returns `{x=num, y=num, z=num}`
2838 * `setacceleration({x=num, y=num, z=num})`
2839 * `getacceleration()`: returns `{x=num, y=num, z=num}`
2841 * `getyaw()`: returns number in radians
2842 * `settexturemod(mod)`
2843 * `setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
2844 select_horiz_by_yawpitch=false)`
2845 * Select sprite from spritesheet with optional animation and DM-style
2846 texture selection based on yaw relative to camera
2847 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
2850 ##### Player-only (no-op for other objects)
2851 * `get_player_name()`: returns `""` if is not a player
2852 * `get_player_velocity()`: returns `nil` if is not a player, otherwise a
2853 table {x, y, z} representing the player's instantaneous velocity in nodes/s
2854 * `get_look_dir()`: get camera direction as a unit vector
2855 * `get_look_vertical()`: pitch in radians
2856 * Angle ranges between -pi/2 and pi/2, which are straight up and down respectively.
2857 * `get_look_horizontal()`: yaw in radians
2858 * Angle is counter-clockwise from the +z direction.
2859 * `set_look_vertical(radians)`: sets look pitch
2860 * radians - Angle from looking forward, where positive is downwards.
2861 * `set_look_horizontal(radians)`: sets look yaw
2862 * radians - Angle from the +z direction, where positive is counter-clockwise.
2863 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use get_look_vertical.
2864 * Angle ranges between -pi/2 and pi/2, which are straight down and up respectively.
2865 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use get_look_horizontal.
2866 * Angle is counter-clockwise from the +x direction.
2867 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use set_look_vertical.
2868 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use set_look_horizontal.
2869 * `get_breath()`: returns players breath
2870 * `set_breath(value)`: sets players breath
2872 * `0`: player is drowning,
2873 * `1`-`10`: remaining number of bubbles
2874 * `11`: bubbles bar is not shown
2875 * `set_inventory_formspec(formspec)`
2876 * Redefine player's inventory form
2877 * Should usually be called in on_joinplayer
2878 * `get_inventory_formspec()`: returns a formspec string
2879 * `get_player_control()`: returns table with player pressed keys
2880 * `{jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}`
2881 * `get_player_control_bits()`: returns integer with bit packed player pressed keys
2882 * bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
2883 * `set_physics_override(override_table)`
2884 * `override_table` is a table with the following fields:
2885 * `speed`: multiplier to default walking speed value (default: `1`)
2886 * `jump`: multiplier to default jump value (default: `1`)
2887 * `gravity`: multiplier to default gravity value (default: `1`)
2888 * `sneak`: whether player can sneak (default: `true`)
2889 * `sneak_glitch`: whether player can use the sneak glitch (default: `true`)
2890 * `get_physics_override()`: returns the table given to set_physics_override
2891 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
2893 * `hud_remove(id)`: remove the HUD element of the specified id
2894 * `hud_change(id, stat, value)`: change a value of a previously added HUD element
2895 * element `stat` values: `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
2896 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
2897 * `hud_set_flags(flags)`: sets specified HUD flags to `true`/`false`
2898 * `flags`: (is visible) `hotbar`, `healthbar`, `crosshair`, `wielditem`, `minimap`
2899 * pass a table containing a `true`/`false` value of each flag to be set or unset
2900 * if a flag equals `nil`, the flag is not modified
2901 * note that setting `minimap` modifies the client's permission to view the minimap -
2902 * the client may locally elect to not view the minimap
2903 * `hud_get_flags()`: returns a table containing status of hud flags
2904 * returns `{ hotbar=true, healthbar=true, crosshair=true, wielditem=true, breathbar=true, minimap=true }`
2905 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
2906 * `count`: number of items, must be between `1` and `23`
2907 * `hud_get_hotbar_itemcount`: returns number of visible items
2908 * `hud_set_hotbar_image(texturename)`
2909 * sets background image for hotbar
2910 * `hud_get_hotbar_image`: returns texturename
2911 * `hud_set_hotbar_selected_image(texturename)`
2912 * sets image for selected item of hotbar
2913 * `hud_get_hotbar_selected_image`: returns texturename
2914 * `set_sky(bgcolor, type, {texture names})`
2915 * `bgcolor`: ColorSpec, defaults to white
2917 * `"regular"`: Uses 0 textures, `bgcolor` ignored
2918 * `"skybox"`: Uses 6 textures, `bgcolor` used
2919 * `"plain"`: Uses 0 textures, `bgcolor` used
2920 * `get_sky()`: returns bgcolor, type and a table with the textures
2921 * `override_day_night_ratio(ratio or nil)`
2922 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific amount
2923 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
2924 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
2925 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`
2927 set animation for player model in third person view
2929 set_local_animation({x=0, y=79}, -- < stand/idle animation key frames
2930 {x=168, y=187}, -- < walk animation key frames
2931 {x=189, y=198}, -- < dig animation key frames
2932 {x=200, y=219}, -- < walk+dig animation key frames
2933 frame_speed=30): -- < animation frame speed
2934 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and frame_speed
2935 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for camera per player
2936 * in first person view
2937 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
2938 * `get_eye_offset()`: returns offset_first and offset_third
2941 An `InvRef` is a reference to an inventory.
2944 * `is_empty(listname)`: return `true` if list is empty
2945 * `get_size(listname)`: get size of a list
2946 * `set_size(listname, size)`: set size of a list
2947 * returns `false` on error (e.g. invalid `listname` or `size`)
2948 * `get_width(listname)`: get width of a list
2949 * `set_width(listname, width)`: set width of list; currently used for crafting
2950 * `get_stack(listname, i)`: get a copy of stack index `i` in list
2951 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
2952 * `get_list(listname)`: return full list
2953 * `set_list(listname, list)`: set full list (size will not change)
2954 * `get_lists()`: returns list of inventory lists
2955 * `set_lists(lists)`: sets inventory lists (size will not change)
2956 * `add_item(listname, stack)`: add item somewhere in list, returns leftover `ItemStack`
2957 * `room_for_item(listname, stack):` returns `true` if the stack of items
2958 can be fully added to the list
2959 * `contains_item(listname, stack)`: returns `true` if the stack of items
2960 can be fully taken from the list
2961 * `remove_item(listname, stack)`: take as many items as specified from the list,
2962 returns the items that were actually removed (as an `ItemStack`) -- note that
2963 any item metadata is ignored, so attempting to remove a specific unique
2964 item this way will likely remove the wrong one -- to do that use `set_stack`
2965 with an empty `ItemStack`
2966 * `get_location()`: returns a location compatible to `minetest.get_inventory(location)`
2967 * returns `{type="undefined"}` in case location is not known
2970 A fast access data structure to store areas, and find areas near a given position or area.
2971 Every area has a `data` string attribute to store additional information.
2972 You can create an empty `AreaStore` by calling `AreaStore()`, or `AreaStore(type_name)`.
2973 If you chose the parameter-less constructor, a fast implementation will be automatically
2977 * `get_area(id, include_borders, include_data)`: returns the area with the id `id`.
2978 (optional) Boolean values `include_borders` and `include_data` control what's copied.
2979 Returns nil if specified area id does not exist.
2980 * `get_areas_for_pos(pos, include_borders, include_data)`: returns all areas that contain
2981 the position `pos`. (optional) Boolean values `include_borders` and `include_data` control
2983 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`:
2984 returns all areas that contain all nodes inside the area specified by `edge1` and `edge2` (inclusive).
2985 If `accept_overlap` is true, also areas are returned that have nodes in common with the specified area.
2986 (optional) Boolean values `include_borders` and `include_data` control what's copied.
2987 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store. Returns the new area's ID,
2988 or nil if the insertion failed. The (inclusive) positions `edge1` and `edge2` describe the area.
2989 `data` is a string stored with the area. If passed, `id` will be used as the internal area ID,
2990 it must be a unique number between 0 and 2^32-2. If you use the `id` parameter you must always use it,
2991 or insertions are likely to fail due to conflicts.
2992 * `reserve(count)`: reserves resources for at most `count` many contained areas.
2993 Only needed for efficiency, and only some implementations profit.
2994 * `remove_area(id)`: removes the area with the given id from the store, returns success.
2995 * `set_cache_params(params)`: sets params for the included prefiltering cache.
2996 Calling invalidates the cache, so that its elements have to be newly generated.
2999 enabled = boolean, -- whether to enable, default true
3000 block_radius = number, -- the radius (in nodes) of the areas the cache generates
3001 prefiltered lists for, minimum 16, default 64
3002 limit = number, -- the cache's size, minimum 20, default 1000
3004 * `to_string()`: Experimental. Returns area store serialized as a (binary) string.
3005 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to a file.
3006 * `from_string(str)`: Experimental. Deserializes string and loads it into the AreaStore.
3007 Returns success and, optionally, an error message.
3008 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data from a file.
3011 An `ItemStack` is a stack of items.
3013 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
3014 an itemstring, a table or `nil`.
3017 * `is_empty()`: Returns `true` if stack is empty.
3018 * `get_name()`: Returns item name (e.g. `"default:stone"`).
3019 * `set_name(item_name)`: Returns boolean whether item was cleared
3020 * `get_count()`: Returns number of items on the stack.
3021 * `set_count(count)`: Returns boolean whether item was cleared
3022 * `get_wear()`: Returns tool wear (`0`-`65535`), `0` for non-tools.
3023 * `set_wear(wear)`: Returns boolean whether item was cleared
3024 * `get_metadata()`: Returns metadata (a string attached to an item stack).
3025 * `set_metadata(metadata)`: Returns true.
3026 * `clear()`: removes all items from the stack, making it empty.
3027 * `replace(item)`: replace the contents of this stack.
3028 * `item` can also be an itemstring or table.
3029 * `to_string()`: Returns the stack in itemstring form.
3030 * `to_table()`: Returns the stack in Lua table form.
3031 * `get_stack_max()`: Returns the maximum size of the stack (depends on the item).
3032 * `get_free_space()`: Returns `get_stack_max() - get_count()`.
3033 * `is_known()`: Returns `true` if the item name refers to a defined item type.
3034 * `get_definition()`: Returns the item definition table.
3035 * `get_tool_capabilities()`: Returns the digging properties of the item,
3036 or those of the hand if none are defined for this item type
3037 * `add_wear(amount)`: Increases wear by `amount` if the item is a tool.
3038 * `add_item(item)`: Put some item or stack onto this stack.
3039 Returns leftover `ItemStack`.
3040 * `item_fits(item)`: Returns `true` if item or stack can be fully added to
3042 * `take_item(n=1)`: Take (and remove) up to `n` items from this stack.
3043 Returns taken `ItemStack`.
3044 * `peek_item(n=1)`: copy (don't remove) up to `n` items from this stack.
3045 Returns taken `ItemStack`.
3048 A 16-bit pseudorandom number generator.
3049 Uses a well-known LCG algorithm introduced by K&R.
3051 It can be created via `PseudoRandom(seed)`.
3054 * `next()`: return next integer random number [`0`...`32767`]
3055 * `next(min, max)`: return next integer random number [`min`...`max`]
3056 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
3057 due to the simple implementation making bad distribution otherwise.
3060 A 32-bit pseudorandom number generator.
3061 Uses PCG32, an algorithm of the permuted congruential generator family, offering very strong randomness.
3063 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
3066 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
3067 * `next(min, max)`: return next integer random number [`min`...`max`]
3068 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed random number [`min`...`max`]
3069 * This is only a rough approximation of a normal distribution with:
3070 * mean = (max - min) / 2, and
3071 * variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)
3072 * Increasing num_trials improves accuracy of the approximation
3075 Interface for the operating system's crypto-secure PRNG.
3077 It can be created via `SecureRandom()`. The constructor returns nil if a secure random device cannot be
3078 be found on the system.
3081 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many random bytes, as a string.
3084 A perlin noise generator.
3085 It can be created via `PerlinNoise(seed, octaves, persistence, scale)`
3086 or `PerlinNoise(noiseparams)`.
3087 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
3088 or `minetest.get_perlin(noiseparams)`.
3091 * `get2d(pos)`: returns 2D noise value at `pos={x=,y=}`
3092 * `get3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
3094 ### `PerlinNoiseMap`
3095 A fast, bulk perlin noise generator.
3097 It can be created via `PerlinNoiseMap(noiseparams, size)` or
3098 `minetest.get_perlin_map(noiseparams, size)`.
3100 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` conponent is ommitted
3101 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
3104 For each of the functions with an optional `buffer` parameter: If `buffer` is not
3105 nil, this table will be used to store the result instead of creating a new table.
3109 * `get2dMap(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
3110 with values starting at `pos={x=,y=}`
3111 * `get3dMap(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>` 3D array
3112 of 3D noise with values starting at `pos={x=,y=,z=}`
3113 * `get2dMap_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element array of 2D noise
3114 with values starting at `pos={x=,y=}`
3115 * `get3dMap_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
3116 * `calc2dMap(pos)`: Calculates the 2d noise map starting at `pos`. The result is stored internally.
3117 * `calc3dMap(pos)`: Calculates the 3d noise map starting at `pos`. The result is stored internally.
3118 * `getMapSlice(slice_offset, slice_size, buffer)`: In the form of an array, returns a slice of the
3119 most recently computed noise results. The result slice begins at coordinates `slice_offset` and
3120 takes a chunk of `slice_size`.
3121 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer offset y = 20:
3122 `noisevals = noise:getMapSlice({y=20}, {y=2})`
3123 It is important to note that `slice_offset` offset coordinates begin at 1, and are relative to
3124 the starting position of the most recently calculated noise.
3125 To grab a single vertical column of noise starting at map coordinates x = 1023, y=1000, z = 1000:
3126 `noise:calc3dMap({x=1000, y=1000, z=1000})`
3127 `noisevals = noise:getMapSlice({x=24, z=1}, {x=1, z=1})`
3131 #### About VoxelManip
3132 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator' facility. The purpose of
3133 this object is for fast, low-level, bulk access to reading and writing Map content. As such, setting
3134 map nodes through VoxelManip will lack many of the higher level features and concepts you may be used
3135 to with other methods of setting nodes. For example, nodes will not have their construction and
3136 destruction callbacks run, and no rollback information is logged.
3138 It is important to note that VoxelManip is designed for speed, and *not* ease of use or flexibility.
3139 If your mod requires a map manipulation facility that will handle 100% of all edge cases, or the use
3140 of high level node placement features, perhaps minetest.set_node() is better suited for the job.
3142 In addition, VoxelManip might not be faster, or could even be slower, for your specific use case.
3143 VoxelManip is most effective when setting very large areas of map at once - for example, if only
3144 setting a 5x5x5 node area, a minetest.set_node() loop may be more optimal. Always profile code
3145 using both methods of map manipulation to determine which is most appropriate for your usage.
3147 #### Using VoxelManip
3148 A VoxelManip object can be created any time using either:
3149 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
3151 If the optional position parameters are present for either of these routines, the specified region
3152 will be pre-loaded into the VoxelManip object on creation. Otherwise, the area of map you wish to
3153 manipulate must first be loaded into the VoxelManip object using `VoxelManip:read_from_map()`.
3155 Note that `VoxelManip:read_from_map()` returns two position vectors. The region formed by these
3156 positions indicate the minimum and maximum (respectively) positions of the area actually loaded in
3157 the VoxelManip, which may be larger than the area requested. For convenience, the loaded area
3158 coordinates can also be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
3160 Now that the VoxelManip object is populated with map data, your mod can fetch a copy of this data
3161 using either of two methods. `VoxelManip:get_node_at()`, which retrieves an individual node in a
3162 MapNode formatted table at the position requested is the simplest method to use, but also the slowest.
3164 Nodes in a VoxelManip object may also be read in bulk to a flat array table using:
3165 `VoxelManip:get_data()` for node content (in Content ID form, see section 'Content IDs'),
3166 `VoxelManip:get_light_data()` for node light levels, and
3167 `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
3169 See section 'Flat array format' for more details.
3171 It is very important to understand that the tables returned by any of the above three functions
3172 represent a snapshot of the VoxelManip's internal state at the time of the call. This copy of the
3173 data will *not* magically update itself if another function modifies the internal VoxelManip state.
3174 Any functions that modify a VoxelManip's contents work on the VoxelManip's internal state unless
3175 otherwise explicitly stated.
3177 Once the bulk data has been edited to your liking, the internal VoxelManip state can be set using:
3178 `VoxelManip:set_data()` for node content (in Content ID form, see section 'Content IDs'),
3179 `VoxelManip:set_light_data()` for node light levels, and
3180 `VoxelManip:set_param2_data()` for the node type-dependent "param2" values.
3182 The parameter to each of the above three functions can use any table at all in the same flat array
3183 format as produced by get_data() et al. and is *not required* to be a table retrieved from get_data().
3185 Once the internal VoxelManip state has been modified to your liking, the changes can be committed back
3186 to the map by calling `VoxelManip:write_to_map()`.
3188 Finally, a call to `VoxelManip:update_map()` is required to re-calculate lighting and set the blocks
3189 as being modified so that connected clients are sent the updated parts of map.
3192 ##### Flat array format
3194 `Nx = p2.X - p1.X + 1`,
3195 `Ny = p2.Y - p1.Y + 1`, and
3196 `Nz = p2.Z - p1.Z + 1`.
3198 Then, for a loaded region of p1..p2, this array ranges from `1` up to and including the value of
3199 the expression `Nx * Ny * Nz`.
3201 Positions offset from p1 are present in the array with the format of:
3204 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
3205 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
3207 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
3208 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
3210 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
3212 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
3216 and the array index for a position p contained completely in p1..p2 is:
3218 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
3220 Note that this is the same "flat 3D array" format as `PerlinNoiseMap:get3dMap_flat()`.
3221 VoxelArea objects (see section 'VoxelArea') can be used to simplify calculation of the index
3222 for a single point in a flat VoxelManip array.
3225 A Content ID is a unique integer identifier for a specific node type. These IDs are used by VoxelManip
3226 in place of the node name string for `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
3227 `minetest.get_content_id()` to look up the Content ID for the specified node name, and
3228 `minetest.get_name_from_content_id()` to look up the node name string for a given Content ID.
3229 After registration of a node, its Content ID will remain the same throughout execution of the mod.
3230 Note that the node being queried needs to have already been been registered.
3232 The following builtin node types have their Content IDs defined as constants:
3234 core.CONTENT_UNKNOWN (ID for "unknown" nodes)
3235 core.CONTENT_AIR (ID for "air" nodes)
3236 core.CONTENT_IGNORE (ID for "ignore" nodes)
3239 ##### Mapgen VoxelManip objects
3240 Inside of `on_generated()` callbacks, it is possible to retrieve the same VoxelManip object used by the
3241 core's Map Generator (commonly abbreviated Mapgen). Most of the rules previously described still apply
3242 but with a few differences:
3244 * The Mapgen VoxelManip object is retrieved using: `minetest.get_mapgen_object("voxelmanip")`
3245 * This VoxelManip object already has the region of map just generated loaded into it; it's not necessary
3246 to call `VoxelManip:read_from_map()` before using a Mapgen VoxelManip.
3247 * The `on_generated()` callbacks of some mods may place individual nodes in the generated area using
3248 non-VoxelManip map modification methods. Because the same Mapgen VoxelManip object is passed through
3249 each `on_generated()` callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3250 consistency with the current map state. For this reason, calling any of the following functions:
3251 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3252 will also update the Mapgen VoxelManip object's internal state active on the current thread.
3253 * After modifying the Mapgen VoxelManip object's internal buffer, it may be necessary to update lighting
3254 information using either: `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3255 * `VoxelManip:update_map()` does not need to be called after `write_to_map()`. The map update is performed
3256 automatically after all on_generated callbacks have been run for that generated block.
3258 ##### Other API functions operating on a VoxelManip
3259 If any VoxelManip contents were set to a liquid node, `VoxelManip:update_liquids()` must be called
3260 for these liquid nodes to begin flowing. It is recommended to call this function only after having
3261 written all buffered data back to the VoxelManip object, save for special situations where the modder
3262 desires to only have certain liquid nodes begin flowing.
3264 The functions `minetest.generate_ores()` and `minetest.generate_decorations()` will generate all
3265 registered decorations and ores throughout the full area inside of the specified VoxelManip object.
3267 `minetest.place_schematic_on_vmanip()` is otherwise identical to `minetest.place_schematic()`,
3268 except instead of placing the specified schematic directly on the map at the specified position, it
3269 will place the schematic inside of the VoxelManip.
3272 * Attempting to read data from a VoxelManip object before map is read will result in a zero-length
3273 array table for `VoxelManip:get_data()`, and an "ignore" node at any position for
3274 `VoxelManip:get_node_at()`.
3275 * If either a region of map has not yet been generated or is out-of-bounds of the map, that region is
3276 filled with "ignore" nodes.
3277 * Other mods, or the core itself, could possibly modify the area of map currently loaded into a VoxelManip
3278 object. With the exception of Mapgen VoxelManips (see above section), the internal buffers are not
3279 updated. For this reason, it is strongly encouraged to complete the usage of a particular VoxelManip
3280 object in the same callback it had been created.
3281 * If a VoxelManip object will be used often, such as in an `on_generated()` callback, consider passing
3282 a file-scoped table as the optional parameter to `VoxelManip:get_data()`, which serves as a static
3283 buffer the function can use to write map data to instead of returning a new table each call. This
3284 greatly enhances performance by avoiding unnecessary memory allocations.
3287 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object containing
3288 the region formed by `p1` and `p2`.
3289 * returns actual emerged `pmin`, actual emerged `pmax`
3290 * `write_to_map()`: Writes the data loaded from the `VoxelManip` back to the map.
3291 * **important**: data must be set using `VoxelManip:set_data()` before calling this
3292 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
3293 the `VoxelManip` at that position
3294 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at that position
3295 * `get_data([buffer])`: Retrieves the node content data loaded into the `VoxelManip` object
3296 * returns raw node data in the form of an array of node content IDs
3297 * if the param `buffer` is present, this table will be used to store the result instead
3298 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
3299 * `update_map()`: Update map after writing chunk back to map.
3300 * To be used only by `VoxelManip` objects created by the mod itself;
3301 not a `VoxelManip` that was retrieved from `minetest.get_mapgen_object`
3302 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to a uniform value
3303 * `light` is a table, `{day=<0...15>, night=<0...15>}`
3304 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
3305 * (`p1`, `p2`) is the area in which lighting is set;
3306 defaults to the whole area if left out
3307 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
3308 * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
3309 * Each value is the bitwise combination of day and night light values (`0` to `15` each)
3310 * `light = day + (night * 16)`
3311 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
3313 * expects lighting data in the same format that `get_light_data()` returns
3314 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the `VoxelManip` object
3315 * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
3316 * If the param `buffer` is present, this table will be used to store the result instead
3317 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in the `VoxelManip`
3318 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the `VoxelManip`
3319 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
3320 * (`p1`, `p2`) is the area in which lighting is set; defaults to the whole area
3322 * `propagate_shadow` is an optional boolean deciding whether shadows in a generated
3323 mapchunk above are propagated down into the mapchunk; defaults to `true` if left out
3324 * `update_liquids()`: Update liquid flow
3325 * `was_modified()`: Returns `true` or `false` if the data in the voxel manipulator
3326 had been modified since the last read from map, due to a call to
3327 `minetest.set_data()` on the loaded area elsewhere
3328 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
3331 A helper class for voxel areas.
3332 It can be created via `VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}`.
3333 The coordinates are *inclusive*, like most other things in Minetest.
3336 * `getExtent()`: returns a 3D vector containing the size of the area formed by
3337 `MinEdge` and `MaxEdge`
3338 * `getVolume()`: returns the volume of the area formed by `MinEdge` and `MaxEdge`
3339 * `index(x, y, z)`: returns the index of an absolute position in a flat array starting at `1`
3340 * useful for things like `VoxelManip`, raw Schematic specifiers,
3341 `PerlinNoiseMap:get2d`/`3dMap`, and so on
3342 * `indexp(p)`: same as above, except takes a vector
3343 * `position(i)`: returns the absolute position vector corresponding to index `i`
3344 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by `MinEdge` and `MaxEdge`
3345 * `containsp(p)`: same as above, except takes a vector
3346 * `containsi(i)`: same as above, except takes an index `i`
3347 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns indices
3348 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of `[z [y [x]]]`
3349 * `iterp(minp, maxp)`: same as above, except takes a vector
3352 An interface to read config files in the format of `minetest.conf`.
3354 It can be created via `Settings(filename)`.
3357 * `get(key)`: returns a value
3358 * `get_bool(key)`: returns a boolean
3360 * `remove(key)`: returns a boolean (`true` for success)
3361 * `get_names()`: returns `{key1,...}`
3362 * `write()`: returns a boolean (`true` for success)
3363 * write changes to file
3364 * `to_table()`: returns `{[key1]=value1,...}`
3368 A mapgen object is a construct used in map generation. Mapgen objects can be used
3369 by an `on_generate` callback to speed up operations by avoiding unnecessary
3370 recalculations; these can be retrieved using the `minetest.get_mapgen_object()`
3371 function. If the requested Mapgen object is unavailable, or `get_mapgen_object()`
3372 was called outside of an `on_generate()` callback, `nil` is returned.
3374 The following Mapgen objects are currently available:
3377 This returns three values; the `VoxelManip` object to be used, minimum and maximum
3378 emerged position, in that order. All mapgens support this object.
3381 Returns an array containing the y coordinates of the ground levels of nodes in
3382 the most recently generated chunk by the current mapgen.
3385 Returns an array containing the biome IDs of nodes in the most recently
3386 generated chunk by the current mapgen.
3389 Returns an array containing the temperature values of nodes in the most
3390 recently generated chunk by the current mapgen.
3393 Returns an array containing the humidity values of nodes in the most recently
3394 generated chunk by the current mapgen.
3397 Returns a table mapping requested generation notification types to arrays of
3398 positions at which the corresponding generated structures are located at within
3399 the current chunk. To set the capture of positions of interest to be recorded
3400 on generate, use `minetest.set_gen_notify()`.
3402 Possible fields of the table returned are:
3408 * `large_cave_begin`
3412 Decorations have a key in the format of `"decoration#id"`, where `id` is the
3413 numeric unique decoration ID.
3417 * Functions receive a "luaentity" as `self`:
3418 * It has the member `.name`, which is the registered name `("mod:thing")`
3419 * It has the member `.object`, which is an `ObjectRef` pointing to the object
3420 * The original prototype stuff is visible directly via a metatable
3422 * `on_activate(self, staticdata, dtime_s)`
3423 * Called when the object is instantiated.
3424 * `dtime_s` is the time passed since the object was unloaded, which can
3425 be used for updating the entity state.
3426 * `on_step(self, dtime)`
3427 * Called on every server tick, after movement and collision processing.
3428 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
3430 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)`
3431 * Called when somebody punches the object.
3432 * Note that you probably want to handle most punches using the
3433 automatic armor group system.
3434 * `puncher`: an `ObjectRef` (can be `nil`)
3435 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be `nil`)
3436 * `tool_capabilities`: capability table of used tool (can be `nil`)
3437 * `dir`: unit vector of direction of punch. Always defined. Points from
3438 the puncher to the punched.
3439 * `on_rightclick(self, clicker)`
3440 * `get_staticdata(self)`
3441 * Should return a string that will be passed to `on_activate` when
3442 the object is instantiated the next time.
3447 L-system generation currently creates lighting bugs in the form of mapblock-sized shadows.
3448 Often these bugs appear as subtle shadows in water.
3453 axiom, --string initial tree axiom
3454 rules_a, --string rules set A
3455 rules_b, --string rules set B
3456 rules_c, --string rules set C
3457 rules_d, --string rules set D
3458 trunk, --string trunk node name
3459 leaves, --string leaves node name
3460 leaves2, --string secondary leaves node name
3461 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
3462 angle, --num angle in deg
3463 iterations, --num max # of iterations, usually 2 -5
3464 random_level, --num factor to lower nr of iterations, usually 0 - 3
3465 trunk_type, --string single/double/crossed) type of trunk: 1 node,
3466 -- 2x2 nodes or 3x3 in cross shape
3467 thin_branches, --boolean true -> use thin (1 node) branches
3468 fruit, --string fruit node name
3469 fruit_chance, --num chance (0-100) to replace leaves with fruit node
3470 seed, --num random seed; if no seed is provided, the engine will create one
3473 ### Key for Special L-System Symbols used in Axioms
3475 * `G`: move forward one unit with the pen up
3476 * `F`: move forward one unit with the pen down drawing trunks and branches
3477 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
3478 * `T`: move forward one unit with the pen down drawing trunks only
3479 * `R`: move forward one unit with the pen down placing fruit
3480 * `A`: replace with rules set A
3481 * `B`: replace with rules set B
3482 * `C`: replace with rules set C
3483 * `D`: replace with rules set D
3484 * `a`: replace with rules set A, chance 90%
3485 * `b`: replace with rules set B, chance 80%
3486 * `c`: replace with rules set C, chance 70%
3487 * `d`: replace with rules set D, chance 60%
3488 * `+`: yaw the turtle right by `angle` parameter
3489 * `-`: yaw the turtle left by `angle` parameter
3490 * `&`: pitch the turtle down by `angle` parameter
3491 * `^`: pitch the turtle up by `angle` parameter
3492 * `/`: roll the turtle to the right by `angle` parameter
3493 * `*`: roll the turtle to the left by `angle` parameter
3494 * `[`: save in stack current state info
3495 * `]`: recover from stack state info
3498 Spawn a small apple tree:
3500 pos = {x=230,y=20,z=4}
3503 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
3504 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
3505 trunk="default:tree",
3506 leaves="default:leaves",
3510 trunk_type="single",
3513 fruit="default:apple"
3515 minetest.spawn_tree(pos,apple_tree)
3520 ### Object Properties
3525 collide_with_objects = true, -- collide with other objects if physical=true
3527 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
3528 visual = "cube"/"sprite"/"upright_sprite"/"mesh"/"wielditem",
3529 visual_size = {x=1, y=1},
3531 textures = {}, -- number of required textures depends on visual
3532 colors = {}, -- number of required colors depends on visual
3533 spritediv = {x=1, y=1},
3534 initial_sprite_basepos = {x=0, y=0},
3536 makes_footstep_sound = false,
3537 automatic_rotate = false,
3539 automatic_face_movement_dir = 0.0,
3540 -- ^ automatically set yaw to movement direction; offset in degrees; false to disable
3541 automatic_face_movement_max_rotation_per_sec = -1,
3542 -- ^ limit automatic rotation to this value in degrees per second. values < 0 no limit
3543 backface_culling = true, -- false to disable backface_culling for model
3544 nametag = "", -- by default empty, for players their name is shown if empty
3545 nametag_color = <color>, -- sets color of nametag as ColorSpec
3546 infotext = "", -- by default empty, text to be shown when pointed at object
3549 ### Entity definition (`register_entity`)
3552 -- Deprecated: Everything in object properties is read directly from here
3554 initial_properties = --[[<initial object properties>]],
3556 on_activate = function(self, staticdata, dtime_s),
3557 on_step = function(self, dtime),
3558 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
3559 on_rightclick = function(self, clicker),
3560 get_staticdata = function(self),
3561 -- ^ Called sometimes; the string returned is passed to on_activate when
3562 -- the entity is re-activated from static state
3564 -- Also you can define arbitrary member variables here (see item definition for
3566 _custom_field = whatever,
3569 ### ABM (ActiveBlockModifier) definition (`register_abm`)
3572 label = "Lava cooling",
3573 -- ^ Descriptive label for profiling purposes (optional).
3574 -- Definitions with identical labels will be listed as one.
3575 -- In the following two fields, also group:groupname will work.
3576 nodenames = {"default:lava_source"},
3577 neighbors = {"default:water_source", "default:water_flowing"}, -- Any of these --[[
3578 ^ If left out or empty, any neighbor will do ]]
3579 interval = 1.0, -- Operation interval in seconds
3580 chance = 1, -- Chance of trigger per-node per-interval is 1.0 / this
3581 catch_up = true, -- If true, catch-up behaviour is enabled --[[
3582 ^ The chance value is temporarily reduced when returning to
3583 an area to simulate time lost by the area being unattended.
3584 ^ Note chance value can often be reduced to 1 ]]
3585 action = func(pos, node, active_object_count, active_object_count_wider),
3588 ### LBM (LoadingBlockModifier) definition (`register_lbm`)
3591 label = "Upgrade legacy doors",
3592 -- ^ Descriptive label for profiling purposes (optional).
3593 -- Definitions with identical labels will be listed as one.
3594 name = "modname:replace_legacy_door",
3595 nodenames = {"default:lava_source"},
3596 -- ^ List of node names to trigger the LBM on.
3597 -- Also non-registered nodes will work.
3598 -- Groups (as of group:groupname) will work as well.
3599 run_at_every_load = false,
3600 -- ^ Whether to run the LBM's action every time a block gets loaded,
3601 -- and not just for blocks that were saved last time before LBMs were
3602 -- introduced to the world.
3603 action = func(pos, node),
3606 ### Item definition (`register_node`, `register_craftitem`, `register_tool`)
3609 description = "Steel Axe",
3610 groups = {}, -- key = name, value = rating; rating = 1..3.
3611 if rating not applicable, use 1.
3612 e.g. {wool = 1, fluffy = 3}
3613 {soil = 2, outerspace = 1, crumbly = 1}
3614 {bendy = 2, snappy = 1},
3615 {hard = 1, metal = 1, spikes = 1}
3616 inventory_image = "default_tool_steelaxe.png",
3618 wield_scale = {x = 1, y = 1, z = 1},
3621 liquids_pointable = false,
3622 tool_capabilities = {
3623 full_punch_interval = 1.0,
3627 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00}, uses = 20, maxlevel = 2},
3629 damage_groups = {groupname = damage},
3631 node_placement_prediction = nil,
3633 ^ If nil and item is node, prediction is made automatically
3634 ^ If nil and item is not a node, no prediction is made
3635 ^ If "" and item is anything, no prediction is made
3636 ^ Otherwise should be name of node which the client immediately places
3637 on ground when the player places the item. Server will always update
3638 actual result to client in a short moment.
3641 breaks = "default_tool_break", -- tools only
3642 place = --[[<SimpleSoundSpec>]],
3645 on_place = func(itemstack, placer, pointed_thing),
3647 ^ Shall place item and return the leftover itemstack
3648 ^ The placer may be any ObjectRef or nil.
3649 ^ default: minetest.item_place ]]
3650 on_secondary_use = func(itemstack, user, pointed_thing),
3652 ^ Same as on_place but called when pointing at nothing.
3653 ^ The user may be any ObjectRef or nil.
3654 ^ pointed_thing : always { type = "nothing" }
3656 on_drop = func(itemstack, dropper, pos),
3658 ^ Shall drop item and return the leftover itemstack
3659 ^ The dropper may be any ObjectRef or nil.
3660 ^ default: minetest.item_drop ]]
3661 on_use = func(itemstack, user, pointed_thing),
3664 ^ Function must return either nil if no item shall be removed from
3665 inventory, or an itemstack to replace the original itemstack.
3666 e.g. itemstack:take_item(); return itemstack
3667 ^ Otherwise, the function is free to do what it wants.
3668 ^ The user may be any ObjectRef or nil.
3669 ^ The default functions handle regular use cases.
3671 after_use = func(itemstack, user, node, digparams),
3674 ^ If defined, should return an itemstack and will be called instead of
3675 wearing out the tool. If returns nil, does nothing.
3676 If after_use doesn't exist, it is the same as:
3677 function(itemstack, user, node, digparams)
3678 itemstack:add_wear(digparams.wear)
3681 ^ The user may be any ObjectRef or nil.
3683 _custom_field = whatever,
3685 ^ Add your own custom fields. By convention, all custom field names
3686 should start with `_` to avoid naming collisions with future engine
3693 * `{name="image.png", animation={Tile Animation definition}}`
3694 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
3695 tileable_horizontal=bool}`
3696 * backface culling enabled by default for most nodes
3697 * tileable flags are info for shaders, how they should treat texture
3698 when displacement mapping is used
3699 Directions are from the point of view of the tile texture,
3700 not the node it's on
3701 * deprecated, yet still supported field names:
3704 ### Tile animation definition
3707 type = "vertical_frames",
3709 -- ^ specify width of a frame in pixels
3711 -- ^ specify height of a frame in pixels
3713 -- ^ specify full loop length
3719 -- ^ specify width in number of frames
3721 -- ^ specify height in number of frames
3723 -- ^ specify length of a single frame
3726 ### Node definition (`register_node`)
3729 -- <all fields allowed in item definitions>,
3731 drawtype = "normal", -- See "Node drawtypes"
3732 visual_scale = 1.0, --[[
3733 ^ Supported for drawtypes "plantlike", "signlike", "torchlike", "mesh".
3734 ^ For plantlike, the image will start at the bottom of the node; for the
3735 ^ other drawtypes, the image will be centered on the node.
3736 ^ Note that positioning for "torchlike" may still change. ]]
3737 tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
3738 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
3739 ^ List can be shortened to needed length ]]
3740 special_tiles = {tile definition 1, Tile definition 2}, --[[
3741 ^ Special textures of node; used rarely (old field name: special_materials)
3742 ^ List can be shortened to needed length ]]
3744 use_texture_alpha = false, -- Use texture's alpha channel
3745 post_effect_color = "green#0F", -- If player is inside node, see "ColorSpec"
3746 paramtype = "none", -- See "Nodes" --[[
3747 ^ paramtype = "light" allows light to propagate from or through the node with light value
3748 ^ falling by 1 per node. This line is essential for a light source node to spread its light. ]]
3749 paramtype2 = "none", -- See "Nodes"
3750 place_param2 = nil, -- Force value for param2 when player places node
3751 is_ground_content = true, -- If false, the cave generator will not carve through this
3752 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
3753 walkable = true, -- If true, objects collide with node
3754 pointable = true, -- If true, can be pointed at
3755 diggable = true, -- If false, can never be dug
3756 climbable = false, -- If true, can be climbed on (ladder)
3757 buildable_to = false, -- If true, placed nodes can replace this node
3758 floodable = false, -- If true, liquids flow into and replace this node
3759 liquidtype = "none", -- "none"/"source"/"flowing"
3760 liquid_alternative_flowing = "", -- Flowing version of source liquid
3761 liquid_alternative_source = "", -- Source version of flowing liquid
3762 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
3763 liquid_renewable = true, --[[
3764 ^ If true, a new liquid source can be created by placing two or more sources nearby ]]
3766 ^ Block contains level in param2. Value is default level, used for snow.
3767 ^ Don't forget to use "leveled" type nodebox. ]]
3768 liquid_range = 8, -- number of flowing nodes around source (max. 8)
3769 drowning = 0, -- Player will take this amount of damage if no bubbles are left
3770 light_source = 0, --[[
3771 ^ Amount of light emitted by node.
3772 ^ To set the maximum (currently 14), use the value 'minetest.LIGHT_MAX'.
3773 ^ A value outside the range 0 to minetest.LIGHT_MAX causes undefined behavior.]]
3774 damage_per_second = 0, -- If player is inside node, this damage is caused
3775 node_box = {type="regular"}, -- See "Node boxes"
3776 connects_to = nodenames, --[[
3777 * Used for nodebox nodes with the type == "connected"
3778 * Specifies to what neighboring nodes connections will be drawn
3779 * e.g. `{"group:fence", "default:wood"}` or `"default:stone"` ]]
3780 connect_sides = { "top", "bottom", "front", "left", "back", "right" }, --[[
3781 ^ Tells connected nodebox nodes to connect only to these sides of this node. ]]
3783 selection_box = {type="regular"}, -- See "Node boxes" --[[
3784 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used. ]]
3785 legacy_facedir_simple = false, -- Support maps made in and before January 2012
3786 legacy_wallmounted = false, -- Support maps made in and before January 2012
3788 footstep = <SimpleSoundSpec>,
3789 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
3790 dug = <SimpleSoundSpec>,
3791 place = <SimpleSoundSpec>,
3792 place_failed = <SimpleSoundSpec>,
3794 drop = "", -- Name of dropped node when dug. Default is the node itself.
3797 max_items = 1, -- Maximum number of items to drop.
3798 items = { -- Choose max_items randomly from this list.
3800 items = {"foo:bar", "baz:frob"}, -- Items to drop.
3801 rarity = 1, -- Probability of dropping is 1 / rarity.
3806 on_construct = func(pos), --[[
3807 ^ Node constructor; called after adding node
3808 ^ Can set up metadata and stuff like that
3809 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3811 on_destruct = func(pos), --[[
3812 ^ Node destructor; called before removing node
3813 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3815 after_destruct = func(pos, oldnode), --[[
3816 ^ Node destructor; called after removing node
3817 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3820 after_place_node = func(pos, placer, itemstack, pointed_thing) --[[
3821 ^ Called after constructing node when node was placed using
3822 minetest.item_place_node / minetest.place_node
3823 ^ If return true no item is taken from itemstack
3825 after_dig_node = func(pos, oldnode, oldmetadata, digger), --[[
3826 ^ oldmetadata is in table format
3827 ^ Called after destructing node when node was dug using
3828 minetest.node_dig / minetest.dig_node
3830 can_dig = function(pos, [player]) --[[
3831 ^ returns true if node can be dug, or false if not
3834 on_punch = func(pos, node, puncher, pointed_thing), --[[
3835 ^ default: minetest.node_punch
3836 ^ By default: Calls minetest.register_on_punchnode callbacks ]]
3837 on_rightclick = func(pos, node, clicker, itemstack, pointed_thing), --[[
3839 ^ if defined, itemstack will hold clicker's wielded item
3840 ^ Shall return the leftover itemstack
3841 ^ Note: pointed_thing can be nil, if a mod calls this function ]]
3843 on_dig = func(pos, node, digger), --[[
3844 ^ default: minetest.node_dig
3845 ^ By default: checks privileges, wears out tool and removes node ]]
3847 on_timer = function(pos,elapsed), --[[
3849 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
3850 ^ elapsed is the total time passed since the timer was started
3851 ^ return true to run the timer for another cycle with the same timeout value ]]
3853 on_receive_fields = func(pos, formname, fields, sender), --[[
3854 ^ fields = {name1 = value1, name2 = value2, ...}
3855 ^ Called when an UI form (e.g. sign text input) returns data
3858 allow_metadata_inventory_move = func(pos, from_list, from_index,
3859 to_list, to_index, count, player), --[[
3860 ^ Called when a player wants to move items inside the inventory
3861 ^ Return value: number of items allowed to move ]]
3863 allow_metadata_inventory_put = func(pos, listname, index, stack, player), --[[
3864 ^ Called when a player wants to put something into the inventory
3865 ^ Return value: number of items allowed to put
3866 ^ Return value: -1: Allow and don't modify item count in inventory ]]
3868 allow_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
3869 ^ Called when a player wants to take something out of the inventory
3870 ^ Return value: number of items allowed to take
3871 ^ Return value: -1: Allow and don't modify item count in inventory ]]
3873 on_metadata_inventory_move = func(pos, from_list, from_index,
3874 to_list, to_index, count, player),
3875 on_metadata_inventory_put = func(pos, listname, index, stack, player),
3876 on_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
3877 ^ Called after the actual action has happened, according to what was allowed.
3878 ^ No return value ]]
3880 on_blast = func(pos, intensity), --[[
3881 ^ intensity: 1.0 = mid range of regular TNT
3882 ^ If defined, called when an explosion touches the node, instead of
3883 removing the node ]]
3886 ### Recipe for `register_craft` (shaped)
3889 output = 'default:pick_stone',
3891 {'default:cobble', 'default:cobble', 'default:cobble'},
3892 {'', 'default:stick', ''},
3893 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
3895 replacements = --[[<optional list of item pairs,
3896 replace one input item with another item on crafting>]]
3899 ### Recipe for `register_craft` (shapeless)
3903 output = 'mushrooms:mushroom_stew',
3906 "mushrooms:mushroom_brown",
3907 "mushrooms:mushroom_red",
3909 replacements = --[[<optional list of item pairs,
3910 replace one input item with another item on crafting>]]
3913 ### Recipe for `register_craft` (tool repair)
3916 type = "toolrepair",
3917 additional_wear = -0.02,
3920 ### Recipe for `register_craft` (cooking)
3924 output = "default:glass",
3925 recipe = "default:sand",
3929 ### Recipe for `register_craft` (furnace fuel)
3933 recipe = "default:leaves",
3937 ### Ore definition (`register_ore`)
3940 ore_type = "scatter", -- See "Ore types"
3941 ore = "default:stone_with_coal",
3942 wherein = "default:stone",
3943 -- ^ a list of nodenames is supported too
3944 clust_scarcity = 8*8*8,
3945 -- ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
3946 -- ^ This value should be *MUCH* higher than your intuition might tell you!
3948 -- ^ Number of ores in a cluster
3950 -- ^ Size of the bounding box of the cluster
3951 -- ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
3955 -- ^ Attributes for this ore generation
3956 noise_threshold = 0.5,
3957 -- ^ If noise is above this threshold, ore is placed. Not needed for a uniform distribution
3958 noise_params = {offset=0, scale=1, spread={x=100, y=100, z=100}, seed=23, octaves=3, persist=0.70}
3959 -- ^ NoiseParams structure describing the perlin noise used for ore distribution.
3960 -- ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
3961 random_factor = 1.0,
3962 -- ^ Multiplier of the randomness contribution to the noise value at any
3963 -- given point to decide if ore should be placed. Set to 0 for solid veins.
3964 -- ^ This parameter is only valid for ore_type == "vein".
3965 biomes = {"desert", "rainforest"}
3966 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
3967 -- ^ and ignored if the Mapgen being used does not support biomes.
3968 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
3971 ### Biome definition (`register_biome`)
3974 The Biome API is still in an experimental phase and subject to change.
3978 node_dust = "default:snow",
3979 -- ^ Node dropped onto upper surface after all else is generated.
3980 node_top = "default:dirt_with_snow",
3982 -- ^ Node forming surface layer of biome and thickness of this layer.
3983 node_filler = "default:permafrost",
3985 -- ^ Node forming lower layer of biome and thickness of this layer.
3986 node_stone = "default:bluestone",
3987 -- ^ Node that replaces all stone nodes between roughly y_min and y_max.
3988 node_water_top = "default:ice",
3989 depth_water_top = 10,
3990 -- ^ Node forming a surface layer in seawater with the defined thickness.
3992 -- ^ Node that replaces all seawater nodes not in the defined surface layer.
3993 node_river_water = "default:ice",
3994 -- ^ Node that replaces river water in mapgens that use default:river_water.
3995 node_riverbed = "default:gravel",
3997 -- ^ Node placed under river water and thickness of this layer.
4000 -- ^ Lower and upper limits for biome.
4001 -- ^ Because biome is not recalculated for every node in a node column
4002 -- ^ some biome materials can exceed their limits, especially stone.
4003 -- ^ For each node column in a mapchunk, biome is only recalculated at column
4004 -- ^ top and at each of these surfaces:
4005 -- ^ Ground below air, water below air, ground below water.
4006 -- ^ The selected biome then stays in effect for all nodes below until
4007 -- ^ column base or the next biome recalculation.
4009 humidity_point = 50,
4010 -- ^ Characteristic average temperature and humidity for the biome.
4011 -- ^ These values create 'biome points' on a voronoi diagram that has heat
4012 -- ^ and humidity as axes. The resulting voronoi cells determine which
4013 -- ^ heat/humidity points belong to which biome, and therefore determine
4014 -- ^ the area and location of each biome in the world.
4015 -- ^ The biome points need to be carefully and evenly spaced on the voronoi
4016 -- ^ diagram to result in roughly equal size biomes.
4017 -- ^ Heat and humidity have average values of 50, vary mostly between
4018 -- ^ 0 and 100 but also often exceed these values.
4019 -- ^ Heat is not in degrees celcius, both values are abstract.
4022 ### Decoration definition (`register_decoration`)
4025 deco_type = "simple", -- See "Decoration types"
4026 place_on = "default:dirt_with_grass",
4027 -- ^ Node (or list of nodes) that the decoration can be placed on
4029 -- ^ Size of divisions made in the chunk being generated.
4030 -- ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
4032 -- ^ Ratio of the area to be uniformly filled by the decoration.
4033 -- ^ Used only if noise_params is not specified.
4034 noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
4035 -- ^ NoiseParams structure describing the perlin noise used for decoration distribution.
4036 -- ^ The result of this is multiplied by the 2d area of the division being decorated.
4037 biomes = {"Oceanside", "Hills", "Plains"},
4038 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
4039 -- ^ and ignored if the Mapgen being used does not support biomes.
4040 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
4043 -- ^ Minimum and maximum `y` positions these decorations can be generated at.
4044 -- ^ This parameter refers to the `y` position of the decoration base, so
4045 -- the actual maximum height would be `height_max + size.Y`.
4046 spawn_by = "default:water",
4047 -- ^ Node (or list of nodes) that the decoration only spawns next to.
4048 -- ^ Checks two horizontal planes of neighbouring nodes (including diagonal neighbours),
4049 -- ^ one plane at Y = surface and one plane at Y = surface = + 1.
4051 -- ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
4052 -- ^ If absent or -1, decorations occur next to any nodes.
4053 flags = "liquid_surface, force_placement",
4054 -- ^ Flags for all decoration types.
4055 -- ^ "liquid_surface": Instead of placement on the highest solid surface
4056 -- ^ in a mapchunk column, placement is on the highest liquid surface.
4057 -- ^ Placement is disabled if solid nodes are found above the liquid surface.
4058 -- ^ "force_placement": Nodes other than "air" and "ignore" are replaced by the decoration.
4060 ----- Simple-type parameters
4061 decoration = "default:grass",
4062 -- ^ The node name used as the decoration.
4063 -- ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
4065 -- ^ Number of nodes high the decoration is made.
4066 -- ^ If height_max is not 0, this is the lower bound of the randomly selected height.
4068 -- ^ Number of nodes the decoration can be at maximum.
4069 -- ^ If absent, the parameter 'height' is used as a constant.
4071 -- ^ Param2 value of placed decoration node.
4073 ----- Schematic-type parameters
4074 schematic = "foobar.mts",
4075 -- ^ If schematic is a string, it is the filepath relative to the current working directory of the
4076 -- ^ specified Minetest schematic file.
4077 -- ^ - OR -, could be the ID of a previously registered schematic
4078 -- ^ - OR -, could instead be a table containing two mandatory fields, size and data,
4079 -- ^ and an optional table yslice_prob:
4081 size = {x=4, y=6, z=4},
4083 {name="default:cobble", param1=255, param2=0},
4084 {name="default:dirt_with_grass", param1=255, param2=0},
4085 {name="ignore", param1=255, param2=0},
4086 {name="air", param1=255, param2=0},
4095 -- ^ See 'Schematic specifier' for details.
4096 replacements = {["oldname"] = "convert_to", ...},
4097 flags = "place_center_x, place_center_y, place_center_z",
4098 -- ^ Flags for schematic decorations. See 'Schematic attributes'.
4099 rotation = "90" -- rotate schematic 90 degrees on placement
4100 -- ^ Rotation can be "0", "90", "180", "270", or "random".
4103 ### Chat command definition (`register_chatcommand`)
4106 params = "<name> <privilege>", -- Short parameter description
4107 description = "Remove privilege from player", -- Full description
4108 privs = {privs=true}, -- Require the "privs" privilege to run
4109 func = function(name, param), -- Called when command is run.
4110 -- Returns boolean success and text output.
4113 ### Detached inventory callbacks
4116 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
4117 -- ^ Called when a player wants to move items inside the inventory
4118 -- ^ Return value: number of items allowed to move
4120 allow_put = func(inv, listname, index, stack, player),
4121 -- ^ Called when a player wants to put something into the inventory
4122 -- ^ Return value: number of items allowed to put
4123 -- ^ Return value: -1: Allow and don't modify item count in inventory
4125 allow_take = func(inv, listname, index, stack, player),
4126 -- ^ Called when a player wants to take something out of the inventory
4127 -- ^ Return value: number of items allowed to take
4128 -- ^ Return value: -1: Allow and don't modify item count in inventory
4130 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
4131 on_put = func(inv, listname, index, stack, player),
4132 on_take = func(inv, listname, index, stack, player),
4133 -- ^ Called after the actual action has happened, according to what was allowed.
4134 -- ^ No return value
4137 ### HUD Definition (`hud_add`, `hud_get`)
4140 hud_elem_type = "image", -- see HUD element types
4141 -- ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
4142 position = {x=0.5, y=0.5},
4143 -- ^ Left corner position of element
4149 -- ^ Selected item in inventory. 0 for no item selected.
4151 -- ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
4152 alignment = {x=0, y=0},
4153 -- ^ See "HUD Element Types"
4154 offset = {x=0, y=0},
4155 -- ^ See "HUD Element Types"
4156 size = { x=100, y=100 },
4157 -- ^ Size of element in pixels
4160 ### Particle definition (`add_particle`)
4163 pos = {x=0, y=0, z=0},
4164 velocity = {x=0, y=0, z=0},
4165 acceleration = {x=0, y=0, z=0},
4166 -- ^ Spawn particle at pos with velocity and acceleration
4168 -- ^ Disappears after expirationtime seconds
4170 collisiondetection = false,
4171 -- ^ collisiondetection: if true collides with physical objects
4172 collision_removal = false,
4173 -- ^ collision_removal: if true then particle is removed when it collides,
4174 -- ^ requires collisiondetection = true to have any effect
4176 -- ^ vertical: if true faces player using y axis only
4177 texture = "image.png",
4178 -- ^ Uses texture (string)
4179 playername = "singleplayer"
4180 -- ^ optional, if specified spawns particle only on the player's client
4183 ### `ParticleSpawner` definition (`add_particlespawner`)
4188 -- ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
4189 minpos = {x=0, y=0, z=0},
4190 maxpos = {x=0, y=0, z=0},
4191 minvel = {x=0, y=0, z=0},
4192 maxvel = {x=0, y=0, z=0},
4193 minacc = {x=0, y=0, z=0},
4194 maxacc = {x=0, y=0, z=0},
4199 -- ^ The particle's properties are random values in between the bounds:
4200 -- ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
4201 -- ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
4202 collisiondetection = false,
4203 -- ^ collisiondetection: if true uses collision detection
4204 collision_removal = false,
4205 -- ^ collision_removal: if true then particle is removed when it collides,
4206 -- ^ requires collisiondetection = true to have any effect
4207 attached = ObjectRef,
4208 -- ^ attached: if defined, particle positions, velocities and accelerations
4209 -- ^ are relative to this object's position and yaw.
4211 -- ^ vertical: if true faces player using y axis only
4212 texture = "image.png",
4213 -- ^ Uses texture (string)
4214 playername = "singleplayer"
4215 -- ^ Playername is optional, if specified spawns particle only on the player's client
4218 ### `HTTPRequest` definition (`HTTPApiTable.fetch_async`, `HTTPApiTable.fetch_async`)
4221 url = "http://example.org",
4223 -- ^ Timeout for connection in seconds. Default is 3 seconds.
4224 post_data = "Raw POST request data string" OR { field1 = "data1", field2 = "data2" },
4225 -- ^ Optional, if specified a POST request with post_data is performed.
4226 -- ^ Accepts both a string and a table. If a table is specified, encodes table
4227 -- ^ as x-www-form-urlencoded key-value pairs.
4228 -- ^ If post_data ist not specified, a GET request is performed instead.
4229 user_agent = "ExampleUserAgent",
4230 -- ^ Optional, if specified replaces the default minetest user agent with given string
4231 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
4232 -- ^ Optional, if specified adds additional headers to the HTTP request. You must make sure
4233 -- ^ that the header strings follow HTTP specification ("Key: Value").
4235 -- ^ Optional, if true performs a multipart HTTP request. Default is false.
4238 ### `HTTPRequestResult` definition (`HTTPApiTable.fetch` callback, `HTTPApiTable.fetch_async_get`)
4242 -- ^ If true, the request has finished (either succeeded, failed or timed out)
4244 -- ^ If true, the request was succesful
4246 -- ^ If true, the request timed out
4248 -- ^ HTTP status code