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 or the word "`alpha`". If
361 it is an int, then it specifies how far to interpolate between the
362 colors where 0 is only the texture color and 255 is only `<color>`. If
363 omitted, the alpha of `<color>` will be used as the ratio. If it is
364 the word "`alpha`", then each texture pixel will contain the RGB of
365 `<color>` and the alpha of `<color>` multiplied by the alpha of the
370 Only Ogg Vorbis files are supported.
372 For positional playing of sounds, only single-channel (mono) files are
373 supported. Otherwise OpenAL will play them non-positionally.
375 Mods should generally prefix their sounds with `modname_`, e.g. given
376 the mod name "`foomod`", a sound could be called:
380 Sounds are referred to by their name with a dot, a single digit and the
381 file extension stripped out. When a sound is played, the actual sound file
382 is chosen randomly from the matching sounds.
384 When playing the sound `foomod_foosound`, the sound is chosen randomly
385 from the available ones of the following files:
387 * `foomod_foosound.ogg`
388 * `foomod_foosound.0.ogg`
389 * `foomod_foosound.1.ogg`
391 * `foomod_foosound.9.ogg`
393 Examples of sound parameter tables:
395 -- Play location-less on all clients
397 gain = 1.0, -- default
399 -- Play location-less to a player
402 gain = 1.0, -- default
404 -- Play in a location
407 gain = 1.0, -- default
408 max_hear_distance = 32, -- default, uses an euclidean metric
410 -- Play connected to an object, looped
412 object = <an ObjectRef>,
413 gain = 1.0, -- default
414 max_hear_distance = 32, -- default, uses an euclidean metric
415 loop = true, -- only sounds connected to objects can be looped
418 ### `SimpleSoundSpec`
420 * e.g. `"default_place_node"`
422 * e.g. `{name="default_place_node"}`
423 * e.g. `{name="default_place_node", gain=1.0}`
425 Registered definitions of stuff
426 -------------------------------
427 Anything added using certain `minetest.register_*` functions get added to
428 the global `minetest.registered_*` tables.
430 * `minetest.register_entity(name, prototype table)`
431 * added to `minetest.registered_entities[name]`
433 * `minetest.register_node(name, node definition)`
434 * added to `minetest.registered_items[name]`
435 * added to `minetest.registered_nodes[name]`
437 * `minetest.register_tool(name, item definition)`
438 * added to `minetest.registered_items[name]`
440 * `minetest.register_craftitem(name, item definition)`
441 * added to `minetest.registered_items[name]`
443 * `minetest.register_biome(biome definition)`
444 * returns an integer uniquely identifying the registered biome
445 * added to `minetest.registered_biome` with the key of `biome.name`
446 * if `biome.name` is nil, the key is the returned ID
448 * `minetest.register_ore(ore definition)`
449 * returns an integer uniquely identifying the registered ore
450 * added to `minetest.registered_ores` with the key of `ore.name`
451 * if `ore.name` is nil, the key is the returned ID
453 * `minetest.register_decoration(decoration definition)`
454 * returns an integer uniquely identifying the registered decoration
455 * added to `minetest.registered_decorations` with the key of `decoration.name`
456 * if `decoration.name` is nil, the key is the returned ID
458 * `minetest.register_schematic(schematic definition)`
459 * returns an integer uniquely identifying the registered schematic
460 * added to `minetest.registered_schematic` with the key of `schematic.name`
461 * if `schematic.name` is nil, the key is the returned ID
462 * if the schematic is loaded from a file, schematic.name is set to the filename
463 * if the function is called when loading the mod, and schematic.name is a relative path,
464 * then the current mod path will be prepended to the schematic filename
466 * `minetest.clear_registered_biomes()`
467 * clears all biomes currently registered
469 * `minetest.clear_registered_ores()`
470 * clears all ores currently registered
472 * `minetest.clear_registered_decorations()`
473 * clears all decorations currently registered
475 * `minetest.clear_registered_schematics()`
476 * clears all schematics currently registered
478 Note that in some cases you will stumble upon things that are not contained
479 in these tables (e.g. when a mod has been removed). Always check for
480 existence before trying to access the fields.
482 Example: If you want to check the drawtype of a node, you could do:
484 local function get_nodedef_field(nodename, fieldname)
485 if not minetest.registered_nodes[nodename] then
488 return minetest.registered_nodes[nodename][fieldname]
490 local drawtype = get_nodedef_field(nodename, "drawtype")
492 Example: `minetest.get_item_group(name, group)` has been implemented as:
494 function minetest.get_item_group(name, group)
495 if not minetest.registered_items[name] or not
496 minetest.registered_items[name].groups[group] then
499 return minetest.registered_items[name].groups[group]
504 Nodes are the bulk data of the world: cubes and other things that take the
505 space of a cube. Huge amounts of them are handled efficiently, but they
508 The definition of a node is stored and can be accessed by name in
510 minetest.registered_nodes[node.name]
512 See "Registered definitions of stuff".
514 Nodes are passed by value between Lua and the engine.
515 They are represented by a table:
517 {name="name", param1=num, param2=num}
519 `param1` and `param2` are 8-bit integers. The engine uses them for certain
520 automated functions. If you don't use these functions, you can use them to
521 store arbitrary values.
523 The functions of `param1` and `param2` are determined by certain fields in the
526 `param1` is reserved for the engine when `paramtype != "none"`:
529 ^ The value stores light with and without sun in its upper and lower 4 bits
530 respectively. Allows light to propagate from or through the node with
531 light value falling by 1 per node. This is essential for a light source
532 node to spread its light.
534 `param2` is reserved for the engine when any of these are used:
536 liquidtype == "flowing"
537 ^ The level and some flags of the liquid is stored in param2
538 drawtype == "flowingliquid"
539 ^ The drawn liquid level is read from param2
540 drawtype == "torchlike"
541 drawtype == "signlike"
542 paramtype2 == "wallmounted"
543 ^ The rotation of the node is stored in param2. You can make this value
544 by using minetest.dir_to_wallmounted().
545 paramtype2 == "facedir"
546 ^ The rotation of the node is stored in param2. Furnaces and chests are
547 rotated this way. Can be made by using minetest.dir_to_facedir().
549 facedir modulo 4 = axisdir
550 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
551 facedir's two less significant bits are rotation around the axis
552 paramtype2 == "leveled"
553 paramtype2 == "degrotate"
554 ^ The rotation of this node is stored in param2. Plants are rotated this way.
555 Values range 0 - 179. The value stored in param2 is multiplied by two to
556 get the actual rotation of the node.
560 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
563 ^ defines list of collision boxes for the node. If empty, collision boxes
564 will be the same as nodeboxes, in case of any other nodes will be full cube
565 as in the example above.
567 Nodes can also contain extra data. See "Node Metadata".
571 There are a bunch of different looking node types.
573 Look for examples in `games/minimal` or `games/minetest_game`.
581 * `glasslike_framed_optional`
583 * `allfaces_optional`
590 * `nodebox` -- See below. (**Experimental!**)
591 * `mesh` -- use models for nodes
593 `*_optional` drawtypes need less rendering time if deactivated (always client side).
597 Node selection boxes are defined using "node boxes"
599 The `nodebox` node drawtype allows defining visual of nodes consisting of
600 arbitrary number of boxes. It allows defining stuff like stairs. Only the
601 `fixed` and `leveled` box type is supported for these.
603 Please note that this is still experimental, and may be incompatibly
604 changed in the future.
606 A nodebox is defined as any of:
609 -- A normal cube; the default in most things
613 -- A fixed box (facedir param2 is used, if applicable)
615 fixed = box OR {box1, box2, ...}
618 -- A box like the selection box for torches
619 -- (wallmounted param2 is used, if applicable)
620 type = "wallmounted",
626 -- A node that has optional boxes depending on neighbouring nodes'
627 -- presence and type. See also `connects_to`.
629 fixed = box OR {box1, box2, ...}
630 connect_top = box OR {box1, box2, ...}
631 connect_bottom = box OR {box1, box2, ...}
632 connect_front = box OR {box1, box2, ...}
633 connect_left = box OR {box1, box2, ...}
634 connect_back = box OR {box1, box2, ...}
635 connect_right = box OR {box1, box2, ...}
638 A `box` is defined as:
640 {x1, y1, z1, x2, y2, z2}
642 A box of a regular node would look like:
644 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
646 `type = "leveled"` is same as `type = "fixed"`, but `y2` will be automatically
647 set to level from `param2`.
652 If drawtype `mesh` is used, tiles should hold model materials textures.
653 Only static meshes are implemented.
654 For supported model formats see Irrlicht engine documentation.
659 Noise Parameters, or commonly called "`NoiseParams`", define the properties of
663 Offset that the noise is translated by (i.e. added) after calculation.
666 Factor that the noise is scaled by (i.e. multiplied) after calculation.
669 Vector containing values by which each coordinate is divided by before calculation.
670 Higher spread values result in larger noise features.
672 A value of `{x=250, y=250, z=250}` is common.
675 Random seed for the noise. Add the world seed to a seed offset for world-unique noise.
676 In the case of `minetest.get_perlin()`, this value has the world seed automatically added.
679 Number of times the noise gradient is accumulated into the noise.
681 Increase this number to increase the amount of detail in the resulting noise.
683 A value of `6` is common.
686 Factor by which the effect of the noise gradient function changes with each successive octave.
688 Values less than `1` make the details of successive octaves' noise diminish, while values
689 greater than `1` make successive octaves stronger.
691 A value of `0.6` is common.
694 Factor by which the noise feature sizes change with each successive octave.
696 A value of `2.0` is common.
699 Leave this field unset for no special handling.
701 Currently supported are `defaults`, `eased` and `absvalue`.
704 Specify this if you would like to keep auto-selection of eased/not-eased while specifying
708 Maps noise gradient values onto a quintic S-curve before performing interpolation.
709 This results in smooth, rolling noise. Disable this (`noeased`) for sharp-looking noise.
710 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is not eased.
713 Accumulates the absolute value of each noise gradient result.
715 Noise parameters format example for 2D or 3D perlin noise or perlin noise maps:
719 spread = {x=500, y=500, z=500},
724 flags = "defaults, absvalue"
726 ^ A single noise parameter table can be used to get 2D or 3D noise,
727 when getting 2D noise spread.z is ignored.
732 These tell in what manner the ore is generated.
734 All default ores are of the uniformly-distributed scatter type.
737 Randomly chooses a location and generates a cluster of ore.
739 If `noise_params` is specified, the ore will be placed if the 3D perlin noise at
740 that point is greater than the `noise_threshold`, giving the ability to create
741 a non-equal distribution of ore.
744 Creates a sheet of ore in a blob shape according to the 2D perlin noise
745 described by `noise_params` and `noise_threshold`. This is essentially an
746 improved version of the so-called "stratus" ore seen in some unofficial mods.
748 This sheet consists of vertical columns of uniform randomly distributed height,
749 varying between the inclusive range `column_height_min` and `column_height_max`.
750 If `column_height_min` is not specified, this parameter defaults to 1.
751 If `column_height_max` is not specified, this parameter defaults to `clust_size`
752 for reverse compatibility. New code should prefer `column_height_max`.
754 The `column_midpoint_factor` parameter controls the position of the column at which
755 ore eminates from. If 1, columns grow upward. If 0, columns grow downward. If 0.5,
756 columns grow equally starting from each direction. `column_midpoint_factor` is a
757 decimal number ranging in value from 0 to 1. If this parameter is not specified,
760 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this ore type.
763 Creates a sheet of ore in a cloud-like puff shape.
765 As with the `sheet` ore type, the size and shape of puffs are described by
766 `noise_params` and `noise_threshold` and are placed at random vertical positions
767 within the currently generated chunk.
769 The vertical top and bottom displacement of each puff are determined by the noise
770 parameters `np_puff_top` and `np_puff_bottom`, respectively.
774 Creates a deformed sphere of ore according to 3d perlin noise described by
775 `noise_params`. The maximum size of the blob is `clust_size`, and
776 `clust_scarcity` has the same meaning as with the `scatter` type.
779 Creates veins of ore varying in density by according to the intersection of two
780 instances of 3d perlin noise with diffferent seeds, both described by
781 `noise_params`. `random_factor` varies the influence random chance has on
782 placement of an ore inside the vein, which is `1` by default. Note that
783 modifying this parameter may require adjusting `noise_threshold`.
784 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
785 by this ore type. This ore type is difficult to control since it is sensitive
786 to small changes. The following is a decent set of parameters to work from:
791 spread = {x=200, y=200, z=200},
797 noise_threshold = 1.6
799 WARNING: Use this ore type *very* sparingly since it is ~200x more
800 computationally expensive than any other ore.
804 See section "Flag Specifier Format".
806 Currently supported flags: `absheight`
809 Also produce this same ore between the height range of `-y_max` and `-y_min`.
811 Useful for having ore in sky realms without having to duplicate ore entries.
814 If set, puff ore generation will not taper down large differences in displacement
815 when approaching the edge of a puff. This flag has no effect for ore types other
818 ### `puff_additive_composition`
819 By default, when noise described by `np_puff_top` or `np_puff_bottom` results in a
820 negative displacement, the sub-column at that point is not generated. With this
821 attribute set, puff ore generation will instead generate the absolute difference in
822 noise displacement values. This flag has no effect for ore types other than `puff`.
826 The varying types of decorations that can be placed.
829 Creates a 1 times `H` times 1 column of a specified node (or a random node from
830 a list, if a decoration list is specified). Can specify a certain node it must
831 spawn next to, such as water or lava, for example. Can also generate a
832 decoration of random height between a specified lower and upper bound.
833 This type of decoration is intended for placement of grass, flowers, cacti,
834 papyri, waterlilies and so on.
837 Copies a box of `MapNodes` from a specified schematic file (or raw description).
838 Can specify a probability of a node randomly appearing when placed.
839 This decoration type is intended to be used for multi-node sized discrete
840 structures, such as trees, cave spikes, rocks, and so on.
845 A schematic specifier identifies a schematic by either a filename to a
846 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
847 in the form of a table. This table specifies the following fields:
849 * The `size` field is a 3D vector containing the dimensions of the provided schematic. (required)
850 * The `yslice_prob` field is a table of {ypos, prob} which sets the `ypos`th vertical slice
851 of the schematic to have a `prob / 256 * 100` chance of occuring. (default: 255)
852 * The `data` field is a flat table of MapNode tables making up the schematic,
853 in the order of `[z [y [x]]]`. (required)
854 Each MapNode table contains:
855 * `name`: the name of the map node to place (required)
856 * `prob` (alias `param1`): the probability of this node being placed (default: 255)
857 * `param2`: the raw param2 value of the node being placed onto the map (default: 0)
858 * `force_place`: boolean representing if the node should forcibly overwrite any
859 previous contents (default: false)
861 About probability values:
862 * A probability value of `0` or `1` means that node will never appear (0% chance).
863 * A probability value of `254` or `255` means the node will always appear (100% chance).
864 * If the probability value `p` is greater than `1`, then there is a
865 `(p / 256 * 100)` percent chance that node will appear when the schematic is
871 See section "Flag Specifier Format".
873 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
876 * `place_center_x`: Placement of this decoration is centered along the X axis.
877 * `place_center_y`: Placement of this decoration is centered along the Y axis.
878 * `place_center_z`: Placement of this decoration is centered along the Z axis.
879 * `force_placement`: Schematic nodes other than "ignore" will replace existing nodes.
884 The position field is used for all element types.
886 To account for differing resolutions, the position coordinates are the percentage
887 of the screen, ranging in value from `0` to `1`.
889 The name field is not yet used, but should contain a description of what the
890 HUD element represents. The direction field is the direction in which something
893 `0` draws from left to right, `1` draws from right to left, `2` draws from
894 top to bottom, and `3` draws from bottom to top.
896 The `alignment` field specifies how the item will be aligned. It ranges from `-1` to `1`,
897 with `0` being the center, `-1` is moved to the left/up, and `1` is to the right/down.
898 Fractional values can be used.
900 The `offset` field specifies a pixel offset from the position. Contrary to position,
901 the offset is not scaled to screen size. This allows for some precisely-positioned
904 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling factor!
906 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
908 **Note**: Future revisions to the HUD API may be incompatible; the HUD API is still
909 in the experimental stages.
912 Displays an image on the HUD.
914 * `scale`: The scale of the image, with 1 being the original texture size.
915 Only the X coordinate scale is used (positive values).
916 Negative values represent that percentage of the screen it
917 should take; e.g. `x=-100` means 100% (width).
918 * `text`: The name of the texture that is displayed.
919 * `alignment`: The alignment of the image.
920 * `offset`: offset in pixels from position.
923 Displays text on the HUD.
925 * `scale`: Defines the bounding rectangle of the text.
926 A value such as `{x=100, y=100}` should work.
927 * `text`: The text to be displayed in the HUD element.
928 * `number`: An integer containing the RGB value of the color used to draw the text.
929 Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
930 * `alignment`: The alignment of the text.
931 * `offset`: offset in pixels from position.
934 Displays a horizontal bar made up of half-images.
936 * `text`: The name of the texture that is used.
937 * `number`: The number of half-textures that are displayed.
938 If odd, will end with a vertically center-split texture.
940 * `offset`: offset in pixels from position.
941 * `size`: If used, will force full-image size to this value (override texture pack image size)
944 * `text`: The name of the inventory list to be displayed.
945 * `number`: Number of items in the inventory to be displayed.
946 * `item`: Position of item that is selected.
950 Displays distance to selected world position.
952 * `name`: The name of the waypoint.
953 * `text`: Distance suffix. Can be blank.
954 * `number:` An integer containing the RGB value of the color used to draw the text.
955 * `world_pos`: World position of the waypoint.
957 Representations of simple things
958 --------------------------------
962 {x=num, y=num, z=num}
964 For helper functions see "Vector helpers".
968 * `{type="node", under=pos, above=pos}`
969 * `{type="object", ref=ObjectRef}`
971 Flag Specifier Format
972 ---------------------
973 Flags using the standardized flag specifier format can be specified in either of
974 two ways, by string or table.
976 The string format is a comma-delimited set of flag names; whitespace and
977 unrecognized flag fields are ignored. Specifying a flag in the string sets the
978 flag, and specifying a flag prefixed by the string `"no"` explicitly
979 clears the flag from whatever the default may be.
981 In addition to the standard string flag format, the schematic flags field can
982 also be a table of flag names to boolean values representing whether or not the
983 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
984 is present, mapped to a boolean of any value, the specified flag is unset.
986 E.g. A flag field of value
988 {place_center_x = true, place_center_y=false, place_center_z=true}
992 {place_center_x = true, noplace_center_y=true, place_center_z=true}
994 which is equivalent to
996 "place_center_x, noplace_center_y, place_center_z"
1000 "place_center_x, place_center_z"
1002 since, by default, no schematic attributes are set.
1008 There are three kinds of items: nodes, tools and craftitems.
1010 * Node (`register_node`): A node from the world.
1011 * Tool (`register_tool`): A tool/weapon that can dig and damage
1012 things according to `tool_capabilities`.
1013 * Craftitem (`register_craftitem`): A miscellaneous item.
1016 Items and item stacks can exist in three formats: Serializes, table format
1020 This is called "stackstring" or "itemstring":
1022 * e.g. `'default:dirt 5'`
1023 * e.g. `'default:pick_wood 21323'`
1024 * e.g. `'default:apple'`
1031 {name="default:dirt", count=5, wear=0, metadata=""}
1033 A wooden pick about 1/3 worn out:
1035 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1039 {name="default:apple", count=1, wear=0, metadata=""}
1042 A native C++ format with many helper methods. Useful for converting
1043 between formats. See the Class reference section for details.
1045 When an item must be passed to a function, it can usually be in any of
1051 In a number of places, there is a group table. Groups define the
1052 properties of a thing (item, node, armor of entity, capabilities of
1053 tool) in such a way that the engine and other mods can can interact with
1054 the thing without actually knowing what the thing is.
1057 Groups are stored in a table, having the group names with keys and the
1058 group ratings as values. For example:
1060 groups = {crumbly=3, soil=1}
1063 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1064 -- ^ A more special dirt-kind of thing
1066 Groups always have a rating associated with them. If there is no
1067 useful meaning for a rating for an enabled group, it shall be `1`.
1069 When not defined, the rating of a group defaults to `0`. Thus when you
1070 read groups, you must interpret `nil` and `0` as the same value, `0`.
1072 You can read the rating of a group for an item or a node by using
1074 minetest.get_item_group(itemname, groupname)
1077 Groups of items can define what kind of an item it is (e.g. wool).
1080 In addition to the general item things, groups are used to define whether
1081 a node is destroyable and how long it takes to destroy by a tool.
1083 ### Groups of entities
1084 For entities, groups are, as of now, used only for calculating damage.
1085 The rating is the percentage of damage caused by tools with this damage group.
1086 See "Entity damage mechanism".
1088 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1089 object.set_armor_groups({fleshy=30, cracky=80})
1092 Groups in tools define which groups of nodes and entities they are
1095 ### Groups in crafting recipes
1096 An example: Make meat soup from any meat, any water and any bowl:
1099 output = 'food:meat_soup_raw',
1105 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1108 Another example: Make red wool from white wool and red dye:
1112 output = 'wool:red',
1113 recipe = {'wool:white', 'group:dye,basecolor_red'},
1117 * `immortal`: Disables the group damage system for an entity
1118 * `level`: Can be used to give an additional sense of progression in the game.
1119 * A larger level will cause e.g. a weapon of a lower level make much less
1120 damage, and get worn out much faster, or not be able to get drops
1121 from destroyed nodes.
1122 * `0` is something that is directly accessible at the start of gameplay
1123 * There is no upper limit
1124 * `dig_immediate`: (player can always pick up node without tool wear)
1125 * `2`: node is removed without tool wear after 0.5 seconds or so
1127 * `3`: node is removed without tool wear immediately (torch)
1128 * `disable_jump`: Player (and possibly other things) cannot jump from node
1129 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1130 * `bouncy`: value is bounce speed in percent
1131 * `falling_node`: if there is no walkable block under the node it will fall
1132 * `attached_node`: if the node under it is not a walkable block the node will be
1133 dropped as an item. If the node is wallmounted the wallmounted direction is
1135 * `soil`: saplings will grow on nodes in this group
1136 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1137 connect to each other
1139 ### Known damage and digging time defining groups
1140 * `crumbly`: dirt, sand
1141 * `cracky`: tough but crackable stuff like stone.
1142 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1143 plants, wire, sheets of metal
1144 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1145 * `fleshy`: Living things like animals and the player. This could imply
1146 some blood effects when hitting.
1147 * `explody`: Especially prone to explosions
1148 * `oddly_breakable_by_hand`:
1149 Can be added to nodes that shouldn't logically be breakable by the
1150 hand but are. Somewhat similar to `dig_immediate`, but times are more
1151 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1152 speed of a tool if the tool can dig at a faster speed than this
1153 suggests for the hand.
1155 ### Examples of custom groups
1156 Item groups are often used for defining, well, _groups of items_.
1157 * `meat`: any meat-kind of a thing (rating might define the size or healing
1158 ability or be irrelevant -- it is not defined as of yet)
1159 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1161 * `flammable`: can be set on fire. Rating might define the intensity of the
1162 fire, affecting e.g. the speed of the spreading of an open fire.
1163 * `wool`: any wool (any origin, any color)
1164 * `metal`: any metal
1165 * `weapon`: any weapon
1166 * `heavy`: anything considerably heavy
1168 ### Digging time calculation specifics
1169 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1170 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1171 faster digging time.
1173 The `level` group is used to limit the toughness of nodes a tool can dig
1174 and to scale the digging times / damage to a greater extent.
1176 **Please do understand this**, otherwise you cannot use the system to it's
1179 Tools define their properties by a list of parameters for groups. They
1180 cannot dig other groups; thus it is important to use a standard bunch of
1181 groups to enable interaction with tools.
1183 #### Tools definition
1186 * Full punch interval
1187 * Maximum drop level
1188 * For an arbitrary list of groups:
1189 * Uses (until the tool breaks)
1190 * Maximum level (usually `0`, `1`, `2` or `3`)
1194 #### Full punch interval
1195 When used as a weapon, the tool will do full damage if this time is spent
1196 between punches. If e.g. half the time is spent, the tool will do half
1199 #### Maximum drop level
1200 Suggests the maximum level of node, when dug with the tool, that will drop
1201 it's useful item. (e.g. iron ore to drop a lump of iron).
1203 This is not automated; it is the responsibility of the node definition
1207 Determines how many uses the tool has when it is used for digging a node,
1208 of this group, of the maximum level. For lower leveled nodes, the use count
1209 is multiplied by `3^leveldiff`.
1211 * `uses=10, leveldiff=0`: actual uses: 10
1212 * `uses=10, leveldiff=1`: actual uses: 30
1213 * `uses=10, leveldiff=2`: actual uses: 90
1216 Tells what is the maximum level of a node of this group that the tool will
1220 List of digging times for different ratings of the group, for nodes of the
1223 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1224 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1225 for this group, and unable to dig the rating `1`, which is the toughest.
1226 Unless there is a matching group that enables digging otherwise.
1229 List of damage for groups of entities. See "Entity damage mechanism".
1231 #### Example definition of the capabilities of a tool
1233 tool_capabilities = {
1234 full_punch_interval=1.5,
1237 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1239 damage_groups = {fleshy=2},
1242 This makes the tool be able to dig nodes that fulfil both of these:
1244 * Have the `crumbly` group
1245 * Have a `level` group less or equal to `2`
1247 Table of resulting digging times:
1249 crumbly 0 1 2 3 4 <- level
1251 1 0.80 1.60 1.60 - -
1252 2 0.60 1.20 1.20 - -
1253 3 0.40 0.80 0.80 - -
1255 level diff: 2 1 0 -1 -2
1257 Table of resulting tool uses:
1266 * At `crumbly==0`, the node is not diggable.
1267 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1268 easy nodes to be quickly breakable.
1269 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1271 Entity damage mechanism
1272 -----------------------
1276 foreach group in cap.damage_groups:
1277 damage += cap.damage_groups[group] * limit(actual_interval /
1278 cap.full_punch_interval, 0.0, 1.0)
1279 * (object.armor_groups[group] / 100.0)
1280 -- Where object.armor_groups[group] is 0 for inexistent values
1283 Client predicts damage based on damage groups. Because of this, it is able to
1284 give an immediate response when an entity is damaged or dies; the response is
1285 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1287 Currently a smoke puff will appear when an entity dies.
1289 The group `immortal` completely disables normal damage.
1291 Entities can define a special armor group, which is `punch_operable`. This
1292 group disables the regular damage mechanism for players punching it by hand or
1293 a non-tool item, so that it can do something else than take damage.
1295 On the Lua side, every punch calls:
1297 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction)
1299 This should never be called directly, because damage is usually not handled by
1302 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1303 accessed unless absolutely required, to encourage interoperability.
1304 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1305 * `tool_capabilities` can be `nil`.
1306 * `direction` is a unit vector, pointing from the source of the punch to
1309 To punch an entity/object in Lua, call:
1311 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1313 * Return value is tool wear.
1314 * Parameters are equal to the above callback.
1315 * If `direction` equals `nil` and `puncher` does not equal `nil`,
1316 `direction` will be automatically filled in based on the location of `puncher`.
1320 The instance of a node in the world normally only contains the three values
1321 mentioned in "Nodes". However, it is possible to insert extra data into a
1322 node. It is called "node metadata"; See "`NodeMetaRef`".
1324 Metadata contains two things:
1329 Some of the values in the key-value store are handled specially:
1331 * `formspec`: Defines a right-click inventory menu. See "Formspec".
1332 * `infotext`: Text shown on the screen when the node is pointed at
1336 local meta = minetest.get_meta(pos)
1337 meta:set_string("formspec",
1339 "list[context;main;0,0;8,4;]"..
1340 "list[current_player;main;0,5;8,4;]")
1341 meta:set_string("infotext", "Chest");
1342 local inv = meta:get_inventory()
1343 inv:set_size("main", 8*4)
1344 print(dump(meta:to_table()))
1347 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1348 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1349 [10] = "", [11] = "", [12] = "", [13] = "",
1350 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1351 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1352 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1353 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1357 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1364 Formspec defines a menu. Currently not much else than inventories are
1365 supported. It is a string, with a somewhat strange format.
1367 Spaces and newlines can be inserted between the blocks, as is used in the
1375 list[context;main;0,0;8,4;]
1376 list[current_player;main;0,5;8,4;]
1381 list[context;fuel;2,3;1,1;]
1382 list[context;src;2,1;1,1;]
1383 list[context;dst;5,1;2,2;]
1384 list[current_player;main;0,5;8,4;]
1386 #### Minecraft-like player inventory
1389 image[1,0.6;1,2;player.png]
1390 list[current_player;main;0,3.5;8,4;]
1391 list[current_player;craft;3,0;3,3;]
1392 list[current_player;craftpreview;7,1;1,1;]
1396 #### `size[<W>,<H>,<fixed_size>]`
1397 * Define the size of the menu in inventory slots
1398 * `fixed_size`: `true`/`false` (optional)
1399 * deprecated: `invsize[<W>,<H>;]`
1401 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
1402 * Show an inventory list
1404 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
1405 * Show an inventory list
1407 #### `listring[<inventory location>;<list name>]`
1408 * Allows to create a ring of inventory lists
1409 * Shift-clicking on items in one element of the ring
1410 * will send them to the next inventory list inside the ring
1411 * The first occurrence of an element inside the ring will
1412 * determine the inventory where items will be sent to
1415 * Shorthand for doing `listring[<inventory location>;<list name>]`
1416 * for the last two inventory lists added by list[...]
1418 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
1419 * Sets background color of slots as `ColorString`
1420 * Sets background color of slots on mouse hovering
1422 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
1423 * Sets background color of slots as `ColorString`
1424 * Sets background color of slots on mouse hovering
1425 * Sets color of slots border
1427 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
1428 * Sets background color of slots as `ColorString`
1429 * Sets background color of slots on mouse hovering
1430 * Sets color of slots border
1431 * Sets default background color of tooltips
1432 * Sets default font color of tooltips
1434 #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>,<fontcolor>]`
1435 * Adds tooltip for an element
1436 * `<bgcolor>` tooltip background color as `ColorString` (optional)
1437 * `<fontcolor>` tooltip font color as `ColorString` (optional)
1439 #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
1441 * Position and size units are inventory slots
1443 #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
1444 * Show an inventory image of registered item/node
1445 * Position and size units are inventory slots
1447 #### `bgcolor[<color>;<fullscreen>]`
1448 * Sets background color of formspec as `ColorString`
1449 * If `true`, the background color is drawn fullscreen (does not effect the size of the formspec)
1451 #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
1452 * Use a background. Inventory rectangles are not drawn then.
1453 * Position and size units are inventory slots
1454 * Example for formspec 8x4 in 16x resolution: image shall be sized
1455 8 times 16px times 4 times 16px.
1457 #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
1458 * Use a background. Inventory rectangles are not drawn then.
1459 * Position and size units are inventory slots
1460 * Example for formspec 8x4 in 16x resolution:
1461 image shall be sized 8 times 16px times 4 times 16px
1462 * If `true` the background is clipped to formspec size
1463 (`x` and `y` are used as offset values, `w` and `h` are ignored)
1465 #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
1466 * Textual password style field; will be sent to server when a button is clicked
1467 * `x` and `y` position the field relative to the top left of the menu
1468 * `w` and `h` are the size of the field
1469 * fields are a set height, but will be vertically centred on `h`
1470 * Position and size units are inventory slots
1471 * `name` is the name of the field as returned in fields to `on_receive_fields`
1472 * `label`, if not blank, will be text printed on the top left above the field
1474 #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1475 * Textual field; will be sent to server when a button is clicked
1476 * `x` and `y` position the field relative to the top left of the menu
1477 * `w` and `h` are the size of the field
1478 * fields are a set height, but will be vertically centred on `h`
1479 * Position and size units are inventory slots
1480 * `name` is the name of the field as returned in fields to `on_receive_fields`
1481 * `label`, if not blank, will be text printed on the top left above the field
1482 * `default` is the default value of the field
1483 * `default` may contain variable references such as `${text}'` which
1484 will fill the value from the metadata value `text`
1485 * **Note**: no extra text or more than a single variable is supported ATM.
1487 #### `field[<name>;<label>;<default>]`
1488 * as above, but without position/size units
1489 * special field for creating simple forms, such as sign text input
1490 * must be used without a `size[]` element
1491 * a "Proceed" button will be added automatically
1493 #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1494 * same as fields above, but with multi-line input
1496 #### `label[<X>,<Y>;<label>]`
1497 * `x` and `y` work as per field
1498 * `label` is the text on the label
1499 * Position and size units are inventory slots
1501 #### `vertlabel[<X>,<Y>;<label>]`
1502 * Textual label drawn vertically
1503 * `x` and `y` work as per field
1504 * `label` is the text on the label
1505 * Position and size units are inventory slots
1507 #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
1508 * Clickable button. When clicked, fields will be sent.
1509 * `x`, `y` and `name` work as per field
1510 * `w` and `h` are the size of the button
1511 * `label` is the text on the button
1512 * Position and size units are inventory slots
1514 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
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
1519 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
1520 * `x`, `y`, `w`, `h`, and `name` work as per button
1521 * `texture name` is the filename of an image
1522 * Position and size units are inventory slots
1523 * `noclip=true` means the image button doesn't need to be within specified formsize
1524 * `drawborder`: draw button border or not
1525 * `pressed texture name` is the filename of an image on pressed state
1527 #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
1528 * `x`, `y`, `w`, `h`, `name` and `label` work as per button
1529 * `item name` is the registered name of an item/node,
1530 tooltip will be made out of its description
1531 to override it use tooltip element
1532 * Position and size units are inventory slots
1534 #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
1535 * When clicked, fields will be sent and the form will quit.
1537 #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1538 * When clicked, fields will be sent and the form will quit.
1540 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
1541 * Scrollable item list showing arbitrary text elements
1542 * `x` and `y` position the itemlist relative to the top left of the menu
1543 * `w` and `h` are the size of the itemlist
1544 * `name` fieldname sent to server on doubleclick value is current selected element
1545 * `listelements` can be prepended by #color in hexadecimal format RRGGBB (only),
1546 * if you want a listelement to start with "#" write "##".
1548 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
1549 * Scrollable itemlist showing arbitrary text elements
1550 * `x` and `y` position the item list relative to the top left of the menu
1551 * `w` and `h` are the size of the item list
1552 * `name` fieldname sent to server on doubleclick value is current selected element
1553 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
1554 * if you want a listelement to start with "#" write "##"
1555 * index to be selected within textlist
1556 * `true`/`false`: draw transparent background
1557 * see also `minetest.explode_textlist_event` (main menu: `engine.explode_textlist_event`)
1559 #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
1560 * show a tab**header** at specific position (ignores formsize)
1561 * `x` and `y` position the itemlist relative to the top left of the menu
1562 * `name` fieldname data is transferred to Lua
1563 * `caption 1`...: name shown on top of tab
1564 * `current_tab`: index of selected tab 1...
1565 * `transparent` (optional): show transparent
1566 * `draw_border` (optional): draw border
1568 #### `box[<X>,<Y>;<W>,<H>;<color>]`
1569 * simple colored semitransparent box
1570 * `x` and `y` position the box relative to the top left of the menu
1571 * `w` and `h` are the size of box
1572 * `color` is color specified as a `ColorString`
1574 #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
1575 * show a dropdown field
1576 * **Important note**: There are two different operation modes:
1577 1. handle directly on change (only changed dropdown is submitted)
1578 2. read the value on pressing a button (all dropdown values are available)
1579 * `x` and `y` position of dropdown
1581 * fieldname data is transferred to Lua
1582 * items to be shown in dropdown
1583 * index of currently selected dropdown item
1585 #### `checkbox[<X>,<Y>;<name>;<label>;<selected>;<tooltip>]`
1587 * `x` and `y`: position of checkbox
1588 * `name` fieldname data is transferred to Lua
1589 * `label` to be shown left of checkbox
1590 * `selected` (optional): `true`/`false`
1591 * `tooltip` (optional)
1593 #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
1595 * there are two ways to use it:
1596 1. handle the changed event (only changed scrollbar is available)
1597 2. read the value on pressing a button (all scrollbars are available)
1598 * `x` and `y`: position of trackbar
1599 * `w` and `h`: width and height
1600 * `orientation`: `vertical`/`horizontal`
1601 * fieldname data is transferred to Lua
1602 * value this trackbar is set to (`0`-`1000`)
1603 * see also `minetest.explode_scrollbar_event` (main menu: `engine.explode_scrollbar_event`)
1605 #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
1606 * show scrollable table using options defined by the previous `tableoptions[]`
1607 * displays cells as defined by the previous `tablecolumns[]`
1608 * `x` and `y`: position the itemlist relative to the top left of the menu
1609 * `w` and `h` are the size of the itemlist
1610 * `name`: fieldname sent to server on row select or doubleclick
1611 * `cell 1`...`cell n`: cell contents given in row-major order
1612 * `selected idx`: index of row to be selected within table (first row = `1`)
1613 * see also `minetest.explode_table_event` (main menu: `engine.explode_table_event`)
1615 #### `tableoptions[<opt 1>;<opt 2>;...]`
1616 * sets options for `table[]`
1618 * default text color (`ColorString`), defaults to `#FFFFFF`
1619 * `background=#RRGGBB`
1620 * table background color (`ColorString`), defaults to `#000000`
1621 * `border=<true/false>`
1622 * should the table be drawn with a border? (default: `true`)
1623 * `highlight=#RRGGBB`
1624 * highlight background color (`ColorString`), defaults to `#466432`
1625 * `highlight_text=#RRGGBB`
1626 * highlight text color (`ColorString`), defaults to `#FFFFFF`
1627 * `opendepth=<value>`
1628 * all subtrees up to `depth < value` are open (default value = `0`)
1629 * only useful when there is a column of type "tree"
1631 #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
1632 * sets columns for `table[]`
1633 * types: `text`, `image`, `color`, `indent`, `tree`
1634 * `text`: show cell contents as text
1635 * `image`: cell contents are an image index, use column options to define images
1636 * `color`: cell contents are a ColorString and define color of following cell
1637 * `indent`: cell contents are a number and define indentation of following cell
1638 * `tree`: same as indent, but user can open and close subtrees (treeview-like)
1641 * for `text` and `image`: content alignment within cells.
1642 Available values: `left` (default), `center`, `right`, `inline`
1644 * for `text` and `image`: minimum width in em (default: `0`)
1645 * for `indent` and `tree`: indent width in em (default: `1.5`)
1646 * `padding=<value>`: padding left of the column, in em (default `0.5`).
1647 Exception: defaults to 0 for indent columns
1648 * `tooltip=<value>`: tooltip text (default: empty)
1649 * `image` column options:
1650 * `0=<value>` sets image for image index 0
1651 * `1=<value>` sets image for image index 1
1652 * `2=<value>` sets image for image index 2
1653 * and so on; defined indices need not be contiguous empty or
1654 non-numeric cells are treated as `0`.
1655 * `color` column options:
1656 * `span=<value>`: number of following columns to affect (default: infinite)
1658 **Note**: do _not_ use a element name starting with `key_`; those names are reserved to
1659 pass key press events to formspec!
1663 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
1664 * `"current_player"`: Player to whom the menu is shown
1665 * `"player:<name>"`: Any player
1666 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
1667 * `"detached:<name>"`: A detached inventory
1671 `#RGB` defines a color in hexadecimal format.
1673 `#RGBA` defines a color in hexadecimal format and alpha channel.
1675 `#RRGGBB` defines a color in hexadecimal format.
1677 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
1679 Named colors are also supported and are equivalent to
1680 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
1681 To specify the value of the alpha channel, append `#AA` to the end of the color name
1682 (e.g. `colorname#08`). For named colors the hexadecimal string representing the alpha
1683 value must (always) be two hexadecimal digits.
1687 A ColorSpec specifies a 32-bit color. It can be written in either:
1688 table form, each element ranging from 0..255 (a, if absent, defaults to 255):
1689 `colorspec = {a=255, r=0, g=255, b=0}`
1690 numerical form, the raw integer value of an ARGB8 quad:
1691 `colorspec = 0xFF00FF00`
1692 or string form, a ColorString (defined above):
1693 `colorspec = "green"`
1697 * `vector.new(a[, b, c])`: returns a vector:
1698 * A copy of `a` if `a` is a vector.
1699 * `{x = a, y = b, z = c}`, if all `a, b, c` are defined
1700 * `vector.direction(p1, p2)`: returns a vector
1701 * `vector.distance(p1, p2)`: returns a number
1702 * `vector.length(v)`: returns a number
1703 * `vector.normalize(v)`: returns a vector
1704 * `vector.round(v)`: returns a vector, each dimension rounded to floor
1705 * `vector.apply(v, func)`: returns a vector
1706 * `vector.equals(v1, v2)`: returns a boolean
1708 For the following functions `x` can be either a vector or a number:
1710 * `vector.add(v, x)`: returns a vector
1711 * `vector.subtract(v, x)`: returns a vector
1712 * `vector.multiply(v, x)`: returns a scaled vector or Schur product
1713 * `vector.divide(v, x)`: returns a scaled vector or Schur quotient
1717 * `dump2(obj, name="_", dumped={})`
1718 * Return object serialized as a string, handles reference loops
1719 * `dump(obj, dumped={})`
1720 * Return object serialized as a string
1721 * `math.hypot(x, y)`
1722 * Get the hypotenuse of a triangle with legs x and y.
1723 Useful for distance calculation.
1724 * `math.sign(x, tolerance)`
1725 * Get the sign of a number.
1726 Optional: Also returns `0` when the absolute value is within the tolerance (default: `0`)
1727 * `string.split(str, separator=",", include_empty=false, max_splits=-1,
1728 * sep_is_pattern=false)`
1729 * If `max_splits` is negative, do not limit splits.
1730 * `sep_is_pattern` specifies if separator is a plain string or a pattern (regex).
1731 * e.g. `string:split("a,b", ",") == {"a","b"}`
1733 * e.g. `string.trim("\n \t\tfoo bar\t ") == "foo bar"`
1734 * `minetest.pos_to_string({x=X,y=Y,z=Z}, decimal_places))`: returns `"(X,Y,Z)"`
1735 * Convert position to a printable string
1736 Optional: 'decimal_places' will round the x, y and z of the pos to the given decimal place.
1737 * `minetest.string_to_pos(string)`: returns a position
1738 * Same but in reverse. Returns `nil` if the string can't be parsed to a position.
1739 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
1740 * Converts a string representing an area box into two positions
1741 * `minetest.formspec_escape(string)`: returns a string
1742 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
1743 * `minetest.is_yes(arg)`
1744 * returns whether `arg` can be interpreted as yes
1745 * `minetest.get_us_time()`
1746 * returns time with microsecond precision. May not return wall time.
1747 * `table.copy(table)`: returns a table
1748 * returns a deep copy of `table`
1750 `minetest` namespace reference
1751 ------------------------------
1755 * `minetest.get_current_modname()`: returns the currently loading mod's name, when we are loading a mod
1756 * `minetest.get_modpath(modname)`: returns e.g. `"/home/user/.minetest/usermods/modname"`
1757 * Useful for loading additional `.lua` modules or static data from mod
1758 * `minetest.get_modnames()`: returns a list of installed mods
1759 * Return a list of installed mods, sorted alphabetically
1760 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
1761 * Useful for storing custom data
1762 * `minetest.is_singleplayer()`
1763 * `minetest.features`
1764 * Table containing API feature flags: `{foo=true, bar=true}`
1765 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
1766 * `arg`: string or table in format `{foo=true, bar=true}`
1767 * `missing_features`: `{foo=true, bar=true}`
1768 * `minetest.get_player_information(player_name)`: returns a table containing
1769 information about player. Example return value:
1771 address = "127.0.0.1", -- IP address of client
1772 ip_version = 4, -- IPv4 / IPv6
1773 min_rtt = 0.01, -- minimum round trip time
1774 max_rtt = 0.2, -- maximum round trip time
1775 avg_rtt = 0.02, -- average round trip time
1776 min_jitter = 0.01, -- minimum packet time jitter
1777 max_jitter = 0.5, -- maximum packet time jitter
1778 avg_jitter = 0.03, -- average packet time jitter
1779 connection_uptime = 200, -- seconds since client connected
1781 -- following information is available on debug build only!!!
1782 -- DO NOT USE IN MODS
1783 --ser_vers = 26, -- serialization version used by client
1784 --prot_vers = 23, -- protocol version used by client
1785 --major = 0, -- major version number
1786 --minor = 4, -- minor version number
1787 --patch = 10, -- patch version number
1788 --vers_string = "0.4.9-git", -- full version string
1789 --state = "Active" -- current client state
1791 * `minetest.mkdir(path)`: returns success.
1792 * Creates a directory specified by `path`, creating parent directories
1793 if they don't exist.
1794 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
1796 * nil: return all entries,
1797 * true: return only subdirectory names, or
1798 * false: return only file names.
1801 * `minetest.debug(...)`
1802 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
1803 * `minetest.log([level,] text)`
1804 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
1805 `"info"`, or `"verbose"`. Default is `"none"`.
1807 ### Registration functions
1808 Call these functions only at load time!
1810 * `minetest.register_entity(name, prototype table)`
1811 * `minetest.register_abm(abm definition)`
1812 * `minetest.register_lbm(lbm definition)`
1813 * `minetest.register_node(name, node definition)`
1814 * `minetest.register_tool(name, item definition)`
1815 * `minetest.register_craftitem(name, item definition)`
1816 * `minetest.register_alias(name, convert_to)`
1817 * `minetest.register_craft(recipe)`
1818 * `minetest.register_ore(ore definition)`
1819 * `minetest.register_decoration(decoration definition)`
1820 * `minetest.override_item(name, redefinition)`
1821 * Overrides fields of an item registered with register_node/tool/craftitem.
1822 * Note: Item must already be defined, (opt)depend on the mod defining it.
1823 * Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})`
1825 * `minetest.clear_registered_ores()`
1826 * `minetest.clear_registered_decorations()`
1828 ### Global callback registration functions
1829 Call these functions only at load time!
1831 * `minetest.register_globalstep(func(dtime))`
1832 * Called every server step, usually interval of 0.1s
1833 * `minetest.register_on_shutdown(func())`
1834 * Called before server shutdown
1835 * **Warning**: If the server terminates abnormally (i.e. crashes), the registered
1836 callbacks **will likely not be run**. Data should be saved at
1837 semi-frequent intervals as well as on server shutdown.
1838 * `minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
1839 * Called when a node has been placed
1840 * If return `true` no item is taken from `itemstack`
1841 * **Not recommended**; use `on_construct` or `after_place_node` in node definition
1843 * `minetest.register_on_dignode(func(pos, oldnode, digger))`
1844 * Called when a node has been dug.
1845 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node definition
1847 * `minetest.register_on_punchnode(func(pos, node, puncher, pointed_thing))`
1848 * Called when a node is punched
1849 * `minetest.register_on_generated(func(minp, maxp, blockseed))`
1850 * Called after generating a piece of world. Modifying nodes inside the area
1851 is a bit faster than usually.
1852 * `minetest.register_on_newplayer(func(ObjectRef))`
1853 * Called after a new player has been created
1854 * `minetest.register_on_dieplayer(func(ObjectRef))`
1855 * Called when a player dies
1856 * `minetest.register_on_punchplayer(func(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
1857 * Called when a player is punched
1858 * `player` - ObjectRef - Player that was punched
1859 * `hitter` - ObjectRef - Player that hit
1860 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be nil)
1861 * `tool_capabilities`: capability table of used tool (can be nil)
1862 * `dir`: unit vector of direction of punch. Always defined. Points from
1863 the puncher to the punched.
1864 * `damage` - number that represents the damage calculated by the engine
1865 * should return `true` to prevent the default damage mechanism
1866 * `minetest.register_on_player_hpchange(func(player, hp_change), modifier)`
1867 * Called when the player gets damaged or healed
1868 * `player`: ObjectRef of the player
1869 * `hp_change`: the amount of change. Negative when it is damage.
1870 * `modifier`: when true, the function should return the actual hp_change.
1871 Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
1872 modifiers can return true as a second argument to stop the execution of further functions.
1873 Non-modifiers receive the final hp change calculated by the modifiers.
1874 * `minetest.register_on_respawnplayer(func(ObjectRef))`
1875 * Called when player is to be respawned
1876 * Called _before_ repositioning of player occurs
1877 * return true in func to disable regular player placement
1878 * `minetest.register_on_prejoinplayer(func(name, ip))`
1879 * Called before a player joins the game
1880 * If it returns a string, the player is disconnected with that string as reason
1881 * `minetest.register_on_joinplayer(func(ObjectRef))`
1882 * Called when a player joins the game
1883 * `minetest.register_on_leaveplayer(func(ObjectRef))`
1884 * Called when a player leaves the game
1885 * `minetest.register_on_cheat(func(ObjectRef, cheat))`
1886 * Called when a player cheats
1887 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
1888 * `"moved_too_fast"`
1889 * `"interacted_too_far"`
1890 * `"finished_unknown_dig"`
1893 * `minetest.register_on_chat_message(func(name, message))`
1894 * Called always when a player says something
1895 * Return `true` to mark the message as handled, which means that it will not be sent to other players
1896 * `minetest.register_on_player_receive_fields(func(player, formname, fields))`
1897 * Called when a button is pressed in player's inventory form
1898 * Newest functions are called first
1899 * If function returns `true`, remaining functions are not called
1900 * `minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))`
1901 * Called when `player` crafts something
1902 * `itemstack` is the output
1903 * `old_craft_grid` contains the recipe (Note: the one in the inventory is cleared)
1904 * `craft_inv` is the inventory with the crafting grid
1905 * Return either an `ItemStack`, to replace the output, or `nil`, to not modify it
1906 * `minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))`
1907 * The same as before, except that it is called before the player crafts, to make
1908 craft prediction, and it should not change anything.
1909 * `minetest.register_on_protection_violation(func(pos, name))`
1910 * Called by `builtin` and mods when a player violates protection at a position
1911 (eg, digs a node or punches a protected entity).
1912 * The registered functions can be called using `minetest.record_protection_violation`
1913 * The provided function should check that the position is protected by the mod
1914 calling this function before it prints a message, if it does, to allow for
1915 multiple protection mods.
1916 * `minetest.register_on_item_eat(func(hp_change, replace_with_item, itemstack, user, pointed_thing))`
1917 * Called when an item is eaten, by `minetest.item_eat`
1918 * Return `true` or `itemstack` to cancel the default item eat response (i.e.: hp increase)
1920 ### Other registration functions
1921 * `minetest.register_chatcommand(cmd, chatcommand definition)`
1922 * `minetest.register_privilege(name, definition)`
1923 * `definition`: `"description text"`
1924 * `definition`: `{ description = "description text", give_to_singleplayer = boolean, -- default: true }`
1925 * `minetest.register_authentication_handler(handler)`
1926 * See `minetest.builtin_auth_handler` in `builtin.lua` for reference
1929 * `minetest.setting_set(name, value)`
1930 * Setting names can't contain whitespace or any of `="{}#`.
1931 * Setting values can't contain the sequence `\n"""`.
1932 * Setting names starting with "secure." can't be set.
1933 * `minetest.setting_get(name)`: returns string or `nil`
1934 * `minetest.setting_setbool(name, value)`
1935 * See documentation on `setting_set` for restrictions.
1936 * `minetest.setting_getbool(name)`: returns boolean or `nil`
1937 * `minetest.setting_get_pos(name)`: returns position or nil
1938 * `minetest.setting_save()`, returns `nil`, save all settings to config file
1941 * `minetest.notify_authentication_modified(name)`
1942 * Should be called by the authentication handler if privileges changes.
1943 * To report everybody, set `name=nil`.
1944 * `minetest.get_password_hash(name, raw_password)`
1945 * Convert a name-password pair to a password hash that Minetest can use.
1946 * The returned value alone is not a good basis for password checks based
1947 * on comparing the password hash in the database with the password hash
1948 * from the function, with an externally provided password, as the hash
1949 * in the db might use the new SRP verifier format.
1950 * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
1951 * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
1952 * Convert between two privilege representations
1953 * `minetest.set_player_password(name, password_hash)`
1954 * `minetest.set_player_privs(name, {priv1=true,...})`
1955 * `minetest.get_player_privs(name) -> {priv1=true,...}`
1956 * `minetest.auth_reload()`
1957 * `minetest.check_player_privs(player_or_name, ...)`: returns `bool, missing_privs`
1958 * A quickhand for checking privileges.
1959 * `player_or_name`: Either a Player object or the name of a player.
1960 * `...` is either a list of strings, e.g. `"priva", "privb"` or
1961 a table, e.g. `{ priva = true, privb = true }`.
1962 * `minetest.get_player_ip(name)`: returns an IP address string
1964 `minetest.set_player_password`, `minetest_set_player_privs`, `minetest_get_player_privs`
1965 and `minetest.auth_reload` call the authetification handler.
1968 * `minetest.chat_send_all(text)`
1969 * `minetest.chat_send_player(name, text)`
1971 ### Environment access
1972 * `minetest.set_node(pos, node)`
1973 * `minetest.add_node(pos, node): alias set_node(pos, node)`
1974 * Set node at position (`node = {name="foo", param1=0, param2=0}`)
1975 * `minetest.swap_node(pos, node`
1976 * Set node at position, but don't remove metadata
1977 * `minetest.remove_node(pos)`
1978 * Equivalent to `set_node(pos, "air")`
1979 * `minetest.get_node(pos)`
1980 * Returns the node at the given position as table in the format
1981 `{name="node_name", param1=0, param2=0}`, returns `{name="ignore", param1=0, param2=0}`
1983 * `minetest.get_node_or_nil(pos)`
1984 * Same as `get_node` but returns `nil` for unloaded areas.
1985 * `minetest.get_node_light(pos, timeofday)`
1986 * Gets the light value at the given position. Note that the light value
1987 "inside" the node at the given position is returned, so you usually want
1988 to get the light value of a neighbor.
1989 * `pos`: The position where to measure the light.
1990 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
1991 * Returns a number between `0` and `15` or `nil`
1992 * `minetest.place_node(pos, node)`
1993 * Place node with the same effects that a player would cause
1994 * `minetest.dig_node(pos)`
1995 * Dig node with the same effects that a player would cause
1996 * Returns `true` if successful, `false` on failure (e.g. protected location)
1997 * `minetest.punch_node(pos)`
1998 * Punch node with the same effects that a player would cause
2000 * `minetest.find_nodes_with_meta(pos1, pos2)`
2001 * Get a table of positions of nodes that have metadata within a region {pos1, pos2}
2002 * `minetest.get_meta(pos)`
2003 * Get a `NodeMetaRef` at that position
2004 * `minetest.get_node_timer(pos)`
2005 * Get `NodeTimerRef`
2007 * `minetest.add_entity(pos, name)`: Spawn Lua-defined entity at position
2008 * Returns `ObjectRef`, or `nil` if failed
2009 * `minetest.add_item(pos, item)`: Spawn item
2010 * Returns `ObjectRef`, or `nil` if failed
2011 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
2012 * `minetest.get_objects_inside_radius(pos, radius)`
2013 * `radius`: using an euclidean metric
2014 * `minetest.set_timeofday(val)`
2015 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
2016 * `minetest.get_timeofday()`
2017 * `minetest.get_gametime()`: returns the time, in seconds, since the world was created
2018 * `minetest.get_day_count()`: returns number days elapsed since world was created,
2019 * accounting for time changes.
2020 * `minetest.find_node_near(pos, radius, nodenames)`: returns pos or `nil`
2021 * `radius`: using a maximum metric
2022 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2023 * `minetest.find_nodes_in_area(minp, maxp, nodenames)`: returns a list of positions
2024 * returns as second value a table with the count of the individual nodes found
2025 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2026 * `minetest.find_nodes_in_area_under_air(minp, maxp, nodenames)`: returns a list of positions
2027 * returned positions are nodes with a node air above
2028 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
2029 * `minetest.get_perlin(noiseparams)`
2030 * `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
2031 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
2032 * `minetest.get_voxel_manip([pos1, pos2])`
2033 * Return voxel manipulator object.
2034 * Loads the manipulator from the map if positions are passed.
2035 * `minetest.set_gen_notify(flags, {deco_ids})`
2036 * Set the types of on-generate notifications that should be collected
2037 * `flags` is a flag field with the available flags: `dungeon`, `temple`, `cave_begin`,
2038 `cave_end`, `large_cave_begin`, `large_cave_end`, `decoration`
2039 * The second parameter is a list of IDS of decorations which notification is requested for
2040 * `get_gen_notify()`: returns a flagstring and a table with the deco_ids
2041 * `minetest.get_mapgen_object(objectname)`
2042 * Return requested mapgen object if available (see "Mapgen objects")
2043 * `minetest.get_biome_id(biome_name)`
2044 * Returns the biome id, as used in the biomemap Mapgen object, for a
2045 given biome_name string.
2046 * `minetest.get_mapgen_params()` Returns mapgen parameters, a table containing
2047 `mgname`, `seed`, `chunksize`, `water_level`, and `flags`.
2048 * `minetest.set_mapgen_params(MapgenParams)`
2049 * Set map generation parameters
2050 * Function cannot be called after the registration period; only initialization
2051 and `on_mapgen_init`
2052 * Takes a table as an argument with the fields `mgname`, `seed`, `water_level`,
2054 * Leave field unset to leave that parameter unchanged
2055 * `flags` contains a comma-delimited string of flags to set,
2056 or if the prefix `"no"` is attached, clears instead.
2057 * `flags` is in the same format and has the same options as `mg_flags` in `minetest.conf`
2058 * `minetest.set_noiseparams(name, noiseparams, set_default)`
2059 * Sets the noiseparams setting of `name` to the noiseparams table specified in `noiseparams`.
2060 * `set_default` is an optional boolean (default: `true`) that specifies whether the setting
2061 should be applied to the default config or current active config
2062 * `minetest.get_noiseparams(name)`: returns a table of the noiseparams for name
2063 * `minetest.generate_ores(vm, pos1, pos2)`
2064 * Generate all registered ores within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
2065 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
2066 * `minetest.generate_decorations(vm, pos1, pos2)`
2067 * Generate all registered decorations within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
2068 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
2069 * `minetest.clear_objects([options])`
2070 * Clear all objects in the environment
2071 * Takes an optional table as an argument with the field `mode`.
2072 * mode = `"full"`: Load and go through every mapblock, clearing objects (default).
2073 * mode = `"quick"`: Clear objects immediately in loaded mapblocks;
2074 clear objects in unloaded mapblocks only when the mapblocks are next activated.
2075 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
2076 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be asynchronously
2077 * fetched from memory, loaded from disk, or if inexistent, generates them.
2078 * If `callback` is a valid Lua function, this will be called for each block emerged.
2079 * The function signature of callback is:
2080 * `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
2081 * - `blockpos` is the *block* coordinates of the block that had been emerged
2082 * - `action` could be one of the following constant values:
2083 * `core.EMERGE_CANCELLED`, `core.EMERGE_ERRORED`, `core.EMERGE_FROM_MEMORY`,
2084 * `core.EMERGE_FROM_DISK`, `core.EMERGE_GENERATED`
2085 * - `calls_remaining` is the number of callbacks to be expected after this one
2086 * - `param` is the user-defined parameter passed to emerge_area (or nil if the
2087 * parameter was absent)
2088 * `minetest.delete_area(pos1, pos2)`
2089 * delete all mapblocks in the area from pos1 to pos2, inclusive
2090 * `minetest.line_of_sight(pos1, pos2, stepsize)`: returns `boolean, pos`
2091 * Check if there is a direct line of sight between `pos1` and `pos2`
2092 * Returns the position of the blocking node when `false`
2093 * `pos1`: First position
2094 * `pos2`: Second position
2095 * `stepsize`: smaller gives more accurate results but requires more computing
2096 time. Default is `1`.
2097 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
2098 * returns table containing path
2099 * returns a table of 3D points representing a path from `pos1` to `pos2` or `nil`
2100 * `pos1`: start position
2101 * `pos2`: end position
2102 * `searchdistance`: number of blocks to search in each direction using a maximum metric
2103 * `max_jump`: maximum height difference to consider walkable
2104 * `max_drop`: maximum height difference to consider droppable
2105 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
2106 * `minetest.spawn_tree (pos, {treedef})`
2107 * spawns L-System tree at given `pos` with definition in `treedef` table
2108 * `minetest.transforming_liquid_add(pos)`
2109 * add node to liquid update queue
2110 * `minetest.get_node_max_level(pos)`
2111 * get max available level for leveled node
2112 * `minetest.get_node_level(pos)`
2113 * get level of leveled node (water, snow)
2114 * `minetest.set_node_level(pos, level)`
2115 * set level of leveled node, default `level` equals `1`
2116 * if `totallevel > maxlevel`, returns rest (`total-max`).
2117 * `minetest.add_node_level(pos, level)`
2118 * increase level of leveled node by level, default `level` equals `1`
2119 * if `totallevel > maxlevel`, returns rest (`total-max`)
2120 * can be negative for decreasing
2123 `minetest.get_inventory(location)`: returns an `InvRef`
2126 * `{type="player", name="celeron55"}`
2127 * `{type="node", pos={x=, y=, z=}}`
2128 * `{type="detached", name="creative"}`
2129 * `minetest.create_detached_inventory(name, callbacks)`: returns an `InvRef`
2130 * callbacks: See "Detached inventory callbacks"
2131 * Creates a detached inventory. If it already exists, it is cleared.
2132 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
2133 returns left over ItemStack
2134 * See `minetest.item_eat` and `minetest.register_on_item_eat`
2137 * `minetest.show_formspec(playername, formname, formspec)`
2138 * `playername`: name of player to show formspec
2139 * `formname`: name passed to `on_player_receive_fields` callbacks.
2140 It should follow the `"modname:<whatever>"` naming convention
2141 * `formspec`: formspec to display
2142 * `minetest.formspec_escape(string)`: returns a string
2143 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
2144 * `minetest.explode_table_event(string)`: returns a table
2145 * returns e.g. `{type="CHG", row=1, column=2}`
2147 * `"INV"`: no row selected)
2148 * `"CHG"`: selected)
2149 * `"DCL"`: double-click
2150 * `minetest.explode_textlist_event(string)`: returns a table
2151 * returns e.g. `{type="CHG", index=1}`
2153 * `"INV"`: no row selected)
2154 * `"CHG"`: selected)
2155 * `"DCL"`: double-click
2156 * `minetest.explode_scrollbar_event(string)`: returns a table
2157 * returns e.g. `{type="CHG", value=500}`
2159 * `"INV"`: something failed
2160 * `"CHG"`: has been changed
2161 * `"VAL"`: not changed
2164 * `minetest.inventorycube(img1, img2, img3)`
2165 * Returns a string for making an image of a cube (useful as an item image)
2166 * `minetest.get_pointed_thing_position(pointed_thing, above)`
2167 * Get position of a `pointed_thing` (that you can get from somewhere)
2168 * `minetest.dir_to_facedir(dir, is6d)`
2169 * Convert a vector to a facedir value, used in `param2` for `paramtype2="facedir"`;
2170 * passing something non-`nil`/`false` for the optional second parameter causes it to
2171 take the y component into account
2172 * `minetest.facedir_to_dir(facedir)`
2173 * Convert a facedir back into a vector aimed directly out the "back" of a node
2174 * `minetest.dir_to_wallmounted(dir)`
2175 * Convert a vector to a wallmounted value, used for `paramtype2="wallmounted"`
2176 * `minetest.wallmounted_to_dir(wallmounted)`
2177 * Convert a wallmounted value back into a vector aimed directly out the "back" of a node
2178 * `minetest.get_node_drops(nodename, toolname)`
2179 * Returns list of item names.
2180 * **Note**: This will be removed or modified in a future version.
2181 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
2182 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2183 * `input.width` = for example `3`
2184 * `input.items` = for example
2185 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2186 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
2187 * `output.time` = a number, if unsuccessful: `0`
2188 * `output.replacements` = list of `ItemStack`s that couldn't be placed in
2189 `decremented_input.items`
2190 * `decremented_input` = like `input`
2191 * `minetest.get_craft_recipe(output)`: returns input
2192 * returns last registered recipe for output item (node)
2193 * `output` is a node or item type such as `"default:torch"`
2194 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2195 * `input.width` = for example `3`
2196 * `input.items` = for example
2197 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2198 * `input.items` = `nil` if no recipe found
2199 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
2200 * returns indexed table with all registered recipes for query item (node)
2201 or `nil` if no recipe was found
2202 * recipe entry table:
2204 method = 'normal' or 'cooking' or 'fuel'
2205 width = 0-3, 0 means shapeless recipe
2206 items = indexed [1-9] table with recipe items
2207 output = string with item name and quantity
2209 * Example query for `"default:gold_ingot"` will return table:
2211 [1]={type = "cooking", width = 3, output = "default:gold_ingot",
2212 items = {1 = "default:gold_lump"}},
2213 [2]={type = "normal", width = 1, output = "default:gold_ingot 9",
2214 items = {1 = "default:goldblock"}}
2216 * `minetest.handle_node_drops(pos, drops, digger)`
2217 * `drops`: list of itemstrings
2218 * Handles drops from nodes after digging: Default action is to put them into
2220 * Can be overridden to get different functionality (e.g. dropping items on
2224 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
2225 returns `{{actor, pos, time, oldnode, newnode}, ...}`
2226 * Find who has done something to a node, or near a node
2227 * `actor`: `"player:<name>"`, also `"liquid"`.
2228 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns `boolean, log_messages`
2229 * Revert latest actions of someone
2230 * `actor`: `"player:<name>"`, also `"liquid"`.
2232 ### Defaults for the `on_*` item definition functions
2233 These functions return the leftover itemstack.
2235 * `minetest.item_place_node(itemstack, placer, pointed_thing, param2)`
2236 * Place item as a node
2237 * `param2` overrides `facedir` and wallmounted `param2`
2238 * returns `itemstack, success`
2239 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
2241 * `minetest.item_place(itemstack, placer, pointed_thing, param2)`
2242 * Use one of the above based on what the item is.
2243 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
2244 * **Note**: is not called when wielded item overrides `on_place`
2245 * `param2` overrides `facedir` and wallmounted `param2`
2246 * returns `itemstack, success`
2247 * `minetest.item_drop(itemstack, dropper, pos)`
2249 * `minetest.item_eat(hp_change, replace_with_item)`
2251 * `replace_with_item` is the itemstring which is added to the inventory.
2252 If the player is eating a stack, then replace_with_item goes to a
2253 different spot. Can be `nil`
2254 * See `minetest.do_item_eat`
2256 ### Defaults for the `on_punch` and `on_dig` node definition callbacks
2257 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
2258 * Calls functions registered by `minetest.register_on_punchnode()`
2259 * `minetest.node_dig(pos, node, digger)`
2260 * Checks if node can be dug, puts item into inventory, removes node
2261 * Calls functions registered by `minetest.registered_on_dignodes()`
2264 * `minetest.sound_play(spec, parameters)`: returns a handle
2265 * `spec` is a `SimpleSoundSpec`
2266 * `parameters` is a sound parameter table
2267 * `minetest.sound_stop(handle)`
2270 * `minetest.after(time, func, ...)`
2271 * Call the function `func` after `time` seconds, may be fractional
2272 * Optional: Variable number of arguments that are passed to `func`
2275 * `minetest.request_shutdown([message],[reconnect])`: request for server shutdown. Will display `message` to clients,
2276 and `reconnect` == true displays a reconnect button.
2277 * `minetest.get_server_status()`: returns server status string
2280 * `minetest.get_ban_list()`: returns the ban list (same as `minetest.get_ban_description("")`)
2281 * `minetest.get_ban_description(ip_or_name)`: returns ban description (string)
2282 * `minetest.ban_player(name)`: ban a player
2283 * `minetest.unban_player_or_ip(name)`: unban player or IP address
2284 * `minetest.kick_player(name, [reason])`: disconnect a player with a optional reason
2287 * `minetest.add_particle(particle definition)`
2288 * Deprecated: `minetest.add_particle(pos, velocity, acceleration, expirationtime,
2289 size, collisiondetection, texture, playername)`
2291 * `minetest.add_particlespawner(particlespawner definition)`
2292 * Add a `ParticleSpawner`, an object that spawns an amount of particles over `time` seconds
2293 * Returns an `id`, and -1 if adding didn't succeed
2294 * `Deprecated: minetest.add_particlespawner(amount, time,
2298 minexptime, maxexptime,
2300 collisiondetection, texture, playername)`
2302 * `minetest.delete_particlespawner(id, player)``
2303 * Delete `ParticleSpawner` with `id` (return value from `minetest.add_particlespawner`)
2304 * If playername is specified, only deletes on the player's client,
2305 * otherwise on all clients
2308 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
2309 * Create a schematic from the volume of map specified by the box formed by p1 and p2.
2310 * Apply the specified probability values to the specified nodes in `probability_list`.
2311 * `probability_list` is an array of tables containing two fields, `pos` and `prob`.
2312 * `pos` is the 3D vector specifying the absolute coordinates of the
2313 node being modified,
2314 * `prob` is the integer value from `0` to `255` of the probability (see: Schematic specifier).
2315 * If there are two or more entries with the same pos value, the
2317 * If `pos` is not inside the box formed by `p1` and `p2`, it is ignored.
2318 * If `probability_list` equals `nil`, no probabilities are applied.
2319 * Slice probability works in the same manner, except takes a field
2320 called `ypos` instead which
2321 indicates the y position of the slice with a probability applied.
2322 * If slice probability list equals `nil`, no slice probabilities are applied.
2323 * Saves schematic in the Minetest Schematic format to filename.
2325 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement)`
2326 * Place the schematic specified by schematic (see: Schematic specifier) at `pos`.
2327 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
2328 * If the `rotation` parameter is omitted, the schematic is not rotated.
2329 * `replacements` = `{["old_name"] = "convert_to", ...}`
2330 * `force_placement` is a boolean indicating whether nodes other than `air` and
2331 `ignore` are replaced by the schematic
2332 * Returns nil if the schematic could not be loaded.
2334 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement)`:
2335 * This function is analagous to minetest.place_schematic, but places a schematic onto the
2336 specified VoxelManip object `vmanip` instead of the whole map.
2337 * Returns false if any part of the schematic was cut-off due to the VoxelManip not
2338 containing the full area required, and true if the whole schematic was able to fit.
2339 * Returns nil if the schematic could not be loaded.
2340 * After execution, any external copies of the VoxelManip contents are invalidated.
2342 * `minetest.serialize_schematic(schematic, format, options)`
2343 * Return the serialized schematic specified by schematic (see: Schematic specifier)
2344 * in the `format` of either "mts" or "lua".
2345 * "mts" - a string containing the binary MTS data used in the MTS file format
2346 * "lua" - a string containing Lua code representing the schematic in table format
2347 * `options` is a table containing the following optional parameters:
2348 * If `lua_use_comments` is true and `format` is "lua", the Lua code generated will have (X, Z)
2349 * position comments for every X row generated in the schematic data for easier reading.
2350 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua", the Lua code generated
2351 * will use that number of spaces as indentation instead of a tab character.
2354 * `minetest.request_http_api()`:
2355 * returns `HTTPApiTable` containing http functions if the calling mod has been granted
2356 access by being listed in the `secure.http_mods` or `secure.trusted_mods` setting,
2357 otherwise returns `nil`.
2358 * The returned table contains the functions `fetch`, `fetch_async` and `fetch_async_get`
2360 * Only works at init time and must be called from the mod's main scope (not from a function).
2361 * Function only exists if minetest server was built with cURL support.
2362 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
2364 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
2365 * Performs given request asynchronously and calls callback upon completion
2366 * callback: `function(HTTPRequestResult res)`
2367 * Use this HTTP function if you are unsure, the others are for advanced use.
2368 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
2369 * Performs given request asynchronously and returns handle for `minetest.http_fetch_async_get`
2370 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
2371 * Return response data for given asynchronous HTTP request
2374 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
2375 * `minetest.hash_node_position({x=,y=,z=})`: returns an 48-bit integer
2376 * Gives a unique hash number for a node position (16+16+16=48bit)
2377 * `minetest.get_position_from_hash(hash)`: returns a position
2378 * Inverse transform of `minetest.hash_node_position`
2379 * `minetest.get_item_group(name, group)`: returns a rating
2380 * Get rating of a group of an item. (`0` means: not in group)
2381 * `minetest.get_node_group(name, group)`: returns a rating
2382 * Deprecated: An alias for the former.
2383 * `minetest.raillike_group(name)`: returns a rating
2384 * Returns rating of the connect_to_raillike group corresponding to name
2385 * If name is not yet the name of a connect_to_raillike group, a new group id
2386 * is created, with that name
2387 * `minetest.get_content_id(name)`: returns an integer
2388 * Gets the internal content ID of `name`
2389 * `minetest.get_name_from_content_id(content_id)`: returns a string
2390 * Gets the name of the content with that content ID
2391 * `minetest.parse_json(string[, nullvalue])`: returns something
2392 * Convert a string containing JSON data into the Lua equivalent
2393 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
2394 * On success returns a table, a string, a number, a boolean or `nullvalue`
2395 * On failure outputs an error message and returns `nil`
2396 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
2397 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
2398 * Convert a Lua table into a JSON string
2399 * styled: Outputs in a human-readable format if this is set, defaults to false
2400 * Unserializable things like functions and userdata are saved as null.
2401 * **Warning**: JSON is more strict than the Lua table format.
2402 1. You can only use strings and positive integers of at least one as keys.
2403 2. You can not mix string and integer keys.
2404 This is due to the fact that JSON has two distinct array and object values.
2405 * Example: `write_json({10, {a = false}})`, returns `"[10, {\"a\": false}]"`
2406 * `minetest.serialize(table)`: returns a string
2407 * Convert a table containing tables, strings, numbers, booleans and `nil`s
2408 into string form readable by `minetest.deserialize`
2409 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
2410 * `minetest.deserialize(string)`: returns a table
2411 * Convert a string returned by `minetest.deserialize` into a table
2412 * `string` is loaded in an empty sandbox environment.
2413 * Will load functions, but they cannot access the global environment.
2414 * Example: `deserialize('return { ["foo"] = "bar" }')`, returns `{foo='bar'}`
2415 * Example: `deserialize('print("foo")')`, returns `nil` (function call fails)
2416 * `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
2417 * `minetest.compress(data, method, ...)`: returns `compressed_data`
2418 * Compress a string of data.
2419 * `method` is a string identifying the compression method to be used.
2420 * Supported compression methods:
2421 * Deflate (zlib): `"deflate"`
2422 * `...` indicates method-specific arguments. Currently defined arguments are:
2423 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
2424 * `minetest.decompress(compressed_data, method, ...)`: returns data
2425 * Decompress a string of data (using ZLib).
2426 * See documentation on `minetest.compress()` for supported compression methods.
2427 * currently supported.
2428 * `...` indicates method-specific arguments. Currently, no methods use this.
2429 * `minetest.is_protected(pos, name)`: returns boolean
2430 * Returns true, if player `name` shouldn't be abled to dig at `pos` or do other
2431 actions, defineable by mods, due to some mod-defined ownership-like concept.
2432 Returns false or nil, if the player is allowed to do such actions.
2433 * This function should be overridden by protection mods and should be used to
2434 check if a player can interact at a position.
2435 * This function should call the old version of itself if the position is not
2436 protected by the mod.
2439 local old_is_protected = minetest.is_protected
2440 function minetest.is_protected(pos, name)
2441 if mymod:position_protected_from(pos, name) then
2444 return old_is_protected(pos, name)
2446 * `minetest.record_protection_violation(pos, name)`
2447 * This function calls functions registered with
2448 `minetest.register_on_protection_violation`.
2449 * `minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)`
2450 * Attempt to predict the desired orientation of the facedir-capable node
2451 defined by `itemstack`, and place it accordingly (on-wall, on the floor, or
2452 hanging from the ceiling). Stacks are handled normally if the `infinitestacks`
2453 field is false or omitted (else, the itemstack is not changed). `orient_flags`
2454 is an optional table containing extra tweaks to the placement code:
2455 * `invert_wall`: if `true`, place wall-orientation on the ground and ground-
2456 orientation on the wall.
2457 * `force_wall` : if `true`, always place the node in wall orientation.
2458 * `force_ceiling`: if `true`, always place on the ceiling.
2459 * `force_floor`: if `true`, always place the node on the floor.
2460 * `force_facedir`: if `true`, forcefully reset the facedir to north when placing on
2461 the floor or ceiling
2462 * The first four options are mutually-exclusive; the last in the list takes
2463 precedence over the first.
2464 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
2465 * calls `rotate_and_place()` with infinitestacks set according to the state of
2466 the creative mode setting, and checks for "sneak" to set the `invert_wall`
2469 * `minetest.forceload_block(pos)`
2470 * forceloads the position `pos`.
2471 * returns `true` if area could be forceloaded
2472 * Please note that forceloaded areas are saved when the server restarts.
2474 * `minetest.forceload_free_block(pos)`
2475 * stops forceloading the position `pos`
2477 * `minetest.request_insecure_environment()`: returns an environment containing
2478 insecure functions if the calling mod has been listed as trusted in the
2479 `secure.trusted_mods` setting or security is disabled, otherwise returns `nil`.
2480 * Only works at init time and must be called from the mod's main scope (not from a function).
2481 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE IT IN
2484 * `minetest.global_exists(name)`
2485 * Checks if a global variable has been set, without triggering a warning.
2488 * `minetest.env`: `EnvRef` of the server environment and world.
2489 * Any function in the minetest namespace can be called using the syntax
2490 `minetest.env:somefunction(somearguments)`
2491 instead of `minetest.somefunction(somearguments)`
2492 * Deprecated, but support is not to be dropped soon
2495 * `minetest.registered_items`
2496 * Map of registered items, indexed by name
2497 * `minetest.registered_nodes`
2498 * Map of registered node definitions, indexed by name
2499 * `minetest.registered_craftitems`
2500 * Map of registered craft item definitions, indexed by name
2501 * `minetest.registered_tools`
2502 * Map of registered tool definitions, indexed by name
2503 * `minetest.registered_entities`
2504 * Map of registered entity prototypes, indexed by name
2505 * `minetest.object_refs`
2506 * Map of object references, indexed by active object id
2507 * `minetest.luaentities`
2508 * Map of Lua entities, indexed by active object id
2509 * `minetest.registered_ores`
2510 * List of registered ore definitions.
2511 * `minetest.registered_biomes`
2512 * List of registered biome definitions.
2513 * `minetest.registered_decorations`
2514 * List of registered decoration definitions.
2520 Node metadata: reference extra data and functionality stored in a node.
2521 Can be gotten via `minetest.get_meta(pos)`.
2524 * `set_string(name, value)`
2525 * `get_string(name)`
2526 * `set_int(name, value)`
2528 * `set_float(name, value)`
2530 * `get_inventory()`: returns `InvRef`
2531 * `to_table()`: returns `nil` or `{fields = {...}, inventory = {list1 = {}, ...}}`
2532 * `from_table(nil or {})`
2533 * See "Node Metadata"
2536 Node Timers: a high resolution persistent per-node timer.
2537 Can be gotten via `minetest.get_node_timer(pos)`.
2540 * `set(timeout,elapsed)`
2541 * set a timer's state
2542 * `timeout` is in seconds, and supports fractional values (0.1 etc)
2543 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
2544 * will trigger the node's `on_timer` function after `timeout`-elapsed seconds
2547 * equivalent to `set(timeout,0)`
2550 * `get_timeout()`: returns current timeout in seconds
2551 * if `timeout` equals `0`, timer is inactive
2552 * `get_elapsed()`: returns current elapsed time in seconds
2553 * the node's `on_timer` function will be called after `timeout`-elapsed seconds
2554 * `is_started()`: returns boolean state of timer
2555 * returns `true` if timer is started, otherwise `false`
2558 Moving things in the game are generally these.
2560 This is basically a reference to a C++ `ServerActiveObject`
2563 * `remove()`: remove object (after returning from Lua)
2564 * Note: Doesn't work on players, use minetest.kick_player instead
2565 * `getpos()`: returns `{x=num, y=num, z=num}`
2566 * `setpos(pos)`; `pos`=`{x=num, y=num, z=num}`
2567 * `moveto(pos, continuous=false)`: interpolated move
2568 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
2569 * `puncher` = another `ObjectRef`,
2570 * `time_from_last_punch` = time since last punch action of the puncher
2571 * `direction`: can be `nil`
2572 * `right_click(clicker)`; `clicker` is another `ObjectRef`
2573 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
2574 * `set_hp(hp)`: set number of hitpoints (2 * number of hearts)
2575 * `get_inventory()`: returns an `InvRef`
2576 * `get_wield_list()`: returns the name of the inventory list the wielded item is in
2577 * `get_wield_index()`: returns the index of the wielded item
2578 * `get_wielded_item()`: returns an `ItemStack`
2579 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if successful
2580 * `set_armor_groups({group1=rating, group2=rating, ...})`
2581 * `get_armor_groups()`: returns a table with the armor group ratings
2582 * `set_animation({x=1,y=1}, frame_speed=15, frame_blend=0, frame_loop=true)`
2583 * `get_animation()`: returns range, frame_speed, frame_blend and frame_loop
2584 * `set_attach(parent, bone, position, rotation)`
2586 * `position`: `{x=num, y=num, z=num}` (relative)
2587 * `rotation`: `{x=num, y=num, z=num}`
2588 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't attached
2590 * `set_bone_position(bone, position, rotation)`
2592 * `position`: `{x=num, y=num, z=num}` (relative)
2593 * `rotation`: `{x=num, y=num, z=num}`
2594 * `get_bone_position(bone)`: returns position and rotation of the bone
2595 * `set_properties(object property table)`
2596 * `get_properties()`: returns object property table
2597 * `is_player()`: returns true for players, false otherwise
2598 * `get_nametag_attributes()`
2599 * returns a table with the attributes of the nametag of an object
2601 color = {a=0..255, r=0..255, g=0..255, b=0..255},
2604 * `set_nametag_attributes(attributes)`
2605 * sets the attributes of the nametag of an object
2609 text = "My Nametag",
2612 ##### LuaEntitySAO-only (no-op for other objects)
2613 * `setvelocity({x=num, y=num, z=num})`
2614 * `getvelocity()`: returns `{x=num, y=num, z=num}`
2615 * `setacceleration({x=num, y=num, z=num})`
2616 * `getacceleration()`: returns `{x=num, y=num, z=num}`
2618 * `getyaw()`: returns number in radians
2619 * `settexturemod(mod)`
2620 * `setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
2621 select_horiz_by_yawpitch=false)`
2622 * Select sprite from spritesheet with optional animation and DM-style
2623 texture selection based on yaw relative to camera
2624 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
2627 ##### Player-only (no-op for other objects)
2628 * `get_player_name()`: returns `""` if is not a player
2629 * `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
2630 * `get_look_dir()`: get camera direction as a unit vector
2631 * `get_look_pitch()`: pitch in radians
2632 * `get_look_yaw()`: yaw in radians (wraps around pretty randomly as of now)
2633 * `set_look_pitch(radians)`: sets look pitch
2634 * `set_look_yaw(radians)`: sets look yaw
2635 * `get_breath()`: returns players breath
2636 * `set_breath(value)`: sets players breath
2638 * `0`: player is drowning,
2639 * `1`-`10`: remaining number of bubbles
2640 * `11`: bubbles bar is not shown
2641 * `set_inventory_formspec(formspec)`
2642 * Redefine player's inventory form
2643 * Should usually be called in on_joinplayer
2644 * `get_inventory_formspec()`: returns a formspec string
2645 * `get_player_control()`: returns table with player pressed keys
2646 * `{jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}`
2647 * `get_player_control_bits()`: returns integer with bit packed player pressed keys
2648 * bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
2649 * `set_physics_override(override_table)`
2650 * `override_table` is a table with the following fields:
2651 * `speed`: multiplier to default walking speed value (default: `1`)
2652 * `jump`: multiplier to default jump value (default: `1`)
2653 * `gravity`: multiplier to default gravity value (default: `1`)
2654 * `sneak`: whether player can sneak (default: `true`)
2655 * `sneak_glitch`: whether player can use the sneak glitch (default: `true`)
2656 * `get_physics_override()`: returns the table given to set_physics_override
2657 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
2659 * `hud_remove(id)`: remove the HUD element of the specified id
2660 * `hud_change(id, stat, value)`: change a value of a previously added HUD element
2661 * element `stat` values: `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
2662 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
2663 * `hud_set_flags(flags)`: sets specified HUD flags to `true`/`false`
2664 * `flags`: (is visible) `hotbar`, `healthbar`, `crosshair`, `wielditem`, `minimap`
2665 * pass a table containing a `true`/`false` value of each flag to be set or unset
2666 * if a flag equals `nil`, the flag is not modified
2667 * note that setting `minimap` modifies the client's permission to view the minimap -
2668 * the client may locally elect to not view the minimap
2669 * `hud_get_flags()`: returns a table containing status of hud flags
2670 * returns `{ hotbar=true, healthbar=true, crosshair=true, wielditem=true, breathbar=true, minimap=true }`
2671 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
2672 * `count`: number of items, must be between `1` and `23`
2673 * `hud_get_hotbar_itemcount`: returns number of visible items
2674 * `hud_set_hotbar_image(texturename)`
2675 * sets background image for hotbar
2676 * `hud_get_hotbar_image`: returns texturename
2677 * `hud_set_hotbar_selected_image(texturename)`
2678 * sets image for selected item of hotbar
2679 * `hud_get_hotbar_selected_image`: returns texturename
2680 * `hud_replace_builtin(name, hud_definition)`
2681 * replace definition of a builtin hud element
2682 * `name`: `"breath"` or `"health"`
2683 * `hud_definition`: definition to replace builtin definition
2684 * `set_sky(bgcolor, type, {texture names})`
2685 * `bgcolor`: ColorSpec, defaults to white
2687 * `"regular"`: Uses 0 textures, `bgcolor` ignored
2688 * `"skybox"`: Uses 6 textures, `bgcolor` used
2689 * `"plain"`: Uses 0 textures, `bgcolor` used
2690 * `get_sky()`: returns bgcolor, type and a table with the textures
2691 * `override_day_night_ratio(ratio or nil)`
2692 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific amount
2693 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
2694 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
2695 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`
2697 set animation for player model in third person view
2699 set_local_animation({x=0, y=79}, -- < stand/idle animation key frames
2700 {x=168, y=187}, -- < walk animation key frames
2701 {x=189, y=198}, -- < dig animation key frames
2702 {x=200, y=219}, -- < walk+dig animation key frames
2703 frame_speed=30): -- < animation frame speed
2704 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and frame_speed
2705 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for camera per player
2706 * in first person view
2707 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
2708 * `get_eye_offset()`: returns offset_first and offset_third
2711 An `InvRef` is a reference to an inventory.
2714 * `is_empty(listname)`: return `true` if list is empty
2715 * `get_size(listname)`: get size of a list
2716 * `set_size(listname, size)`: set size of a list
2717 * returns `false` on error (e.g. invalid `listname` or `size`)
2718 * `get_width(listname)`: get width of a list
2719 * `set_width(listname, width)`: set width of list; currently used for crafting
2720 * `get_stack(listname, i)`: get a copy of stack index `i` in list
2721 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
2722 * `get_list(listname)`: return full list
2723 * `set_list(listname, list)`: set full list (size will not change)
2724 * `get_lists()`: returns list of inventory lists
2725 * `set_lists(lists)`: sets inventory lists (size will not change)
2726 * `add_item(listname, stack)`: add item somewhere in list, returns leftover `ItemStack`
2727 * `room_for_item(listname, stack):` returns `true` if the stack of items
2728 can be fully added to the list
2729 * `contains_item(listname, stack)`: returns `true` if the stack of items
2730 can be fully taken from the list
2731 * `remove_item(listname, stack)`: take as many items as specified from the list,
2732 returns the items that were actually removed (as an `ItemStack`) -- note that
2733 any item metadata is ignored, so attempting to remove a specific unique
2734 item this way will likely remove the wrong one -- to do that use `set_stack`
2735 with an empty `ItemStack`
2736 * `get_location()`: returns a location compatible to `minetest.get_inventory(location)`
2737 * returns `{type="undefined"}` in case location is not known
2740 A fast access data structure to store areas, and find areas near a given position or area.
2741 Every area has a `data` string attribute to store additional information.
2742 You can create an empty `AreaStore` by calling `AreaStore()`, or `AreaStore(type_name)`.
2743 If you chose the parameter-less constructor, a fast implementation will be automatically chosen for you.
2746 * `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.
2747 * `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.
2748 * `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.
2749 * `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.
2750 * `reserve(count)`: reserves resources for at most `count` many contained areas. Only needed for efficiency, and only some implementations profit.
2751 * `remove_area(id)`: removes the area with the given id from the store, returns success.
2752 * `set_cache_params(params)`: sets params for the included prefiltering cache. Calling invalidates the cache, so that its elements have to be newly generated.
2755 enabled = boolean, -- whether to enable, default true
2756 block_radius = number, -- the radius (in nodes) of the areas the cache generates prefiltered lists for, minimum 16, default 64
2757 limit = number, -- the cache's size, minimum 20, default 1000
2759 * `to_string()`: Experimental. Returns area store serialized as a (binary) string.
2760 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to a file.
2761 * `from_string(str)`: Experimental. Deserializes string and loads it into the AreaStore. Returns success and, optionally, an error message.
2762 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data from a file.
2765 An `ItemStack` is a stack of items.
2767 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
2768 an itemstring, a table or `nil`.
2771 * `is_empty()`: Returns `true` if stack is empty.
2772 * `get_name()`: Returns item name (e.g. `"default:stone"`).
2773 * `set_name(item_name)`: Returns boolean success.
2774 Clears item on failure.
2775 * `get_count()`: Returns number of items on the stack.
2776 * `set_count(count)`
2777 * `get_wear()`: Returns tool wear (`0`-`65535`), `0` for non-tools.
2778 * `set_wear(wear)`: Returns boolean success.
2779 Clears item on failure.
2780 * `get_metadata()`: Returns metadata (a string attached to an item stack).
2781 * `set_metadata(metadata)`: Returns true.
2782 * `clear()`: removes all items from the stack, making it empty.
2783 * `replace(item)`: replace the contents of this stack.
2784 * `item` can also be an itemstring or table.
2785 * `to_string()`: Returns the stack in itemstring form.
2786 * `to_table()`: Returns the stack in Lua table form.
2787 * `get_stack_max()`: Returns the maximum size of the stack (depends on the item).
2788 * `get_free_space()`: Returns `get_stack_max() - get_count()`.
2789 * `is_known()`: Returns `true` if the item name refers to a defined item type.
2790 * `get_definition()`: Returns the item definition table.
2791 * `get_tool_capabilities()`: Returns the digging properties of the item,
2792 or those of the hand if none are defined for this item type
2793 * `add_wear(amount)`: Increases wear by `amount` if the item is a tool.
2794 * `add_item(item)`: Put some item or stack onto this stack.
2795 Returns leftover `ItemStack`.
2796 * `item_fits(item)`: Returns `true` if item or stack can be fully added to
2798 * `take_item(n=1)`: Take (and remove) up to `n` items from this stack.
2799 Returns taken `ItemStack`.
2800 * `peek_item(n=1)`: copy (don't remove) up to `n` items from this stack.
2801 Returns taken `ItemStack`.
2804 A 16-bit pseudorandom number generator.
2805 Uses a well-known LCG algorithm introduced by K&R.
2807 It can be created via `PseudoRandom(seed)`.
2810 * `next()`: return next integer random number [`0`...`32767`]
2811 * `next(min, max)`: return next integer random number [`min`...`max`]
2812 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
2813 due to the simple implementation making bad distribution otherwise.
2816 A 32-bit pseudorandom number generator.
2817 Uses PCG32, an algorithm of the permuted congruential generator family, offering very strong randomness.
2819 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
2822 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
2823 * `next(min, max)`: return next integer random number [`min`...`max`]
2824 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed random number [`min`...`max`]
2825 * This is only a rough approximation of a normal distribution with mean=(max-min)/2 and variance=1
2826 * Increasing num_trials improves accuracy of the approximation
2829 Interface for the operating system's crypto-secure PRNG.
2831 It can be created via `SecureRandom()`. The constructor returns nil if a secure random device cannot be
2832 be found on the system.
2835 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many random bytes, as a string.
2838 A perlin noise generator.
2839 It can be created via `PerlinNoise(seed, octaves, persistence, scale)`
2840 or `PerlinNoise(noiseparams)`.
2841 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
2842 or `minetest.get_perlin(noiseparams)`.
2845 * `get2d(pos)`: returns 2D noise value at `pos={x=,y=}`
2846 * `get3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
2848 ### `PerlinNoiseMap`
2849 A fast, bulk perlin noise generator.
2851 It can be created via `PerlinNoiseMap(noiseparams, size)` or
2852 `minetest.get_perlin_map(noiseparams, size)`.
2854 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` conponent is ommitted
2855 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
2858 For each of the functions with an optional `buffer` parameter: If `buffer` is not
2859 nil, this table will be used to store the result instead of creating a new table.
2863 * `get2dMap(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
2864 with values starting at `pos={x=,y=}`
2865 * `get3dMap(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>` 3D array
2866 of 3D noise with values starting at `pos={x=,y=,z=}`
2867 * `get2dMap_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element array of 2D noise
2868 with values starting at `pos={x=,y=}`
2869 * `get3dMap_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
2870 * `calc2dMap(pos)`: Calculates the 2d noise map starting at `pos`. The result is stored internally.
2871 * `calc3dMap(pos)`: Calculates the 3d noise map starting at `pos`. The result is stored internally.
2872 * `getMapSlice(slice_offset, slice_size, buffer)`: In the form of an array, returns a slice of the
2873 most recently computed noise results. The result slice begins at coordinates `slice_offset` and
2874 takes a chunk of `slice_size`.
2875 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer offset y = 20:
2876 `noisevals = noise:getMapSlice({y=20}, {y=2})`
2877 It is important to note that `slice_offset` offset coordinates begin at 1, and are relative to
2878 the starting position of the most recently calculated noise.
2879 To grab a single vertical column of noise starting at map coordinates x = 1023, y=1000, z = 1000:
2880 `noise:calc3dMap({x=1000, y=1000, z=1000})`
2881 `noisevals = noise:getMapSlice({x=24, z=1}, {x=1, z=1})`
2885 #### About VoxelManip
2886 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator' facility. The purpose of
2887 this object is for fast, low-level, bulk access to reading and writing Map content. As such, setting
2888 map nodes through VoxelManip will lack many of the higher level features and concepts you may be used
2889 to with other methods of setting nodes. For example, nodes will not have their construction and
2890 destruction callbacks run, and no rollback information is logged.
2892 It is important to note that VoxelManip is designed for speed, and *not* ease of use or flexibility.
2893 If your mod requires a map manipulation facility that will handle 100% of all edge cases, or the use
2894 of high level node placement features, perhaps minetest.set_node() is better suited for the job.
2896 In addition, VoxelManip might not be faster, or could even be slower, for your specific use case.
2897 VoxelManip is most effective when setting very large areas of map at once - for example, if only
2898 setting a 5x5x5 node area, a minetest.set_node() loop may be more optimal. Always profile code
2899 using both methods of map manipulation to determine which is most appropriate for your usage.
2901 #### Using VoxelManip
2902 A VoxelManip object can be created any time using either:
2903 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
2905 If the optional position parameters are present for either of these routines, the specified region
2906 will be pre-loaded into the VoxelManip object on creation. Otherwise, the area of map you wish to
2907 manipulate must first be loaded into the VoxelManip object using `VoxelManip:read_from_map()`.
2909 Note that `VoxelManip:read_from_map()` returns two position vectors. The region formed by these
2910 positions indicate the minimum and maximum (respectively) positions of the area actually loaded in
2911 the VoxelManip, which may be larger than the area requested. For convenience, the loaded area
2912 coordinates can also be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
2914 Now that the VoxelManip object is populated with map data, your mod can fetch a copy of this data
2915 using either of two methods. `VoxelManip:get_node_at()`, which retrieves an individual node in a
2916 MapNode formatted table at the position requested is the simplest method to use, but also the slowest.
2918 Nodes in a VoxelManip object may also be read in bulk to a flat array table using:
2919 `VoxelManip:get_data()` for node content (in Content ID form, see section 'Content IDs'),
2920 `VoxelManip:get_light_data()` for node light levels, and
2921 `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
2923 See section 'Flat array format' for more details.
2925 It is very important to understand that the tables returned by any of the above three functions
2926 represent a snapshot of the VoxelManip's internal state at the time of the call. This copy of the
2927 data will *not* magically update itself if another function modifies the internal VoxelManip state.
2928 Any functions that modify a VoxelManip's contents work on the VoxelManip's internal state unless
2929 otherwise explicitly stated.
2931 Once the bulk data has been edited to your liking, the internal VoxelManip state can be set using:
2932 `VoxelManip:set_data()` for node content (in Content ID form, see section 'Content IDs'),
2933 `VoxelManip:set_light_data()` for node light levels, and
2934 `VoxelManip:set_param2_data()` for the node type-dependent "param2" values.
2936 The parameter to each of the above three functions can use any table at all in the same flat array
2937 format as produced by get_data() et al. and is *not required* to be a table retrieved from get_data().
2939 Once the internal VoxelManip state has been modified to your liking, the changes can be committed back
2940 to the map by calling `VoxelManip:write_to_map()`.
2942 Finally, a call to `VoxelManip:update_map()` is required to re-calculate lighting and set the blocks
2943 as being modified so that connected clients are sent the updated parts of map.
2946 ##### Flat array format
2948 `Nx = p2.X - p1.X + 1`,
2949 `Ny = p2.Y - p1.Y + 1`, and
2950 `Nz = p2.Z - p1.Z + 1`.
2952 Then, for a loaded region of p1..p2, this array ranges from `1` up to and including the value of
2953 the expression `Nx * Ny * Nz`.
2955 Positions offset from p1 are present in the array with the format of:
2958 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
2959 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
2961 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
2962 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
2964 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
2966 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
2970 and the array index for a position p contained completely in p1..p2 is:
2972 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
2974 Note that this is the same "flat 3D array" format as `PerlinNoiseMap:get3dMap_flat()`.
2975 VoxelArea objects (see section 'VoxelArea') can be used to simplify calculation of the index
2976 for a single point in a flat VoxelManip array.
2979 A Content ID is a unique integer identifier for a specific node type. These IDs are used by VoxelManip
2980 in place of the node name string for `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
2981 `minetest.get_content_id()` to look up the Content ID for the specified node name, and
2982 `minetest.get_name_from_content_id()` to look up the node name string for a given Content ID.
2983 After registration of a node, its Content ID will remain the same throughout execution of the mod.
2984 Note that the node being queried needs to have already been been registered.
2986 The following builtin node types have their Content IDs defined as constants:
2988 core.CONTENT_UNKNOWN (ID for "unknown" nodes)
2989 core.CONTENT_AIR (ID for "air" nodes)
2990 core.CONTENT_IGNORE (ID for "ignore" nodes)
2993 ##### Mapgen VoxelManip objects
2994 Inside of `on_generated()` callbacks, it is possible to retrieve the same VoxelManip object used by the
2995 core's Map Generator (commonly abbreviated Mapgen). Most of the rules previously described still apply
2996 but with a few differences:
2998 * The Mapgen VoxelManip object is retrieved using: `minetest.get_mapgen_object("voxelmanip")`
2999 * This VoxelManip object already has the region of map just generated loaded into it; it's not necessary
3000 to call `VoxelManip:read_from_map()` before using a Mapgen VoxelManip.
3001 * The `on_generated()` callbacks of some mods may place individual nodes in the generated area using
3002 non-VoxelManip map modification methods. Because the same Mapgen VoxelManip object is passed through
3003 each `on_generated()` callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3004 consistency with the current map state. For this reason, calling any of the following functions:
3005 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3006 will also update the Mapgen VoxelManip object's internal state active on the current thread.
3007 * After modifying the Mapgen VoxelManip object's internal buffer, it may be necessary to update lighting
3008 information using either: `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3009 * `VoxelManip:update_map()` does not need to be called after `write_to_map()`. The map update is performed
3010 automatically after all on_generated callbacks have been run for that generated block.
3012 ##### Other API functions operating on a VoxelManip
3013 If any VoxelManip contents were set to a liquid node, `VoxelManip:update_liquids()` must be called
3014 for these liquid nodes to begin flowing. It is recommended to call this function only after having
3015 written all buffered data back to the VoxelManip object, save for special situations where the modder
3016 desires to only have certain liquid nodes begin flowing.
3018 The functions `minetest.generate_ores()` and `minetest.generate_decorations()` will generate all
3019 registered decorations and ores throughout the full area inside of the specified VoxelManip object.
3021 `minetest.place_schematic_on_vmanip()` is otherwise identical to `minetest.place_schematic()`,
3022 except instead of placing the specified schematic directly on the map at the specified position, it
3023 will place the schematic inside of the VoxelManip.
3026 * Attempting to read data from a VoxelManip object before map is read will result in a zero-length
3027 array table for `VoxelManip:get_data()`, and an "ignore" node at any position for
3028 `VoxelManip:get_node_at()`.
3029 * If either a region of map has not yet been generated or is out-of-bounds of the map, that region is
3030 filled with "ignore" nodes.
3031 * Other mods, or the core itself, could possibly modify the area of map currently loaded into a VoxelManip
3032 object. With the exception of Mapgen VoxelManips (see above section), the internal buffers are not
3033 updated. For this reason, it is strongly encouraged to complete the usage of a particular VoxelManip
3034 object in the same callback it had been created.
3035 * If a VoxelManip object will be used often, such as in an `on_generated()` callback, consider passing
3036 a file-scoped table as the optional parameter to `VoxelManip:get_data()`, which serves as a static
3037 buffer the function can use to write map data to instead of returning a new table each call. This
3038 greatly enhances performance by avoiding unnecessary memory allocations.
3041 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object containing
3042 the region formed by `p1` and `p2`.
3043 * returns actual emerged `pmin`, actual emerged `pmax`
3044 * `write_to_map()`: Writes the data loaded from the `VoxelManip` back to the map.
3045 * **important**: data must be set using `VoxelManip:set_data()` before calling this
3046 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
3047 the `VoxelManip` at that position
3048 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at that position
3049 * `get_data([buffer])`: Retrieves the node content data loaded into the `VoxelManip` object
3050 * returns raw node data in the form of an array of node content IDs
3051 * if the param `buffer` is present, this table will be used to store the result instead
3052 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
3053 * `update_map()`: Update map after writing chunk back to map.
3054 * To be used only by `VoxelManip` objects created by the mod itself;
3055 not a `VoxelManip` that was retrieved from `minetest.get_mapgen_object`
3056 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to a uniform value
3057 * `light` is a table, `{day=<0...15>, night=<0...15>}`
3058 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
3059 * (`p1`, `p2`) is the area in which lighting is set;
3060 defaults to the whole area if left out
3061 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
3062 * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
3063 * Each value is the bitwise combination of day and night light values (`0` to `15` each)
3064 * `light = day + (night * 16)`
3065 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
3067 * expects lighting data in the same format that `get_light_data()` returns
3068 * `get_param2_data()`: Gets the raw `param2` data read into the `VoxelManip` object
3069 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in the `VoxelManip`
3070 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the `VoxelManip`
3071 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
3072 * (`p1`, `p2`) is the area in which lighting is set; defaults to the whole area
3074 * `propagate_shadow` is an optional boolean deciding whether shadows in a generated
3075 mapchunk above are propagated down into the mapchunk; defaults to `true` if left out
3076 * `update_liquids()`: Update liquid flow
3077 * `was_modified()`: Returns `true` or `false` if the data in the voxel manipulator
3078 had been modified since the last read from map, due to a call to
3079 `minetest.set_data()` on the loaded area elsewhere
3080 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
3083 A helper class for voxel areas.
3084 It can be created via `VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}`.
3085 The coordinates are *inclusive*, like most other things in Minetest.
3088 * `getExtent()`: returns a 3D vector containing the size of the area formed by
3089 `MinEdge` and `MaxEdge`
3090 * `getVolume()`: returns the volume of the area formed by `MinEdge` and `MaxEdge`
3091 * `index(x, y, z)`: returns the index of an absolute position in a flat array starting at `1`
3092 * useful for things like `VoxelManip`, raw Schematic specifiers,
3093 `PerlinNoiseMap:get2d`/`3dMap`, and so on
3094 * `indexp(p)`: same as above, except takes a vector
3095 * `position(i)`: returns the absolute position vector corresponding to index `i`
3096 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by `MinEdge` and `MaxEdge`
3097 * `containsp(p)`: same as above, except takes a vector
3098 * `containsi(i)`: same as above, except takes an index `i`
3099 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns indices
3100 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of `[z [y [x]]]`
3101 * `iterp(minp, maxp)`: same as above, except takes a vector
3104 An interface to read config files in the format of `minetest.conf`.
3106 It can be created via `Settings(filename)`.
3109 * `get(key)`: returns a value
3110 * `get_bool(key)`: returns a boolean
3112 * `remove(key)`: returns a boolean (`true` for success)
3113 * `get_names()`: returns `{key1,...}`
3114 * `write()`: returns a boolean (`true` for success)
3115 * write changes to file
3116 * `to_table()`: returns `{[key1]=value1,...}`
3120 A mapgen object is a construct used in map generation. Mapgen objects can be used
3121 by an `on_generate` callback to speed up operations by avoiding unnecessary
3122 recalculations; these can be retrieved using the `minetest.get_mapgen_object()`
3123 function. If the requested Mapgen object is unavailable, or `get_mapgen_object()`
3124 was called outside of an `on_generate()` callback, `nil` is returned.
3126 The following Mapgen objects are currently available:
3129 This returns three values; the `VoxelManip` object to be used, minimum and maximum
3130 emerged position, in that order. All mapgens support this object.
3133 Returns an array containing the y coordinates of the ground levels of nodes in
3134 the most recently generated chunk by the current mapgen.
3137 Returns an array containing the biome IDs of nodes in the most recently
3138 generated chunk by the current mapgen.
3141 Returns an array containing the temperature values of nodes in the most
3142 recently generated chunk by the current mapgen.
3145 Returns an array containing the humidity values of nodes in the most recently
3146 generated chunk by the current mapgen.
3149 Returns a table mapping requested generation notification types to arrays of
3150 positions at which the corresponding generated structures are located at within
3151 the current chunk. To set the capture of positions of interest to be recorded
3152 on generate, use `minetest.set_gen_notify()`.
3154 Possible fields of the table returned are:
3160 * `large_cave_begin`
3164 Decorations have a key in the format of `"decoration#id"`, where `id` is the
3165 numeric unique decoration ID.
3169 * Functions receive a "luaentity" as `self`:
3170 * It has the member `.name`, which is the registered name `("mod:thing")`
3171 * It has the member `.object`, which is an `ObjectRef` pointing to the object
3172 * The original prototype stuff is visible directly via a metatable
3174 * `on_activate(self, staticdata)`
3175 * Called when the object is instantiated.
3176 * `on_step(self, dtime)`
3177 * Called on every server tick, after movement and collision processing.
3178 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
3180 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir`
3181 * Called when somebody punches the object.
3182 * Note that you probably want to handle most punches using the
3183 automatic armor group system.
3184 * `puncher`: an `ObjectRef` (can be `nil`)
3185 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be `nil`)
3186 * `tool_capabilities`: capability table of used tool (can be `nil`)
3187 * `dir`: unit vector of direction of punch. Always defined. Points from
3188 the puncher to the punched.
3189 * `on_rightclick(self, clicker)`
3190 * `get_staticdata(self)`
3191 * Should return a string that will be passed to `on_activate` when
3192 the object is instantiated the next time.
3200 axiom, --string initial tree axiom
3201 rules_a, --string rules set A
3202 rules_b, --string rules set B
3203 rules_c, --string rules set C
3204 rules_d, --string rules set D
3205 trunk, --string trunk node name
3206 leaves, --string leaves node name
3207 leaves2, --string secondary leaves node name
3208 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
3209 angle, --num angle in deg
3210 iterations, --num max # of iterations, usually 2 -5
3211 random_level, --num factor to lower nr of iterations, usually 0 - 3
3212 trunk_type, --string single/double/crossed) type of trunk: 1 node,
3213 -- 2x2 nodes or 3x3 in cross shape
3214 thin_branches, --boolean true -> use thin (1 node) branches
3215 fruit, --string fruit node name
3216 fruit_chance, --num chance (0-100) to replace leaves with fruit node
3217 seed, --num random seed; if no seed is provided, the engine will create one
3220 ### Key for Special L-System Symbols used in Axioms
3222 * `G`: move forward one unit with the pen up
3223 * `F`: move forward one unit with the pen down drawing trunks and branches
3224 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
3225 * `T`: move forward one unit with the pen down drawing trunks only
3226 * `R`: move forward one unit with the pen down placing fruit
3227 * `A`: replace with rules set A
3228 * `B`: replace with rules set B
3229 * `C`: replace with rules set C
3230 * `D`: replace with rules set D
3231 * `a`: replace with rules set A, chance 90%
3232 * `b`: replace with rules set B, chance 80%
3233 * `c`: replace with rules set C, chance 70%
3234 * `d`: replace with rules set D, chance 60%
3235 * `+`: yaw the turtle right by `angle` parameter
3236 * `-`: yaw the turtle left by `angle` parameter
3237 * `&`: pitch the turtle down by `angle` parameter
3238 * `^`: pitch the turtle up by `angle` parameter
3239 * `/`: roll the turtle to the right by `angle` parameter
3240 * `*`: roll the turtle to the left by `angle` parameter
3241 * `[`: save in stack current state info
3242 * `]`: recover from stack state info
3245 Spawn a small apple tree:
3247 pos = {x=230,y=20,z=4}
3250 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
3251 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
3252 trunk="default:tree",
3253 leaves="default:leaves",
3257 trunk_type="single",
3260 fruit="default:apple"
3262 minetest.spawn_tree(pos,apple_tree)
3267 ### Object Properties
3272 collide_with_objects = true, -- collide with other objects if physical=true
3274 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
3275 visual = "cube"/"sprite"/"upright_sprite"/"mesh"/"wielditem",
3276 visual_size = {x=1, y=1},
3278 textures = {}, -- number of required textures depends on visual
3279 colors = {}, -- number of required colors depends on visual
3280 spritediv = {x=1, y=1},
3281 initial_sprite_basepos = {x=0, y=0},
3283 makes_footstep_sound = false,
3284 automatic_rotate = false,
3286 automatic_face_movement_dir = 0.0,
3287 -- ^ automatically set yaw to movement direction; offset in degrees; false to disable
3288 automatic_face_movement_max_rotation_per_sec = -1,
3289 -- ^ limit automatic rotation to this value in degrees per second. values < 0 no limit
3290 backface_culling = true, -- false to disable backface_culling for model
3291 nametag = "", -- by default empty, for players their name is shown if empty
3292 nametag_color = <color>, -- sets color of nametag as ColorSpec
3293 infotext = "", -- by default empty, text to be shown when pointed at object
3296 ### Entity definition (`register_entity`)
3299 -- Deprecated: Everything in object properties is read directly from here
3301 initial_properties = --[[<initial object properties>]],
3303 on_activate = function(self, staticdata, dtime_s),
3304 on_step = function(self, dtime),
3305 on_punch = function(self, hitter),
3306 on_rightclick = function(self, clicker),
3307 get_staticdata = function(self),
3308 -- ^ Called sometimes; the string returned is passed to on_activate when
3309 -- the entity is re-activated from static state
3311 -- Also you can define arbitrary member variables here
3312 myvariable = whatever,
3315 ### ABM (ActiveBlockModifier) definition (`register_abm`)
3318 -- In the following two fields, also group:groupname will work.
3319 nodenames = {"default:lava_source"},
3320 neighbors = {"default:water_source", "default:water_flowing"}, -- Any of these --[[
3321 ^ If left out or empty, any neighbor will do ]]
3322 interval = 1.0, -- Operation interval in seconds
3323 chance = 1, -- Chance of trigger per-node per-interval is 1.0 / this
3324 catch_up = true, -- If true, catch-up behaviour is enabled --[[
3325 ^ The chance value is temporarily reduced when returning to
3326 an area to simulate time lost by the area being unattended.
3327 ^ Note chance value can often be reduced to 1 ]]
3328 action = func(pos, node, active_object_count, active_object_count_wider),
3331 ### LBM (LoadingBlockModifier) definition (`register_lbm`)
3334 name = "modname:replace_legacy_door",
3335 nodenames = {"default:lava_source"},
3336 -- ^ List of node names to trigger the LBM on.
3337 -- Also non-registered nodes will work.
3338 -- Groups (as of group:groupname) will work as well.
3339 run_at_every_load = false,
3340 -- ^ Whether to run the LBM's action every time a block gets loaded,
3341 -- and not just for blocks that were saved last time before LBMs were
3342 -- introduced to the world.
3343 action = func(pos, node),
3346 ### Item definition (`register_node`, `register_craftitem`, `register_tool`)
3349 description = "Steel Axe",
3350 groups = {}, -- key=name, value=rating; rating=1..3.
3351 if rating not applicable, use 1.
3352 e.g. {wool=1, fluffy=3}
3353 {soil=2, outerspace=1, crumbly=1}
3354 {bendy=2, snappy=1},
3355 {hard=1, metal=1, spikes=1}
3356 inventory_image = "default_tool_steelaxe.png",
3358 wield_scale = {x=1,y=1,z=1},
3361 liquids_pointable = false,
3362 tool_capabilities = {
3363 full_punch_interval = 1.0,
3367 snappy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
3368 choppy={times={[3]=0.90}, maxwear=0.05, maxlevel=0}
3370 damage_groups = {groupname=damage},
3372 node_placement_prediction = nil,
3374 ^ If nil and item is node, prediction is made automatically
3375 ^ If nil and item is not a node, no prediction is made
3376 ^ If "" and item is anything, no prediction is made
3377 ^ Otherwise should be name of node which the client immediately places
3378 on ground when the player places the item. Server will always update
3379 actual result to client in a short moment.
3382 place = --[[<SimpleSoundSpec>]],
3385 on_place = func(itemstack, placer, pointed_thing),
3387 ^ Shall place item and return the leftover itemstack
3388 ^ default: minetest.item_place ]]
3389 on_secondary_use = func(itemstack, user, pointed_thing),
3391 ^ Same as on_place but called when pointing at nothing.
3392 ^ pointed_thing : always { type = "nothing" }
3394 on_drop = func(itemstack, dropper, pos),
3396 ^ Shall drop item and return the leftover itemstack
3397 ^ default: minetest.item_drop ]]
3398 on_use = func(itemstack, user, pointed_thing),
3401 ^ Function must return either nil if no item shall be removed from
3402 inventory, or an itemstack to replace the original itemstack.
3403 e.g. itemstack:take_item(); return itemstack
3404 ^ Otherwise, the function is free to do what it wants.
3405 ^ The default functions handle regular use cases.
3407 after_use = func(itemstack, user, node, digparams),
3410 ^ If defined, should return an itemstack and will be called instead of
3411 wearing out the tool. If returns nil, does nothing.
3412 If after_use doesn't exist, it is the same as:
3413 function(itemstack, user, node, digparams)
3414 itemstack:add_wear(digparams.wear)
3422 * `{name="image.png", animation={Tile Animation definition}}`
3423 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
3424 tileable_horizontal=bool}`
3425 * backface culling enabled by default for most nodes
3426 * tileable flags are info for shaders, how they should treat texture
3427 when displacement mapping is used
3428 Directions are from the point of view of the tile texture,
3429 not the node it's on
3430 * deprecated, yet still supported field names:
3433 ### Tile animation definition
3434 * `{type="vertical_frames", aspect_w=16, aspect_h=16, length=3.0}`
3436 ### Node definition (`register_node`)
3439 -- <all fields allowed in item definitions>,
3441 drawtype = "normal", -- See "Node drawtypes"
3442 visual_scale = 1.0, --[[
3443 ^ Supported for drawtypes "plantlike", "signlike", "torchlike", "mesh".
3444 ^ For plantlike, the image will start at the bottom of the node; for the
3445 ^ other drawtypes, the image will be centered on the node.
3446 ^ Note that positioning for "torchlike" may still change. ]]
3447 tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
3448 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
3449 ^ List can be shortened to needed length ]]
3450 special_tiles = {tile definition 1, Tile definition 2}, --[[
3451 ^ Special textures of node; used rarely (old field name: special_materials)
3452 ^ List can be shortened to needed length ]]
3454 use_texture_alpha = false, -- Use texture's alpha channel
3455 post_effect_color = "green#0F", -- If player is inside node, see "ColorSpec"
3456 paramtype = "none", -- See "Nodes" --[[
3457 ^ paramtype = "light" allows light to propagate from or through the node with light value
3458 ^ falling by 1 per node. This line is essential for a light source node to spread its light. ]]
3459 paramtype2 = "none", -- See "Nodes"
3460 is_ground_content = true, -- If false, the cave generator will not carve through this
3461 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
3462 walkable = true, -- If true, objects collide with node
3463 pointable = true, -- If true, can be pointed at
3464 diggable = true, -- If false, can never be dug
3465 climbable = false, -- If true, can be climbed on (ladder)
3466 buildable_to = false, -- If true, placed nodes can replace this node
3467 floodable = false, -- If true, liquids flow into and replace this node
3468 liquidtype = "none", -- "none"/"source"/"flowing"
3469 liquid_alternative_flowing = "", -- Flowing version of source liquid
3470 liquid_alternative_source = "", -- Source version of flowing liquid
3471 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
3472 liquid_renewable = true, -- Can new liquid source be created by placing two or more sources nearby?
3474 ^ Block contains level in param2. Value is default level, used for snow.
3475 ^ Don't forget to use "leveled" type nodebox. ]]
3476 liquid_range = 8, -- number of flowing nodes around source (max. 8)
3477 drowning = 0, -- Player will take this amount of damage if no bubbles are left
3478 light_source = 0, -- Amount of light emitted by node
3479 damage_per_second = 0, -- If player is inside node, this damage is caused
3480 node_box = {type="regular"}, -- See "Node boxes"
3481 connects_to = nodenames, --[[
3482 * Used for nodebox nodes with the type == "connected"
3483 * Specifies to what neighboring nodes connections will be drawn
3484 * e.g. `{"group:fence", "default:wood"}` or `"default:stone"` ]]
3485 connect_sides = { "top", "bottom", "front", "left", "back", "right" }, --[[
3486 ^ Tells connected nodebox nodes to connect only to these sides of this node. ]]
3488 selection_box = {type="regular"}, -- See "Node boxes" --[[
3489 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used. ]]
3490 legacy_facedir_simple = false, -- Support maps made in and before January 2012
3491 legacy_wallmounted = false, -- Support maps made in and before January 2012
3493 footstep = <SimpleSoundSpec>,
3494 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
3495 dug = <SimpleSoundSpec>,
3496 place = <SimpleSoundSpec>,
3497 place_failed = <SimpleSoundSpec>,
3499 drop = "", -- Name of dropped node when dug. Default is the node itself.
3502 max_items = 1, -- Maximum number of items to drop.
3503 items = { -- Choose max_items randomly from this list.
3505 items = {"foo:bar", "baz:frob"}, -- Choose one item randomly from this list.
3506 rarity = 1, -- Probability of getting is 1 / rarity.
3511 on_construct = func(pos), --[[
3512 ^ Node constructor; called after adding node
3513 ^ Can set up metadata and stuff like that
3514 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3516 on_destruct = func(pos), --[[
3517 ^ Node destructor; called before removing node
3518 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3520 after_destruct = func(pos, oldnode), --[[
3521 ^ Node destructor; called after removing node
3522 ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
3525 after_place_node = func(pos, placer, itemstack, pointed_thing) --[[
3526 ^ Called after constructing node when node was placed using
3527 minetest.item_place_node / minetest.place_node
3528 ^ If return true no item is taken from itemstack
3530 after_dig_node = func(pos, oldnode, oldmetadata, digger), --[[
3531 ^ oldmetadata is in table format
3532 ^ Called after destructing node when node was dug using
3533 minetest.node_dig / minetest.dig_node
3535 can_dig = function(pos, [player]) --[[
3536 ^ returns true if node can be dug, or false if not
3539 on_punch = func(pos, node, puncher, pointed_thing), --[[
3540 ^ default: minetest.node_punch
3541 ^ By default: Calls minetest.register_on_punchnode callbacks ]]
3542 on_rightclick = func(pos, node, clicker, itemstack, pointed_thing), --[[
3544 ^ if defined, itemstack will hold clicker's wielded item
3545 ^ Shall return the leftover itemstack
3546 ^ Note: pointed_thing can be nil, if a mod calls this function ]]
3548 on_dig = func(pos, node, digger), --[[
3549 ^ default: minetest.node_dig
3550 ^ By default: checks privileges, wears out tool and removes node ]]
3552 on_timer = function(pos,elapsed), --[[
3554 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
3555 ^ elapsed is the total time passed since the timer was started
3556 ^ return true to run the timer for another cycle with the same timeout value ]]
3558 on_receive_fields = func(pos, formname, fields, sender), --[[
3559 ^ fields = {name1 = value1, name2 = value2, ...}
3560 ^ Called when an UI form (e.g. sign text input) returns data
3563 allow_metadata_inventory_move = func(pos, from_list, from_index,
3564 to_list, to_index, count, player), --[[
3565 ^ Called when a player wants to move items inside the inventory
3566 ^ Return value: number of items allowed to move ]]
3568 allow_metadata_inventory_put = func(pos, listname, index, stack, player), --[[
3569 ^ Called when a player wants to put something into the inventory
3570 ^ Return value: number of items allowed to put
3571 ^ Return value: -1: Allow and don't modify item count in inventory ]]
3573 allow_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
3574 ^ Called when a player wants to take something out of the inventory
3575 ^ Return value: number of items allowed to take
3576 ^ Return value: -1: Allow and don't modify item count in inventory ]]
3578 on_metadata_inventory_move = func(pos, from_list, from_index,
3579 to_list, to_index, count, player),
3580 on_metadata_inventory_put = func(pos, listname, index, stack, player),
3581 on_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
3582 ^ Called after the actual action has happened, according to what was allowed.
3583 ^ No return value ]]
3585 on_blast = func(pos, intensity), --[[
3586 ^ intensity: 1.0 = mid range of regular TNT
3587 ^ If defined, called when an explosion touches the node, instead of
3588 removing the node ]]
3591 ### Recipe for `register_craft` (shaped)
3594 output = 'default:pick_stone',
3596 {'default:cobble', 'default:cobble', 'default:cobble'},
3597 {'', 'default:stick', ''},
3598 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
3600 replacements = --[[<optional list of item pairs,
3601 replace one input item with another item on crafting>]]
3604 ### Recipe for `register_craft` (shapeless)
3608 output = 'mushrooms:mushroom_stew',
3611 "mushrooms:mushroom_brown",
3612 "mushrooms:mushroom_red",
3614 replacements = --[[<optional list of item pairs,
3615 replace one input item with another item on crafting>]]
3618 ### Recipe for `register_craft` (tool repair)
3621 type = "toolrepair",
3622 additional_wear = -0.02,
3625 ### Recipe for `register_craft` (cooking)
3629 output = "default:glass",
3630 recipe = "default:sand",
3634 ### Recipe for `register_craft` (furnace fuel)
3638 recipe = "default:leaves",
3642 ### Ore definition (`register_ore`)
3645 ore_type = "scatter", -- See "Ore types"
3646 ore = "default:stone_with_coal",
3647 wherein = "default:stone",
3648 -- ^ a list of nodenames is supported too
3649 clust_scarcity = 8*8*8,
3650 -- ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
3651 -- ^ This value should be *MUCH* higher than your intuition might tell you!
3653 -- ^ Number of ores in a cluster
3655 -- ^ Size of the bounding box of the cluster
3656 -- ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
3660 -- ^ Attributes for this ore generation
3661 noise_threshold = 0.5,
3662 -- ^ If noise is above this threshold, ore is placed. Not needed for a uniform distribution
3663 noise_params = {offset=0, scale=1, spread={x=100, y=100, z=100}, seed=23, octaves=3, persist=0.70}
3664 -- ^ NoiseParams structure describing the perlin noise used for ore distribution.
3665 -- ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
3666 random_factor = 1.0,
3667 -- ^ Multiplier of the randomness contribution to the noise value at any
3668 -- given point to decide if ore should be placed. Set to 0 for solid veins.
3669 -- ^ This parameter is only valid for ore_type == "vein".
3670 biomes = {"desert", "rainforest"}
3671 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
3672 -- ^ and ignored if the Mapgen being used does not support biomes.
3673 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
3676 ### Biome definition (`register_biome`)
3680 node_dust = "default:snow",
3681 -- ^ Node dropped onto upper surface after all else is generated.
3682 node_top = "default:dirt_with_snow",
3684 -- ^ Node forming surface layer of biome and thickness of this layer.
3685 node_filler = "default:permafrost",
3687 -- ^ Node forming lower layer of biome and thickness of this layer.
3688 node_stone = "default:bluestone",
3689 -- ^ Node that replaces all stone nodes between roughly y_min and y_max.
3690 node_water_top = "default:ice",
3691 depth_water_top = 10,
3692 -- ^ Node forming a surface layer in seawater with the defined thickness.
3694 -- ^ Node that replaces all seawater nodes not in the defined surface layer.
3695 node_river_water = "default:ice",
3696 -- ^ Node that replaces river water in mapgens that use default:river_water.
3699 -- ^ Lower and upper limits for biome.
3700 -- ^ Because biome is not recalculated for every node in a node column
3701 -- ^ some biome materials can exceed their limits, especially stone.
3702 -- ^ For each node column in a mapchunk, biome is only recalculated at column
3703 -- ^ top and at each of these surfaces:
3704 -- ^ Ground below air, water below air, ground below water.
3705 -- ^ The selected biome then stays in effect for all nodes below until
3706 -- ^ column base or the next biome recalculation.
3708 humidity_point = 50,
3709 -- ^ Characteristic average temperature and humidity for the biome.
3710 -- ^ These values create 'biome points' on a voronoi diagram that has heat
3711 -- ^ and humidity as axes. The resulting voronoi cells determine which
3712 -- ^ heat/humidity points belong to which biome, and therefore determine
3713 -- ^ the area and location of each biome in the world.
3714 -- ^ The biome points need to be carefully and evenly spaced on the voronoi
3715 -- ^ diagram to result in roughly equal size biomes.
3716 -- ^ Heat and humidity have average values of 50, vary mostly between
3717 -- ^ 0 and 100 but also often exceed these values.
3718 -- ^ Heat is not in degrees celcius, both values are abstract.
3721 ### Decoration definition (`register_decoration`)
3724 deco_type = "simple", -- See "Decoration types"
3725 place_on = "default:dirt_with_grass",
3726 -- ^ Node that decoration can be placed on
3728 -- ^ Size of divisions made in the chunk being generated.
3729 -- ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
3731 -- ^ Ratio of the area to be uniformly filled by the decoration.
3732 -- ^ Used only if noise_params is not specified.
3733 noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
3734 -- ^ NoiseParams structure describing the perlin noise used for decoration distribution.
3735 -- ^ The result of this is multiplied by the 2d area of the division being decorated.
3736 biomes = {"Oceanside", "Hills", "Plains"},
3737 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
3738 -- ^ and ignored if the Mapgen being used does not support biomes.
3739 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
3742 -- ^ Minimum and maximum `y` positions these decorations can be generated at.
3743 -- ^ This parameter refers to the `y` position of the decoration base, so
3744 -- the actual maximum height would be `height_max + size.Y`.
3745 flags = "liquid_surface, force_placement",
3746 -- ^ Flags for all decoration types.
3747 -- ^ "liquid_surface": Instead of placement on the highest solid surface
3748 -- ^ in a mapchunk column, placement is on the highest liquid surface.
3749 -- ^ Placement is disabled if solid nodes are found above the liquid surface.
3750 -- ^ "force_placement": Nodes other than "air" and "ignore" are replaced by the decoration.
3752 ----- Simple-type parameters
3753 decoration = "default:grass",
3754 -- ^ The node name used as the decoration.
3755 -- ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
3757 -- ^ Number of nodes high the decoration is made.
3758 -- ^ If height_max is not 0, this is the lower bound of the randomly selected height.
3760 -- ^ Number of nodes the decoration can be at maximum.
3761 -- ^ If absent, the parameter 'height' is used as a constant.
3762 spawn_by = "default:water",
3763 -- ^ Node that the decoration only spawns next to.
3764 -- ^ The neighbours checked are the 8 nodes horizontally surrounding the lowest node of the
3765 -- ^ decoration, and the 8 nodes horizontally surrounding the ground node below the decoration.
3767 -- ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
3768 -- ^ If absent or -1, decorations occur next to any nodes.
3770 ----- Schematic-type parameters
3771 schematic = "foobar.mts",
3772 -- ^ If schematic is a string, it is the filepath relative to the current working directory of the
3773 -- ^ specified Minetest schematic file.
3774 -- ^ - OR -, could be the ID of a previously registered schematic
3775 -- ^ - OR -, could instead be a table containing two mandatory fields, size and data,
3776 -- ^ and an optional table yslice_prob:
3778 size = {x=4, y=6, z=4},
3780 {name="default:cobble", param1=255, param2=0},
3781 {name="default:dirt_with_grass", param1=255, param2=0},
3782 {name="ignore", param1=255, param2=0},
3783 {name="air", param1=255, param2=0},
3792 -- ^ See 'Schematic specifier' for details.
3793 replacements = {["oldname"] = "convert_to", ...},
3794 flags = "place_center_x, place_center_y, place_center_z",
3795 -- ^ Flags for schematic decorations. See 'Schematic attributes'.
3796 rotation = "90" -- rotate schematic 90 degrees on placement
3797 -- ^ Rotation can be "0", "90", "180", "270", or "random".
3800 ### Chat command definition (`register_chatcommand`)
3803 params = "<name> <privilege>", -- Short parameter description
3804 description = "Remove privilege from player", -- Full description
3805 privs = {privs=true}, -- Require the "privs" privilege to run
3806 func = function(name, param), -- Called when command is run.
3807 -- Returns boolean success and text output.
3810 ### Detached inventory callbacks
3813 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
3814 -- ^ Called when a player wants to move items inside the inventory
3815 -- ^ Return value: number of items allowed to move
3817 allow_put = func(inv, listname, index, stack, player),
3818 -- ^ Called when a player wants to put something into the inventory
3819 -- ^ Return value: number of items allowed to put
3820 -- ^ Return value: -1: Allow and don't modify item count in inventory
3822 allow_take = func(inv, listname, index, stack, player),
3823 -- ^ Called when a player wants to take something out of the inventory
3824 -- ^ Return value: number of items allowed to take
3825 -- ^ Return value: -1: Allow and don't modify item count in inventory
3827 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
3828 on_put = func(inv, listname, index, stack, player),
3829 on_take = func(inv, listname, index, stack, player),
3830 -- ^ Called after the actual action has happened, according to what was allowed.
3831 -- ^ No return value
3834 ### HUD Definition (`hud_add`, `hud_get`)
3837 hud_elem_type = "image", -- see HUD element types
3838 -- ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
3839 position = {x=0.5, y=0.5},
3840 -- ^ Left corner position of element
3846 -- ^ Selected item in inventory. 0 for no item selected.
3848 -- ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
3849 alignment = {x=0, y=0},
3850 -- ^ See "HUD Element Types"
3851 offset = {x=0, y=0},
3852 -- ^ See "HUD Element Types"
3853 size = { x=100, y=100 },
3854 -- ^ Size of element in pixels
3857 ### Particle definition (`add_particle`)
3860 pos = {x=0, y=0, z=0},
3861 velocity = {x=0, y=0, z=0},
3862 acceleration = {x=0, y=0, z=0},
3863 -- ^ Spawn particle at pos with velocity and acceleration
3865 -- ^ Disappears after expirationtime seconds
3867 collisiondetection = false,
3868 -- ^ collisiondetection: if true collides with physical objects
3870 -- ^ vertical: if true faces player using y axis only
3871 texture = "image.png",
3872 -- ^ Uses texture (string)
3873 playername = "singleplayer"
3874 -- ^ optional, if specified spawns particle only on the player's client
3877 ### `ParticleSpawner` definition (`add_particlespawner`)
3882 -- ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
3883 minpos = {x=0, y=0, z=0},
3884 maxpos = {x=0, y=0, z=0},
3885 minvel = {x=0, y=0, z=0},
3886 maxvel = {x=0, y=0, z=0},
3887 minacc = {x=0, y=0, z=0},
3888 maxacc = {x=0, y=0, z=0},
3893 -- ^ The particle's properties are random values in between the bounds:
3894 -- ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
3895 -- ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
3896 collisiondetection = false,
3897 -- ^ collisiondetection: if true uses collision detection
3899 -- ^ vertical: if true faces player using y axis only
3900 texture = "image.png",
3901 -- ^ Uses texture (string)
3902 playername = "singleplayer"
3903 -- ^ Playername is optional, if specified spawns particle only on the player's client
3906 ### `HTTPRequest` definition (`http_fetch`, `http_fetch_async`)
3909 url = "http://example.org",
3911 -- ^ Timeout for connection in seconds. Default is 3 seconds.
3912 post_data = "Raw POST request data string" OR { field1 = "data1", field2 = "data2" },
3913 -- ^ Optional, if specified a POST request with post_data is performed.
3914 -- ^ Accepts both a string and a table. If a table is specified, encodes table
3915 -- ^ as x-www-form-urlencoded key-value pairs.
3916 -- ^ If post_data ist not specified, a GET request is performed instead.
3917 user_agent = "ExampleUserAgent",
3918 -- ^ Optional, if specified replaces the default minetest user agent with given string
3919 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
3920 -- ^ Optional, if specified adds additional headers to the HTTP request. You must make sure
3921 -- ^ that the header strings follow HTTP specification ("Key: Value").
3923 -- ^ Optional, if true performs a multipart HTTP request. Default is false.
3926 ### `HTTPRequestResult` definition (`http_fetch` callback, `http_fetch_async_get`)
3930 -- ^ If true, the request has finished (either succeeded, failed or timed out)
3932 -- ^ If true, the request was succesful
3934 -- ^ If true, the request timed out
3936 -- ^ HTTP status code