1 Minetest Lua Modding API Reference 0.4.13
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 in the "Games" category in the settings tab.
72 Games can provide custom main menu images. They are put inside a `menu` directory inside the game directory.
74 The images are named `$identifier.png`, where `$identifier` is one of `overlay,background,footer,header`.
75 If you want to specify multiple images for one identifier, add additional images named like `$identifier.$n.png`, with an ascending number $n starting with 1,
76 and a random image will be chosen from the provided ones.
83 * `$path_share/games/gameid/mods/`
85 * `$path_user/games/gameid/mods/`
86 * `$path_user/mods/` (User-installed mods)
87 * `$worldpath/worldmods/`
89 In a run-in-place version (e.g. the distributed windows version):
91 * `minetest-0.4.x/games/gameid/mods/`
92 * `minetest-0.4.x/mods/` (User-installed mods)
93 * `minetest-0.4.x/worlds/worldname/worldmods/`
95 On an installed version on Linux:
97 * `/usr/share/minetest/games/gameid/mods/`
98 * `$HOME/.minetest/mods/` (User-installed mods)
99 * `$HOME/.minetest/worlds/worldname/worldmods`
101 Mod load path for world-specific games
102 --------------------------------------
103 It is possible to include a game in a world; in this case, no mods or
104 games are loaded or checked from anywhere else.
106 This is useful for e.g. adventure worlds.
108 This happens if the following directory exists:
112 Mods should be then be placed in:
118 Mods can be put in a subdirectory, if the parent directory, which otherwise
119 should be a mod, contains a file named `modpack.txt`. This file shall be
120 empty, except for lines starting with `#`, which are comments.
122 Mod directory structure
123 ------------------------
129 | |-- description.txt
130 | |-- settingtypes.txt
134 | | |-- modname_stuff.png
135 | | `-- modname_something_else.png
143 The location of this directory can be fetched by using
144 `minetest.get_modpath(modname)`.
147 List of mods that have to be loaded before loading this mod.
149 A single line contains a single modname.
151 Optional dependencies can be defined by appending a question mark
152 to a single modname. Their meaning is that if the specified mod
153 is missing, that does not prevent this mod from being loaded.
156 A screenshot shown in modmanager within mainmenu.
158 ### `description.txt`
159 A File containing description to be shown within mainmenu.
161 ### `settingtypes.txt`
162 A file in the same format as the one in builtin. It will be parsed by the
163 settings menu and the settings will be displayed in the "Mods" category.
166 The main Lua script. Running this script should register everything it
167 wants to register. Subsequent execution depends on minetest calling the
168 registered callbacks.
170 `minetest.setting_get(name)` and `minetest.setting_getbool(name)` can be used
171 to read custom or existing settings at load time, if necessary.
174 Models for entities or meshnodes.
176 ### `textures`, `sounds`, `media`
177 Media files (textures, sounds, whatever) that will be transferred to the
178 client and will be available for use by the mod.
180 Naming convention for registered textual names
181 ----------------------------------------------
182 Registered names should generally be in this format:
184 "modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
186 This is to prevent conflicting names from corrupting maps and is
187 enforced by the mod loader.
190 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
191 So the name should be `experimental:tnt`.
193 Enforcement can be overridden by prefixing the name with `:`. This can
194 be used for overriding the registrations of some other mod.
196 Example: Any mod can redefine `experimental:tnt` by using the name
201 (also that mod is required to have `experimental` as a dependency)
203 The `:` prefix can also be used for maintaining backwards compatibility.
206 Aliases can be added by using `minetest.register_alias(name, convert_to)`.
208 This will make Minetest to convert things called name to things called
211 This can be used for maintaining backwards compatibility.
213 This can be also used for setting quick access names for things, e.g. if
214 you have an item called `epiclylongmodname:stuff`, you could do
216 minetest.register_alias("stuff", "epiclylongmodname:stuff")
218 and be able to use `/giveme stuff`.
222 Mods should generally prefix their textures with `modname_`, e.g. given
223 the mod name `foomod`, a texture could be called:
227 Textures are referred to by their complete name, or alternatively by
228 stripping out the file extension:
230 * e.g. `foomod_foothing.png`
231 * e.g. `foomod_foothing`
235 There are various texture modifiers that can be used
236 to generate textures on-the-fly.
238 ### Texture overlaying
239 Textures can be overlaid by putting a `^` between them.
243 default_dirt.png^default_grass_side.png
245 `default_grass_side.png` is overlayed over `default_dirt.png`.
248 Textures can be grouped together by enclosing them in `(` and `)`.
250 Example: `cobble.png^(thing1.png^thing2.png)`
252 A texture for `thing1.png^thing2.png` is created and the resulting
253 texture is overlaid over `cobble.png`.
255 ### Advanced texture modifiers
257 #### `[crack:<n>:<p>`
258 * `<n>` = animation frame count
259 * `<p>` = current animation frame
261 Draw a step of the crack animation on the texture.
265 default_cobble.png^[crack:10:1
267 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
272 * `<file>` = texture to combine
274 Creates a texture of size `<w>` times `<h>` and blits the listed files to their
275 specified coordinates.
279 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
282 Brightens the texture.
286 tnt_tnt_side.png^[brighten
289 Makes the texture completely opaque.
293 default_leaves.png^[noalpha
295 #### `[makealpha:<r>,<g>,<b>`
296 Convert one color to transparency.
300 default_cobble.png^[makealpha:128,128,128
303 * `<t>` = transformation(s) to apply
305 Rotates and/or flips the image.
307 `<t>` can be a number (between 0 and 7) or a transform name.
308 Rotations are counter-clockwise.
311 1 R90 rotate by 90 degrees
312 2 R180 rotate by 180 degrees
313 3 R270 rotate by 270 degrees
315 5 FXR90 flip X then rotate by 90 degrees
317 7 FYR90 flip Y then rotate by 90 degrees
321 default_stone.png^[transformFXR90
323 #### `[inventorycube{<top>{<left>{<right>`
324 `^` is replaced by `&` in texture names.
326 Create an inventory cube texture using the side textures.
330 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
332 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
333 `dirt.png^grass_side.png` textures
335 #### `[lowpart:<percent>:<file>`
336 Blit the lower `<percent>`% part of `<file>` on the texture.
340 base.png^[lowpart:25:overlay.png
342 #### `[verticalframe:<t>:<n>`
343 * `<t>` = animation frame count
344 * `<n>` = current animation frame
346 Crops the texture to a frame of a vertical animation.
350 default_torch_animated.png^[verticalframe:16:8
353 Apply a mask to the base image.
355 The mask is applied using binary AND.
357 #### `[colorize:<color>:<ratio>`
358 Colorize the textures with the given color.
359 `<color>` is specified as a `ColorString`.
360 `<ratio>` is an int ranging from 0 to 255, and specifies how much of the
361 color to apply. If ommitted, the alpha will be used.
365 Only Ogg Vorbis files are supported.
367 For positional playing of sounds, only single-channel (mono) files are
368 supported. Otherwise OpenAL will play them non-positionally.
370 Mods should generally prefix their sounds with `modname_`, e.g. given
371 the mod name "`foomod`", a sound could be called:
375 Sounds are referred to by their name with a dot, a single digit and the
376 file extension stripped out. When a sound is played, the actual sound file
377 is chosen randomly from the matching sounds.
379 When playing the sound `foomod_foosound`, the sound is chosen randomly
380 from the available ones of the following files:
382 * `foomod_foosound.ogg`
383 * `foomod_foosound.0.ogg`
384 * `foomod_foosound.1.ogg`
386 * `foomod_foosound.9.ogg`
388 Examples of sound parameter tables:
390 -- Play location-less on all clients
392 gain = 1.0, -- default
394 -- Play location-less to a player
397 gain = 1.0, -- default
399 -- Play in a location
402 gain = 1.0, -- default
403 max_hear_distance = 32, -- default, uses an euclidean metric
405 -- Play connected to an object, looped
407 object = <an ObjectRef>,
408 gain = 1.0, -- default
409 max_hear_distance = 32, -- default, uses an euclidean metric
410 loop = true, -- only sounds connected to objects can be looped
413 ### `SimpleSoundSpec`
415 * e.g. `"default_place_node"`
417 * e.g. `{name="default_place_node"}`
418 * e.g. `{name="default_place_node", gain=1.0}`
420 Registered definitions of stuff
421 -------------------------------
422 Anything added using certain `minetest.register_*` functions get added to
423 the global `minetest.registered_*` tables.
425 * `minetest.register_entity(name, prototype table)`
426 * added to `minetest.registered_entities[name]`
428 * `minetest.register_node(name, node definition)`
429 * added to `minetest.registered_items[name]`
430 * added to `minetest.registered_nodes[name]`
432 * `minetest.register_tool(name, item definition)`
433 * added to `minetest.registered_items[name]`
435 * `minetest.register_craftitem(name, item definition)`
436 * added to `minetest.registered_items[name]`
438 * `minetest.register_biome(biome definition)`
439 * returns an integer uniquely identifying the registered biome
440 * added to `minetest.registered_biome` with the key of `biome.name`
441 * if `biome.name` is nil, the key is the returned ID
443 * `minetest.register_ore(ore definition)`
444 * returns an integer uniquely identifying the registered ore
445 * added to `minetest.registered_ores` with the key of `ore.name`
446 * if `ore.name` is nil, the key is the returned ID
448 * `minetest.register_decoration(decoration definition)`
449 * returns an integer uniquely identifying the registered decoration
450 * added to `minetest.registered_decorations` with the key of `decoration.name`
451 * if `decoration.name` is nil, the key is the returned ID
453 * `minetest.register_schematic(schematic definition)`
454 * returns an integer uniquely identifying the registered schematic
455 * added to `minetest.registered_schematic` with the key of `schematic.name`
456 * if `schematic.name` is nil, the key is the returned ID
457 * if the schematic is loaded from a file, schematic.name is set to the filename
458 * if the function is called when loading the mod, and schematic.name is a relative path,
459 * then the current mod path will be prepended to the schematic filename
461 * `minetest.clear_registered_biomes()`
462 * clears all biomes currently registered
464 * `minetest.clear_registered_ores()`
465 * clears all ores currently registered
467 * `minetest.clear_registered_decorations()`
468 * clears all decorations currently registered
470 * `minetest.clear_registered_schematics()`
471 * clears all schematics currently registered
473 Note that in some cases you will stumble upon things that are not contained
474 in these tables (e.g. when a mod has been removed). Always check for
475 existence before trying to access the fields.
477 Example: If you want to check the drawtype of a node, you could do:
479 local function get_nodedef_field(nodename, fieldname)
480 if not minetest.registered_nodes[nodename] then
483 return minetest.registered_nodes[nodename][fieldname]
485 local drawtype = get_nodedef_field(nodename, "drawtype")
487 Example: `minetest.get_item_group(name, group)` has been implemented as:
489 function minetest.get_item_group(name, group)
490 if not minetest.registered_items[name] or not
491 minetest.registered_items[name].groups[group] then
494 return minetest.registered_items[name].groups[group]
499 Nodes are the bulk data of the world: cubes and other things that take the
500 space of a cube. Huge amounts of them are handled efficiently, but they
503 The definition of a node is stored and can be accessed by name in
505 minetest.registered_nodes[node.name]
507 See "Registered definitions of stuff".
509 Nodes are passed by value between Lua and the engine.
510 They are represented by a table:
512 {name="name", param1=num, param2=num}
514 `param1` and `param2` are 8-bit integers. The engine uses them for certain
515 automated functions. If you don't use these functions, you can use them to
516 store arbitrary values.
518 The functions of `param1` and `param2` are determined by certain fields in the
521 `param1` is reserved for the engine when `paramtype != "none"`:
524 ^ The value stores light with and without sun in its upper and lower 4 bits
525 respectively. Allows light to propagate from or through the node with
526 light value falling by 1 per node. This is essential for a light source
527 node to spread its light.
529 `param2` is reserved for the engine when any of these are used:
531 liquidtype == "flowing"
532 ^ The level and some flags of the liquid is stored in param2
533 drawtype == "flowingliquid"
534 ^ The drawn liquid level is read from param2
535 drawtype == "torchlike"
536 drawtype == "signlike"
537 paramtype2 == "wallmounted"
538 ^ The rotation of the node is stored in param2. You can make this value
539 by using minetest.dir_to_wallmounted().
540 paramtype2 == "facedir"
541 ^ The rotation of the node is stored in param2. Furnaces and chests are
542 rotated this way. Can be made by using minetest.dir_to_facedir().
544 facedir modulo 4 = axisdir
545 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
546 facedir's two less significant bits are rotation around the axis
547 paramtype2 == "leveled"
548 paramtype2 == "degrotate"
549 ^ The rotation of this node is stored in param2. Plants are rotated this way.
550 Values range 0 - 179. The value stored in param2 is multiplied by two to
551 get the actual rotation of the node.
555 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
558 ^ defines list of collision boxes for the node. If empty, collision boxes
559 will be the same as nodeboxes, in case of any other nodes will be full cube
560 as in the example above.
562 Nodes can also contain extra data. See "Node Metadata".
566 There are a bunch of different looking node types.
568 Look for examples in `games/minimal` or `games/minetest_game`.
576 * `glasslike_framed_optional`
578 * `allfaces_optional`
585 * `nodebox` -- See below. (**Experimental!**)
586 * `mesh` -- use models for nodes
588 `*_optional` drawtypes need less rendering time if deactivated (always client side).
592 Node selection boxes are defined using "node boxes"
594 The `nodebox` node drawtype allows defining visual of nodes consisting of
595 arbitrary number of boxes. It allows defining stuff like stairs. Only the
596 `fixed` and `leveled` box type is supported for these.
598 Please note that this is still experimental, and may be incompatibly
599 changed in the future.
601 A nodebox is defined as any of:
604 -- A normal cube; the default in most things
608 -- A fixed box (facedir param2 is used, if applicable)
610 fixed = box OR {box1, box2, ...}
613 -- A box like the selection box for torches
614 -- (wallmounted param2 is used, if applicable)
615 type = "wallmounted",
621 -- A node that has optional boxes depending on neighbouring nodes'
622 -- presence and type. See also `connects_to`.
624 fixed = box OR {box1, box2, ...}
625 connect_top = box OR {box1, box2, ...}
626 connect_bottom = box OR {box1, box2, ...}
627 connect_front = box OR {box1, box2, ...}
628 connect_left = box OR {box1, box2, ...}
629 connect_back = box OR {box1, box2, ...}
630 connect_right = box OR {box1, box2, ...}
633 A `box` is defined as:
635 {x1, y1, z1, x2, y2, z2}
637 A box of a regular node would look like:
639 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
641 `type = "leveled"` is same as `type = "fixed"`, but `y2` will be automatically
642 set to level from `param2`.
647 If drawtype `mesh` is used, tiles should hold model materials textures.
648 Only static meshes are implemented.
649 For supported model formats see Irrlicht engine documentation.
654 Noise Parameters, or commonly called "`NoiseParams`", define the properties of
658 Offset that the noise is translated by (i.e. added) after calculation.
661 Factor that the noise is scaled by (i.e. multiplied) after calculation.
664 Vector containing values by which each coordinate is divided by before calculation.
665 Higher spread values result in larger noise features.
667 A value of `{x=250, y=250, z=250}` is common.
670 Random seed for the noise. Add the world seed to a seed offset for world-unique noise.
671 In the case of `minetest.get_perlin()`, this value has the world seed automatically added.
674 Number of times the noise gradient is accumulated into the noise.
676 Increase this number to increase the amount of detail in the resulting noise.
678 A value of `6` is common.
681 Factor by which the effect of the noise gradient function changes with each successive octave.
683 Values less than `1` make the details of successive octaves' noise diminish, while values
684 greater than `1` make successive octaves stronger.
686 A value of `0.6` is common.
689 Factor by which the noise feature sizes change with each successive octave.
691 A value of `2.0` is common.
694 Leave this field unset for no special handling.
696 Currently supported are `defaults`, `eased` and `absvalue`.
699 Specify this if you would like to keep auto-selection of eased/not-eased while specifying
703 Maps noise gradient values onto a quintic S-curve before performing interpolation.
704 This results in smooth, rolling noise. Disable this (`noeased`) for sharp-looking noise.
705 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is not eased.
708 Accumulates the absolute value of each noise gradient result.
710 Noise parameters format example for 2D or 3D perlin noise or perlin noise maps:
714 spread = {x=500, y=500, z=500},
719 flags = "defaults, absvalue"
721 ^ A single noise parameter table can be used to get 2D or 3D noise,
722 when getting 2D noise spread.z is ignored.
727 These tell in what manner the ore is generated.
729 All default ores are of the uniformly-distributed scatter type.
732 Randomly chooses a location and generates a cluster of ore.
734 If `noise_params` is specified, the ore will be placed if the 3D perlin noise at
735 that point is greater than the `noise_threshold`, giving the ability to create
736 a non-equal distribution of ore.
739 Creates a sheet of ore in a blob shape according to the 2D perlin noise
740 described by `noise_params` and `noise_threshold`. This is essentially an
741 improved version of the so-called "stratus" ore seen in some unofficial mods.
743 This sheet consists of vertical columns of uniform randomly distributed height,
744 varying between the inclusive range `column_height_min` and `column_height_max`.
745 If `column_height_min` is not specified, this parameter defaults to 1.
746 If `column_height_max` is not specified, this parameter defaults to `clust_size`
747 for reverse compatibility. New code should prefer `column_height_max`.
749 The `column_midpoint_factor` parameter controls the position of the column at which
750 ore eminates from. If 1, columns grow upward. If 0, columns grow downward. If 0.5,
751 columns grow equally starting from each direction. `column_midpoint_factor` is a
752 decimal number ranging in value from 0 to 1. If this parameter is not specified,
755 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this ore type.
758 Creates a sheet of ore in a cloud-like puff shape.
760 As with the `sheet` ore type, the size and shape of puffs are described by
761 `noise_params` and `noise_threshold` and are placed at random vertical positions
762 within the currently generated chunk.
764 The vertical top and bottom displacement of each puff are determined by the noise
765 parameters `np_puff_top` and `np_puff_bottom`, respectively.
769 Creates a deformed sphere of ore according to 3d perlin noise described by
770 `noise_params`. The maximum size of the blob is `clust_size`, and
771 `clust_scarcity` has the same meaning as with the `scatter` type.
774 Creates veins of ore varying in density by according to the intersection of two
775 instances of 3d perlin noise with diffferent seeds, both described by
776 `noise_params`. `random_factor` varies the influence random chance has on
777 placement of an ore inside the vein, which is `1` by default. Note that
778 modifying this parameter may require adjusting `noise_threshold`.
779 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
780 by this ore type. This ore type is difficult to control since it is sensitive
781 to small changes. The following is a decent set of parameters to work from:
786 spread = {x=200, y=200, z=200},
792 noise_threshold = 1.6
794 WARNING: Use this ore type *very* sparingly since it is ~200x more
795 computationally expensive than any other ore.
799 See section "Flag Specifier Format".
801 Currently supported flags: `absheight`
804 Also produce this same ore between the height range of `-y_max` and `-y_min`.
806 Useful for having ore in sky realms without having to duplicate ore entries.
809 If set, puff ore generation will not taper down large differences in displacement
810 when approaching the edge of a puff. This flag has no effect for ore types other
813 ### `puff_additive_composition`
814 By default, when noise described by `np_puff_top` or `np_puff_bottom` results in a
815 negative displacement, the sub-column at that point is not generated. With this
816 attribute set, puff ore generation will instead generate the absolute difference in
817 noise displacement values. This flag has no effect for ore types other than `puff`.
821 The varying types of decorations that can be placed.
824 Creates a 1 times `H` times 1 column of a specified node (or a random node from
825 a list, if a decoration list is specified). Can specify a certain node it must
826 spawn next to, such as water or lava, for example. Can also generate a
827 decoration of random height between a specified lower and upper bound.
828 This type of decoration is intended for placement of grass, flowers, cacti,
829 papyri, waterlilies and so on.
832 Copies a box of `MapNodes` from a specified schematic file (or raw description).
833 Can specify a probability of a node randomly appearing when placed.
834 This decoration type is intended to be used for multi-node sized discrete
835 structures, such as trees, cave spikes, rocks, and so on.
840 A schematic specifier identifies a schematic by either a filename to a
841 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
842 in the form of a table. This table specifies the following fields:
844 * The `size` field is a 3D vector containing the dimensions of the provided schematic. (required)
845 * The `yslice_prob` field is a table of {ypos, prob} which sets the `ypos`th vertical slice
846 of the schematic to have a `prob / 256 * 100` chance of occuring. (default: 255)
847 * The `data` field is a flat table of MapNode tables making up the schematic,
848 in the order of `[z [y [x]]]`. (required)
849 Each MapNode table contains:
850 * `name`: the name of the map node to place (required)
851 * `prob` (alias `param1`): the probability of this node being placed (default: 255)
852 * `param2`: the raw param2 value of the node being placed onto the map (default: 0)
853 * `force_place`: boolean representing if the node should forcibly overwrite any
854 previous contents (default: false)
856 About probability values:
857 * A probability value of `0` or `1` means that node will never appear (0% chance).
858 * A probability value of `254` or `255` means the node will always appear (100% chance).
859 * If the probability value `p` is greater than `1`, then there is a
860 `(p / 256 * 100)` percent chance that node will appear when the schematic is
866 See section "Flag Specifier Format".
868 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
871 * `place_center_x`: Placement of this decoration is centered along the X axis.
872 * `place_center_y`: Placement of this decoration is centered along the Y axis.
873 * `place_center_z`: Placement of this decoration is centered along the Z axis.
874 * `force_placement`: Schematic nodes other than "ignore" will replace existing nodes.
879 The position field is used for all element types.
881 To account for differing resolutions, the position coordinates are the percentage
882 of the screen, ranging in value from `0` to `1`.
884 The name field is not yet used, but should contain a description of what the
885 HUD element represents. The direction field is the direction in which something
888 `0` draws from left to right, `1` draws from right to left, `2` draws from
889 top to bottom, and `3` draws from bottom to top.
891 The `alignment` field specifies how the item will be aligned. It ranges from `-1` to `1`,
892 with `0` being the center, `-1` is moved to the left/up, and `1` is to the right/down.
893 Fractional values can be used.
895 The `offset` field specifies a pixel offset from the position. Contrary to position,
896 the offset is not scaled to screen size. This allows for some precisely-positioned
899 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling factor!
901 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
903 **Note**: Future revisions to the HUD API may be incompatible; the HUD API is still
904 in the experimental stages.
907 Displays an image on the HUD.
909 * `scale`: The scale of the image, with 1 being the original texture size.
910 Only the X coordinate scale is used (positive values).
911 Negative values represent that percentage of the screen it
912 should take; e.g. `x=-100` means 100% (width).
913 * `text`: The name of the texture that is displayed.
914 * `alignment`: The alignment of the image.
915 * `offset`: offset in pixels from position.
918 Displays text on the HUD.
920 * `scale`: Defines the bounding rectangle of the text.
921 A value such as `{x=100, y=100}` should work.
922 * `text`: The text to be displayed in the HUD element.
923 * `number`: An integer containing the RGB value of the color used to draw the text.
924 Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
925 * `alignment`: The alignment of the text.
926 * `offset`: offset in pixels from position.
929 Displays a horizontal bar made up of half-images.
931 * `text`: The name of the texture that is used.
932 * `number`: The number of half-textures that are displayed.
933 If odd, will end with a vertically center-split texture.
935 * `offset`: offset in pixels from position.
936 * `size`: If used, will force full-image size to this value (override texture pack image size)
939 * `text`: The name of the inventory list to be displayed.
940 * `number`: Number of items in the inventory to be displayed.
941 * `item`: Position of item that is selected.
945 Displays distance to selected world position.
947 * `name`: The name of the waypoint.
948 * `text`: Distance suffix. Can be blank.
949 * `number:` An integer containing the RGB value of the color used to draw the text.
950 * `world_pos`: World position of the waypoint.
952 Representations of simple things
953 --------------------------------
957 {x=num, y=num, z=num}
959 For helper functions see "Vector helpers".
963 * `{type="node", under=pos, above=pos}`
964 * `{type="object", ref=ObjectRef}`
966 Flag Specifier Format
967 ---------------------
968 Flags using the standardized flag specifier format can be specified in either of
969 two ways, by string or table.
971 The string format is a comma-delimited set of flag names; whitespace and
972 unrecognized flag fields are ignored. Specifying a flag in the string sets the
973 flag, and specifying a flag prefixed by the string `"no"` explicitly
974 clears the flag from whatever the default may be.
976 In addition to the standard string flag format, the schematic flags field can
977 also be a table of flag names to boolean values representing whether or not the
978 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
979 is present, mapped to a boolean of any value, the specified flag is unset.
981 E.g. A flag field of value
983 {place_center_x = true, place_center_y=false, place_center_z=true}
987 {place_center_x = true, noplace_center_y=true, place_center_z=true}
989 which is equivalent to
991 "place_center_x, noplace_center_y, place_center_z"
995 "place_center_x, place_center_z"
997 since, by default, no schematic attributes are set.
1003 There are three kinds of items: nodes, tools and craftitems.
1005 * Node (`register_node`): A node from the world.
1006 * Tool (`register_tool`): A tool/weapon that can dig and damage
1007 things according to `tool_capabilities`.
1008 * Craftitem (`register_craftitem`): A miscellaneous item.
1011 Items and item stacks can exist in three formats: Serializes, table format
1015 This is called "stackstring" or "itemstring":
1017 * e.g. `'default:dirt 5'`
1018 * e.g. `'default:pick_wood 21323'`
1019 * e.g. `'default:apple'`
1026 {name="default:dirt", count=5, wear=0, metadata=""}
1028 A wooden pick about 1/3 worn out:
1030 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1034 {name="default:apple", count=1, wear=0, metadata=""}
1037 A native C++ format with many helper methods. Useful for converting
1038 between formats. See the Class reference section for details.
1040 When an item must be passed to a function, it can usually be in any of
1046 In a number of places, there is a group table. Groups define the
1047 properties of a thing (item, node, armor of entity, capabilities of
1048 tool) in such a way that the engine and other mods can can interact with
1049 the thing without actually knowing what the thing is.
1052 Groups are stored in a table, having the group names with keys and the
1053 group ratings as values. For example:
1055 groups = {crumbly=3, soil=1}
1058 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1059 -- ^ A more special dirt-kind of thing
1061 Groups always have a rating associated with them. If there is no
1062 useful meaning for a rating for an enabled group, it shall be `1`.
1064 When not defined, the rating of a group defaults to `0`. Thus when you
1065 read groups, you must interpret `nil` and `0` as the same value, `0`.
1067 You can read the rating of a group for an item or a node by using
1069 minetest.get_item_group(itemname, groupname)
1072 Groups of items can define what kind of an item it is (e.g. wool).
1075 In addition to the general item things, groups are used to define whether
1076 a node is destroyable and how long it takes to destroy by a tool.
1078 ### Groups of entities
1079 For entities, groups are, as of now, used only for calculating damage.
1080 The rating is the percentage of damage caused by tools with this damage group.
1081 See "Entity damage mechanism".
1083 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1084 object.set_armor_groups({fleshy=30, cracky=80})
1087 Groups in tools define which groups of nodes and entities they are
1090 ### Groups in crafting recipes
1091 An example: Make meat soup from any meat, any water and any bowl:
1094 output = 'food:meat_soup_raw',
1100 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1103 Another example: Make red wool from white wool and red dye:
1107 output = 'wool:red',
1108 recipe = {'wool:white', 'group:dye,basecolor_red'},
1112 * `immortal`: Disables the group damage system for an entity
1113 * `level`: Can be used to give an additional sense of progression in the game.
1114 * A larger level will cause e.g. a weapon of a lower level make much less
1115 damage, and get worn out much faster, or not be able to get drops
1116 from destroyed nodes.
1117 * `0` is something that is directly accessible at the start of gameplay
1118 * There is no upper limit
1119 * `dig_immediate`: (player can always pick up node without tool wear)
1120 * `2`: node is removed without tool wear after 0.5 seconds or so
1122 * `3`: node is removed without tool wear immediately (torch)
1123 * `disable_jump`: Player (and possibly other things) cannot jump from node
1124 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1125 * `bouncy`: value is bounce speed in percent
1126 * `falling_node`: if there is no walkable block under the node it will fall
1127 * `attached_node`: if the node under it is not a walkable block the node will be
1128 dropped as an item. If the node is wallmounted the wallmounted direction is
1130 * `soil`: saplings will grow on nodes in this group
1131 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1132 connect to each other
1134 ### Known damage and digging time defining groups
1135 * `crumbly`: dirt, sand
1136 * `cracky`: tough but crackable stuff like stone.
1137 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1138 plants, wire, sheets of metal
1139 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1140 * `fleshy`: Living things like animals and the player. This could imply
1141 some blood effects when hitting.
1142 * `explody`: Especially prone to explosions
1143 * `oddly_breakable_by_hand`:
1144 Can be added to nodes that shouldn't logically be breakable by the
1145 hand but are. Somewhat similar to `dig_immediate`, but times are more
1146 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1147 speed of a tool if the tool can dig at a faster speed than this
1148 suggests for the hand.
1150 ### Examples of custom groups
1151 Item groups are often used for defining, well, _groups of items_.
1152 * `meat`: any meat-kind of a thing (rating might define the size or healing
1153 ability or be irrelevant -- it is not defined as of yet)
1154 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1156 * `flammable`: can be set on fire. Rating might define the intensity of the
1157 fire, affecting e.g. the speed of the spreading of an open fire.
1158 * `wool`: any wool (any origin, any color)
1159 * `metal`: any metal
1160 * `weapon`: any weapon
1161 * `heavy`: anything considerably heavy
1163 ### Digging time calculation specifics
1164 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1165 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1166 faster digging time.
1168 The `level` group is used to limit the toughness of nodes a tool can dig
1169 and to scale the digging times / damage to a greater extent.
1171 **Please do understand this**, otherwise you cannot use the system to it's
1174 Tools define their properties by a list of parameters for groups. They
1175 cannot dig other groups; thus it is important to use a standard bunch of
1176 groups to enable interaction with tools.
1178 #### Tools definition
1181 * Full punch interval
1182 * Maximum drop level
1183 * For an arbitrary list of groups:
1184 * Uses (until the tool breaks)
1185 * Maximum level (usually `0`, `1`, `2` or `3`)
1189 #### Full punch interval
1190 When used as a weapon, the tool will do full damage if this time is spent
1191 between punches. If e.g. half the time is spent, the tool will do half
1194 #### Maximum drop level
1195 Suggests the maximum level of node, when dug with the tool, that will drop
1196 it's useful item. (e.g. iron ore to drop a lump of iron).
1198 This is not automated; it is the responsibility of the node definition
1202 Determines how many uses the tool has when it is used for digging a node,
1203 of this group, of the maximum level. For lower leveled nodes, the use count
1204 is multiplied by `3^leveldiff`.
1206 * `uses=10, leveldiff=0`: actual uses: 10
1207 * `uses=10, leveldiff=1`: actual uses: 30
1208 * `uses=10, leveldiff=2`: actual uses: 90
1211 Tells what is the maximum level of a node of this group that the tool will
1215 List of digging times for different ratings of the group, for nodes of the
1218 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1219 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1220 for this group, and unable to dig the rating `1`, which is the toughest.
1221 Unless there is a matching group that enables digging otherwise.
1224 List of damage for groups of entities. See "Entity damage mechanism".
1226 #### Example definition of the capabilities of a tool
1228 tool_capabilities = {
1229 full_punch_interval=1.5,
1232 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1234 damage_groups = {fleshy=2},
1237 This makes the tool be able to dig nodes that fulfil both of these:
1239 * Have the `crumbly` group
1240 * Have a `level` group less or equal to `2`
1242 Table of resulting digging times:
1244 crumbly 0 1 2 3 4 <- level
1246 1 0.80 1.60 1.60 - -
1247 2 0.60 1.20 1.20 - -
1248 3 0.40 0.80 0.80 - -
1250 level diff: 2 1 0 -1 -2
1252 Table of resulting tool uses:
1261 * At `crumbly==0`, the node is not diggable.
1262 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1263 easy nodes to be quickly breakable.
1264 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1266 Entity damage mechanism
1267 -----------------------
1271 foreach group in cap.damage_groups:
1272 damage += cap.damage_groups[group] * limit(actual_interval /
1273 cap.full_punch_interval, 0.0, 1.0)
1274 * (object.armor_groups[group] / 100.0)
1275 -- Where object.armor_groups[group] is 0 for inexistent values
1278 Client predicts damage based on damage groups. Because of this, it is able to
1279 give an immediate response when an entity is damaged or dies; the response is
1280 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1282 Currently a smoke puff will appear when an entity dies.
1284 The group `immortal` completely disables normal damage.
1286 Entities can define a special armor group, which is `punch_operable`. This
1287 group disables the regular damage mechanism for players punching it by hand or
1288 a non-tool item, so that it can do something else than take damage.
1290 On the Lua side, every punch calls:
1292 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction)
1294 This should never be called directly, because damage is usually not handled by
1297 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1298 accessed unless absolutely required, to encourage interoperability.
1299 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1300 * `tool_capabilities` can be `nil`.
1301 * `direction` is a unit vector, pointing from the source of the punch to
1304 To punch an entity/object in Lua, call:
1306 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1308 * Return value is tool wear.
1309 * Parameters are equal to the above callback.
1310 * If `direction` equals `nil` and `puncher` does not equal `nil`,
1311 `direction` will be automatically filled in based on the location of `puncher`.
1315 The instance of a node in the world normally only contains the three values
1316 mentioned in "Nodes". However, it is possible to insert extra data into a
1317 node. It is called "node metadata"; See "`NodeMetaRef`".
1319 Metadata contains two things:
1324 Some of the values in the key-value store are handled specially:
1326 * `formspec`: Defines a right-click inventory menu. See "Formspec".
1327 * `infotext`: Text shown on the screen when the node is pointed at
1331 local meta = minetest.get_meta(pos)
1332 meta:set_string("formspec",
1334 "list[context;main;0,0;8,4;]"..
1335 "list[current_player;main;0,5;8,4;]")
1336 meta:set_string("infotext", "Chest");
1337 local inv = meta:get_inventory()
1338 inv:set_size("main", 8*4)
1339 print(dump(meta:to_table()))
1342 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1343 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1344 [10] = "", [11] = "", [12] = "", [13] = "",
1345 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1346 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1347 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1348 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1352 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1359 Formspec defines a menu. Currently not much else than inventories are
1360 supported. It is a string, with a somewhat strange format.
1362 Spaces and newlines can be inserted between the blocks, as is used in the
1370 list[context;main;0,0;8,4;]
1371 list[current_player;main;0,5;8,4;]
1376 list[context;fuel;2,3;1,1;]
1377 list[context;src;2,1;1,1;]
1378 list[context;dst;5,1;2,2;]
1379 list[current_player;main;0,5;8,4;]
1381 #### Minecraft-like player inventory
1384 image[1,0.6;1,2;player.png]
1385 list[current_player;main;0,3.5;8,4;]
1386 list[current_player;craft;3,0;3,3;]
1387 list[current_player;craftpreview;7,1;1,1;]
1391 #### `size[<W>,<H>,<fixed_size>]`
1392 * Define the size of the menu in inventory slots
1393 * `fixed_size`: `true`/`false` (optional)
1394 * deprecated: `invsize[<W>,<H>;]`
1396 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
1397 * Show an inventory list
1399 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
1400 * Show an inventory list
1402 #### `listring[<inventory location>;<list name>]`
1403 * Allows to create a ring of inventory lists
1404 * Shift-clicking on items in one element of the ring
1405 * will send them to the next inventory list inside the ring
1406 * The first occurrence of an element inside the ring will
1407 * determine the inventory where items will be sent to
1410 * Shorthand for doing `listring[<inventory location>;<list name>]`
1411 * for the last two inventory lists added by list[...]
1413 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
1414 * Sets background color of slots as `ColorString`
1415 * Sets background color of slots on mouse hovering
1417 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
1418 * Sets background color of slots as `ColorString`
1419 * Sets background color of slots on mouse hovering
1420 * Sets color of slots border
1422 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
1423 * Sets background color of slots as `ColorString`
1424 * Sets background color of slots on mouse hovering
1425 * Sets color of slots border
1426 * Sets default background color of tooltips
1427 * Sets default font color of tooltips
1429 #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>,<fontcolor>]`
1430 * Adds tooltip for an element
1431 * `<bgcolor>` tooltip background color as `ColorString` (optional)
1432 * `<fontcolor>` tooltip font color as `ColorString` (optional)
1434 #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
1436 * Position and size units are inventory slots
1438 #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
1439 * Show an inventory image of registered item/node
1440 * Position and size units are inventory slots
1442 #### `bgcolor[<color>;<fullscreen>]`
1443 * Sets background color of formspec as `ColorString`
1444 * If `true`, the background color is drawn fullscreen (does not effect the size of the formspec)
1446 #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
1447 * Use a background. Inventory rectangles are not drawn then.
1448 * Position and size units are inventory slots
1449 * Example for formspec 8x4 in 16x resolution: image shall be sized
1450 8 times 16px times 4 times 16px.
1452 #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
1453 * Use a background. Inventory rectangles are not drawn then.
1454 * Position and size units are inventory slots
1455 * Example for formspec 8x4 in 16x resolution:
1456 image shall be sized 8 times 16px times 4 times 16px
1457 * If `true` the background is clipped to formspec size
1458 (`x` and `y` are used as offset values, `w` and `h` are ignored)
1460 #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
1461 * Textual password style field; will be sent to server when a button is clicked
1462 * `x` and `y` position the field relative to the top left of the menu
1463 * `w` and `h` are the size of the field
1464 * fields are a set height, but will be vertically centred on `h`
1465 * Position and size units are inventory slots
1466 * `name` is the name of the field as returned in fields to `on_receive_fields`
1467 * `label`, if not blank, will be text printed on the top left above the field
1469 #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1470 * Textual field; will be sent to server when a button is clicked
1471 * `x` and `y` position the field relative to the top left of the menu
1472 * `w` and `h` are the size of the field
1473 * fields are a set height, but will be vertically centred on `h`
1474 * Position and size units are inventory slots
1475 * `name` is the name of the field as returned in fields to `on_receive_fields`
1476 * `label`, if not blank, will be text printed on the top left above the field
1477 * `default` is the default value of the field
1478 * `default` may contain variable references such as `${text}'` which
1479 will fill the value from the metadata value `text`
1480 * **Note**: no extra text or more than a single variable is supported ATM.
1482 #### `field[<name>;<label>;<default>]`
1483 * as above, but without position/size units
1484 * special field for creating simple forms, such as sign text input
1485 * must be used without a `size[]` element
1486 * a "Proceed" button will be added automatically
1488 #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1489 * same as fields above, but with multi-line input
1491 #### `label[<X>,<Y>;<label>]`
1492 * `x` and `y` work as per field
1493 * `label` is the text on the label
1494 * Position and size units are inventory slots
1496 #### `vertlabel[<X>,<Y>;<label>]`
1497 * Textual label drawn vertically
1498 * `x` and `y` work as per field
1499 * `label` is the text on the label
1500 * Position and size units are inventory slots
1502 #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
1503 * Clickable button. When clicked, fields will be sent.
1504 * `x`, `y` and `name` work as per field
1505 * `w` and `h` are the size of the button
1506 * `label` is the text on the button
1507 * Position and size units are inventory slots
1509 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1510 * `x`, `y`, `w`, `h`, and `name` work as per button
1511 * `texture name` is the filename of an image
1512 * Position and size units are inventory slots
1514 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
1515 * `x`, `y`, `w`, `h`, and `name` work as per button
1516 * `texture name` is the filename of an image
1517 * Position and size units are inventory slots
1518 * `noclip=true` means the image button doesn't need to be within specified formsize
1519 * `drawborder`: draw button border or not
1520 * `pressed texture name` is the filename of an image on pressed state
1522 #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
1523 * `x`, `y`, `w`, `h`, `name` and `label` work as per button
1524 * `item name` is the registered name of an item/node,
1525 tooltip will be made out of its description
1526 to override it use tooltip element
1527 * Position and size units are inventory slots
1529 #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
1530 * When clicked, fields will be sent and the form will quit.
1532 #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1533 * When clicked, fields will be sent and the form will quit.
1535 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
1536 * Scrollable item list showing arbitrary text elements
1537 * `x` and `y` position the itemlist relative to the top left of the menu
1538 * `w` and `h` are the size of the itemlist
1539 * `name` fieldname sent to server on doubleclick value is current selected element
1540 * `listelements` can be prepended by #color in hexadecimal format RRGGBB (only),
1541 * if you want a listelement to start with "#" write "##".
1543 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
1544 * Scrollable itemlist showing arbitrary text elements
1545 * `x` and `y` position the item list relative to the top left of the menu
1546 * `w` and `h` are the size of the item list
1547 * `name` fieldname sent to server on doubleclick value is current selected element
1548 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
1549 * if you want a listelement to start with "#" write "##"
1550 * index to be selected within textlist
1551 * `true`/`false`: draw transparent background
1552 * see also `minetest.explode_textlist_event` (main menu: `engine.explode_textlist_event`)
1554 #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
1555 * show a tab**header** at specific position (ignores formsize)
1556 * `x` and `y` position the itemlist relative to the top left of the menu
1557 * `name` fieldname data is transferred to Lua
1558 * `caption 1`...: name shown on top of tab
1559 * `current_tab`: index of selected tab 1...
1560 * `transparent` (optional): show transparent
1561 * `draw_border` (optional): draw border
1563 #### `box[<X>,<Y>;<W>,<H>;<color>]`
1564 * simple colored semitransparent box
1565 * `x` and `y` position the box relative to the top left of the menu
1566 * `w` and `h` are the size of box
1567 * `color` is color specified as a `ColorString`
1569 #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
1570 * show a dropdown field
1571 * **Important note**: There are two different operation modes:
1572 1. handle directly on change (only changed dropdown is submitted)
1573 2. read the value on pressing a button (all dropdown values are available)
1574 * `x` and `y` position of dropdown
1576 * fieldname data is transferred to Lua
1577 * items to be shown in dropdown
1578 * index of currently selected dropdown item
1580 #### `checkbox[<X>,<Y>;<name>;<label>;<selected>;<tooltip>]`
1582 * `x` and `y`: position of checkbox
1583 * `name` fieldname data is transferred to Lua
1584 * `label` to be shown left of checkbox
1585 * `selected` (optional): `true`/`false`
1586 * `tooltip` (optional)
1588 #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
1590 * there are two ways to use it:
1591 1. handle the changed event (only changed scrollbar is available)
1592 2. read the value on pressing a button (all scrollbars are available)
1593 * `x` and `y`: position of trackbar
1594 * `w` and `h`: width and height
1595 * `orientation`: `vertical`/`horizontal`
1596 * fieldname data is transferred to Lua
1597 * value this trackbar is set to (`0`-`1000`)
1598 * see also `minetest.explode_scrollbar_event` (main menu: `engine.explode_scrollbar_event`)
1600 #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
1601 * show scrollable table using options defined by the previous `tableoptions[]`
1602 * displays cells as defined by the previous `tablecolumns[]`
1603 * `x` and `y`: position the itemlist relative to the top left of the menu
1604 * `w` and `h` are the size of the itemlist
1605 * `name`: fieldname sent to server on row select or doubleclick
1606 * `cell 1`...`cell n`: cell contents given in row-major order
1607 * `selected idx`: index of row to be selected within table (first row = `1`)
1608 * see also `minetest.explode_table_event` (main menu: `engine.explode_table_event`)
1610 #### `tableoptions[<opt 1>;<opt 2>;...]`
1611 * sets options for `table[]`
1613 * default text color (`ColorString`), defaults to `#FFFFFF`
1614 * `background=#RRGGBB`
1615 * table background color (`ColorString`), defaults to `#000000`
1616 * `border=<true/false>`
1617 * should the table be drawn with a border? (default: `true`)
1618 * `highlight=#RRGGBB`
1619 * highlight background color (`ColorString`), defaults to `#466432`
1620 * `highlight_text=#RRGGBB`
1621 * highlight text color (`ColorString`), defaults to `#FFFFFF`
1622 * `opendepth=<value>`
1623 * all subtrees up to `depth < value` are open (default value = `0`)
1624 * only useful when there is a column of type "tree"
1626 #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
1627 * sets columns for `table[]`
1628 * types: `text`, `image`, `color`, `indent`, `tree`
1629 * `text`: show cell contents as text
1630 * `image`: cell contents are an image index, use column options to define images
1631 * `color`: cell contents are a ColorString and define color of following cell
1632 * `indent`: cell contents are a number and define indentation of following cell
1633 * `tree`: same as indent, but user can open and close subtrees (treeview-like)
1636 * for `text` and `image`: content alignment within cells.
1637 Available values: `left` (default), `center`, `right`, `inline`
1639 * for `text` and `image`: minimum width in em (default: `0`)
1640 * for `indent` and `tree`: indent width in em (default: `1.5`)
1641 * `padding=<value>`: padding left of the column, in em (default `0.5`).
1642 Exception: defaults to 0 for indent columns
1643 * `tooltip=<value>`: tooltip text (default: empty)
1644 * `image` column options:
1645 * `0=<value>` sets image for image index 0
1646 * `1=<value>` sets image for image index 1
1647 * `2=<value>` sets image for image index 2
1648 * and so on; defined indices need not be contiguous empty or
1649 non-numeric cells are treated as `0`.
1650 * `color` column options:
1651 * `span=<value>`: number of following columns to affect (default: infinite)
1653 **Note**: do _not_ use a element name starting with `key_`; those names are reserved to
1654 pass key press events to formspec!
1658 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
1659 * `"current_player"`: Player to whom the menu is shown
1660 * `"player:<name>"`: Any player
1661 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
1662 * `"detached:<name>"`: A detached inventory
1666 `#RGB` defines a color in hexadecimal format.
1668 `#RGBA` defines a color in hexadecimal format and alpha channel.
1670 `#RRGGBB` defines a color in hexadecimal format.
1672 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
1674 Named colors are also supported and are equivalent to
1675 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
1676 To specify the value of the alpha channel, append `#AA` to the end of the color name
1677 (e.g. `colorname#08`). For named colors the hexadecimal string representing the alpha
1678 value must (always) be two hexadecimal digits.
1682 A ColorSpec specifies a 32-bit color. It can be written in either:
1683 table form, each element ranging from 0..255 (a, if absent, defaults to 255):
1684 `colorspec = {a=255, r=0, g=255, b=0}`
1685 numerical form, the raw integer value of an ARGB8 quad:
1686 `colorspec = 0xFF00FF00`
1687 or string form, a ColorString (defined above):
1688 `colorspec = "green"`
1692 * `vector.new(a[, b, c])`: returns a vector:
1693 * A copy of `a` if `a` is a vector.
1694 * `{x = a, y = b, z = c}`, if all `a, b, c` are defined
1695 * `vector.direction(p1, p2)`: returns a vector
1696 * `vector.distance(p1, p2)`: returns a number
1697 * `vector.length(v)`: returns a number
1698 * `vector.normalize(v)`: returns a vector
1699 * `vector.round(v)`: returns a vector, each dimension rounded to floor
1700 * `vector.apply(v, func)`: returns a vector
1701 * `vector.equals(v1, v2)`: returns a boolean
1703 For the following functions `x` can be either a vector or a number:
1705 * `vector.add(v, x)`: returns a vector
1706 * `vector.subtract(v, x)`: returns a vector
1707 * `vector.multiply(v, x)`: returns a scaled vector or Schur product
1708 * `vector.divide(v, x)`: returns a scaled vector or Schur quotient
1712 * `dump2(obj, name="_", dumped={})`
1713 * Return object serialized as a string, handles reference loops
1714 * `dump(obj, dumped={})`
1715 * Return object serialized as a string
1716 * `math.hypot(x, y)`
1717 * Get the hypotenuse of a triangle with legs x and y.
1718 Useful for distance calculation.
1719 * `math.sign(x, tolerance)`
1720 * Get the sign of a number.
1721 Optional: Also returns `0` when the absolute value is within the tolerance (default: `0`)
1722 * `string.split(str, separator=",", include_empty=false, max_splits=-1,
1723 * sep_is_pattern=false)`
1724 * If `max_splits` is negative, do not limit splits.
1725 * `sep_is_pattern` specifies if separator is a plain string or a pattern (regex).
1726 * e.g. `string:split("a,b", ",") == {"a","b"}`
1728 * e.g. `string.trim("\n \t\tfoo bar\t ") == "foo bar"`
1729 * `minetest.pos_to_string({x=X,y=Y,z=Z}, decimal_places))`: returns `"(X,Y,Z)"`
1730 * Convert position to a printable string
1731 Optional: 'decimal_places' will round the x, y and z of the pos to the given decimal place.
1732 * `minetest.string_to_pos(string)`: returns a position
1733 * Same but in reverse. Returns `nil` if the string can't be parsed to a position.
1734 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
1735 * Converts a string representing an area box into two positions
1736 * `minetest.formspec_escape(string)`: returns a string
1737 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
1738 * `minetest.is_yes(arg)`
1739 * returns whether `arg` can be interpreted as yes
1740 * `minetest.get_us_time()`
1741 * returns time with microsecond precision. May not return wall time.
1742 * `table.copy(table)`: returns a table
1743 * returns a deep copy of `table`
1745 `minetest` namespace reference
1746 ------------------------------
1750 * `minetest.get_current_modname()`: returns the currently loading mod's name, when we are loading a mod
1751 * `minetest.get_modpath(modname)`: returns e.g. `"/home/user/.minetest/usermods/modname"`
1752 * Useful for loading additional `.lua` modules or static data from mod
1753 * `minetest.get_modnames()`: returns a list of installed mods
1754 * Return a list of installed mods, sorted alphabetically
1755 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
1756 * Useful for storing custom data
1757 * `minetest.is_singleplayer()`
1758 * `minetest.features`
1759 * Table containing API feature flags: `{foo=true, bar=true}`
1760 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
1761 * `arg`: string or table in format `{foo=true, bar=true}`
1762 * `missing_features`: `{foo=true, bar=true}`
1763 * `minetest.get_player_information(player_name)`: returns a table containing
1764 information about player. Example return value:
1766 address = "127.0.0.1", -- IP address of client
1767 ip_version = 4, -- IPv4 / IPv6
1768 min_rtt = 0.01, -- minimum round trip time
1769 max_rtt = 0.2, -- maximum round trip time
1770 avg_rtt = 0.02, -- average round trip time
1771 min_jitter = 0.01, -- minimum packet time jitter
1772 max_jitter = 0.5, -- maximum packet time jitter
1773 avg_jitter = 0.03, -- average packet time jitter
1774 connection_uptime = 200, -- seconds since client connected
1776 -- following information is available on debug build only!!!
1777 -- DO NOT USE IN MODS
1778 --ser_vers = 26, -- serialization version used by client
1779 --prot_vers = 23, -- protocol version used by client
1780 --major = 0, -- major version number
1781 --minor = 4, -- minor version number
1782 --patch = 10, -- patch version number
1783 --vers_string = "0.4.9-git", -- full version string
1784 --state = "Active" -- current client state
1786 * `minetest.mkdir(path)`: returns success.
1787 * Creates a directory specified by `path`, creating parent directories
1788 if they don't exist.
1789 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
1791 * nil: return all entries,
1792 * true: return only subdirectory names, or
1793 * false: return only file names.
1796 * `minetest.debug(...)`
1797 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
1798 * `minetest.log([level,] text)`
1799 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
1800 `"info"`, or `"verbose"`. Default is `"none"`.
1802 ### Registration functions
1803 Call these functions only at load time!
1805 * `minetest.register_entity(name, prototype table)`
1806 * `minetest.register_abm(abm definition)`
1807 * `minetest.register_lbm(lbm definition)`
1808 * `minetest.register_node(name, node definition)`
1809 * `minetest.register_tool(name, item definition)`
1810 * `minetest.register_craftitem(name, item definition)`
1811 * `minetest.register_alias(name, convert_to)`
1812 * `minetest.register_craft(recipe)`
1813 * `minetest.register_ore(ore definition)`
1814 * `minetest.register_decoration(decoration definition)`
1815 * `minetest.override_item(name, redefinition)`
1816 * Overrides fields of an item registered with register_node/tool/craftitem.
1817 * Note: Item must already be defined, (opt)depend on the mod defining it.
1818 * Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})`
1820 * `minetest.clear_registered_ores()`
1821 * `minetest.clear_registered_decorations()`
1823 ### Global callback registration functions
1824 Call these functions only at load time!
1826 * `minetest.register_globalstep(func(dtime))`
1827 * Called every server step, usually interval of 0.1s
1828 * `minetest.register_on_shutdown(func())`
1829 * Called before server shutdown
1830 * **Warning**: If the server terminates abnormally (i.e. crashes), the registered
1831 callbacks **will likely not be run**. Data should be saved at
1832 semi-frequent intervals as well as on server shutdown.
1833 * `minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
1834 * Called when a node has been placed
1835 * If return `true` no item is taken from `itemstack`
1836 * **Not recommended**; use `on_construct` or `after_place_node` in node definition
1838 * `minetest.register_on_dignode(func(pos, oldnode, digger))`
1839 * Called when a node has been dug.
1840 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node definition
1842 * `minetest.register_on_punchnode(func(pos, node, puncher, pointed_thing))`
1843 * Called when a node is punched
1844 * `minetest.register_on_generated(func(minp, maxp, blockseed))`
1845 * Called after generating a piece of world. Modifying nodes inside the area
1846 is a bit faster than usually.
1847 * `minetest.register_on_newplayer(func(ObjectRef))`
1848 * Called after a new player has been created
1849 * `minetest.register_on_dieplayer(func(ObjectRef))`
1850 * Called when a player dies
1851 * `minetest.register_on_punchplayer(func(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
1852 * Called when a player is punched
1853 * `player` - ObjectRef - Player that was punched
1854 * `hitter` - ObjectRef - Player that hit
1855 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be nil)
1856 * `tool_capabilities`: capability table of used tool (can be nil)
1857 * `dir`: unit vector of direction of punch. Always defined. Points from
1858 the puncher to the punched.
1859 * `damage` - number that represents the damage calculated by the engine
1860 * should return `true` to prevent the default damage mechanism
1861 * `minetest.register_on_player_hpchange(func(player, hp_change), modifier)`
1862 * Called when the player gets damaged or healed
1863 * `player`: ObjectRef of the player
1864 * `hp_change`: the amount of change. Negative when it is damage.
1865 * `modifier`: when true, the function should return the actual hp_change.
1866 Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
1867 modifiers can return true as a second argument to stop the execution of further functions.
1868 * `minetest.register_on_respawnplayer(func(ObjectRef))`
1869 * Called when player is to be respawned
1870 * Called _before_ repositioning of player occurs
1871 * return true in func to disable regular player placement
1872 * `minetest.register_on_prejoinplayer(func(name, ip))`
1873 * Called before a player joins the game
1874 * If it returns a string, the player is disconnected with that string as reason
1875 * `minetest.register_on_joinplayer(func(ObjectRef))`
1876 * Called when a player joins the game
1877 * `minetest.register_on_leaveplayer(func(ObjectRef))`
1878 * Called when a player leaves the game
1879 * `minetest.register_on_cheat(func(ObjectRef, cheat))`
1880 * Called when a player cheats
1881 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
1882 * `"moved_too_fast"`
1883 * `"interacted_too_far"`
1884 * `"finished_unknown_dig"`
1887 * `minetest.register_on_chat_message(func(name, message))`
1888 * Called always when a player says something
1889 * Return `true` to mark the message as handled, which means that it will not be sent to other players
1890 * `minetest.register_on_player_receive_fields(func(player, formname, fields))`
1891 * Called when a button is pressed in player's inventory form
1892 * Newest functions are called first
1893 * If function returns `true`, remaining functions are not called
1894 * `minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))`
1895 * Called when `player` crafts something
1896 * `itemstack` is the output
1897 * `old_craft_grid` contains the recipe (Note: the one in the inventory is cleared)
1898 * `craft_inv` is the inventory with the crafting grid
1899 * Return either an `ItemStack`, to replace the output, or `nil`, to not modify it
1900 * `minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))`
1901 * The same as before, except that it is called before the player crafts, to make
1902 craft prediction, and it should not change anything.
1903 * `minetest.register_on_protection_violation(func(pos, name))`
1904 * Called by `builtin` and mods when a player violates protection at a position
1905 (eg, digs a node or punches a protected entity).
1906 * The registered functions can be called using `minetest.record_protection_violation`
1907 * The provided function should check that the position is protected by the mod
1908 calling this function before it prints a message, if it does, to allow for
1909 multiple protection mods.
1910 * `minetest.register_on_item_eat(func(hp_change, replace_with_item, itemstack, user, pointed_thing))`
1911 * Called when an item is eaten, by `minetest.item_eat`
1912 * Return `true` or `itemstack` to cancel the default item eat response (i.e.: hp increase)
1914 ### Other registration functions
1915 * `minetest.register_chatcommand(cmd, chatcommand definition)`
1916 * `minetest.register_privilege(name, definition)`
1917 * `definition`: `"description text"`
1918 * `definition`: `{ description = "description text", give_to_singleplayer = boolean, -- default: true }`
1919 * `minetest.register_authentication_handler(handler)`
1920 * See `minetest.builtin_auth_handler` in `builtin.lua` for reference
1923 * `minetest.setting_set(name, value)`
1924 * Setting names can't contain whitespace or any of `="{}#`.
1925 * Setting values can't contain the sequence `\n"""`.
1926 * Setting names starting with "secure." can't be set.
1927 * `minetest.setting_get(name)`: returns string or `nil`
1928 * `minetest.setting_setbool(name, value)`
1929 * See documentation on `setting_set` for restrictions.
1930 * `minetest.setting_getbool(name)`: returns boolean or `nil`
1931 * `minetest.setting_get_pos(name)`: returns position or nil
1932 * `minetest.setting_save()`, returns `nil`, save all settings to config file
1935 * `minetest.notify_authentication_modified(name)`
1936 * Should be called by the authentication handler if privileges changes.
1937 * To report everybody, set `name=nil`.
1938 * `minetest.get_password_hash(name, raw_password)`
1939 * Convert a name-password pair to a password hash that Minetest can use.
1940 * The returned value alone is not a good basis for password checks based
1941 * on comparing the password hash in the database with the password hash
1942 * from the function, with an externally provided password, as the hash
1943 * in the db might use the new SRP verifier format.
1944 * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
1945 * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
1946 * Convert between two privilege representations
1947 * `minetest.set_player_password(name, password_hash)`
1948 * `minetest.set_player_privs(name, {priv1=true,...})`
1949 * `minetest.get_player_privs(name) -> {priv1=true,...}`
1950 * `minetest.auth_reload()`
1951 * `minetest.check_player_privs(player_or_name, ...)`: returns `bool, missing_privs`
1952 * A quickhand for checking privileges.
1953 * `player_or_name`: Either a Player object or the name of a player.
1954 * `...` is either a list of strings, e.g. `"priva", "privb"` or
1955 a table, e.g. `{ priva = true, privb = true }`.
1956 * `minetest.get_player_ip(name)`: returns an IP address string
1958 `minetest.set_player_password`, `minetest_set_player_privs`, `minetest_get_player_privs`
1959 and `minetest.auth_reload` call the authetification handler.
1962 * `minetest.chat_send_all(text)`
1963 * `minetest.chat_send_player(name, text)`
1965 ### Environment access
1966 * `minetest.set_node(pos, node)`
1967 * `minetest.add_node(pos, node): alias set_node(pos, node)`
1968 * Set node at position (`node = {name="foo", param1=0, param2=0}`)
1969 * `minetest.swap_node(pos, node`
1970 * Set node at position, but don't remove metadata
1971 * `minetest.remove_node(pos)`
1972 * Equivalent to `set_node(pos, "air")`
1973 * `minetest.get_node(pos)`
1974 * Returns the node at the given position as table in the format
1975 `{name="node_name", param1=0, param2=0}`, returns `{name="ignore", param1=0, param2=0}`
1977 * `minetest.get_node_or_nil(pos)`
1978 * Same as `get_node` but returns `nil` for unloaded areas.
1979 * `minetest.get_node_light(pos, timeofday)`
1980 * Gets the light value at the given position. Note that the light value
1981 "inside" the node at the given position is returned, so you usually want
1982 to get the light value of a neighbor.
1983 * `pos`: The position where to measure the light.
1984 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
1985 * Returns a number between `0` and `15` or `nil`
1986 * `minetest.place_node(pos, node)`
1987 * Place node with the same effects that a player would cause
1988 * `minetest.dig_node(pos)`
1989 * Dig node with the same effects that a player would cause
1990 * Returns `true` if successful, `false` on failure (e.g. protected location)
1991 * `minetest.punch_node(pos)`
1992 * Punch node with the same effects that a player would cause
1994 * `minetest.find_nodes_with_meta(pos1, pos2)`
1995 * Get a table of positions of nodes that have metadata within a region {pos1, pos2}
1996 * `minetest.get_meta(pos)`
1997 * Get a `NodeMetaRef` at that position
1998 * `minetest.get_node_timer(pos)`
1999 * Get `NodeTimerRef`
2001 * `minetest.add_entity(pos, name)`: Spawn Lua-defined entity at position
2002 * Returns `ObjectRef`, or `nil` if failed
2003 * `minetest.add_item(pos, item)`: Spawn item
2004 * Returns `ObjectRef`, or `nil` if failed
2005 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
2006 * `minetest.get_objects_inside_radius(pos, radius)`
2007 * `radius`: using an euclidean metric
2008 * `minetest.set_timeofday(val)`
2009 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
2010 * `minetest.get_timeofday()`
2011 * `minetest.get_gametime()`: returns the time, in seconds, since the world was created
2012 * `minetest.get_day_count()`: returns number days elapsed since world was created,
2013 * accounting for time changes.
2014 * `minetest.find_node_near(pos, radius, nodenames)`: returns pos or `nil`
2015 * `radius`: using a maximum metric
2016 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2017 * `minetest.find_nodes_in_area(minp, maxp, nodenames)`: returns a list of positions
2018 * returns as second value a table with the count of the individual nodes found
2019 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2020 * `minetest.find_nodes_in_area_under_air(minp, maxp, nodenames)`: returns a list of positions
2021 * returned positions are nodes with a node air above
2022 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2023 * `minetest.get_perlin(noiseparams)`
2024 * `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
2025 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
2026 * `minetest.get_voxel_manip([pos1, pos2])`
2027 * Return voxel manipulator object.
2028 * Loads the manipulator from the map if positions are passed.
2029 * `minetest.set_gen_notify(flags, {deco_ids})`
2030 * Set the types of on-generate notifications that should be collected
2031 * `flags` is a flag field with the available flags: `dungeon`, `temple`, `cave_begin`,
2032 `cave_end`, `large_cave_begin`, `large_cave_end`, `decoration`
2033 * The second parameter is a list of IDS of decorations which notification is requested for
2034 * `get_gen_notify()`: returns a flagstring and a table with the deco_ids
2035 * `minetest.get_mapgen_object(objectname)`
2036 * Return requested mapgen object if available (see "Mapgen objects")
2037 * `minetest.get_biome_id(biome_name)`
2038 * Returns the biome id, as used in the biomemap Mapgen object, for a
2039 given biome_name string.
2040 * `minetest.get_mapgen_params()` Returns mapgen parameters, a table containing
2041 `mgname`, `seed`, `chunksize`, `water_level`, and `flags`.
2042 * `minetest.set_mapgen_params(MapgenParams)`
2043 * Set map generation parameters
2044 * Function cannot be called after the registration period; only initialization
2045 and `on_mapgen_init`
2046 * Takes a table as an argument with the fields `mgname`, `seed`, `water_level`,
2048 * Leave field unset to leave that parameter unchanged
2049 * `flags` contains a comma-delimited string of flags to set,
2050 or if the prefix `"no"` is attached, clears instead.
2051 * `flags` is in the same format and has the same options as `mg_flags` in `minetest.conf`
2052 * `minetest.set_noiseparams(name, noiseparams, set_default)`
2053 * Sets the noiseparams setting of `name` to the noiseparams table specified in `noiseparams`.
2054 * `set_default` is an optional boolean (default: `true`) that specifies whether the setting
2055 should be applied to the default config or current active config
2056 * `minetest.get_noiseparams(name)`: returns a table of the noiseparams for name
2057 * `minetest.generate_ores(vm, pos1, pos2)`
2058 * Generate all registered ores within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
2059 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
2060 * `minetest.generate_decorations(vm, pos1, pos2)`
2061 * Generate all registered decorations within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
2062 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
2063 * `minetest.clear_objects([options])`
2064 * Clear all objects in the environment
2065 * Takes an optional table as an argument with the field `mode`.
2066 * mode = `"full"`: Load and go through every mapblock, clearing objects (default).
2067 * mode = `"quick"`: Clear objects immediately in loaded mapblocks;
2068 clear objects in unloaded mapblocks only when the mapblocks are next activated.
2069 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
2070 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be asynchronously
2071 * fetched from memory, loaded from disk, or if inexistent, generates them.
2072 * If `callback` is a valid Lua function, this will be called for each block emerged.
2073 * The function signature of callback is:
2074 * `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
2075 * - `blockpos` is the *block* coordinates of the block that had been emerged
2076 * - `action` could be one of the following constant values:
2077 * `core.EMERGE_CANCELLED`, `core.EMERGE_ERRORED`, `core.EMERGE_FROM_MEMORY`,
2078 * `core.EMERGE_FROM_DISK`, `core.EMERGE_GENERATED`
2079 * - `calls_remaining` is the number of callbacks to be expected after this one
2080 * - `param` is the user-defined parameter passed to emerge_area (or nil if the
2081 * parameter was absent)
2082 * `minetest.delete_area(pos1, pos2)`
2083 * delete all mapblocks in the area from pos1 to pos2, inclusive
2084 * `minetest.line_of_sight(pos1, pos2, stepsize)`: returns `boolean, pos`
2085 * Check if there is a direct line of sight between `pos1` and `pos2`
2086 * Returns the position of the blocking node when `false`
2087 * `pos1`: First position
2088 * `pos2`: Second position
2089 * `stepsize`: smaller gives more accurate results but requires more computing
2090 time. Default is `1`.
2091 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
2092 * returns table containing path
2093 * returns a table of 3D points representing a path from `pos1` to `pos2` or `nil`
2094 * `pos1`: start position
2095 * `pos2`: end position
2096 * `searchdistance`: number of blocks to search in each direction using a maximum metric
2097 * `max_jump`: maximum height difference to consider walkable
2098 * `max_drop`: maximum height difference to consider droppable
2099 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
2100 * `minetest.spawn_tree (pos, {treedef})`
2101 * spawns L-System tree at given `pos` with definition in `treedef` table
2102 * `minetest.transforming_liquid_add(pos)`
2103 * add node to liquid update queue
2104 * `minetest.get_node_max_level(pos)`
2105 * get max available level for leveled node
2106 * `minetest.get_node_level(pos)`
2107 * get level of leveled node (water, snow)
2108 * `minetest.set_node_level(pos, level)`
2109 * set level of leveled node, default `level` equals `1`
2110 * if `totallevel > maxlevel`, returns rest (`total-max`).
2111 * `minetest.add_node_level(pos, level)`
2112 * increase level of leveled node by level, default `level` equals `1`
2113 * if `totallevel > maxlevel`, returns rest (`total-max`)
2114 * can be negative for decreasing
2117 `minetest.get_inventory(location)`: returns an `InvRef`
2120 * `{type="player", name="celeron55"}`
2121 * `{type="node", pos={x=, y=, z=}}`
2122 * `{type="detached", name="creative"}`
2123 * `minetest.create_detached_inventory(name, callbacks)`: returns an `InvRef`
2124 * callbacks: See "Detached inventory callbacks"
2125 * Creates a detached inventory. If it already exists, it is cleared.
2126 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
2127 returns left over ItemStack
2128 * See `minetest.item_eat` and `minetest.register_on_item_eat`
2131 * `minetest.show_formspec(playername, formname, formspec)`
2132 * `playername`: name of player to show formspec
2133 * `formname`: name passed to `on_player_receive_fields` callbacks.
2134 It should follow the `"modname:<whatever>"` naming convention
2135 * `formspec`: formspec to display
2136 * `minetest.formspec_escape(string)`: returns a string
2137 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
2138 * `minetest.explode_table_event(string)`: returns a table
2139 * returns e.g. `{type="CHG", row=1, column=2}`
2141 * `"INV"`: no row selected)
2142 * `"CHG"`: selected)
2143 * `"DCL"`: double-click
2144 * `minetest.explode_textlist_event(string)`: returns a table
2145 * returns e.g. `{type="CHG", index=1}`
2147 * `"INV"`: no row selected)
2148 * `"CHG"`: selected)
2149 * `"DCL"`: double-click
2150 * `minetest.explode_scrollbar_event(string)`: returns a table
2151 * returns e.g. `{type="CHG", value=500}`
2153 * `"INV"`: something failed
2154 * `"CHG"`: has been changed
2155 * `"VAL"`: not changed
2158 * `minetest.inventorycube(img1, img2, img3)`
2159 * Returns a string for making an image of a cube (useful as an item image)
2160 * `minetest.get_pointed_thing_position(pointed_thing, above)`
2161 * Get position of a `pointed_thing` (that you can get from somewhere)
2162 * `minetest.dir_to_facedir(dir, is6d)`
2163 * Convert a vector to a facedir value, used in `param2` for `paramtype2="facedir"`;
2164 * passing something non-`nil`/`false` for the optional second parameter causes it to
2165 take the y component into account
2166 * `minetest.facedir_to_dir(facedir)`
2167 * Convert a facedir back into a vector aimed directly out the "back" of a node
2168 * `minetest.dir_to_wallmounted(dir)`
2169 * Convert a vector to a wallmounted value, used for `paramtype2="wallmounted"`
2170 * `minetest.wallmounted_to_dir(wallmounted)`
2171 * Convert a wallmounted value back into a vector aimed directly out the "back" of a node
2172 * `minetest.get_node_drops(nodename, toolname)`
2173 * Returns list of item names.
2174 * **Note**: This will be removed or modified in a future version.
2175 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
2176 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2177 * `input.width` = for example `3`
2178 * `input.items` = for example
2179 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2180 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
2181 * `output.time` = a number, if unsuccessful: `0`
2182 * `output.replacements` = list of `ItemStack`s that couldn't be placed in
2183 `decremented_input.items`
2184 * `decremented_input` = like `input`
2185 * `minetest.get_craft_recipe(output)`: returns input
2186 * returns last registered recipe for output item (node)
2187 * `output` is a node or item type such as `"default:torch"`
2188 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2189 * `input.width` = for example `3`
2190 * `input.items` = for example
2191 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2192 * `input.items` = `nil` if no recipe found
2193 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
2194 * returns indexed table with all registered recipes for query item (node)
2195 or `nil` if no recipe was found
2196 * recipe entry table:
2198 method = 'normal' or 'cooking' or 'fuel'
2199 width = 0-3, 0 means shapeless recipe
2200 items = indexed [1-9] table with recipe items
2201 output = string with item name and quantity
2203 * Example query for `"default:gold_ingot"` will return table:
2205 [1]={type = "cooking", width = 3, output = "default:gold_ingot",
2206 items = {1 = "default:gold_lump"}},
2207 [2]={type = "normal", width = 1, output = "default:gold_ingot 9",
2208 items = {1 = "default:goldblock"}}
2210 * `minetest.handle_node_drops(pos, drops, digger)`
2211 * `drops`: list of itemstrings
2212 * Handles drops from nodes after digging: Default action is to put them into
2214 * Can be overridden to get different functionality (e.g. dropping items on
2218 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
2219 returns `{{actor, pos, time, oldnode, newnode}, ...}`
2220 * Find who has done something to a node, or near a node
2221 * `actor`: `"player:<name>"`, also `"liquid"`.
2222 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns `boolean, log_messages`
2223 * Revert latest actions of someone
2224 * `actor`: `"player:<name>"`, also `"liquid"`.
2226 ### Defaults for the `on_*` item definition functions
2227 These functions return the leftover itemstack.
2229 * `minetest.item_place_node(itemstack, placer, pointed_thing, param2)`
2230 * Place item as a node
2231 * `param2` overrides `facedir` and wallmounted `param2`
2232 * returns `itemstack, success`
2233 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
2235 * `minetest.item_place(itemstack, placer, pointed_thing, param2)`
2236 * Use one of the above based on what the item is.
2237 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
2238 * **Note**: is not called when wielded item overrides `on_place`
2239 * `param2` overrides `facedir` and wallmounted `param2`
2240 * returns `itemstack, success`
2241 * `minetest.item_drop(itemstack, dropper, pos)`
2243 * `minetest.item_eat(hp_change, replace_with_item)`
2245 * `replace_with_item` is the itemstring which is added to the inventory.
2246 If the player is eating a stack, then replace_with_item goes to a
2247 different spot. Can be `nil`
2248 * See `minetest.do_item_eat`
2250 ### Defaults for the `on_punch` and `on_dig` node definition callbacks
2251 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
2252 * Calls functions registered by `minetest.register_on_punchnode()`
2253 * `minetest.node_dig(pos, node, digger)`
2254 * Checks if node can be dug, puts item into inventory, removes node
2255 * Calls functions registered by `minetest.registered_on_dignodes()`
2258 * `minetest.sound_play(spec, parameters)`: returns a handle
2259 * `spec` is a `SimpleSoundSpec`
2260 * `parameters` is a sound parameter table
2261 * `minetest.sound_stop(handle)`
2264 * `minetest.after(time, func, ...)`
2265 * Call the function `func` after `time` seconds, may be fractional
2266 * Optional: Variable number of arguments that are passed to `func`
2269 * `minetest.request_shutdown([message],[reconnect])`: request for server shutdown. Will display `message` to clients,
2270 and `reconnect` == true displays a reconnect button.
2271 * `minetest.get_server_status()`: returns server status string
2274 * `minetest.get_ban_list()`: returns the ban list (same as `minetest.get_ban_description("")`)
2275 * `minetest.get_ban_description(ip_or_name)`: returns ban description (string)
2276 * `minetest.ban_player(name)`: ban a player
2277 * `minetest.unban_player_or_ip(name)`: unban player or IP address
2278 * `minetest.kick_player(name, [reason])`: disconnect a player with a optional reason
2281 * `minetest.add_particle(particle definition)`
2282 * Deprecated: `minetest.add_particle(pos, velocity, acceleration, expirationtime,
2283 size, collisiondetection, texture, playername)`
2285 * `minetest.add_particlespawner(particlespawner definition)`
2286 * Add a `ParticleSpawner`, an object that spawns an amount of particles over `time` seconds
2287 * Returns an `id`, and -1 if adding didn't succeed
2288 * `Deprecated: minetest.add_particlespawner(amount, time,
2292 minexptime, maxexptime,
2294 collisiondetection, texture, playername)`
2296 * `minetest.delete_particlespawner(id, player)``
2297 * Delete `ParticleSpawner` with `id` (return value from `minetest.add_particlespawner`)
2298 * If playername is specified, only deletes on the player's client,
2299 * otherwise on all clients
2302 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
2303 * Create a schematic from the volume of map specified by the box formed by p1 and p2.
2304 * Apply the specified probability values to the specified nodes in `probability_list`.
2305 * `probability_list` is an array of tables containing two fields, `pos` and `prob`.
2306 * `pos` is the 3D vector specifying the absolute coordinates of the
2307 node being modified,
2308 * `prob` is the integer value from `0` to `255` of the probability (see: Schematic specifier).
2309 * If there are two or more entries with the same pos value, the
2311 * If `pos` is not inside the box formed by `p1` and `p2`, it is ignored.
2312 * If `probability_list` equals `nil`, no probabilities are applied.
2313 * Slice probability works in the same manner, except takes a field
2314 called `ypos` instead which
2315 indicates the y position of the slice with a probability applied.
2316 * If slice probability list equals `nil`, no slice probabilities are applied.
2317 * Saves schematic in the Minetest Schematic format to filename.
2319 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement)`
2320 * Place the schematic specified by schematic (see: Schematic specifier) at `pos`.
2321 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
2322 * If the `rotation` parameter is omitted, the schematic is not rotated.
2323 * `replacements` = `{["old_name"] = "convert_to", ...}`
2324 * `force_placement` is a boolean indicating whether nodes other than `air` and
2325 `ignore` are replaced by the schematic
2326 * Returns nil if the schematic could not be loaded.
2328 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement)`:
2329 * This function is analagous to minetest.place_schematic, but places a schematic onto the
2330 specified VoxelManip object `vmanip` instead of the whole map.
2331 * Returns false if any part of the schematic was cut-off due to the VoxelManip not
2332 containing the full area required, and true if the whole schematic was able to fit.
2333 * Returns nil if the schematic could not be loaded.
2334 * After execution, any external copies of the VoxelManip contents are invalidated.
2336 * `minetest.serialize_schematic(schematic, format, options)`
2337 * Return the serialized schematic specified by schematic (see: Schematic specifier)
2338 * in the `format` of either "mts" or "lua".
2339 * "mts" - a string containing the binary MTS data used in the MTS file format
2340 * "lua" - a string containing Lua code representing the schematic in table format
2341 * `options` is a table containing the following optional parameters:
2342 * If `lua_use_comments` is true and `format` is "lua", the Lua code generated will have (X, Z)
2343 * position comments for every X row generated in the schematic data for easier reading.
2344 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua", the Lua code generated
2345 * will use that number of spaces as indentation instead of a tab character.
2348 * `minetest.request_http_api()`:
2349 * returns `HTTPApiTable` containing http functions if the calling mod has been granted
2350 access by being listed in the `secure.http_mods` or `secure.trusted_mods` setting,
2351 otherwise returns `nil`.
2352 * The returned table contains the functions `fetch`, `fetch_async` and `fetch_async_get`
2354 * Only works at init time and must be called from the mod's main scope (not from a function).
2355 * Function only exists if minetest server was built with cURL support.
2356 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
2358 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
2359 * Performs given request asynchronously and calls callback upon completion
2360 * callback: `function(HTTPRequestResult res)`
2361 * Use this HTTP function if you are unsure, the others are for advanced use.
2362 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
2363 * Performs given request asynchronously and returns handle for `minetest.http_fetch_async_get`
2364 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
2365 * Return response data for given asynchronous HTTP request
2368 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
2369 * `minetest.hash_node_position({x=,y=,z=})`: returns an 48-bit integer
2370 * Gives a unique hash number for a node position (16+16+16=48bit)
2371 * `minetest.get_position_from_hash(hash)`: returns a position
2372 * Inverse transform of `minetest.hash_node_position`
2373 * `minetest.get_item_group(name, group)`: returns a rating
2374 * Get rating of a group of an item. (`0` means: not in group)
2375 * `minetest.get_node_group(name, group)`: returns a rating
2376 * Deprecated: An alias for the former.
2377 * `minetest.raillike_group(name)`: returns a rating
2378 * Returns rating of the connect_to_raillike group corresponding to name
2379 * If name is not yet the name of a connect_to_raillike group, a new group id
2380 * is created, with that name
2381 * `minetest.get_content_id(name)`: returns an integer
2382 * Gets the internal content ID of `name`
2383 * `minetest.get_name_from_content_id(content_id)`: returns a string
2384 * Gets the name of the content with that content ID
2385 * `minetest.parse_json(string[, nullvalue])`: returns something
2386 * Convert a string containing JSON data into the Lua equivalent
2387 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
2388 * On success returns a table, a string, a number, a boolean or `nullvalue`
2389 * On failure outputs an error message and returns `nil`
2390 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
2391 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
2392 * Convert a Lua table into a JSON string
2393 * styled: Outputs in a human-readable format if this is set, defaults to false
2394 * Unserializable things like functions and userdata are saved as null.
2395 * **Warning**: JSON is more strict than the Lua table format.
2396 1. You can only use strings and positive integers of at least one as keys.
2397 2. You can not mix string and integer keys.
2398 This is due to the fact that JSON has two distinct array and object values.
2399 * Example: `write_json({10, {a = false}})`, returns `"[10, {\"a\": false}]"`
2400 * `minetest.serialize(table)`: returns a string
2401 * Convert a table containing tables, strings, numbers, booleans and `nil`s
2402 into string form readable by `minetest.deserialize`
2403 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
2404 * `minetest.deserialize(string)`: returns a table
2405 * Convert a string returned by `minetest.deserialize` into a table
2406 * `string` is loaded in an empty sandbox environment.
2407 * Will load functions, but they cannot access the global environment.
2408 * Example: `deserialize('return { ["foo"] = "bar" }')`, returns `{foo='bar'}`
2409 * Example: `deserialize('print("foo")')`, returns `nil` (function call fails)
2410 * `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
2411 * `minetest.compress(data, method, ...)`: returns `compressed_data`
2412 * Compress a string of data.
2413 * `method` is a string identifying the compression method to be used.
2414 * Supported compression methods:
2415 * Deflate (zlib): `"deflate"`
2416 * `...` indicates method-specific arguments. Currently defined arguments are:
2417 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
2418 * `minetest.decompress(compressed_data, method, ...)`: returns data
2419 * Decompress a string of data (using ZLib).
2420 * See documentation on `minetest.compress()` for supported compression methods.
2421 * currently supported.
2422 * `...` indicates method-specific arguments. Currently, no methods use this.
2423 * `minetest.is_protected(pos, name)`: returns boolean
2424 * Returns true, if player `name` shouldn't be abled to dig at `pos` or do other
2425 actions, defineable by mods, due to some mod-defined ownership-like concept.
2426 Returns false or nil, if the player is allowed to do such actions.
2427 * This function should be overridden by protection mods and should be used to
2428 check if a player can interact at a position.
2429 * This function should call the old version of itself if the position is not
2430 protected by the mod.
2433 local old_is_protected = minetest.is_protected
2434 function minetest.is_protected(pos, name)
2435 if mymod:position_protected_from(pos, name) then
2438 return old_is_protected(pos, name)
2440 * `minetest.record_protection_violation(pos, name)`
2441 * This function calls functions registered with
2442 `minetest.register_on_protection_violation`.
2443 * `minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)`
2444 * Attempt to predict the desired orientation of the facedir-capable node
2445 defined by `itemstack`, and place it accordingly (on-wall, on the floor, or
2446 hanging from the ceiling). Stacks are handled normally if the `infinitestacks`
2447 field is false or omitted (else, the itemstack is not changed). `orient_flags`
2448 is an optional table containing extra tweaks to the placement code:
2449 * `invert_wall`: if `true`, place wall-orientation on the ground and ground-
2450 orientation on the wall.
2451 * `force_wall` : if `true`, always place the node in wall orientation.
2452 * `force_ceiling`: if `true`, always place on the ceiling.
2453 * `force_floor`: if `true`, always place the node on the floor.
2454 * `force_facedir`: if `true`, forcefully reset the facedir to north when placing on
2455 the floor or ceiling
2456 * The first four options are mutually-exclusive; the last in the list takes
2457 precedence over the first.
2458 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
2459 * calls `rotate_and_place()` with infinitestacks set according to the state of
2460 the creative mode setting, and checks for "sneak" to set the `invert_wall`
2463 * `minetest.forceload_block(pos)`
2464 * forceloads the position `pos`.
2465 * returns `true` if area could be forceloaded
2466 * Please note that forceloaded areas are saved when the server restarts.
2468 * `minetest.forceload_free_block(pos)`
2469 * stops forceloading the position `pos`
2471 * `minetest.request_insecure_environment()`: returns an environment containing
2472 insecure functions if the calling mod has been listed as trusted in the
2473 `secure.trusted_mods` setting or security is disabled, otherwise returns `nil`.
2474 * Only works at init time and must be called from the mod's main scope (not from a function).
2475 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE IT IN
2478 * `minetest.global_exists(name)`
2479 * Checks if a global variable has been set, without triggering a warning.
2482 * `minetest.env`: `EnvRef` of the server environment and world.
2483 * Any function in the minetest namespace can be called using the syntax
2484 `minetest.env:somefunction(somearguments)`
2485 instead of `minetest.somefunction(somearguments)`
2486 * Deprecated, but support is not to be dropped soon
2489 * `minetest.registered_items`
2490 * Map of registered items, indexed by name
2491 * `minetest.registered_nodes`
2492 * Map of registered node definitions, indexed by name
2493 * `minetest.registered_craftitems`
2494 * Map of registered craft item definitions, indexed by name
2495 * `minetest.registered_tools`
2496 * Map of registered tool definitions, indexed by name
2497 * `minetest.registered_entities`
2498 * Map of registered entity prototypes, indexed by name
2499 * `minetest.object_refs`
2500 * Map of object references, indexed by active object id
2501 * `minetest.luaentities`
2502 * Map of Lua entities, indexed by active object id
2503 * `minetest.registered_ores`
2504 * List of registered ore definitions.
2505 * `minetest.registered_biomes`
2506 * List of registered biome definitions.
2507 * `minetest.registered_decorations`
2508 * List of registered decoration definitions.
2514 Node metadata: reference extra data and functionality stored in a node.
2515 Can be gotten via `minetest.get_meta(pos)`.
2518 * `set_string(name, value)`
2519 * `get_string(name)`
2520 * `set_int(name, value)`
2522 * `set_float(name, value)`
2524 * `get_inventory()`: returns `InvRef`
2525 * `to_table()`: returns `nil` or `{fields = {...}, inventory = {list1 = {}, ...}}`
2526 * `from_table(nil or {})`
2527 * See "Node Metadata"
2530 Node Timers: a high resolution persistent per-node timer.
2531 Can be gotten via `minetest.get_node_timer(pos)`.
2534 * `set(timeout,elapsed)`
2535 * set a timer's state
2536 * `timeout` is in seconds, and supports fractional values (0.1 etc)
2537 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
2538 * will trigger the node's `on_timer` function after `timeout`-elapsed seconds
2541 * equivalent to `set(timeout,0)`
2544 * `get_timeout()`: returns current timeout in seconds
2545 * if `timeout` equals `0`, timer is inactive
2546 * `get_elapsed()`: returns current elapsed time in seconds
2547 * the node's `on_timer` function will be called after `timeout`-elapsed seconds
2548 * `is_started()`: returns boolean state of timer
2549 * returns `true` if timer is started, otherwise `false`
2552 Moving things in the game are generally these.
2554 This is basically a reference to a C++ `ServerActiveObject`
2557 * `remove()`: remove object (after returning from Lua)
2558 * Note: Doesn't work on players, use minetest.kick_player instead
2559 * `getpos()`: returns `{x=num, y=num, z=num}`
2560 * `setpos(pos)`; `pos`=`{x=num, y=num, z=num}`
2561 * `moveto(pos, continuous=false)`: interpolated move
2562 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
2563 * `puncher` = another `ObjectRef`,
2564 * `time_from_last_punch` = time since last punch action of the puncher
2565 * `direction`: can be `nil`
2566 * `right_click(clicker)`; `clicker` is another `ObjectRef`
2567 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
2568 * `set_hp(hp)`: set number of hitpoints (2 * number of hearts)
2569 * `get_inventory()`: returns an `InvRef`
2570 * `get_wield_list()`: returns the name of the inventory list the wielded item is in
2571 * `get_wield_index()`: returns the index of the wielded item
2572 * `get_wielded_item()`: returns an `ItemStack`
2573 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if successful
2574 * `set_armor_groups({group1=rating, group2=rating, ...})`
2575 * `get_armor_groups()`: returns a table with the armor group ratings
2576 * `set_animation({x=1,y=1}, frame_speed=15, frame_blend=0, frame_loop=true)`
2577 * `get_animation()`: returns range, frame_speed, frame_blend and frame_loop
2578 * `set_attach(parent, bone, position, rotation)`
2580 * `position`: `{x=num, y=num, z=num}` (relative)
2581 * `rotation`: `{x=num, y=num, z=num}`
2582 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't attached
2584 * `set_bone_position(bone, position, rotation)`
2586 * `position`: `{x=num, y=num, z=num}` (relative)
2587 * `rotation`: `{x=num, y=num, z=num}`
2588 * `get_bone_position(bone)`: returns position and rotation of the bone
2589 * `set_properties(object property table)`
2590 * `get_properties()`: returns object property table
2591 * `is_player()`: returns true for players, false otherwise
2592 * `get_nametag_attributes()`
2593 * returns a table with the attributes of the nametag of an object
2595 color = {a=0..255, r=0..255, g=0..255, b=0..255},
2598 * `set_nametag_attributes(attributes)`
2599 * sets the attributes of the nametag of an object
2603 text = "My Nametag",
2606 ##### LuaEntitySAO-only (no-op for other objects)
2607 * `setvelocity({x=num, y=num, z=num})`
2608 * `getvelocity()`: returns `{x=num, y=num, z=num}`
2609 * `setacceleration({x=num, y=num, z=num})`
2610 * `getacceleration()`: returns `{x=num, y=num, z=num}`
2612 * `getyaw()`: returns number in radians
2613 * `settexturemod(mod)`
2614 * `setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
2615 select_horiz_by_yawpitch=false)`
2616 * Select sprite from spritesheet with optional animation and DM-style
2617 texture selection based on yaw relative to camera
2618 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
2621 ##### Player-only (no-op for other objects)
2622 * `get_player_name()`: returns `""` if is not a player
2623 * `get_player_velocity()`: returns `nil` if is not a player otherwise a table {x, y, z} representing the player's instantaneous velocity in nodes/s
2624 * `get_look_dir()`: get camera direction as a unit vector
2625 * `get_look_pitch()`: pitch in radians
2626 * `get_look_yaw()`: yaw in radians (wraps around pretty randomly as of now)
2627 * `set_look_pitch(radians)`: sets look pitch
2628 * `set_look_yaw(radians)`: sets look yaw
2629 * `get_breath()`: returns players breath
2630 * `set_breath(value)`: sets players breath
2632 * `0`: player is drowning,
2633 * `1`-`10`: remaining number of bubbles
2634 * `11`: bubbles bar is not shown
2635 * `set_inventory_formspec(formspec)`
2636 * Redefine player's inventory form
2637 * Should usually be called in on_joinplayer
2638 * `get_inventory_formspec()`: returns a formspec string
2639 * `get_player_control()`: returns table with player pressed keys
2640 * `{jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}`
2641 * `get_player_control_bits()`: returns integer with bit packed player pressed keys
2642 * bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
2643 * `set_physics_override(override_table)`
2644 * `override_table` is a table with the following fields:
2645 * `speed`: multiplier to default walking speed value (default: `1`)
2646 * `jump`: multiplier to default jump value (default: `1`)
2647 * `gravity`: multiplier to default gravity value (default: `1`)
2648 * `sneak`: whether player can sneak (default: `true`)
2649 * `sneak_glitch`: whether player can use the sneak glitch (default: `true`)
2650 * `get_physics_override()`: returns the table given to set_physics_override
2651 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
2653 * `hud_remove(id)`: remove the HUD element of the specified id
2654 * `hud_change(id, stat, value)`: change a value of a previously added HUD element
2655 * element `stat` values: `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
2656 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
2657 * `hud_set_flags(flags)`: sets specified HUD flags to `true`/`false`
2658 * `flags`: (is visible) `hotbar`, `healthbar`, `crosshair`, `wielditem`, `minimap`
2659 * pass a table containing a `true`/`false` value of each flag to be set or unset
2660 * if a flag equals `nil`, the flag is not modified
2661 * note that setting `minimap` modifies the client's permission to view the minimap -
2662 * the client may locally elect to not view the minimap
2663 * `hud_get_flags()`: returns a table containing status of hud flags
2664 * returns `{ hotbar=true, healthbar=true, crosshair=true, wielditem=true, breathbar=true, minimap=true }`
2665 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
2666 * `count`: number of items, must be between `1` and `23`
2667 * `hud_get_hotbar_itemcount`: returns number of visible items
2668 * `hud_set_hotbar_image(texturename)`
2669 * sets background image for hotbar
2670 * `hud_get_hotbar_image`: returns texturename
2671 * `hud_set_hotbar_selected_image(texturename)`
2672 * sets image for selected item of hotbar
2673 * `hud_get_hotbar_selected_image`: returns texturename
2674 * `hud_replace_builtin(name, hud_definition)`
2675 * replace definition of a builtin hud element
2676 * `name`: `"breath"` or `"health"`
2677 * `hud_definition`: definition to replace builtin definition
2678 * `set_sky(bgcolor, type, {texture names})`
2679 * `bgcolor`: ColorSpec, defaults to white
2681 * `"regular"`: Uses 0 textures, `bgcolor` ignored
2682 * `"skybox"`: Uses 6 textures, `bgcolor` used
2683 * `"plain"`: Uses 0 textures, `bgcolor` used
2684 * `get_sky()`: returns bgcolor, type and a table with the textures
2685 * `override_day_night_ratio(ratio or nil)`
2686 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific amount
2687 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
2688 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
2689 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`
2691 set animation for player model in third person view
2693 set_local_animation({x=0, y=79}, -- < stand/idle animation key frames
2694 {x=168, y=187}, -- < walk animation key frames
2695 {x=189, y=198}, -- < dig animation key frames
2696 {x=200, y=219}, -- < walk+dig animation key frames
2697 frame_speed=30): -- < animation frame speed
2698 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and frame_speed
2699 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for camera per player
2700 * in first person view
2701 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
2702 * `get_eye_offset()`: returns offset_first and offset_third
2705 An `InvRef` is a reference to an inventory.
2708 * `is_empty(listname)`: return `true` if list is empty
2709 * `get_size(listname)`: get size of a list
2710 * `set_size(listname, size)`: set size of a list
2711 * returns `false` on error (e.g. invalid `listname` or `size`)
2712 * `get_width(listname)`: get width of a list
2713 * `set_width(listname, width)`: set width of list; currently used for crafting
2714 * `get_stack(listname, i)`: get a copy of stack index `i` in list
2715 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
2716 * `get_list(listname)`: return full list
2717 * `set_list(listname, list)`: set full list (size will not change)
2718 * `get_lists()`: returns list of inventory lists
2719 * `set_lists(lists)`: sets inventory lists (size will not change)
2720 * `add_item(listname, stack)`: add item somewhere in list, returns leftover `ItemStack`
2721 * `room_for_item(listname, stack):` returns `true` if the stack of items
2722 can be fully added to the list
2723 * `contains_item(listname, stack)`: returns `true` if the stack of items
2724 can be fully taken from the list
2725 * `remove_item(listname, stack)`: take as many items as specified from the list,
2726 returns the items that were actually removed (as an `ItemStack`) -- note that
2727 any item metadata is ignored, so attempting to remove a specific unique
2728 item this way will likely remove the wrong one -- to do that use `set_stack`
2729 with an empty `ItemStack`
2730 * `get_location()`: returns a location compatible to `minetest.get_inventory(location)`
2731 * returns `{type="undefined"}` in case location is not known
2734 A fast access data structure to store areas, and find areas near a given position or area.
2735 Every area has a `data` string attribute to store additional information.
2736 You can create an empty `AreaStore` by calling `AreaStore()`, or `AreaStore(type_name)`.
2737 If you chose the parameter-less constructor, a fast implementation will be automatically chosen for you.
2740 * `get_area(id, include_borders, include_data)`: returns the area with the id `id`. (optional) Boolean values `include_borders` and `include_data` control what's copied.
2741 * `get_areas_for_pos(pos, include_borders, include_data)`: returns all areas that contain the position `pos`. (optional) Boolean values `include_borders` and `include_data` control what's copied.
2742 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`: returns all areas that contain all nodes inside the area specified by `edge1` and `edge2` (inclusive). If `accept_overlap` is true, also areas are returned that have nodes in common with the specified area. (optional) Boolean values `include_borders` and `include_data` control what's copied.
2743 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store. Returns the new area's ID, or nil if the insertion failed. The (inclusive) positions `edge1` and `edge2` describe the area. `data` is a string stored with the area. If passed, `id` will be used as the internal area ID, it must be a unique number between 0 and 2^32-2. If you use the `id` parameter you must always use it, or insertions are likely to fail due to conflicts.
2744 * `reserve(count)`: reserves resources for at most `count` many contained areas. Only needed for efficiency, and only some implementations profit.
2745 * `remove_area(id)`: removes the area with the given id from the store, returns success.
2746 * `set_cache_params(params)`: sets params for the included prefiltering cache. Calling invalidates the cache, so that its elements have to be newly generated.
2749 enabled = boolean, -- whether to enable, default true
2750 block_radius = number, -- the radius (in nodes) of the areas the cache generates prefiltered lists for, minimum 16, default 64
2751 limit = number, -- the cache's size, minimum 20, default 1000
2753 * `to_string()`: Experimental. Returns area store serialized as a (binary) string.
2754 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to a file.
2755 * `from_string(str)`: Experimental. Deserializes string and loads it into the AreaStore. Returns success and, optionally, an error message.
2756 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data from a file.
2759 An `ItemStack` is a stack of items.
2761 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
2762 an itemstring, a table or `nil`.
2765 * `is_empty()`: Returns `true` if stack is empty.
2766 * `get_name()`: Returns item name (e.g. `"default:stone"`).
2767 * `set_name(item_name)`: Returns boolean success.
2768 Clears item on failure.
2769 * `get_count()`: Returns number of items on the stack.
2770 * `set_count(count)`
2771 * `get_wear()`: Returns tool wear (`0`-`65535`), `0` for non-tools.
2772 * `set_wear(wear)`: Returns boolean success.
2773 Clears item on failure.
2774 * `get_metadata()`: Returns metadata (a string attached to an item stack).
2775 * `set_metadata(metadata)`: Returns true.
2776 * `clear()`: removes all items from the stack, making it empty.
2777 * `replace(item)`: replace the contents of this stack.
2778 * `item` can also be an itemstring or table.
2779 * `to_string()`: Returns the stack in itemstring form.
2780 * `to_table()`: Returns the stack in Lua table form.
2781 * `get_stack_max()`: Returns the maximum size of the stack (depends on the item).
2782 * `get_free_space()`: Returns `get_stack_max() - get_count()`.
2783 * `is_known()`: Returns `true` if the item name refers to a defined item type.
2784 * `get_definition()`: Returns the item definition table.
2785 * `get_tool_capabilities()`: Returns the digging properties of the item,
2786 or those of the hand if none are defined for this item type
2787 * `add_wear(amount)`: Increases wear by `amount` if the item is a tool.
2788 * `add_item(item)`: Put some item or stack onto this stack.
2789 Returns leftover `ItemStack`.
2790 * `item_fits(item)`: Returns `true` if item or stack can be fully added to
2792 * `take_item(n=1)`: Take (and remove) up to `n` items from this stack.
2793 Returns taken `ItemStack`.
2794 * `peek_item(n=1)`: copy (don't remove) up to `n` items from this stack.
2795 Returns taken `ItemStack`.
2798 A 16-bit pseudorandom number generator.
2799 Uses a well-known LCG algorithm introduced by K&R.
2801 It can be created via `PseudoRandom(seed)`.
2804 * `next()`: return next integer random number [`0`...`32767`]
2805 * `next(min, max)`: return next integer random number [`min`...`max`]
2806 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
2807 due to the simple implementation making bad distribution otherwise.
2810 A 32-bit pseudorandom number generator.
2811 Uses PCG32, an algorithm of the permuted congruential generator family, offering very strong randomness.
2813 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
2816 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
2817 * `next(min, max)`: return next integer random number [`min`...`max`]
2818 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed random number [`min`...`max`]
2819 * This is only a rough approximation of a normal distribution with mean=(max-min)/2 and variance=1
2820 * Increasing num_trials improves accuracy of the approximation
2823 Interface for the operating system's crypto-secure PRNG.
2825 It can be created via `SecureRandom()`. The constructor returns nil if a secure random device cannot be
2826 be found on the system.
2829 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many random bytes, as a string.
2832 A perlin noise generator.
2833 It can be created via `PerlinNoise(seed, octaves, persistence, scale)`
2834 or `PerlinNoise(noiseparams)`.
2835 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
2836 or `minetest.get_perlin(noiseparams)`.
2839 * `get2d(pos)`: returns 2D noise value at `pos={x=,y=}`
2840 * `get3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
2842 ### `PerlinNoiseMap`
2843 A fast, bulk perlin noise generator.
2845 It can be created via `PerlinNoiseMap(noiseparams, size)` or
2846 `minetest.get_perlin_map(noiseparams, size)`.
2848 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` conponent is ommitted
2849 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
2852 For each of the functions with an optional `buffer` parameter: If `buffer` is not
2853 nil, this table will be used to store the result instead of creating a new table.
2857 * `get2dMap(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
2858 with values starting at `pos={x=,y=}`
2859 * `get3dMap(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>` 3D array
2860 of 3D noise with values starting at `pos={x=,y=,z=}`
2861 * `get2dMap_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element array of 2D noise
2862 with values starting at `pos={x=,y=}`
2863 * `get3dMap_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
2864 * `calc2dMap(pos)`: Calculates the 2d noise map starting at `pos`. The result is stored internally.
2865 * `calc3dMap(pos)`: Calculates the 3d noise map starting at `pos`. The result is stored internally.
2866 * `getMapSlice(slice_offset, slice_size, buffer)`: In the form of an array, returns a slice of the
2867 most recently computed noise results. The result slice begins at coordinates `slice_offset` and
2868 takes a chunk of `slice_size`.
2869 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer offset y = 20:
2870 `noisevals = noise:getMapSlice({y=20}, {y=2})`
2871 It is important to note that `slice_offset` offset coordinates begin at 1, and are relative to
2872 the starting position of the most recently calculated noise.
2873 To grab a single vertical column of noise starting at map coordinates x = 1023, y=1000, z = 1000:
2874 `noise:calc3dMap({x=1000, y=1000, z=1000})`
2875 `noisevals = noise:getMapSlice({x=24, z=1}, {x=1, z=1})`
2879 #### About VoxelManip
2880 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator' facility. The purpose of
2881 this object is for fast, low-level, bulk access to reading and writing Map content. As such, setting
2882 map nodes through VoxelManip will lack many of the higher level features and concepts you may be used
2883 to with other methods of setting nodes. For example, nodes will not have their construction and
2884 destruction callbacks run, and no rollback information is logged.
2886 It is important to note that VoxelManip is designed for speed, and *not* ease of use or flexibility.
2887 If your mod requires a map manipulation facility that will handle 100% of all edge cases, or the use
2888 of high level node placement features, perhaps minetest.set_node() is better suited for the job.
2890 In addition, VoxelManip might not be faster, or could even be slower, for your specific use case.
2891 VoxelManip is most effective when setting very large areas of map at once - for example, if only
2892 setting a 5x5x5 node area, a minetest.set_node() loop may be more optimal. Always profile code
2893 using both methods of map manipulation to determine which is most appropriate for your usage.
2895 #### Using VoxelManip
2896 A VoxelManip object can be created any time using either:
2897 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
2899 If the optional position parameters are present for either of these routines, the specified region
2900 will be pre-loaded into the VoxelManip object on creation. Otherwise, the area of map you wish to
2901 manipulate must first be loaded into the VoxelManip object using `VoxelManip:read_from_map()`.
2903 Note that `VoxelManip:read_from_map()` returns two position vectors. The region formed by these
2904 positions indicate the minimum and maximum (respectively) positions of the area actually loaded in
2905 the VoxelManip, which may be larger than the area requested. For convenience, the loaded area
2906 coordinates can also be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
2908 Now that the VoxelManip object is populated with map data, your mod can fetch a copy of this data
2909 using either of two methods. `VoxelManip:get_node_at()`, which retrieves an individual node in a
2910 MapNode formatted table at the position requested is the simplest method to use, but also the slowest.
2912 Nodes in a VoxelManip object may also be read in bulk to a flat array table using:
2913 `VoxelManip:get_data()` for node content (in Content ID form, see section 'Content IDs'),
2914 `VoxelManip:get_light_data()` for node light levels, and
2915 `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
2917 See section 'Flat array format' for more details.
2919 It is very important to understand that the tables returned by any of the above three functions
2920 represent a snapshot of the VoxelManip's internal state at the time of the call. This copy of the
2921 data will *not* magically update itself if another function modifies the internal VoxelManip state.
2922 Any functions that modify a VoxelManip's contents work on the VoxelManip's internal state unless
2923 otherwise explicitly stated.
2925 Once the bulk data has been edited to your liking, the internal VoxelManip state can be set using:
2926 `VoxelManip:set_data()` for node content (in Content ID form, see section 'Content IDs'),
2927 `VoxelManip:set_light_data()` for node light levels, and
2928 `VoxelManip:set_param2_data()` for the node type-dependent "param2" values.
2930 The parameter to each of the above three functions can use any table at all in the same flat array
2931 format as produced by get_data() et al. and is *not required* to be a table retrieved from get_data().
2933 Once the internal VoxelManip state has been modified to your liking, the changes can be committed back
2934 to the map by calling `VoxelManip:write_to_map()`.
2936 Finally, a call to `VoxelManip:update_map()` is required to re-calculate lighting and set the blocks
2937 as being modified so that connected clients are sent the updated parts of map.
2940 ##### Flat array format
2942 `Nx = p2.X - p1.X + 1`,
2943 `Ny = p2.Y - p1.Y + 1`, and
2944 `Nz = p2.Z - p1.Z + 1`.
2946 Then, for a loaded region of p1..p2, this array ranges from `1` up to and including the value of
2947 the expression `Nx * Ny * Nz`.
2949 Positions offset from p1 are present in the array with the format of:
2952 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
2953 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
2955 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
2956 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
2958 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
2960 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
2964 and the array index for a position p contained completely in p1..p2 is:
2966 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
2968 Note that this is the same "flat 3D array" format as `PerlinNoiseMap:get3dMap_flat()`.
2969 VoxelArea objects (see section 'VoxelArea') can be used to simplify calculation of the index
2970 for a single point in a flat VoxelManip array.
2973 A Content ID is a unique integer identifier for a specific node type. These IDs are used by VoxelManip
2974 in place of the node name string for `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
2975 `minetest.get_content_id()` to look up the Content ID for the specified node name, and
2976 `minetest.get_name_from_content_id()` to look up the node name string for a given Content ID.
2977 After registration of a node, its Content ID will remain the same throughout execution of the mod.
2978 Note that the node being queried needs to have already been been registered.
2980 The following builtin node types have their Content IDs defined as constants:
2982 core.CONTENT_UNKNOWN (ID for "unknown" nodes)
2983 core.CONTENT_AIR (ID for "air" nodes)
2984 core.CONTENT_IGNORE (ID for "ignore" nodes)
2987 ##### Mapgen VoxelManip objects
2988 Inside of `on_generated()` callbacks, it is possible to retrieve the same VoxelManip object used by the
2989 core's Map Generator (commonly abbreviated Mapgen). Most of the rules previously described still apply
2990 but with a few differences:
2992 * The Mapgen VoxelManip object is retrieved using: `minetest.get_mapgen_object("voxelmanip")`
2993 * This VoxelManip object already has the region of map just generated loaded into it; it's not necessary
2994 to call `VoxelManip:read_from_map()` before using a Mapgen VoxelManip.
2995 * The `on_generated()` callbacks of some mods may place individual nodes in the generated area using
2996 non-VoxelManip map modification methods. Because the same Mapgen VoxelManip object is passed through
2997 each `on_generated()` callback, it becomes necessary for the Mapgen VoxelManip object to maintain
2998 consistency with the current map state. For this reason, calling any of the following functions:
2999 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3000 will also update the Mapgen VoxelManip object's internal state active on the current thread.
3001 * After modifying the Mapgen VoxelManip object's internal buffer, it may be necessary to update lighting
3002 information using either: `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3003 * `VoxelManip:update_map()` does not need to be called after `write_to_map()`. The map update is performed
3004 automatically after all on_generated callbacks have been run for that generated block.
3006 ##### Other API functions operating on a VoxelManip
3007 If any VoxelManip contents were set to a liquid node, `VoxelManip:update_liquids()` must be called
3008 for these liquid nodes to begin flowing. It is recommended to call this function only after having
3009 written all buffered data back to the VoxelManip object, save for special situations where the modder
3010 desires to only have certain liquid nodes begin flowing.
3012 The functions `minetest.generate_ores()` and `minetest.generate_decorations()` will generate all
3013 registered decorations and ores throughout the full area inside of the specified VoxelManip object.
3015 `minetest.place_schematic_on_vmanip()` is otherwise identical to `minetest.place_schematic()`,
3016 except instead of placing the specified schematic directly on the map at the specified position, it
3017 will place the schematic inside of the VoxelManip.
3020 * Attempting to read data from a VoxelManip object before map is read will result in a zero-length
3021 array table for `VoxelManip:get_data()`, and an "ignore" node at any position for
3022 `VoxelManip:get_node_at()`.
3023 * If either a region of map has not yet been generated or is out-of-bounds of the map, that region is
3024 filled with "ignore" nodes.
3025 * Other mods, or the core itself, could possibly modify the area of map currently loaded into a VoxelManip
3026 object. With the exception of Mapgen VoxelManips (see above section), the internal buffers are not
3027 updated. For this reason, it is strongly encouraged to complete the usage of a particular VoxelManip
3028 object in the same callback it had been created.
3029 * If a VoxelManip object will be used often, such as in an `on_generated()` callback, consider passing
3030 a file-scoped table as the optional parameter to `VoxelManip:get_data()`, which serves as a static
3031 buffer the function can use to write map data to instead of returning a new table each call. This
3032 greatly enhances performance by avoiding unnecessary memory allocations.
3035 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object containing
3036 the region formed by `p1` and `p2`.
3037 * returns actual emerged `pmin`, actual emerged `pmax`
3038 * `write_to_map()`: Writes the data loaded from the `VoxelManip` back to the map.
3039 * **important**: data must be set using `VoxelManip:set_data()` before calling this
3040 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
3041 the `VoxelManip` at that position
3042 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at that position
3043 * `get_data([buffer])`: Retrieves the node content data loaded into the `VoxelManip` object
3044 * returns raw node data in the form of an array of node content IDs
3045 * if the param `buffer` is present, this table will be used to store the result instead
3046 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
3047 * `update_map()`: Update map after writing chunk back to map.
3048 * To be used only by `VoxelManip` objects created by the mod itself;
3049 not a `VoxelManip` that was retrieved from `minetest.get_mapgen_object`
3050 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to a uniform value
3051 * `light` is a table, `{day=<0...15>, night=<0...15>}`
3052 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
3053 * (`p1`, `p2`) is the area in which lighting is set;
3054 defaults to the whole area if left out
3055 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
3056 * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
3057 * Each value is the bitwise combination of day and night light values (`0` to `15` each)
3058 * `light = day + (night * 16)`
3059 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
3061 * expects lighting data in the same format that `get_light_data()` returns
3062 * `get_param2_data()`: Gets the raw `param2` data read into the `VoxelManip` object
3063 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in the `VoxelManip`
3064 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the `VoxelManip`
3065 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
3066 * (`p1`, `p2`) is the area in which lighting is set; defaults to the whole area
3068 * `propagate_shadow` is an optional boolean deciding whether shadows in a generated
3069 mapchunk above are propagated down into the mapchunk; defaults to `true` if left out
3070 * `update_liquids()`: Update liquid flow
3071 * `was_modified()`: Returns `true` or `false` if the data in the voxel manipulator
3072 had been modified since the last read from map, due to a call to
3073 `minetest.set_data()` on the loaded area elsewhere
3074 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
3077 A helper class for voxel areas.
3078 It can be created via `VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}`.
3079 The coordinates are *inclusive*, like most other things in Minetest.
3082 * `getExtent()`: returns a 3D vector containing the size of the area formed by
3083 `MinEdge` and `MaxEdge`
3084 * `getVolume()`: returns the volume of the area formed by `MinEdge` and `MaxEdge`
3085 * `index(x, y, z)`: returns the index of an absolute position in a flat array starting at `1`
3086 * useful for things like `VoxelManip`, raw Schematic specifiers,
3087 `PerlinNoiseMap:get2d`/`3dMap`, and so on
3088 * `indexp(p)`: same as above, except takes a vector
3089 * `position(i)`: returns the absolute position vector corresponding to index `i`
3090 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by `MinEdge` and `MaxEdge`
3091 * `containsp(p)`: same as above, except takes a vector
3092 * `containsi(i)`: same as above, except takes an index `i`
3093 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns indices
3094 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of `[z [y [x]]]`
3095 * `iterp(minp, maxp)`: same as above, except takes a vector
3098 An interface to read config files in the format of `minetest.conf`.
3100 It can be created via `Settings(filename)`.
3103 * `get(key)`: returns a value
3104 * `get_bool(key)`: returns a boolean
3106 * `remove(key)`: returns a boolean (`true` for success)
3107 * `get_names()`: returns `{key1,...}`
3108 * `write()`: returns a boolean (`true` for success)
3109 * write changes to file
3110 * `to_table()`: returns `{[key1]=value1,...}`
3114 A mapgen object is a construct used in map generation. Mapgen objects can be used
3115 by an `on_generate` callback to speed up operations by avoiding unnecessary
3116 recalculations; these can be retrieved using the `minetest.get_mapgen_object()`
3117 function. If the requested Mapgen object is unavailable, or `get_mapgen_object()`
3118 was called outside of an `on_generate()` callback, `nil` is returned.
3120 The following Mapgen objects are currently available:
3123 This returns three values; the `VoxelManip` object to be used, minimum and maximum
3124 emerged position, in that order. All mapgens support this object.
3127 Returns an array containing the y coordinates of the ground levels of nodes in
3128 the most recently generated chunk by the current mapgen.
3131 Returns an array containing the biome IDs of nodes in the most recently
3132 generated chunk by the current mapgen.
3135 Returns an array containing the temperature values of nodes in the most
3136 recently generated chunk by the current mapgen.
3139 Returns an array containing the humidity values of nodes in the most recently
3140 generated chunk by the current mapgen.
3143 Returns a table mapping requested generation notification types to arrays of
3144 positions at which the corresponding generated structures are located at within
3145 the current chunk. To set the capture of positions of interest to be recorded
3146 on generate, use `minetest.set_gen_notify()`.
3148 Possible fields of the table returned are:
3154 * `large_cave_begin`
3158 Decorations have a key in the format of `"decoration#id"`, where `id` is the
3159 numeric unique decoration ID.
3163 * Functions receive a "luaentity" as `self`:
3164 * It has the member `.name`, which is the registered name `("mod:thing")`
3165 * It has the member `.object`, which is an `ObjectRef` pointing to the object
3166 * The original prototype stuff is visible directly via a metatable
3168 * `on_activate(self, staticdata)`
3169 * Called when the object is instantiated.
3170 * `on_step(self, dtime)`
3171 * Called on every server tick, after movement and collision processing.
3172 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
3174 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir`
3175 * Called when somebody punches the object.
3176 * Note that you probably want to handle most punches using the
3177 automatic armor group system.
3178 * `puncher`: an `ObjectRef` (can be `nil`)
3179 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be `nil`)
3180 * `tool_capabilities`: capability table of used tool (can be `nil`)
3181 * `dir`: unit vector of direction of punch. Always defined. Points from
3182 the puncher to the punched.
3183 * `on_rightclick(self, clicker)`
3184 * `get_staticdata(self)`
3185 * Should return a string that will be passed to `on_activate` when
3186 the object is instantiated the next time.
3194 axiom, --string initial tree axiom
3195 rules_a, --string rules set A
3196 rules_b, --string rules set B
3197 rules_c, --string rules set C
3198 rules_d, --string rules set D
3199 trunk, --string trunk node name
3200 leaves, --string leaves node name
3201 leaves2, --string secondary leaves node name
3202 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
3203 angle, --num angle in deg
3204 iterations, --num max # of iterations, usually 2 -5
3205 random_level, --num factor to lower nr of iterations, usually 0 - 3
3206 trunk_type, --string single/double/crossed) type of trunk: 1 node,
3207 -- 2x2 nodes or 3x3 in cross shape
3208 thin_branches, --boolean true -> use thin (1 node) branches
3209 fruit, --string fruit node name
3210 fruit_chance, --num chance (0-100) to replace leaves with fruit node
3211 seed, --num random seed; if no seed is provided, the engine will create one
3214 ### Key for Special L-System Symbols used in Axioms
3216 * `G`: move forward one unit with the pen up
3217 * `F`: move forward one unit with the pen down drawing trunks and branches
3218 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
3219 * `T`: move forward one unit with the pen down drawing trunks only
3220 * `R`: move forward one unit with the pen down placing fruit
3221 * `A`: replace with rules set A
3222 * `B`: replace with rules set B
3223 * `C`: replace with rules set C
3224 * `D`: replace with rules set D
3225 * `a`: replace with rules set A, chance 90%
3226 * `b`: replace with rules set B, chance 80%
3227 * `c`: replace with rules set C, chance 70%
3228 * `d`: replace with rules set D, chance 60%
3229 * `+`: yaw the turtle right by `angle` parameter
3230 * `-`: yaw the turtle left by `angle` parameter
3231 * `&`: pitch the turtle down by `angle` parameter
3232 * `^`: pitch the turtle up by `angle` parameter
3233 * `/`: roll the turtle to the right by `angle` parameter
3234 * `*`: roll the turtle to the left by `angle` parameter
3235 * `[`: save in stack current state info
3236 * `]`: recover from stack state info
3239 Spawn a small apple tree:
3241 pos = {x=230,y=20,z=4}
3244 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
3245 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
3246 trunk="default:tree",
3247 leaves="default:leaves",
3251 trunk_type="single",
3254 fruit="default:apple"
3256 minetest.spawn_tree(pos,apple_tree)
3261 ### Object Properties
3266 collide_with_objects = true, -- collide with other objects if physical=true
3268 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
3269 visual = "cube"/"sprite"/"upright_sprite"/"mesh"/"wielditem",
3270 visual_size = {x=1, y=1},
3272 textures = {}, -- number of required textures depends on visual
3273 colors = {}, -- number of required colors depends on visual
3274 spritediv = {x=1, y=1},
3275 initial_sprite_basepos = {x=0, y=0},
3277 makes_footstep_sound = false,
3278 automatic_rotate = false,
3280 automatic_face_movement_dir = 0.0,
3281 -- ^ automatically set yaw to movement direction; offset in degrees; false to disable
3282 automatic_face_movement_max_rotation_per_sec = -1,
3283 -- ^ limit automatic rotation to this value in degrees per second. values < 0 no limit
3284 backface_culling = true, -- false to disable backface_culling for model
3285 nametag = "", -- by default empty, for players their name is shown if empty
3286 nametag_color = <color>, -- sets color of nametag as ColorSpec
3287 infotext = "", -- by default empty, text to be shown when pointed at object
3290 ### Entity definition (`register_entity`)
3293 -- Deprecated: Everything in object properties is read directly from here
3295 initial_properties = --[[<initial object properties>]],
3297 on_activate = function(self, staticdata, dtime_s),
3298 on_step = function(self, dtime),
3299 on_punch = function(self, hitter),
3300 on_rightclick = function(self, clicker),
3301 get_staticdata = function(self),
3302 -- ^ Called sometimes; the string returned is passed to on_activate when
3303 -- the entity is re-activated from static state
3305 -- Also you can define arbitrary member variables here
3306 myvariable = whatever,
3309 ### ABM (ActiveBlockModifier) definition (`register_abm`)
3312 -- In the following two fields, also group:groupname will work.
3313 nodenames = {"default:lava_source"},
3314 neighbors = {"default:water_source", "default:water_flowing"}, -- Any of these --[[
3315 ^ If left out or empty, any neighbor will do ]]
3316 interval = 1.0, -- Operation interval in seconds
3317 chance = 1, -- Chance of trigger per-node per-interval is 1.0 / this
3318 catch_up = true, -- If true, catch-up behaviour is enabled --[[
3319 ^ The chance value is temporarily reduced when returning to
3320 an area to simulate time lost by the area being unattended.
3321 ^ Note chance value can often be reduced to 1 ]]
3322 action = func(pos, node, active_object_count, active_object_count_wider),
3325 ### LBM (LoadingBlockModifier) definition (`register_lbm`)
3328 name = "modname:replace_legacy_door",
3329 nodenames = {"default:lava_source"},
3330 -- ^ List of node names to trigger the LBM on.
3331 -- Also non-registered nodes will work.
3332 -- Groups (as of group:groupname) will work as well.
3333 run_at_every_load = false,
3334 -- ^ Whether to run the LBM's action every time a block gets loaded,
3335 -- and not just for blocks that were saved last time before LBMs were
3336 -- introduced to the world.
3337 action = func(pos, node),
3340 ### Item definition (`register_node`, `register_craftitem`, `register_tool`)
3343 description = "Steel Axe",
3344 groups = {}, -- key=name, value=rating; rating=1..3.
3345 if rating not applicable, use 1.
3346 e.g. {wool=1, fluffy=3}
3347 {soil=2, outerspace=1, crumbly=1}
3348 {bendy=2, snappy=1},
3349 {hard=1, metal=1, spikes=1}
3350 inventory_image = "default_tool_steelaxe.png",
3352 wield_scale = {x=1,y=1,z=1},
3355 liquids_pointable = false,
3356 tool_capabilities = {
3357 full_punch_interval = 1.0,
3361 snappy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
3362 choppy={times={[3]=0.90}, maxwear=0.05, maxlevel=0}
3364 damage_groups = {groupname=damage},
3366 node_placement_prediction = nil,
3368 ^ If nil and item is node, prediction is made automatically
3369 ^ If nil and item is not a node, no prediction is made
3370 ^ If "" and item is anything, no prediction is made
3371 ^ Otherwise should be name of node which the client immediately places
3372 on ground when the player places the item. Server will always update
3373 actual result to client in a short moment.
3376 place = --[[<SimpleSoundSpec>]],
3379 on_place = func(itemstack, placer, pointed_thing),
3381 ^ Shall place item and return the leftover itemstack
3382 ^ default: minetest.item_place ]]
3383 on_secondary_use = func(itemstack, user, pointed_thing),
3385 ^ Same as on_place but called when pointing at nothing.
3386 ^ pointed_thing : always { type = "nothing" }
3388 on_drop = func(itemstack, dropper, pos),
3390 ^ Shall drop item and return the leftover itemstack
3391 ^ default: minetest.item_drop ]]
3392 on_use = func(itemstack, user, pointed_thing),
3395 ^ Function must return either nil if no item shall be removed from
3396 inventory, or an itemstack to replace the original itemstack.
3397 e.g. itemstack:take_item(); return itemstack
3398 ^ Otherwise, the function is free to do what it wants.
3399 ^ The default functions handle regular use cases.
3401 after_use = func(itemstack, user, node, digparams),
3404 ^ If defined, should return an itemstack and will be called instead of
3405 wearing out the tool. If returns nil, does nothing.
3406 If after_use doesn't exist, it is the same as:
3407 function(itemstack, user, node, digparams)
3408 itemstack:add_wear(digparams.wear)
3416 * `{name="image.png", animation={Tile Animation definition}}`
3417 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
3418 tileable_horizontal=bool}`
3419 * backface culling enabled by default for most nodes
3420 * tileable flags are info for shaders, how they should treat texture
3421 when displacement mapping is used
3422 Directions are from the point of view of the tile texture,
3423 not the node it's on
3424 * deprecated, yet still supported field names:
3427 ### Tile animation definition
3428 * `{type="vertical_frames", aspect_w=16, aspect_h=16, length=3.0}`
3430 ### Node definition (`register_node`)
3433 -- <all fields allowed in item definitions>,
3435 drawtype = "normal", -- See "Node drawtypes"
3436 visual_scale = 1.0, --[[
3437 ^ Supported for drawtypes "plantlike", "signlike", "torchlike", "mesh".
3438 ^ For plantlike, the image will start at the bottom of the node; for the
3439 ^ other drawtypes, the image will be centered on the node.
3440 ^ Note that positioning for "torchlike" may still change. ]]
3441 tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
3442 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
3443 ^ List can be shortened to needed length ]]
3444 special_tiles = {tile definition 1, Tile definition 2}, --[[
3445 ^ Special textures of node; used rarely (old field name: special_materials)
3446 ^ List can be shortened to needed length ]]
3448 use_texture_alpha = false, -- Use texture's alpha channel
3449 post_effect_color = "green#0F", -- If player is inside node, see "ColorSpec"
3450 paramtype = "none", -- See "Nodes" --[[
3451 ^ paramtype = "light" allows light to propagate from or through the node with light value
3452 ^ falling by 1 per node. This line is essential for a light source node to spread its light. ]]
3453 paramtype2 = "none", -- See "Nodes"
3454 is_ground_content = true, -- If false, the cave generator will not carve through this
3455 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
3456 walkable = true, -- If true, objects collide with node
3457 pointable = true, -- If true, can be pointed at
3458 diggable = true, -- If false, can never be dug
3459 climbable = false, -- If true, can be climbed on (ladder)
3460 buildable_to = false, -- If true, placed nodes can replace this node
3461 floodable = false, -- If true, liquids flow into and replace this node
3462 liquidtype = "none", -- "none"/"source"/"flowing"
3463 liquid_alternative_flowing = "", -- Flowing version of source liquid
3464 liquid_alternative_source = "", -- Source version of flowing liquid
3465 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
3466 liquid_renewable = true, -- Can new liquid source be created by placing two or more sources nearby?
3468 ^ Block contains level in param2. Value is default level, used for snow.
3469 ^ Don't forget to use "leveled" type nodebox. ]]
3470 liquid_range = 8, -- number of flowing nodes around source (max. 8)
3471 drowning = 0, -- Player will take this amount of damage if no bubbles are left
3472 light_source = 0, -- Amount of light emitted by node
3473 damage_per_second = 0, -- If player is inside node, this damage is caused
3474 node_box = {type="regular"}, -- See "Node boxes"
3475 connects_to = nodenames, --[[
3476 * Used for nodebox nodes with the type == "connected"
3477 * Specifies to what neighboring nodes connections will be drawn
3478 * e.g. `{"group:fence", "default:wood"}` or `"default:stone"` ]]
3479 connect_sides = { "top", "bottom", "front", "left", "back", "right" }, --[[
3480 ^ Tells connected nodebox nodes to connect only to these sides of this node. ]]
3482 selection_box = {type="regular"}, -- See "Node boxes" --[[
3483 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used. ]]
3484 legacy_facedir_simple = false, -- Support maps made in and before January 2012
3485 legacy_wallmounted = false, -- Support maps made in and before January 2012
3487 footstep = <SimpleSoundSpec>,
3488 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
3489 dug = <SimpleSoundSpec>,
3490 place = <SimpleSoundSpec>,
3491 place_failed = <SimpleSoundSpec>,
3493 drop = "", -- Name of dropped node when dug. Default is the node itself.
3496 max_items = 1, -- Maximum number of items to drop.
3497 items = { -- Choose max_items randomly from this list.
3499 items = {"foo:bar", "baz:frob"}, -- Choose one item randomly from this list.
3500 rarity = 1, -- Probability of getting is 1 / rarity.
3505 on_construct = func(pos), --[[
3506 ^ Node constructor; called after adding node
3507 ^ Can set up metadata and stuff like that
3508 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3510 on_destruct = func(pos), --[[
3511 ^ Node destructor; called before removing node
3512 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3514 after_destruct = func(pos, oldnode), --[[
3515 ^ Node destructor; called after removing node
3516 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3519 after_place_node = func(pos, placer, itemstack, pointed_thing) --[[
3520 ^ Called after constructing node when node was placed using
3521 minetest.item_place_node / minetest.place_node
3522 ^ If return true no item is taken from itemstack
3524 after_dig_node = func(pos, oldnode, oldmetadata, digger), --[[
3525 ^ oldmetadata is in table format
3526 ^ Called after destructing node when node was dug using
3527 minetest.node_dig / minetest.dig_node
3529 can_dig = function(pos, [player]) --[[
3530 ^ returns true if node can be dug, or false if not
3533 on_punch = func(pos, node, puncher, pointed_thing), --[[
3534 ^ default: minetest.node_punch
3535 ^ By default: Calls minetest.register_on_punchnode callbacks ]]
3536 on_rightclick = func(pos, node, clicker, itemstack, pointed_thing), --[[
3538 ^ if defined, itemstack will hold clicker's wielded item
3539 ^ Shall return the leftover itemstack
3540 ^ Note: pointed_thing can be nil, if a mod calls this function ]]
3542 on_dig = func(pos, node, digger), --[[
3543 ^ default: minetest.node_dig
3544 ^ By default: checks privileges, wears out tool and removes node ]]
3546 on_timer = function(pos,elapsed), --[[
3548 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
3549 ^ elapsed is the total time passed since the timer was started
3550 ^ return true to run the timer for another cycle with the same timeout value ]]
3552 on_receive_fields = func(pos, formname, fields, sender), --[[
3553 ^ fields = {name1 = value1, name2 = value2, ...}
3554 ^ Called when an UI form (e.g. sign text input) returns data
3557 allow_metadata_inventory_move = func(pos, from_list, from_index,
3558 to_list, to_index, count, player), --[[
3559 ^ Called when a player wants to move items inside the inventory
3560 ^ Return value: number of items allowed to move ]]
3562 allow_metadata_inventory_put = func(pos, listname, index, stack, player), --[[
3563 ^ Called when a player wants to put something into the inventory
3564 ^ Return value: number of items allowed to put
3565 ^ Return value: -1: Allow and don't modify item count in inventory ]]
3567 allow_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
3568 ^ Called when a player wants to take something out of the inventory
3569 ^ Return value: number of items allowed to take
3570 ^ Return value: -1: Allow and don't modify item count in inventory ]]
3572 on_metadata_inventory_move = func(pos, from_list, from_index,
3573 to_list, to_index, count, player),
3574 on_metadata_inventory_put = func(pos, listname, index, stack, player),
3575 on_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
3576 ^ Called after the actual action has happened, according to what was allowed.
3577 ^ No return value ]]
3579 on_blast = func(pos, intensity), --[[
3580 ^ intensity: 1.0 = mid range of regular TNT
3581 ^ If defined, called when an explosion touches the node, instead of
3582 removing the node ]]
3585 ### Recipe for `register_craft` (shaped)
3588 output = 'default:pick_stone',
3590 {'default:cobble', 'default:cobble', 'default:cobble'},
3591 {'', 'default:stick', ''},
3592 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
3594 replacements = --[[<optional list of item pairs,
3595 replace one input item with another item on crafting>]]
3598 ### Recipe for `register_craft` (shapeless)
3602 output = 'mushrooms:mushroom_stew',
3605 "mushrooms:mushroom_brown",
3606 "mushrooms:mushroom_red",
3608 replacements = --[[<optional list of item pairs,
3609 replace one input item with another item on crafting>]]
3612 ### Recipe for `register_craft` (tool repair)
3615 type = "toolrepair",
3616 additional_wear = -0.02,
3619 ### Recipe for `register_craft` (cooking)
3623 output = "default:glass",
3624 recipe = "default:sand",
3628 ### Recipe for `register_craft` (furnace fuel)
3632 recipe = "default:leaves",
3636 ### Ore definition (`register_ore`)
3639 ore_type = "scatter", -- See "Ore types"
3640 ore = "default:stone_with_coal",
3641 wherein = "default:stone",
3642 -- ^ a list of nodenames is supported too
3643 clust_scarcity = 8*8*8,
3644 -- ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
3645 -- ^ This value should be *MUCH* higher than your intuition might tell you!
3647 -- ^ Number of ores in a cluster
3649 -- ^ Size of the bounding box of the cluster
3650 -- ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
3654 -- ^ Attributes for this ore generation
3655 noise_threshold = 0.5,
3656 -- ^ If noise is above this threshold, ore is placed. Not needed for a uniform distribution
3657 noise_params = {offset=0, scale=1, spread={x=100, y=100, z=100}, seed=23, octaves=3, persist=0.70}
3658 -- ^ NoiseParams structure describing the perlin noise used for ore distribution.
3659 -- ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
3660 random_factor = 1.0,
3661 -- ^ Multiplier of the randomness contribution to the noise value at any
3662 -- given point to decide if ore should be placed. Set to 0 for solid veins.
3663 -- ^ This parameter is only valid for ore_type == "vein".
3664 biomes = {"desert", "rainforest"}
3665 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
3666 -- ^ and ignored if the Mapgen being used does not support biomes.
3667 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
3670 ### Biome definition (`register_biome`)
3674 node_dust = "default:snow",
3675 -- ^ Node dropped onto upper surface after all else is generated.
3676 node_top = "default:dirt_with_snow",
3678 -- ^ Node forming surface layer of biome and thickness of this layer.
3679 node_filler = "default:permafrost",
3681 -- ^ Node forming lower layer of biome and thickness of this layer.
3682 node_stone = "default:bluestone",
3683 -- ^ Node that replaces all stone nodes between roughly y_min and y_max.
3684 node_water_top = "default:ice",
3685 depth_water_top = 10,
3686 -- ^ Node forming a surface layer in seawater with the defined thickness.
3688 -- ^ Node that replaces all seawater nodes not in the defined surface layer.
3689 node_river_water = "default:ice",
3690 -- ^ Node that replaces river water in mapgens that use default:river_water.
3693 -- ^ Lower and upper limits for biome.
3694 -- ^ Because biome is not recalculated for every node in a node column
3695 -- ^ some biome materials can exceed their limits, especially stone.
3696 -- ^ For each node column in a mapchunk, biome is only recalculated at column
3697 -- ^ top and at each of these surfaces:
3698 -- ^ Ground below air, water below air, ground below water.
3699 -- ^ The selected biome then stays in effect for all nodes below until
3700 -- ^ column base or the next biome recalculation.
3702 humidity_point = 50,
3703 -- ^ Characteristic average temperature and humidity for the biome.
3704 -- ^ These values create 'biome points' on a voronoi diagram that has heat
3705 -- ^ and humidity as axes. The resulting voronoi cells determine which
3706 -- ^ heat/humidity points belong to which biome, and therefore determine
3707 -- ^ the area and location of each biome in the world.
3708 -- ^ The biome points need to be carefully and evenly spaced on the voronoi
3709 -- ^ diagram to result in roughly equal size biomes.
3710 -- ^ Heat and humidity have average values of 50, vary mostly between
3711 -- ^ 0 and 100 but also often exceed these values.
3712 -- ^ Heat is not in degrees celcius, both values are abstract.
3715 ### Decoration definition (`register_decoration`)
3718 deco_type = "simple", -- See "Decoration types"
3719 place_on = "default:dirt_with_grass",
3720 -- ^ Node that decoration can be placed on
3722 -- ^ Size of divisions made in the chunk being generated.
3723 -- ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
3725 -- ^ Ratio of the area to be uniformly filled by the decoration.
3726 -- ^ Used only if noise_params is not specified.
3727 noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
3728 -- ^ NoiseParams structure describing the perlin noise used for decoration distribution.
3729 -- ^ The result of this is multiplied by the 2d area of the division being decorated.
3730 biomes = {"Oceanside", "Hills", "Plains"},
3731 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
3732 -- ^ and ignored if the Mapgen being used does not support biomes.
3733 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
3736 -- ^ Minimum and maximum `y` positions these decorations can be generated at.
3737 -- ^ This parameter refers to the `y` position of the decoration base, so
3738 -- the actual maximum height would be `height_max + size.Y`.
3739 flags = "liquid_surface, force_placement",
3740 -- ^ Flags for all decoration types.
3741 -- ^ "liquid_surface": Instead of placement on the highest solid surface
3742 -- ^ in a mapchunk column, placement is on the highest liquid surface.
3743 -- ^ Placement is disabled if solid nodes are found above the liquid surface.
3744 -- ^ "force_placement": Nodes other than "air" and "ignore" are replaced by the decoration.
3746 ----- Simple-type parameters
3747 decoration = "default:grass",
3748 -- ^ The node name used as the decoration.
3749 -- ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
3751 -- ^ Number of nodes high the decoration is made.
3752 -- ^ If height_max is not 0, this is the lower bound of the randomly selected height.
3754 -- ^ Number of nodes the decoration can be at maximum.
3755 -- ^ If absent, the parameter 'height' is used as a constant.
3756 spawn_by = "default:water",
3757 -- ^ Node that the decoration only spawns next to.
3758 -- ^ The neighbours checked are the 8 nodes horizontally surrounding the lowest node of the
3759 -- ^ decoration, and the 8 nodes horizontally surrounding the ground node below the decoration.
3761 -- ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
3762 -- ^ If absent or -1, decorations occur next to any nodes.
3764 ----- Schematic-type parameters
3765 schematic = "foobar.mts",
3766 -- ^ If schematic is a string, it is the filepath relative to the current working directory of the
3767 -- ^ specified Minetest schematic file.
3768 -- ^ - OR -, could be the ID of a previously registered schematic
3769 -- ^ - OR -, could instead be a table containing two mandatory fields, size and data,
3770 -- ^ and an optional table yslice_prob:
3772 size = {x=4, y=6, z=4},
3774 {name="default:cobble", param1=255, param2=0},
3775 {name="default:dirt_with_grass", param1=255, param2=0},
3776 {name="ignore", param1=255, param2=0},
3777 {name="air", param1=255, param2=0},
3786 -- ^ See 'Schematic specifier' for details.
3787 replacements = {["oldname"] = "convert_to", ...},
3788 flags = "place_center_x, place_center_y, place_center_z",
3789 -- ^ Flags for schematic decorations. See 'Schematic attributes'.
3790 rotation = "90" -- rotate schematic 90 degrees on placement
3791 -- ^ Rotation can be "0", "90", "180", "270", or "random".
3794 ### Chat command definition (`register_chatcommand`)
3797 params = "<name> <privilege>", -- Short parameter description
3798 description = "Remove privilege from player", -- Full description
3799 privs = {privs=true}, -- Require the "privs" privilege to run
3800 func = function(name, param), -- Called when command is run.
3801 -- Returns boolean success and text output.
3804 ### Detached inventory callbacks
3807 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
3808 -- ^ Called when a player wants to move items inside the inventory
3809 -- ^ Return value: number of items allowed to move
3811 allow_put = func(inv, listname, index, stack, player),
3812 -- ^ Called when a player wants to put something into the inventory
3813 -- ^ Return value: number of items allowed to put
3814 -- ^ Return value: -1: Allow and don't modify item count in inventory
3816 allow_take = func(inv, listname, index, stack, player),
3817 -- ^ Called when a player wants to take something out of the inventory
3818 -- ^ Return value: number of items allowed to take
3819 -- ^ Return value: -1: Allow and don't modify item count in inventory
3821 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
3822 on_put = func(inv, listname, index, stack, player),
3823 on_take = func(inv, listname, index, stack, player),
3824 -- ^ Called after the actual action has happened, according to what was allowed.
3825 -- ^ No return value
3828 ### HUD Definition (`hud_add`, `hud_get`)
3831 hud_elem_type = "image", -- see HUD element types
3832 -- ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
3833 position = {x=0.5, y=0.5},
3834 -- ^ Left corner position of element
3840 -- ^ Selected item in inventory. 0 for no item selected.
3842 -- ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
3843 alignment = {x=0, y=0},
3844 -- ^ See "HUD Element Types"
3845 offset = {x=0, y=0},
3846 -- ^ See "HUD Element Types"
3847 size = { x=100, y=100 },
3848 -- ^ Size of element in pixels
3851 ### Particle definition (`add_particle`)
3854 pos = {x=0, y=0, z=0},
3855 velocity = {x=0, y=0, z=0},
3856 acceleration = {x=0, y=0, z=0},
3857 -- ^ Spawn particle at pos with velocity and acceleration
3859 -- ^ Disappears after expirationtime seconds
3861 collisiondetection = false,
3862 -- ^ collisiondetection: if true collides with physical objects
3864 -- ^ vertical: if true faces player using y axis only
3865 texture = "image.png",
3866 -- ^ Uses texture (string)
3867 playername = "singleplayer"
3868 -- ^ optional, if specified spawns particle only on the player's client
3871 ### `ParticleSpawner` definition (`add_particlespawner`)
3876 -- ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
3877 minpos = {x=0, y=0, z=0},
3878 maxpos = {x=0, y=0, z=0},
3879 minvel = {x=0, y=0, z=0},
3880 maxvel = {x=0, y=0, z=0},
3881 minacc = {x=0, y=0, z=0},
3882 maxacc = {x=0, y=0, z=0},
3887 -- ^ The particle's properties are random values in between the bounds:
3888 -- ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
3889 -- ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
3890 collisiondetection = false,
3891 -- ^ collisiondetection: if true uses collision detection
3893 -- ^ vertical: if true faces player using y axis only
3894 texture = "image.png",
3895 -- ^ Uses texture (string)
3896 playername = "singleplayer"
3897 -- ^ Playername is optional, if specified spawns particle only on the player's client
3900 ### `HTTPRequest` definition (`http_fetch`, `http_fetch_async`)
3903 url = "http://example.org",
3905 -- ^ Timeout for connection in seconds. Default is 3 seconds.
3906 post_data = "Raw POST request data string" OR { field1 = "data1", field2 = "data2" },
3907 -- ^ Optional, if specified a POST request with post_data is performed.
3908 -- ^ Accepts both a string and a table. If a table is specified, encodes table
3909 -- ^ as x-www-form-urlencoded key-value pairs.
3910 -- ^ If post_data ist not specified, a GET request is performed instead.
3911 user_agent = "ExampleUserAgent",
3912 -- ^ Optional, if specified replaces the default minetest user agent with given string
3913 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
3914 -- ^ Optional, if specified adds additional headers to the HTTP request. You must make sure
3915 -- ^ that the header strings follow HTTP specification ("Key: Value").
3917 -- ^ Optional, if true performs a multipart HTTP request. Default is false.
3920 ### `HTTPRequestResult` definition (`http_fetch` callback, `http_fetch_async_get`)
3924 -- ^ If true, the request has finished (either succeeded, failed or timed out)
3926 -- ^ If true, the request was succesful
3928 -- ^ If true, the request timed out
3930 -- ^ HTTP status code