1 Minetest Lua Modding API Reference 0.4.12
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.
70 Games can provide custom main menu images. They are put inside a `menu` directory inside the game directory.
72 The images are named `$identifier.png`, where `$identifier` is one of `overlay,background,footer,header`.
73 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,
74 and a random image will be chosen from the provided ones.
81 * `$path_share/games/gameid/mods/`
83 * `$path_user/games/gameid/mods/`
84 * `$path_user/mods/` (User-installed mods)
85 * `$worldpath/worldmods/`
87 In a run-in-place version (e.g. the distributed windows version):
89 * `minetest-0.4.x/games/gameid/mods/`
90 * `minetest-0.4.x/mods/` (User-installed mods)
91 * `minetest-0.4.x/worlds/worldname/worldmods/`
93 On an installed version on Linux:
95 * `/usr/share/minetest/games/gameid/mods/`
96 * `$HOME/.minetest/mods/` (User-installed mods)
97 * `$HOME/.minetest/worlds/worldname/worldmods`
99 Mod load path for world-specific games
100 --------------------------------------
101 It is possible to include a game in a world; in this case, no mods or
102 games are loaded or checked from anywhere else.
104 This is useful for e.g. adventure worlds.
106 This happens if the following directory exists:
110 Mods should be then be placed in:
116 Mods can be put in a subdirectory, if the parent directory, which otherwise
117 should be a mod, contains a file named `modpack.txt`. This file shall be
118 empty, except for lines starting with `#`, which are comments.
120 Mod directory structure
121 ------------------------
127 | |-- description.txt
131 | | |-- modname_stuff.png
132 | | `-- modname_something_else.png
140 The location of this directory can be fetched by using
141 `minetest.get_modpath(modname)`.
144 List of mods that have to be loaded before loading this mod.
146 A single line contains a single modname.
148 Optional dependencies can be defined by appending a question mark
149 to a single modname. Their meaning is that if the specified mod
150 is missing, that does not prevent this mod from being loaded.
153 A screenshot shown in modmanager within mainmenu.
155 ### `description.txt`
156 A File containing description to be shown within mainmenu.
159 The main Lua script. Running this script should register everything it
160 wants to register. Subsequent execution depends on minetest calling the
161 registered callbacks.
163 `minetest.setting_get(name)` and `minetest.setting_getbool(name)` can be used
164 to read custom or existing settings at load time, if necessary.
167 Models for entities or meshnodes.
169 ### `textures`, `sounds`, `media`
170 Media files (textures, sounds, whatever) that will be transferred to the
171 client and will be available for use by the mod.
173 Naming convention for registered textual names
174 ----------------------------------------------
175 Registered names should generally be in this format:
177 "modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
179 This is to prevent conflicting names from corrupting maps and is
180 enforced by the mod loader.
183 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
184 So the name should be `experimental:tnt`.
186 Enforcement can be overridden by prefixing the name with `:`. This can
187 be used for overriding the registrations of some other mod.
189 Example: Any mod can redefine `experimental:tnt` by using the name
194 (also that mod is required to have `experimental` as a dependency)
196 The `:` prefix can also be used for maintaining backwards compatibility.
199 Aliases can be added by using `minetest.register_alias(name, convert_to)`.
201 This will make Minetest to convert things called name to things called
204 This can be used for maintaining backwards compatibility.
206 This can be also used for setting quick access names for things, e.g. if
207 you have an item called `epiclylongmodname:stuff`, you could do
209 minetest.register_alias("stuff", "epiclylongmodname:stuff")
211 and be able to use `/giveme stuff`.
215 Mods should generally prefix their textures with `modname_`, e.g. given
216 the mod name `foomod`, a texture could be called:
220 Textures are referred to by their complete name, or alternatively by
221 stripping out the file extension:
223 * e.g. `foomod_foothing.png`
224 * e.g. `foomod_foothing`
228 There are various texture modifiers that can be used
229 to generate textures on-the-fly.
231 ### Texture overlaying
232 Textures can be overlaid by putting a `^` between them.
236 default_dirt.png^default_grass_side.png
238 `default_grass_side.png` is overlayed over `default_dirt.png`.
241 Textures can be grouped together by enclosing them in `(` and `)`.
243 Example: `cobble.png^(thing1.png^thing2.png)`
245 A texture for `thing1.png^thing2.png` is created and the resulting
246 texture is overlaid over `cobble.png`.
248 ### Advanced texture modifiers
250 #### `[crack:<n>:<p>`
251 * `<n>` = animation frame count
252 * `<p>` = current animation frame
254 Draw a step of the crack animation on the texture.
258 default_cobble.png^[crack:10:1
260 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>`
263 * `<x1>`/`<x2>` = x positions
264 * `<y1>`/`<y1>` = y positions
265 * `<file1>`/`<file2>` = textures to combine
267 Create a texture of size `<w>` times `<h>` and blit `<file1>` to (`<x1>`,`<y1>`)
268 and blit `<file2>` to (`<x2>`,`<y2>`).
272 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
275 Brightens the texture.
279 tnt_tnt_side.png^[brighten
282 Makes the texture completely opaque.
286 default_leaves.png^[noalpha
288 #### `[makealpha:<r>,<g>,<b>`
289 Convert one color to transparency.
293 default_cobble.png^[makealpha:128,128,128
296 * `<t>` = transformation(s) to apply
298 Rotates and/or flips the image.
300 `<t>` can be a number (between 0 and 7) or a transform name.
301 Rotations are counter-clockwise.
304 1 R90 rotate by 90 degrees
305 2 R180 rotate by 180 degrees
306 3 R270 rotate by 270 degrees
308 5 FXR90 flip X then rotate by 90 degrees
310 7 FYR90 flip Y then rotate by 90 degrees
314 default_stone.png^[transformFXR90
316 #### `[inventorycube{<top>{<left>{<right>`
317 `^` is replaced by `&` in texture names.
319 Create an inventory cube texture using the side textures.
323 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
325 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
326 `dirt.png^grass_side.png` textures
328 #### `[lowpart:<percent>:<file>`
329 Blit the lower `<percent>`% part of `<file>` on the texture.
333 base.png^[lowpart:25:overlay.png
335 #### `[verticalframe:<t>:<n>`
336 * `<t>` = animation frame count
337 * `<n>` = current animation frame
339 Crops the texture to a frame of a vertical animation.
343 default_torch_animated.png^[verticalframe:16:8
346 Apply a mask to the base image.
348 The mask is applied using binary AND.
350 #### `[colorize:<color>:<ratio>`
351 Colorize the textures with the given color.
352 `<color>` is specified as a `ColorString`.
353 `<ratio>` is an int ranging from 0 to 255, and specifies how much of the
354 color to apply. If ommitted, the alpha will be used.
358 Only Ogg Vorbis files are supported.
360 For positional playing of sounds, only single-channel (mono) files are
361 supported. Otherwise OpenAL will play them non-positionally.
363 Mods should generally prefix their sounds with `modname_`, e.g. given
364 the mod name "`foomod`", a sound could be called:
368 Sounds are referred to by their name with a dot, a single digit and the
369 file extension stripped out. When a sound is played, the actual sound file
370 is chosen randomly from the matching sounds.
372 When playing the sound `foomod_foosound`, the sound is chosen randomly
373 from the available ones of the following files:
375 * `foomod_foosound.ogg`
376 * `foomod_foosound.0.ogg`
377 * `foomod_foosound.1.ogg`
379 * `foomod_foosound.9.ogg`
381 Examples of sound parameter tables:
383 -- Play location-less on all clients
385 gain = 1.0, -- default
387 -- Play location-less to a player
390 gain = 1.0, -- default
392 -- Play in a location
395 gain = 1.0, -- default
396 max_hear_distance = 32, -- default
398 -- Play connected to an object, looped
400 object = <an ObjectRef>,
401 gain = 1.0, -- default
402 max_hear_distance = 32, -- default
403 loop = true, -- only sounds connected to objects can be looped
406 ### `SimpleSoundSpec`
408 * e.g. `"default_place_node"`
410 * e.g. `{name="default_place_node"}`
411 * e.g. `{name="default_place_node", gain=1.0}`
413 Registered definitions of stuff
414 -------------------------------
415 Anything added using certain `minetest.register_*` functions get added to
416 the global `minetest.registered_*` tables.
418 * `minetest.register_entity(name, prototype table)`
419 * added to `minetest.registered_entities[name]`
421 * `minetest.register_node(name, node definition)`
422 * added to `minetest.registered_items[name]`
423 * added to `minetest.registered_nodes[name]`
425 * `minetest.register_tool(name, item definition)`
426 * added to `minetest.registered_items[name]`
428 * `minetest.register_craftitem(name, item definition)`
429 * added to `minetest.registered_items[name]`
431 * `minetest.register_biome(biome definition)`
432 * returns an integer uniquely identifying the registered biome
433 * added to `minetest.registered_biome` with the key of `biome.name`
434 * if `biome.name` is nil, the key is the returned ID
436 * `minetest.register_ore(ore definition)`
437 * returns an integer uniquely identifying the registered ore
438 * added to `minetest.registered_ores` with the key of `ore.name`
439 * if `ore.name` is nil, the key is the returned ID
441 * `minetest.register_decoration(decoration definition)`
442 * returns an integer uniquely identifying the registered decoration
443 * added to `minetest.registered_decorations` with the key of `decoration.name`
444 * if `decoration.name` is nil, the key is the returned ID
446 * `minetest.register_schematic(schematic definition)`
447 * returns an integer uniquely identifying the registered schematic
448 * added to `minetest.registered_schematic` with the key of `schematic.name`
449 * if `schematic.name` is nil, the key is the returned ID
450 * if the schematic is loaded from a file, schematic.name is set to the filename
451 * if the function is called when loading the mod, and schematic.name is a relative path,
452 * then the current mod path will be prepended to the schematic filename
454 * `minetest.clear_registered_biomes()`
455 * clears all biomes currently registered
457 * `minetest.clear_registered_ores()`
458 * clears all ores currently registered
460 * `minetest.clear_registered_decorations()`
461 * clears all decorations currently registered
463 * `minetest.clear_registered_schematics()`
464 * clears all schematics currently registered
466 Note that in some cases you will stumble upon things that are not contained
467 in these tables (e.g. when a mod has been removed). Always check for
468 existence before trying to access the fields.
470 Example: If you want to check the drawtype of a node, you could do:
472 local function get_nodedef_field(nodename, fieldname)
473 if not minetest.registered_nodes[nodename] then
476 return minetest.registered_nodes[nodename][fieldname]
478 local drawtype = get_nodedef_field(nodename, "drawtype")
480 Example: `minetest.get_item_group(name, group)` has been implemented as:
482 function minetest.get_item_group(name, group)
483 if not minetest.registered_items[name] or not
484 minetest.registered_items[name].groups[group] then
487 return minetest.registered_items[name].groups[group]
492 Nodes are the bulk data of the world: cubes and other things that take the
493 space of a cube. Huge amounts of them are handled efficiently, but they
496 The definition of a node is stored and can be accessed by name in
498 minetest.registered_nodes[node.name]
500 See "Registered definitions of stuff".
502 Nodes are passed by value between Lua and the engine.
503 They are represented by a table:
505 {name="name", param1=num, param2=num}
507 `param1` and `param2` are 8-bit integers. The engine uses them for certain
508 automated functions. If you don't use these functions, you can use them to
509 store arbitrary values.
511 The functions of `param1` and `param2` are determined by certain fields in the
514 `param1` is reserved for the engine when `paramtype != "none"`:
517 ^ The value stores light with and without sun in its upper and lower 4 bits
518 respectively. Allows light to propagate from or through the node with
519 light value falling by 1 per node. This is essential for a light source
520 node to spread its light.
522 `param2` is reserved for the engine when any of these are used:
524 liquidtype == "flowing"
525 ^ The level and some flags of the liquid is stored in param2
526 drawtype == "flowingliquid"
527 ^ The drawn liquid level is read from param2
528 drawtype == "torchlike"
529 drawtype == "signlike"
530 paramtype2 == "wallmounted"
531 ^ The rotation of the node is stored in param2. You can make this value
532 by using minetest.dir_to_wallmounted().
533 paramtype2 == "facedir"
534 ^ The rotation of the node is stored in param2. Furnaces and chests are
535 rotated this way. Can be made by using minetest.dir_to_facedir().
537 facedir modulo 4 = axisdir
538 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
539 facedir's two less significant bits are rotation around the axis
540 paramtype2 == "leveled"
544 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
547 ^ defines list of collision boxes for the node. If empty, collision boxes
548 will be the same as nodeboxes, in case of any other nodes will be full cube
549 as in the example above.
551 Nodes can also contain extra data. See "Node Metadata".
555 There are a bunch of different looking node types.
557 Look for examples in `games/minimal` or `games/minetest_game`.
565 * `glasslike_framed_optional`
567 * `allfaces_optional`
574 * `nodebox` -- See below. (**Experimental!**)
575 * `mesh` -- use models for nodes
577 `*_optional` drawtypes need less rendering time if deactivated (always client side).
581 Node selection boxes are defined using "node boxes"
583 The `nodebox` node drawtype allows defining visual of nodes consisting of
584 arbitrary number of boxes. It allows defining stuff like stairs. Only the
585 `fixed` and `leveled` box type is supported for these.
587 Please note that this is still experimental, and may be incompatibly
588 changed in the future.
590 A nodebox is defined as any of:
593 -- A normal cube; the default in most things
597 -- A fixed box (facedir param2 is used, if applicable)
599 fixed = box OR {box1, box2, ...}
602 -- A box like the selection box for torches
603 -- (wallmounted param2 is used, if applicable)
604 type = "wallmounted",
610 A `box` is defined as:
612 {x1, y1, z1, x2, y2, z2}
614 A box of a regular node would look like:
616 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
618 `type = "leveled"` is same as `type = "fixed"`, but `y2` will be automatically
619 set to level from `param2`.
624 If drawtype `mesh` is used, tiles should hold model materials textures.
625 Only static meshes are implemented.
626 For supported model formats see Irrlicht engine documentation.
631 Noise Parameters, or commonly called "`NoiseParams`", define the properties of
635 Offset that the noise is translated by (i.e. added) after calculation.
638 Factor that the noise is scaled by (i.e. multiplied) after calculation.
641 Vector containing values by which each coordinate is divided by before calculation.
642 Higher spread values result in larger noise features.
644 A value of `{x=250, y=250, z=250}` is common.
647 Random seed for the noise. Add the world seed to a seed offset for world-unique noise.
648 In the case of `minetest.get_perlin()`, this value has the world seed automatically added.
651 Number of times the noise gradient is accumulated into the noise.
653 Increase this number to increase the amount of detail in the resulting noise.
655 A value of `6` is common.
658 Factor by which the effect of the noise gradient function changes with each successive octave.
660 Values less than `1` make the details of successive octaves' noise diminish, while values
661 greater than `1` make successive octaves stronger.
663 A value of `0.6` is common.
666 Factor by which the noise feature sizes change with each successive octave.
668 A value of `2.0` is common.
671 Leave this field unset for no special handling.
673 Currently supported are `defaults`, `eased` and `absvalue`.
676 Specify this if you would like to keep auto-selection of eased/not-eased while specifying
680 Maps noise gradient values onto a quintic S-curve before performing interpolation.
681 This results in smooth, rolling noise. Disable this (`noeased`) for sharp-looking noise.
682 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is not eased.
685 Accumulates the absolute value of each noise gradient result.
687 Noise parameters format example for 2D or 3D perlin noise or perlin noise maps:
691 spread = {x=500, y=500, z=500},
696 flags = "defaults, absvalue"
698 ^ A single noise parameter table can be used to get 2D or 3D noise,
699 when getting 2D noise spread.z is ignored.
704 These tell in what manner the ore is generated.
706 All default ores are of the uniformly-distributed scatter type.
709 Randomly chooses a location and generates a cluster of ore.
711 If `noise_params` is specified, the ore will be placed if the 3D perlin noise at
712 that point is greater than the `noise_threshold`, giving the ability to create
713 a non-equal distribution of ore.
716 Creates a sheet of ore in a blob shape according to the 2D perlin noise
717 described by `noise_params`. The relative height of the sheet can be
718 controlled by the same perlin noise as well, by specifying a non-zero
719 `scale` parameter in `noise_params`.
721 **IMPORTANT**: The noise is not transformed by `offset` or `scale` when comparing
722 against the noise threshold, but scale is used to determine relative height.
723 The height of the blob is randomly scattered, with a maximum height of `clust_size`.
725 `clust_scarcity` and `clust_num_ores` are ignored.
727 This is essentially an improved version of the so-called "stratus" ore seen in
728 some unofficial mods.
731 Creates a deformed sphere of ore according to 3d perlin noise described by
732 `noise_params`. The maximum size of the blob is `clust_size`, and
733 `clust_scarcity` has the same meaning as with the `scatter` type.
735 Creates veins of ore varying in density by according to the intersection of two
736 instances of 3d perlin noise with diffferent seeds, both described by
737 `noise_params`. `random_factor` varies the influence random chance has on
738 placement of an ore inside the vein, which is `1` by default. Note that
739 modifying this parameter may require adjusting `noise_threshhold`.
740 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
741 by this ore type. This ore type is difficult to control since it is sensitive
742 to small changes. The following is a decent set of parameters to work from:
747 spread = {x=200, y=200, z=200},
753 noise_threshhold = 1.6
755 WARNING: Use this ore type *very* sparingly since it is ~200x more
756 computationally expensive than any other ore.
760 See section "Flag Specifier Format".
762 Currently supported flags: `absheight`
765 Also produce this same ore between the height range of `-y_max` and `-y_min`.
767 Useful for having ore in sky realms without having to duplicate ore entries.
771 The varying types of decorations that can be placed.
773 The default value is `simple`, and is currently the only type supported.
776 Creates a 1 times `H` times 1 column of a specified node (or a random node from
777 a list, if a decoration list is specified). Can specify a certain node it must
778 spawn next to, such as water or lava, for example. Can also generate a
779 decoration of random height between a specified lower and upper bound.
780 This type of decoration is intended for placement of grass, flowers, cacti,
784 Copies a box of `MapNodes` from a specified schematic file (or raw description).
785 Can specify a probability of a node randomly appearing when placed.
786 This decoration type is intended to be used for multi-node sized discrete
787 structures, such as trees, cave spikes, rocks, and so on.
792 A schematic specifier identifies a schematic by either a filename to a
793 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
794 in the form of a table. This table specifies the following fields:
796 * The `size` field is a 3D vector containing the dimensions of the provided schematic. (required)
797 * The `yslice_prob` field is a table of {ypos, prob} which sets the `ypos`th vertical slice
798 of the schematic to have a `prob / 256 * 100` chance of occuring. (default: 255)
799 * The `data` field is a flat table of MapNode tables making up the schematic,
800 in the order of `[z [y [x]]]`. (required)
801 Each MapNode table contains:
802 * `name`: the name of the map node to place (required)
803 * `prob` (alias `param1`): the probability of this node being placed (default: 255)
804 * `param2`: the raw param2 value of the node being placed onto the map (default: 0)
805 * `force_place`: boolean representing if the node should forcibly overwrite any
806 previous contents (default: false)
808 About probability values:
809 * A probability value of `0` or `1` means that node will never appear (0% chance).
810 * A probability value of `254` or `255` means the node will always appear (100% chance).
811 * If the probability value `p` is greater than `1`, then there is a
812 `(p / 256 * 100)` percent chance that node will appear when the schematic is
818 See section "Flag Specifier Format".
820 Currently supported flags: `place_center_x`, `place_center_y`,
821 `place_center_z`, `force_placement`.
823 * `place_center_x`: Placement of this decoration is centered along the X axis.
824 * `place_center_y`: Placement of this decoration is centered along the Y axis.
825 * `place_center_z`: Placement of this decoration is centered along the Z axis.
826 * `force_placement`: Schematic nodes other than "ignore" will replace existing nodes.
831 The position field is used for all element types.
833 To account for differing resolutions, the position coordinates are the percentage
834 of the screen, ranging in value from `0` to `1`.
836 The name field is not yet used, but should contain a description of what the
837 HUD element represents. The direction field is the direction in which something
840 `0` draws from left to right, `1` draws from right to left, `2` draws from
841 top to bottom, and `3` draws from bottom to top.
843 The `alignment` field specifies how the item will be aligned. It ranges from `-1` to `1`,
844 with `0` being the center, `-1` is moved to the left/up, and `1` is to the right/down.
845 Fractional values can be used.
847 The `offset` field specifies a pixel offset from the position. Contrary to position,
848 the offset is not scaled to screen size. This allows for some precisely-positioned
851 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling factor!
853 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
855 **Note**: Future revisions to the HUD API may be incompatible; the HUD API is still
856 in the experimental stages.
859 Displays an image on the HUD.
861 * `scale`: The scale of the image, with 1 being the original texture size.
862 Only the X coordinate scale is used (positive values).
863 Negative values represent that percentage of the screen it
864 should take; e.g. `x=-100` means 100% (width).
865 * `text`: The name of the texture that is displayed.
866 * `alignment`: The alignment of the image.
867 * `offset`: offset in pixels from position.
870 Displays text on the HUD.
872 * `scale`: Defines the bounding rectangle of the text.
873 A value such as `{x=100, y=100}` should work.
874 * `text`: The text to be displayed in the HUD element.
875 * `number`: An integer containing the RGB value of the color used to draw the text.
876 Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
877 * `alignment`: The alignment of the text.
878 * `offset`: offset in pixels from position.
881 Displays a horizontal bar made up of half-images.
883 * `text`: The name of the texture that is used.
884 * `number`: The number of half-textures that are displayed.
885 If odd, will end with a vertically center-split texture.
887 * `offset`: offset in pixels from position.
888 * `size`: If used, will force full-image size to this value (override texture pack image size)
891 * `text`: The name of the inventory list to be displayed.
892 * `number`: Number of items in the inventory to be displayed.
893 * `item`: Position of item that is selected.
897 Displays distance to selected world position.
899 * `name`: The name of the waypoint.
900 * `text`: Distance suffix. Can be blank.
901 * `number:` An integer containing the RGB value of the color used to draw the text.
902 * `world_pos`: World position of the waypoint.
904 Representations of simple things
905 --------------------------------
909 {x=num, y=num, z=num}
911 For helper functions see "Vector helpers".
915 * `{type="node", under=pos, above=pos}`
916 * `{type="object", ref=ObjectRef}`
918 Flag Specifier Format
919 ---------------------
920 Flags using the standardized flag specifier format can be specified in either of
921 two ways, by string or table.
923 The string format is a comma-delimited set of flag names; whitespace and
924 unrecognized flag fields are ignored. Specifying a flag in the string sets the
925 flag, and specifying a flag prefixed by the string `"no"` explicitly
926 clears the flag from whatever the default may be.
928 In addition to the standard string flag format, the schematic flags field can
929 also be a table of flag names to boolean values representing whether or not the
930 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
931 is present, mapped to a boolean of any value, the specified flag is unset.
933 E.g. A flag field of value
935 {place_center_x = true, place_center_y=false, place_center_z=true}
939 {place_center_x = true, noplace_center_y=true, place_center_z=true}
941 which is equivalent to
943 "place_center_x, noplace_center_y, place_center_z"
947 "place_center_x, place_center_z"
949 since, by default, no schematic attributes are set.
955 There are three kinds of items: nodes, tools and craftitems.
957 * Node (`register_node`): A node from the world.
958 * Tool (`register_tool`): A tool/weapon that can dig and damage
959 things according to `tool_capabilities`.
960 * Craftitem (`register_craftitem`): A miscellaneous item.
963 Items and item stacks can exist in three formats: Serializes, table format
967 This is called "stackstring" or "itemstring":
969 * e.g. `'default:dirt 5'`
970 * e.g. `'default:pick_wood 21323'`
971 * e.g. `'default:apple'`
978 {name="default:dirt", count=5, wear=0, metadata=""}
980 A wooden pick about 1/3 worn out:
982 {name="default:pick_wood", count=1, wear=21323, metadata=""}
986 {name="default:apple", count=1, wear=0, metadata=""}
989 A native C++ format with many helper methods. Useful for converting
990 between formats. See the Class reference section for details.
992 When an item must be passed to a function, it can usually be in any of
998 In a number of places, there is a group table. Groups define the
999 properties of a thing (item, node, armor of entity, capabilities of
1000 tool) in such a way that the engine and other mods can can interact with
1001 the thing without actually knowing what the thing is.
1004 Groups are stored in a table, having the group names with keys and the
1005 group ratings as values. For example:
1007 groups = {crumbly=3, soil=1}
1010 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1011 -- ^ A more special dirt-kind of thing
1013 Groups always have a rating associated with them. If there is no
1014 useful meaning for a rating for an enabled group, it shall be `1`.
1016 When not defined, the rating of a group defaults to `0`. Thus when you
1017 read groups, you must interpret `nil` and `0` as the same value, `0`.
1019 You can read the rating of a group for an item or a node by using
1021 minetest.get_item_group(itemname, groupname)
1024 Groups of items can define what kind of an item it is (e.g. wool).
1027 In addition to the general item things, groups are used to define whether
1028 a node is destroyable and how long it takes to destroy by a tool.
1030 ### Groups of entities
1031 For entities, groups are, as of now, used only for calculating damage.
1032 The rating is the percentage of damage caused by tools with this damage group.
1033 See "Entity damage mechanism".
1035 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1036 object.set_armor_groups({fleshy=30, cracky=80})
1039 Groups in tools define which groups of nodes and entities they are
1042 ### Groups in crafting recipes
1043 An example: Make meat soup from any meat, any water and any bowl:
1046 output = 'food:meat_soup_raw',
1052 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1055 Another example: Make red wool from white wool and red dye:
1059 output = 'wool:red',
1060 recipe = {'wool:white', 'group:dye,basecolor_red'},
1064 * `immortal`: Disables the group damage system for an entity
1065 * `level`: Can be used to give an additional sense of progression in the game.
1066 * A larger level will cause e.g. a weapon of a lower level make much less
1067 damage, and get worn out much faster, or not be able to get drops
1068 from destroyed nodes.
1069 * `0` is something that is directly accessible at the start of gameplay
1070 * There is no upper limit
1071 * `dig_immediate`: (player can always pick up node without tool wear)
1072 * `2`: node is removed without tool wear after 0.5 seconds or so
1074 * `3`: node is removed without tool wear immediately (torch)
1075 * `disable_jump`: Player (and possibly other things) cannot jump from node
1076 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1077 * `bouncy`: value is bounce speed in percent
1078 * `falling_node`: if there is no walkable block under the node it will fall
1079 * `attached_node`: if the node under it is not a walkable block the node will be
1080 dropped as an item. If the node is wallmounted the wallmounted direction is
1082 * `soil`: saplings will grow on nodes in this group
1083 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1084 connect to each other
1086 ### Known damage and digging time defining groups
1087 * `crumbly`: dirt, sand
1088 * `cracky`: tough but crackable stuff like stone.
1089 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1090 plants, wire, sheets of metal
1091 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1092 * `fleshy`: Living things like animals and the player. This could imply
1093 some blood effects when hitting.
1094 * `explody`: Especially prone to explosions
1095 * `oddly_breakable_by_hand`:
1096 Can be added to nodes that shouldn't logically be breakable by the
1097 hand but are. Somewhat similar to `dig_immediate`, but times are more
1098 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1099 speed of a tool if the tool can dig at a faster speed than this
1100 suggests for the hand.
1102 ### Examples of custom groups
1103 Item groups are often used for defining, well, _groups of items_.
1104 * `meat`: any meat-kind of a thing (rating might define the size or healing
1105 ability or be irrelevant -- it is not defined as of yet)
1106 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1108 * `flammable`: can be set on fire. Rating might define the intensity of the
1109 fire, affecting e.g. the speed of the spreading of an open fire.
1110 * `wool`: any wool (any origin, any color)
1111 * `metal`: any metal
1112 * `weapon`: any weapon
1113 * `heavy`: anything considerably heavy
1115 ### Digging time calculation specifics
1116 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1117 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1118 faster digging time.
1120 The `level` group is used to limit the toughness of nodes a tool can dig
1121 and to scale the digging times / damage to a greater extent.
1123 **Please do understand this**, otherwise you cannot use the system to it's
1126 Tools define their properties by a list of parameters for groups. They
1127 cannot dig other groups; thus it is important to use a standard bunch of
1128 groups to enable interaction with tools.
1130 #### Tools definition
1133 * Full punch interval
1134 * Maximum drop level
1135 * For an arbitrary list of groups:
1136 * Uses (until the tool breaks)
1137 * Maximum level (usually `0`, `1`, `2` or `3`)
1141 #### Full punch interval
1142 When used as a weapon, the tool will do full damage if this time is spent
1143 between punches. If e.g. half the time is spent, the tool will do half
1146 #### Maximum drop level
1147 Suggests the maximum level of node, when dug with the tool, that will drop
1148 it's useful item. (e.g. iron ore to drop a lump of iron).
1150 This is not automated; it is the responsibility of the node definition
1154 Determines how many uses the tool has when it is used for digging a node,
1155 of this group, of the maximum level. For lower leveled nodes, the use count
1156 is multiplied by `3^leveldiff`.
1158 * `uses=10, leveldiff=0`: actual uses: 10
1159 * `uses=10, leveldiff=1`: actual uses: 30
1160 * `uses=10, leveldiff=2`: actual uses: 90
1163 Tells what is the maximum level of a node of this group that the tool will
1167 List of digging times for different ratings of the group, for nodes of the
1170 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1171 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1172 for this group, and unable to dig the rating `1`, which is the toughest.
1173 Unless there is a matching group that enables digging otherwise.
1176 List of damage for groups of entities. See "Entity damage mechanism".
1178 #### Example definition of the capabilities of a tool
1180 tool_capabilities = {
1181 full_punch_interval=1.5,
1184 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1186 damage_groups = {fleshy=2},
1189 This makes the tool be able to dig nodes that fulfil both of these:
1191 * Have the `crumbly` group
1192 * Have a `level` group less or equal to `2`
1194 Table of resulting digging times:
1196 crumbly 0 1 2 3 4 <- level
1198 1 0.80 1.60 1.60 - -
1199 2 0.60 1.20 1.20 - -
1200 3 0.40 0.80 0.80 - -
1202 level diff: 2 1 0 -1 -2
1204 Table of resulting tool uses:
1213 * At `crumbly==0`, the node is not diggable.
1214 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1215 easy nodes to be quickly breakable.
1216 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1218 Entity damage mechanism
1219 -----------------------
1223 foreach group in cap.damage_groups:
1224 damage += cap.damage_groups[group] * limit(actual_interval /
1225 cap.full_punch_interval, 0.0, 1.0)
1226 * (object.armor_groups[group] / 100.0)
1227 -- Where object.armor_groups[group] is 0 for inexistent values
1230 Client predicts damage based on damage groups. Because of this, it is able to
1231 give an immediate response when an entity is damaged or dies; the response is
1232 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1234 Currently a smoke puff will appear when an entity dies.
1236 The group `immortal` completely disables normal damage.
1238 Entities can define a special armor group, which is `punch_operable`. This
1239 group disables the regular damage mechanism for players punching it by hand or
1240 a non-tool item, so that it can do something else than take damage.
1242 On the Lua side, every punch calls:
1244 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction)
1246 This should never be called directly, because damage is usually not handled by
1249 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1250 accessed unless absolutely required, to encourage interoperability.
1251 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1252 * `tool_capabilities` can be `nil`.
1253 * `direction` is a unit vector, pointing from the source of the punch to
1256 To punch an entity/object in Lua, call:
1258 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1260 * Return value is tool wear.
1261 * Parameters are equal to the above callback.
1262 * If `direction` equals `nil` and `puncher` does not equal `nil`,
1263 `direction` will be automatically filled in based on the location of `puncher`.
1267 The instance of a node in the world normally only contains the three values
1268 mentioned in "Nodes". However, it is possible to insert extra data into a
1269 node. It is called "node metadata"; See "`NodeMetaRef`".
1271 Metadata contains two things:
1275 Some of the values in the key-value store are handled specially:
1276 * `formspec`: Defines a right-click inventory menu. See "Formspec".
1277 * `infotext`: Text shown on the screen when the node is pointed at
1281 local meta = minetest.get_meta(pos)
1282 meta:set_string("formspec",
1284 "list[context;main;0,0;8,4;]"..
1285 "list[current_player;main;0,5;8,4;]")
1286 meta:set_string("infotext", "Chest");
1287 local inv = meta:get_inventory()
1288 inv:set_size("main", 8*4)
1289 print(dump(meta:to_table()))
1292 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
1293 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
1294 [10] = "", [11] = "", [12] = "", [13] = "",
1295 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
1296 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
1297 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
1298 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
1302 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
1309 Formspec defines a menu. Currently not much else than inventories are
1310 supported. It is a string, with a somewhat strange format.
1312 Spaces and newlines can be inserted between the blocks, as is used in the
1320 list[context;main;0,0;8,4;]
1321 list[current_player;main;0,5;8,4;]
1326 list[context;fuel;2,3;1,1;]
1327 list[context;src;2,1;1,1;]
1328 list[context;dst;5,1;2,2;]
1329 list[current_player;main;0,5;8,4;]
1331 #### Minecraft-like player inventory
1334 image[1,0.6;1,2;player.png]
1335 list[current_player;main;0,3.5;8,4;]
1336 list[current_player;craft;3,0;3,3;]
1337 list[current_player;craftpreview;7,1;1,1;]
1341 #### `size[<W>,<H>,<fixed_size>]`
1342 * Define the size of the menu in inventory slots
1343 * `fixed_size`: `true`/`false` (optional)
1344 * deprecated: `invsize[<W>,<H>;]`
1346 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
1347 * Show an inventory list
1349 #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
1350 * Show an inventory list
1352 #### `listring[<inventory location>;<list name>]`
1353 * Allows to create a ring of inventory lists
1354 * Shift-clicking on items in one element of the ring
1355 * will send them to the next inventory list inside the ring
1356 * The first occurrence of an element inside the ring will
1357 * determine the inventory where items will be sent to
1360 * Shorthand for doing `listring[<inventory location>;<list name>]`
1361 * for the last two inventory lists added by list[...]
1363 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
1364 * Sets background color of slots as `ColorString`
1365 * Sets background color of slots on mouse hovering
1367 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
1368 * Sets background color of slots as `ColorString`
1369 * Sets background color of slots on mouse hovering
1370 * Sets color of slots border
1372 #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
1373 * Sets background color of slots as `ColorString`
1374 * Sets background color of slots on mouse hovering
1375 * Sets color of slots border
1376 * Sets default background color of tooltips
1377 * Sets default font color of tooltips
1379 #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>,<fontcolor>]`
1380 * Adds tooltip for an element
1381 * `<bgcolor>` tooltip background color as `ColorString` (optional)
1382 * `<fontcolor>` tooltip font color as `ColorString` (optional)
1384 #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
1386 * Position and size units are inventory slots
1388 #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
1389 * Show an inventory image of registered item/node
1390 * Position and size units are inventory slots
1392 #### `bgcolor[<color>;<fullscreen>]`
1393 * Sets background color of formspec as `ColorString`
1394 * If `true`, the background color is drawn fullscreen (does not effect the size of the formspec)
1396 #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
1397 * Use a background. Inventory rectangles are not drawn then.
1398 * Position and size units are inventory slots
1399 * Example for formspec 8x4 in 16x resolution: image shall be sized
1400 8 times 16px times 4 times 16px.
1402 #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
1403 * Use a background. Inventory rectangles are not drawn then.
1404 * Position and size units are inventory slots
1405 * Example for formspec 8x4 in 16x resolution:
1406 image shall be sized 8 times 16px times 4 times 16px
1407 * If `true` the background is clipped to formspec size
1408 (`x` and `y` are used as offset values, `w` and `h` are ignored)
1410 #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
1411 * Textual password style field; will be sent to server when a button is clicked
1412 * `x` and `y` position the field relative to the top left of the menu
1413 * `w` and `h` are the size of the field
1414 * fields are a set height, but will be vertically centred on `h`
1415 * Position and size units are inventory slots
1416 * `name` is the name of the field as returned in fields to `on_receive_fields`
1417 * `label`, if not blank, will be text printed on the top left above the field
1419 #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1420 * Textual field; will be sent to server when a button is clicked
1421 * `x` and `y` position the field relative to the top left of the menu
1422 * `w` and `h` are the size of the field
1423 * fields are a set height, but will be vertically centred on `h`
1424 * Position and size units are inventory slots
1425 * `name` is the name of the field as returned in fields to `on_receive_fields`
1426 * `label`, if not blank, will be text printed on the top left above the field
1427 * `default` is the default value of the field
1428 * `default` may contain variable references such as `${text}'` which
1429 will fill the value from the metadata value `text`
1430 * **Note**: no extra text or more than a single variable is supported ATM.
1432 #### `field[<name>;<label>;<default>]`
1433 * as above, but without position/size units
1434 * special field for creating simple forms, such as sign text input
1435 * must be used without a `size[]` element
1436 * a "Proceed" button will be added automatically
1438 #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
1439 * same as fields above, but with multi-line input
1441 #### `label[<X>,<Y>;<label>]`
1442 * `x` and `y` work as per field
1443 * `label` is the text on the label
1444 * Position and size units are inventory slots
1446 #### `vertlabel[<X>,<Y>;<label>]`
1447 * Textual label drawn vertically
1448 * `x` and `y` work as per field
1449 * `label` is the text on the label
1450 * Position and size units are inventory slots
1452 #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
1453 * Clickable button. When clicked, fields will be sent.
1454 * `x`, `y` and `name` work as per field
1455 * `w` and `h` are the size of the button
1456 * `label` is the text on the button
1457 * Position and size units are inventory slots
1459 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1460 * `x`, `y`, `w`, `h`, and `name` work as per button
1461 * `texture name` is the filename of an image
1462 * Position and size units are inventory slots
1464 #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
1465 * `x`, `y`, `w`, `h`, and `name` work as per button
1466 * `texture name` is the filename of an image
1467 * Position and size units are inventory slots
1468 * `noclip=true` means the image button doesn't need to be within specified formsize
1469 * `drawborder`: draw button border or not
1470 * `pressed texture name` is the filename of an image on pressed state
1472 #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
1473 * `x`, `y`, `w`, `h`, `name` and `label` work as per button
1474 * `item name` is the registered name of an item/node,
1475 tooltip will be made out of its description
1476 to override it use tooltip element
1477 * Position and size units are inventory slots
1479 #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
1480 * When clicked, fields will be sent and the form will quit.
1482 #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
1483 * When clicked, fields will be sent and the form will quit.
1485 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
1486 * Scrollable item list showing arbitrary text elements
1487 * `x` and `y` position the itemlist relative to the top left of the menu
1488 * `w` and `h` are the size of the itemlist
1489 * `name` fieldname sent to server on doubleclick value is current selected element
1490 * `listelements` can be prepended by #color in hexadecimal format RRGGBB (only),
1491 * if you want a listelement to start with "#" write "##".
1493 #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
1494 * Scrollable itemlist showing arbitrary text elements
1495 * `x` and `y` position the item list relative to the top left of the menu
1496 * `w` and `h` are the size of the item list
1497 * `name` fieldname sent to server on doubleclick value is current selected element
1498 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
1499 * if you want a listelement to start with "#" write "##"
1500 * index to be selected within textlist
1501 * `true`/`false`: draw transparent background
1502 * see also `minetest.explode_textlist_event` (main menu: `engine.explode_textlist_event`)
1504 #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
1505 * show a tab**header** at specific position (ignores formsize)
1506 * `x` and `y` position the itemlist relative to the top left of the menu
1507 * `name` fieldname data is transferred to Lua
1508 * `caption 1`...: name shown on top of tab
1509 * `current_tab`: index of selected tab 1...
1510 * `transparent` (optional): show transparent
1511 * `draw_border` (optional): draw border
1513 #### `box[<X>,<Y>;<W>,<H>;<color>]`
1514 * simple colored semitransparent box
1515 * `x` and `y` position the box relative to the top left of the menu
1516 * `w` and `h` are the size of box
1517 * `color` is color specified as a `ColorString`
1519 #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
1520 * show a dropdown field
1521 * **Important note**: There are two different operation modes:
1522 1. handle directly on change (only changed dropdown is submitted)
1523 2. read the value on pressing a button (all dropdown values are available)
1524 * `x` and `y` position of dropdown
1526 * fieldname data is transferred to Lua
1527 * items to be shown in dropdown
1528 * index of currently selected dropdown item
1530 #### `checkbox[<X>,<Y>;<name>;<label>;<selected>;<tooltip>]`
1532 * `x` and `y`: position of checkbox
1533 * `name` fieldname data is transferred to Lua
1534 * `label` to be shown left of checkbox
1535 * `selected` (optional): `true`/`false`
1536 * `tooltip` (optional)
1538 #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
1540 * there are two ways to use it:
1541 1. handle the changed event (only changed scrollbar is available)
1542 2. read the value on pressing a button (all scrollbars are available)
1543 * `x` and `y`: position of trackbar
1544 * `w` and `h`: width and height
1545 * `orientation`: `vertical`/`horizontal`
1546 * fieldname data is transferred to Lua
1547 * value this trackbar is set to (`0`-`1000`)
1548 * see also `minetest.explode_scrollbar_event` (main menu: `engine.explode_scrollbar_event`)
1550 #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
1551 * show scrollable table using options defined by the previous `tableoptions[]`
1552 * displays cells as defined by the previous `tablecolumns[]`
1553 * `x` and `y`: position the itemlist relative to the top left of the menu
1554 * `w` and `h` are the size of the itemlist
1555 * `name`: fieldname sent to server on row select or doubleclick
1556 * `cell 1`...`cell n`: cell contents given in row-major order
1557 * `selected idx`: index of row to be selected within table (first row = `1`)
1558 * see also `minetest.explode_table_event` (main menu: `engine.explode_table_event`)
1560 #### `tableoptions[<opt 1>;<opt 2>;...]`
1561 * sets options for `table[]`
1563 * default text color (`ColorString`), defaults to `#FFFFFF`
1564 * `background=#RRGGBB`
1565 * table background color (`ColorString`), defaults to `#000000`
1566 * `border=<true/false>`
1567 * should the table be drawn with a border? (default: `true`)
1568 * `highlight=#RRGGBB`
1569 * highlight background color (`ColorString`), defaults to `#466432`
1570 * `highlight_text=#RRGGBB`
1571 * highlight text color (`ColorString`), defaults to `#FFFFFF`
1572 * `opendepth=<value>`
1573 * all subtrees up to `depth < value` are open (default value = `0`)
1574 * only useful when there is a column of type "tree"
1576 #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
1577 * sets columns for `table[]`
1578 * types: `text`, `image`, `color`, `indent`, `tree`
1579 * `text`: show cell contents as text
1580 * `image`: cell contents are an image index, use column options to define images
1581 * `colo`: cell contents are a ColorString and define color of following cell
1582 * `indent`: cell contents are a number and define indentation of following cell
1583 * `tree`: same as indent, but user can open and close subtrees (treeview-like)
1586 * for `text` and `image`: content alignment within cells.
1587 Available values: `left` (default), `center`, `right`, `inline`
1589 * for `text` and `image`: minimum width in em (default: `0`)
1590 * for `indent` and `tree`: indent width in em (default: `1.5`)
1591 * `padding=<value>`: padding left of the column, in em (default `0.5`).
1592 Exception: defaults to 0 for indent columns
1593 * `tooltip=<value>`: tooltip text (default: empty)
1594 * `image` column options:
1595 * `0=<value>` sets image for image index 0
1596 * `1=<value>` sets image for image index 1
1597 * `2=<value>` sets image for image index 2
1598 * and so on; defined indices need not be contiguous empty or
1599 non-numeric cells are treated as `0`.
1600 * `color` column options:
1601 * `span=<value>`: number of following columns to affect (default: infinite)
1603 **Note**: do _not_ use a element name starting with `key_`; those names are reserved to
1604 pass key press events to formspec!
1608 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
1609 * `"current_player"`: Player to whom the menu is shown
1610 * `"player:<name>"`: Any player
1611 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
1612 * `"detached:<name>"`: A detached inventory
1616 `#RGB` defines a color in hexadecimal format.
1618 `#RGBA` defines a color in hexadecimal format and alpha channel.
1620 `#RRGGBB` defines a color in hexadecimal format.
1622 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
1624 Named colors are also supported and are equivalent to
1625 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
1626 To specify the value of the alpha channel, append `#AA` to the end of the color name
1627 (e.g. `colorname#08`). For named colors the hexadecimal string representing the alpha
1628 value must (always) be two hexadecimal digits.
1632 A ColorSpec specifies a 32-bit color. It can be written in either:
1633 table form, each element ranging from 0..255 (a, if absent, defaults to 255):
1634 `colorspec = {a=255, r=0, g=255, b=0}`
1635 numerical form, the raw integer value of an ARGB8 quad:
1636 `colorspec = 0xFF00FF00`
1637 or string form, a ColorString (defined above):
1638 `colorspec = "green"`
1643 * `vector.new([x[, y, z]])`: returns a vector.
1644 * `x` is a table or the `x` position.
1646 * `vector.direction(p1, p2)`: returns a vector
1647 * `vector.distance(p1, p2)`: returns a number
1648 * `vector.length(v)`: returns a number
1649 * `vector.normalize(v)`: returns a vector
1650 * `vector.round(v)`: returns a vector
1651 * `vector.apply(v, func)`: returns a vector
1652 * `vector.equals(v1, v2)`: returns a boolean
1654 For the following functions `x` can be either a vector or a number:
1656 * `vector.add(v, x)`: returns a vector
1657 * `vector.subtract(v, x)`: returns a vector
1658 * `vector.multiply(v, x)`: returns a vector
1659 * `vector.divide(v, x)`: returns a vector
1663 * `dump2(obj, name="_", dumped={})`
1664 * Return object serialized as a string, handles reference loops
1665 * `dump(obj, dumped={})`
1666 * Return object serialized as a string
1667 * `math.hypot(x, y)`
1668 * Get the hypotenuse of a triangle with legs x and y.
1669 Useful for distance calculation.
1670 * `math.sign(x, tolerance)`
1671 * Get the sign of a number.
1672 Optional: Also returns `0` when the absolute value is within the tolerance (default: `0`)
1673 * `string.split(str, separator=",", include_empty=false, max_splits=-1,
1674 * sep_is_pattern=false)`
1675 * If `max_splits` is negative, do not limit splits.
1676 * `sep_is_pattern` specifies if separator is a plain string or a pattern (regex).
1677 * e.g. `string:split("a,b", ",") == {"a","b"}`
1679 * e.g. `string.trim("\n \t\tfoo bar\t ") == "foo bar"`
1680 * `minetest.pos_to_string({x=X,y=Y,z=Z})`: returns `"(X,Y,Z)"`
1681 * Convert position to a printable string
1682 * `minetest.string_to_pos(string)`: returns a position
1683 * Same but in reverse. Returns `nil` if the string can't be parsed to a position.
1684 * `minetest.formspec_escape(string)`: returns a string
1685 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
1686 * `minetest.is_yes(arg)`
1687 * returns whether `arg` can be interpreted as yes
1688 * `minetest.get_us_time()`
1689 * returns time with microsecond precision
1690 * `table.copy(table)`: returns a table
1691 * returns a deep copy of `table`
1693 `minetest` namespace reference
1694 ------------------------------
1698 * `minetest.get_current_modname()`: returns the currently loading mod's name, when we are loading a mod
1699 * `minetest.get_modpath(modname)`: returns e.g. `"/home/user/.minetest/usermods/modname"`
1700 * Useful for loading additional `.lua` modules or static data from mod
1701 * `minetest.get_modnames()`: returns a list of installed mods
1702 * Return a list of installed mods, sorted alphabetically
1703 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
1704 * Useful for storing custom data
1705 * `minetest.is_singleplayer()`
1706 * `minetest.features`
1707 * Table containing API feature flags: `{foo=true, bar=true}`
1708 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
1709 * `arg`: string or table in format `{foo=true, bar=true}`
1710 * `missing_features`: `{foo=true, bar=true}`
1711 * `minetest.get_player_information(player_name)`: returns a table containing
1712 information about player. Example return value:
1714 address = "127.0.0.1", -- IP address of client
1715 ip_version = 4, -- IPv4 / IPv6
1716 min_rtt = 0.01, -- minimum round trip time
1717 max_rtt = 0.2, -- maximum round trip time
1718 avg_rtt = 0.02, -- average round trip time
1719 min_jitter = 0.01, -- minimum packet time jitter
1720 max_jitter = 0.5, -- maximum packet time jitter
1721 avg_jitter = 0.03, -- average packet time jitter
1722 connection_uptime = 200, -- seconds since client connected
1724 -- following information is available on debug build only!!!
1725 -- DO NOT USE IN MODS
1726 --ser_vers = 26, -- serialization version used by client
1727 --prot_vers = 23, -- protocol version used by client
1728 --major = 0, -- major version number
1729 --minor = 4, -- minor version number
1730 --patch = 10, -- patch version number
1731 --vers_string = "0.4.9-git", -- full version string
1732 --state = "Active" -- current client state
1734 * `minetest.mkdir(path)`: returns success.
1735 * Creates a directory specified by `path`, creating parent directories
1736 if they don't exist.
1737 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
1739 * nil: return all entries,
1740 * true: return only subdirectory names, or
1741 * false: return only file names.
1744 * `minetest.debug(line)`
1745 * Always printed to `stderr` and logfile (`print()` is redirected here)
1746 * `minetest.log(line)`
1747 * `minetest.log(loglevel, line)`
1748 * `loglevel` is one of `"error"`, `"action"`, `"info"`, `"verbose"`
1750 ### Registration functions
1751 Call these functions only at load time!
1753 * `minetest.register_entity(name, prototype table)`
1754 * `minetest.register_abm(abm definition)`
1755 * `minetest.register_node(name, node definition)`
1756 * `minetest.register_tool(name, item definition)`
1757 * `minetest.register_craftitem(name, item definition)`
1758 * `minetest.register_alias(name, convert_to)`
1759 * `minetest.register_craft(recipe)`
1760 * `minetest.register_ore(ore definition)`
1761 * `minetest.register_decoration(decoration definition)`
1762 * `minetest.override_item(name, redefinition)`
1763 * Overrides fields of an item registered with register_node/tool/craftitem.
1764 * Note: Item must already be defined, (opt)depend on the mod defining it.
1765 * Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})`
1767 * `minetest.clear_registered_ores()`
1768 * `minetest.clear_registered_decorations()`
1770 ### Global callback registration functions
1771 Call these functions only at load time!
1773 * `minetest.register_globalstep(func(dtime))`
1774 * Called every server step, usually interval of 0.1s
1775 * `minetest.register_on_shutdown(func())`
1776 * Called before server shutdown
1777 * **Warning**: If the server terminates abnormally (i.e. crashes), the registered
1778 callbacks **will likely not be run**. Data should be saved at
1779 semi-frequent intervals as well as on server shutdown.
1780 * `minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
1781 * Called when a node has been placed
1782 * If return `true` no item is taken from `itemstack`
1783 * **Not recommended**; use `on_construct` or `after_place_node` in node definition
1785 * `minetest.register_on_dignode(func(pos, oldnode, digger))`
1786 * Called when a node has been dug.
1787 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node definition
1789 * `minetest.register_on_punchnode(func(pos, node, puncher, pointed_thing))`
1790 * Called when a node is punched
1791 * `minetest.register_on_generated(func(minp, maxp, blockseed))`
1792 * Called after generating a piece of world. Modifying nodes inside the area
1793 is a bit faster than usually.
1794 * `minetest.register_on_newplayer(func(ObjectRef))`
1795 * Called after a new player has been created
1796 * `minetest.register_on_dieplayer(func(ObjectRef))`
1797 * Called when a player dies
1798 * `minetest.register_on_punchplayer(func(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
1799 * Called when a player is punched
1800 * `player` - ObjectRef - Player that was punched
1801 * `hitter` - ObjectRef - Player that hit
1802 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be nil)
1803 * `tool_capabilities`: capability table of used tool (can be nil)
1804 * `dir`: unit vector of direction of punch. Always defined. Points from
1805 the puncher to the punched.
1806 * `damage` - number that represents the damage calculated by the engine
1807 * should return `true` to prevent the default damage mechanism
1808 * `minetest.register_on_player_hpchange(func(player, hp_change), modifier)`
1809 * Called when the player gets damaged or healed
1810 * `player`: ObjectRef of the player
1811 * `hp_change`: the amount of change. Negative when it is damage.
1812 * `modifier`: when true, the function should return the actual hp_change.
1813 Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
1814 modifiers can return true as a second argument to stop the execution of further functions.
1815 * `minetest.register_on_respawnplayer(func(ObjectRef))`
1816 * Called when player is to be respawned
1817 * Called _before_ repositioning of player occurs
1818 * return true in func to disable regular player placement
1819 * `minetest.register_on_prejoinplayer(func(name, ip))`
1820 * Called before a player joins the game
1821 * If it returns a string, the player is disconnected with that string as reason
1822 * `minetest.register_on_joinplayer(func(ObjectRef))`
1823 * Called when a player joins the game
1824 * `minetest.register_on_leaveplayer(func(ObjectRef))`
1825 * Called when a player leaves the game
1826 * `minetest.register_on_cheat(func(ObjectRef, cheat))`
1827 * Called when a player cheats
1828 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
1829 * `"moved_too_fast"`
1830 * `"interacted_too_far"`
1831 * `"finished_unknown_dig"`
1834 * `minetest.register_on_chat_message(func(name, message))`
1835 * Called always when a player says something
1836 * Return `true` to mark the message as handled, which means that it will not be sent to other players
1837 * `minetest.register_on_player_receive_fields(func(player, formname, fields))`
1838 * Called when a button is pressed in player's inventory form
1839 * Newest functions are called first
1840 * If function returns `true`, remaining functions are not called
1841 * `minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))`
1842 * Called when `player` crafts something
1843 * `itemstack` is the output
1844 * `old_craft_grid` contains the recipe (Note: the one in the inventory is cleared)
1845 * `craft_inv` is the inventory with the crafting grid
1846 * Return either an `ItemStack`, to replace the output, or `nil`, to not modify it
1847 * `minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))`
1848 * The same as before, except that it is called before the player crafts, to make
1849 craft prediction, and it should not change anything.
1850 * `minetest.register_on_protection_violation(func(pos, name))`
1851 * Called by `builtin` and mods when a player violates protection at a position
1852 (eg, digs a node or punches a protected entity).
1853 * The registered functions can be called using `minetest.record_protection_violation`
1854 * The provided function should check that the position is protected by the mod
1855 calling this function before it prints a message, if it does, to allow for
1856 multiple protection mods.
1857 * `minetest.register_on_item_eat(func(hp_change, replace_with_item, itemstack, user, pointed_thing))`
1858 * Called when an item is eaten, by `minetest.item_eat`
1859 * Return `true` or `itemstack` to cancel the default item eat response (i.e.: hp increase)
1861 ### Other registration functions
1862 * `minetest.register_chatcommand(cmd, chatcommand definition)`
1863 * `minetest.register_privilege(name, definition)`
1864 * `definition`: `"description text"`
1865 * `definition`: `{ description = "description text", give_to_singleplayer = boolean, -- default: true }`
1866 * `minetest.register_authentication_handler(handler)`
1867 * See `minetest.builtin_auth_handler` in `builtin.lua` for reference
1870 * `minetest.setting_set(name, value)`
1871 * Setting names can't contain whitespace or any of `="{}#`.
1872 * Setting values can't contain the sequence `\n"""`.
1873 * Setting names starting with "secure." can't be set.
1874 * `minetest.setting_get(name)`: returns string or `nil`
1875 * `minetest.setting_setbool(name, value)`
1876 * See documentation on `setting_set` for restrictions.
1877 * `minetest.setting_getbool(name)`: returns boolean or `nil`
1878 * `minetest.setting_get_pos(name)`: returns position or nil
1879 * `minetest.setting_save()`, returns `nil`, save all settings to config file
1882 * `minetest.notify_authentication_modified(name)`
1883 * Should be called by the authentication handler if privileges changes.
1884 * To report everybody, set `name=nil`.
1885 * `minetest.get_password_hash(name, raw_password)`
1886 * Convert a name-password pair to a password hash that Minetest can use
1887 * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
1888 * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
1889 * Convert between two privilege representations
1890 * `minetest.set_player_password(name, password_hash)`
1891 * `minetest.set_player_privs(name, {priv1=true,...})`
1892 * `minetest.get_player_privs(name) -> {priv1=true,...}`
1893 * `minetest.auth_reload()`
1894 * `minetest.check_player_privs(name, {priv1=true,...})`: returns `bool, missing_privs`
1895 * A quickhand for checking privileges
1896 * `minetest.get_player_ip(name)`: returns an IP address string
1898 `minetest.set_player_password`, `minetest_set_player_privs`, `minetest_get_player_privs`
1899 and `minetest.auth_reload` call the authetification handler.
1902 * `minetest.chat_send_all(text)`
1903 * `minetest.chat_send_player(name, text)`
1905 ### Environment access
1906 * `minetest.set_node(pos, node)`
1907 * `minetest.add_node(pos, node): alias set_node(pos, node)`
1908 * Set node at position (`node = {name="foo", param1=0, param2=0}`)
1909 * `minetest.swap_node(pos, node`
1910 * Set node at position, but don't remove metadata
1911 * `minetest.remove_node(pos)`
1912 * Equivalent to `set_node(pos, "air")`
1913 * `minetest.get_node(pos)`
1914 * Returns `{name="ignore", ...}` for unloaded area
1915 * `minetest.get_node_or_nil(pos)`
1916 * Returns `nil` for unloaded area
1917 * `minetest.get_node_light(pos, timeofday)` returns a number between `0` and `15` or `nil`
1918 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
1920 * `minetest.place_node(pos, node)`
1921 * Place node with the same effects that a player would cause
1922 * `minetest.dig_node(pos)`
1923 * Dig node with the same effects that a player would cause
1924 * Returns `true` if successful, `false` on failure (e.g. protected location)
1925 * `minetest.punch_node(pos)`
1926 * Punch node with the same effects that a player would cause
1928 * `minetest.find_nodes_with_meta(pos1, pos2)`
1929 * Get a table of positions of nodes that have metadata within a region {pos1, pos2}
1930 * `minetest.get_meta(pos)`
1931 * Get a `NodeMetaRef` at that position
1932 * `minetest.get_node_timer(pos)`
1933 * Get `NodeTimerRef`
1935 * `minetest.add_entity(pos, name)`: Spawn Lua-defined entity at position
1936 * Returns `ObjectRef`, or `nil` if failed
1937 * `minetest.add_item(pos, item)`: Spawn item
1938 * Returns `ObjectRef`, or `nil` if failed
1939 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
1940 * `minetest.get_objects_inside_radius(pos, radius)`
1941 * `minetest.set_timeofday(val)`
1942 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
1943 * `minetest.get_timeofday()`
1944 * `minetest.get_gametime()`: returns the time, in seconds, since the world was created
1945 * `minetest.find_node_near(pos, radius, nodenames)`: returns pos or `nil`
1946 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
1947 * `minetest.find_nodes_in_area(minp, maxp, nodenames)`: returns a list of positions
1948 * returns as second value a table with the count of the individual nodes found
1949 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
1950 * `minetest.find_nodes_in_area_under_air(minp, maxp, nodenames)`: returns a list of positions
1951 * returned positions are nodes with a node air above
1952 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
1953 * `minetest.get_perlin(noiseparams)`
1954 * `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
1955 * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
1956 * `minetest.get_voxel_manip([pos1, pos2])`
1957 * Return voxel manipulator object.
1958 * Loads the manipulator from the map if positions are passed.
1959 * `minetest.set_gen_notify(flags, {deco_ids})`
1960 * Set the types of on-generate notifications that should be collected
1961 * `flags` is a flag field with the available flags: `dungeon`, `temple`, `cave_begin`,
1962 `cave_end`, `large_cave_begin`, `large_cave_end`, `decoration`
1963 * The second parameter is a list of IDS of decorations which notification is requested for
1964 * `get_gen_notify()`: returns a flagstring and a table with the deco_ids
1965 * `minetest.get_mapgen_object(objectname)`
1966 * Return requested mapgen object if available (see "Mapgen objects")
1967 * `minetest.get_mapgen_params()` Returns mapgen parameters, a table containing
1968 `mgname`, `seed`, `chunksize`, `water_level`, and `flags`.
1969 * `minetest.set_mapgen_params(MapgenParams)`
1970 * Set map generation parameters
1971 * Function cannot be called after the registration period; only initialization
1972 and `on_mapgen_init`
1973 * Takes a table as an argument with the fields `mgname`, `seed`, `water_level`,
1975 * Leave field unset to leave that parameter unchanged
1976 * `flags` contains a comma-delimited string of flags to set,
1977 or if the prefix `"no"` is attached, clears instead.
1978 * `flags` is in the same format and has the same options as `mg_flags` in `minetest.conf`
1979 * `minetest.set_noiseparams(name, noiseparams, set_default)`
1980 * Sets the noiseparams setting of `name` to the noiseparams table specified in `noiseparams`.
1981 * `set_default` is an optional boolean (default: `true`) that specifies whether the setting
1982 should be applied to the default config or current active config
1983 * `minetest.get_noiseparams(name)`: returns a table of the noiseparams for name
1984 * `minetest.generate_ores(vm, pos1, pos2)`
1985 * Generate all registered ores within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
1986 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
1987 * `minetest.generate_decorations(vm, pos1, pos2)`
1988 * Generate all registered decorations within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
1989 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
1990 * `minetest.clear_objects()`
1991 * clear all objects in the environments
1992 * `minetest.delete_area(pos1, pos2)`
1993 * delete all mapblocks in the area from pos1 to pos2, inclusive
1994 * `minetest.line_of_sight(pos1, pos2, stepsize)`: returns `boolean, pos`
1995 * Check if there is a direct line of sight between `pos1` and `pos2`
1996 * Returns the position of the blocking node when `false`
1997 * `pos1`: First position
1998 * `pos2`: Second position
1999 * `stepsize`: smaller gives more accurate results but requires more computing
2000 time. Default is `1`.
2001 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
2002 * returns table containing path
2003 * returns a table of 3D points representing a path from `pos1` to `pos2` or `nil`
2004 * `pos1`: start position
2005 * `pos2`: end position
2006 * `searchdistance`: number of blocks to search in each direction
2007 * `max_jump`: maximum height difference to consider walkable
2008 * `max_drop`: maximum height difference to consider droppable
2009 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
2010 * `minetest.spawn_tree (pos, {treedef})`
2011 * spawns L-System tree at given `pos` with definition in `treedef` table
2012 * `minetest.transforming_liquid_add(pos)`
2013 * add node to liquid update queue
2014 * `minetest.get_node_max_level(pos)`
2015 * get max available level for leveled node
2016 * `minetest.get_node_level(pos)`
2017 * get level of leveled node (water, snow)
2018 * `minetest.set_node_level(pos, level)`
2019 * set level of leveled node, default `level` equals `1`
2020 * if `totallevel > maxlevel`, returns rest (`total-max`).
2021 * `minetest.add_node_level(pos, level)`
2022 * increase level of leveled node by level, default `level` equals `1`
2023 * if `totallevel > maxlevel`, returns rest (`total-max`)
2024 * can be negative for decreasing
2027 `minetest.get_inventory(location)`: returns an `InvRef`
2030 * `{type="player", name="celeron55"}`
2031 * `{type="node", pos={x=, y=, z=}}`
2032 * `{type="detached", name="creative"}`
2033 * `minetest.create_detached_inventory(name, callbacks)`: returns an `InvRef`
2034 * callbacks: See "Detached inventory callbacks"
2035 * Creates a detached inventory. If it already exists, it is cleared.
2036 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
2037 returns left over ItemStack
2038 * See `minetest.item_eat` and `minetest.register_on_item_eat`
2041 * `minetest.show_formspec(playername, formname, formspec)`
2042 * `playername`: name of player to show formspec
2043 * `formname`: name passed to `on_player_receive_fields` callbacks.
2044 It should follow the `"modname:<whatever>"` naming convention
2045 * `formspec`: formspec to display
2046 * `minetest.formspec_escape(string)`: returns a string
2047 * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
2048 * `minetest.explode_table_event(string)`: returns a table
2049 * returns e.g. `{type="CHG", row=1, column=2}`
2051 * `"INV"`: no row selected)
2052 * `"CHG"`: selected)
2053 * `"DCL"`: double-click
2054 * `minetest.explode_textlist_event(string)`: returns a table
2055 * returns e.g. `{type="CHG", index=1}`
2057 * `"INV"`: no row selected)
2058 * `"CHG"`: selected)
2059 * `"DCL"`: double-click
2060 * `minetest.explode_scrollbar_event(string)`: returns a table
2061 * returns e.g. `{type="CHG", value=500}`
2063 * `"INV"`: something failed
2064 * `"CHG"`: has been changed
2065 * `"VAL"`: not changed
2068 * `minetest.inventorycube(img1, img2, img3)`
2069 * Returns a string for making an image of a cube (useful as an item image)
2070 * `minetest.get_pointed_thing_position(pointed_thing, above)`
2071 * Get position of a `pointed_thing` (that you can get from somewhere)
2072 * `minetest.dir_to_facedir(dir, is6d)`
2073 * Convert a vector to a facedir value, used in `param2` for `paramtype2="facedir"`;
2074 * passing something non-`nil`/`false` for the optional second parameter causes it to
2075 take the y component into account
2076 * `minetest.facedir_to_dir(facedir)`
2077 * Convert a facedir back into a vector aimed directly out the "back" of a node
2078 * `minetest.dir_to_wallmounted(dir)`
2079 * Convert a vector to a wallmounted value, used for `paramtype2="wallmounted"`
2080 * `minetest.get_node_drops(nodename, toolname)`
2081 * Returns list of item names.
2082 * **Note**: This will be removed or modified in a future version.
2083 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
2084 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2085 * `input.width` = for example `3`
2086 * `input.items` = for example
2087 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2088 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
2089 * `output.time` = a number, if unsuccessful: `0`
2090 * `output.replacements` = list of `ItemStack`s that couldn't be placed in
2091 `decremented_input.items`
2092 * `decremented_input` = like `input`
2093 * `minetest.get_craft_recipe(output)`: returns input
2094 * returns last registered recipe for output item (node)
2095 * `output` is a node or item type such as `"default:torch"`
2096 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
2097 * `input.width` = for example `3`
2098 * `input.items` = for example
2099 `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
2100 * `input.items` = `nil` if no recipe found
2101 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
2102 * returns indexed table with all registered recipes for query item (node)
2103 or `nil` if no recipe was found
2104 * recipe entry table:
2106 method = 'normal' or 'cooking' or 'fuel'
2107 width = 0-3, 0 means shapeless recipe
2108 items = indexed [1-9] table with recipe items
2109 output = string with item name and quantity
2111 * Example query for `"default:gold_ingot"` will return table:
2113 [1]={type = "cooking", width = 3, output = "default:gold_ingot",
2114 items = {1 = "default:gold_lump"}},
2115 [2]={type = "normal", width = 1, output = "default:gold_ingot 9",
2116 items = {1 = "default:goldblock"}}
2118 * `minetest.handle_node_drops(pos, drops, digger)`
2119 * `drops`: list of itemstrings
2120 * Handles drops from nodes after digging: Default action is to put them into
2122 * Can be overridden to get different functionality (e.g. dropping items on
2126 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
2127 returns `{{actor, pos, time, oldnode, newnode}, ...}`
2128 * Find who has done something to a node, or near a node
2129 * `actor`: `"player:<name>"`, also `"liquid"`.
2130 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns `boolean, log_messages`
2131 * Revert latest actions of someone
2132 * `actor`: `"player:<name>"`, also `"liquid"`.
2134 ### Defaults for the `on_*` item definition functions
2135 These functions return the leftover itemstack.
2137 * `minetest.item_place_node(itemstack, placer, pointed_thing, param2)`
2138 * Place item as a node
2139 * `param2` overrides `facedir` and wallmounted `param2`
2140 * returns `itemstack, success`
2141 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
2143 * `minetest.item_place(itemstack, placer, pointed_thing, param2)`
2144 * Use one of the above based on what the item is.
2145 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
2146 * **Note**: is not called when wielded item overrides `on_place`
2147 * `param2` overrides `facedir` and wallmounted `param2`
2148 * returns `itemstack, success`
2149 * `minetest.item_drop(itemstack, dropper, pos)`
2151 * `minetest.item_eat(hp_change, replace_with_item)`
2153 * `replace_with_item` is the itemstring which is added to the inventory.
2154 If the player is eating a stack, then replace_with_item goes to a
2155 different spot. Can be `nil`
2156 * See `minetest.do_item_eat`
2158 ### Defaults for the `on_punch` and `on_dig` node definition callbacks
2159 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
2160 * Calls functions registered by `minetest.register_on_punchnode()`
2161 * `minetest.node_dig(pos, node, digger)`
2162 * Checks if node can be dug, puts item into inventory, removes node
2163 * Calls functions registered by `minetest.registered_on_dignodes()`
2166 * `minetest.sound_play(spec, parameters)`: returns a handle
2167 * `spec` is a `SimpleSoundSpec`
2168 * `parameters` is a sound parameter table
2169 * `minetest.sound_stop(handle)`
2172 * `minetest.after(time, func, ...)`
2173 * Call the function `func` after `time` seconds
2174 * Optional: Variable number of arguments that are passed to `func`
2177 * `minetest.request_shutdown([message],[reconnect])`: request for server shutdown. Will display `message` to clients,
2178 and `reconnect` == true displays a reconnect button.
2179 * `minetest.get_server_status()`: returns server status string
2182 * `minetest.get_ban_list()`: returns the ban list (same as `minetest.get_ban_description("")`)
2183 * `minetest.get_ban_description(ip_or_name)`: returns ban description (string)
2184 * `minetest.ban_player(name)`: ban a player
2185 * `minetest.unban_player_or_ip(name)`: unban player or IP address
2186 * `minetest.kick_player(name, [reason])`: disconnect a player with a optional reason
2189 * `minetest.add_particle(particle definition)`
2190 * Deprecated: `minetest.add_particle(pos, velocity, acceleration, expirationtime,
2191 size, collisiondetection, texture, playername)`
2193 * `minetest.add_particlespawner(particlespawner definition)`
2194 * Add a `ParticleSpawner`, an object that spawns an amount of particles over `time` seconds
2195 * Returns an `id`, and -1 if adding didn't succeed
2196 * `Deprecated: minetest.add_particlespawner(amount, time,
2200 minexptime, maxexptime,
2202 collisiondetection, texture, playername)`
2204 * `minetest.delete_particlespawner(id, player)``
2205 * Delete `ParticleSpawner` with `id` (return value from `minetest.add_particlespawner`)
2206 * If playername is specified, only deletes on the player's client,
2207 * otherwise on all clients
2210 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
2211 * Create a schematic from the volume of map specified by the box formed by p1 and p2.
2212 * Apply the specified probability values to the specified nodes in `probability_list`.
2213 * `probability_list` is an array of tables containing two fields, `pos` and `prob`.
2214 * `pos` is the 3D vector specifying the absolute coordinates of the
2215 node being modified,
2216 * `prob` is the integer value from `0` to `255` of the probability (see: Schematic specifier).
2217 * If there are two or more entries with the same pos value, the
2219 * If `pos` is not inside the box formed by `p1` and `p2`, it is ignored.
2220 * If `probability_list` equals `nil`, no probabilities are applied.
2221 * Slice probability works in the same manner, except takes a field
2222 called `ypos` instead which
2223 indicates the y position of the slice with a probability applied.
2224 * If slice probability list equals `nil`, no slice probabilities are applied.
2225 * Saves schematic in the Minetest Schematic format to filename.
2227 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement)`
2228 * Place the schematic specified by schematic (see: Schematic specifier) at `pos`.
2229 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
2230 * If the `rotation` parameter is omitted, the schematic is not rotated.
2231 * `replacements` = `{["old_name"] = "convert_to", ...}`
2232 * `force_placement` is a boolean indicating whether nodes other than `air` and
2233 `ignore` are replaced by the schematic
2235 * `minetest.serialize_schematic(schematic, format, options)`
2236 * Return the serialized schematic specified by schematic (see: Schematic specifier)
2237 * in the `format` of either "mts" or "lua".
2238 * "mts" - a string containing the binary MTS data used in the MTS file format
2239 * "lua" - a string containing Lua code representing the schematic in table format
2240 * `options` is a table containing the following optional parameters:
2241 * If `lua_use_comments` is true and `format` is "lua", the Lua code generated will have (X, Z)
2242 * position comments for every X row generated in the schematic data for easier reading.
2243 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua", the Lua code generated
2244 * will use that number of spaces as indentation instead of a tab character.
2247 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
2248 * `minetest.hash_node_position({x=,y=,z=})`: returns an 48-bit integer
2249 * Gives a unique hash number for a node position (16+16+16=48bit)
2250 * `minetest.get_position_from_hash(hash)`: returns a position
2251 * Inverse transform of `minetest.hash_node_position`
2252 * `minetest.get_item_group(name, group)`: returns a rating
2253 * Get rating of a group of an item. (`0` means: not in group)
2254 * `minetest.get_node_group(name, group)`: returns a rating
2255 * Deprecated: An alias for the former.
2256 * `minetest.raillike_group(name)`: returns a rating
2257 * Returns rating of the connect_to_raillike group corresponding to name
2258 * If name is not yet the name of a connect_to_raillike group, a new group id
2259 * is created, with that name
2260 * `minetest.get_content_id(name)`: returns an integer
2261 * Gets the internal content ID of `name`
2262 * `minetest.get_name_from_content_id(content_id)`: returns a string
2263 * Gets the name of the content with that content ID
2264 * `minetest.parse_json(string[, nullvalue])`: returns something
2265 * Convert a string containing JSON data into the Lua equivalent
2266 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
2267 * On success returns a table, a string, a number, a boolean or `nullvalue`
2268 * On failure outputs an error message and returns `nil`
2269 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
2270 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
2271 * Convert a Lua table into a JSON string
2272 * styled: Outputs in a human-readable format if this is set, defaults to false
2273 * Unserializable things like functions and userdata are saved as null.
2274 * **Warning**: JSON is more strict than the Lua table format.
2275 1. You can only use strings and positive integers of at least one as keys.
2276 2. You can not mix string and integer keys.
2277 This is due to the fact that JSON has two distinct array and object values.
2278 * Example: `write_json({10, {a = false}})`, returns `"[10, {\"a\": false}]"`
2279 * `minetest.serialize(table)`: returns a string
2280 * Convert a table containing tables, strings, numbers, booleans and `nil`s
2281 into string form readable by `minetest.deserialize`
2282 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
2283 * `minetest.deserialize(string)`: returns a table
2284 * Convert a string returned by `minetest.deserialize` into a table
2285 * `string` is loaded in an empty sandbox environment.
2286 * Will load functions, but they cannot access the global environment.
2287 * Example: `deserialize('return { ["foo"] = "bar" }')`, returns `{foo='bar'}`
2288 * Example: `deserialize('print("foo")')`, returns `nil` (function call fails)
2289 * `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
2290 * `minetest.compress(data, method, ...)`: returns `compressed_data`
2291 * Compress a string of data.
2292 * `method` is a string identifying the compression method to be used.
2293 * Supported compression methods:
2294 * Deflate (zlib): `"deflate"`
2295 * `...` indicates method-specific arguments. Currently defined arguments are:
2296 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
2297 * `minetest.decompress(compressed_data, method, ...)`: returns data
2298 * Decompress a string of data (using ZLib).
2299 * See documentation on `minetest.compress()` for supported compression methods.
2300 * currently supported.
2301 * `...` indicates method-specific arguments. Currently, no methods use this.
2302 * `minetest.is_protected(pos, name)`: returns boolean
2303 * Returns true, if player `name` shouldn't be abled to dig at `pos` or do other
2304 actions, defineable by mods, due to some mod-defined ownership-like concept.
2305 Returns false or nil, if the player is allowed to do such actions.
2306 * This function should be overridden by protection mods and should be used to
2307 check if a player can interact at a position.
2308 * This function should call the old version of itself if the position is not
2309 protected by the mod.
2312 local old_is_protected = minetest.is_protected
2313 function minetest.is_protected(pos, name)
2314 if mymod:position_protected_from(pos, name) then
2317 return old_is_protected(pos, name)
2319 * `minetest.record_protection_violation(pos, name)`
2320 * This function calls functions registered with
2321 `minetest.register_on_protection_violation`.
2322 * `minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)`
2323 * Attempt to predict the desired orientation of the facedir-capable node
2324 defined by `itemstack`, and place it accordingly (on-wall, on the floor, or
2325 hanging from the ceiling). Stacks are handled normally if the `infinitestacks`
2326 field is false or omitted (else, the itemstack is not changed). `orient_flags`
2327 is an optional table containing extra tweaks to the placement code:
2328 * `invert_wall`: if `true`, place wall-orientation on the ground and ground-
2329 orientation on the wall.
2330 * `force_wall` : if `true`, always place the node in wall orientation.
2331 * `force_ceiling`: if `true`, always place on the ceiling.
2332 * `force_floor`: if `true`, always place the node on the floor.
2333 * `force_facedir`: if `true`, forcefully reset the facedir to north when placing on
2334 the floor or ceiling
2335 * The first four options are mutually-exclusive; the last in the list takes
2336 precedence over the first.
2337 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
2338 * calls `rotate_and_place()` with infinitestacks set according to the state of
2339 the creative mode setting, and checks for "sneak" to set the `invert_wall`
2342 * `minetest.forceload_block(pos)`
2343 * forceloads the position `pos`.
2344 * returns `true` if area could be forceloaded
2345 * Please note that forceloaded areas are saved when the server restarts.
2347 * `minetest.forceload_free_block(pos)`
2348 * stops forceloading the position `pos`
2350 * `minetest.request_insecure_environment()`: returns an environment containing
2351 insecure functions if the calling mod has been listed as trusted in the
2352 `secure.trusted_mods` setting or security is disabled, otherwise returns `nil`.
2353 * Only works at init time.
2354 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE IT IN
2357 * `minetest.global_exists(name)`
2358 * Checks if a global variable has been set, without triggering a warning.
2361 * `minetest.env`: `EnvRef` of the server environment and world.
2362 * Any function in the minetest namespace can be called using the syntax
2363 `minetest.env:somefunction(somearguments)`
2364 instead of `minetest.somefunction(somearguments)`
2365 * Deprecated, but support is not to be dropped soon
2368 * `minetest.registered_items`
2369 * Map of registered items, indexed by name
2370 * `minetest.registered_nodes`
2371 * Map of registered node definitions, indexed by name
2372 * `minetest.registered_craftitems`
2373 * Map of registered craft item definitions, indexed by name
2374 * `minetest.registered_tools`
2375 * Map of registered tool definitions, indexed by name
2376 * `minetest.registered_entities`
2377 * Map of registered entity prototypes, indexed by name
2378 * `minetest.object_refs`
2379 * Map of object references, indexed by active object id
2380 * `minetest.luaentities`
2381 * Map of Lua entities, indexed by active object id
2382 * `minetest.registered_ores`
2383 * List of registered ore definitions.
2384 * `minetest.registered_decorations`
2385 * List of registered decoration definitions.
2391 Node metadata: reference extra data and functionality stored in a node.
2392 Can be gotten via `minetest.get_meta(pos)`.
2395 * `set_string(name, value)`
2396 * `get_string(name)`
2397 * `set_int(name, value)`
2399 * `set_float(name, value)`
2401 * `get_inventory()`: returns `InvRef`
2402 * `to_table()`: returns `nil` or `{fields = {...}, inventory = {list1 = {}, ...}}`
2403 * `from_table(nil or {})`
2404 * See "Node Metadata"
2407 Node Timers: a high resolution persistent per-node timer.
2408 Can be gotten via `minetest.get_node_timer(pos)`.
2411 * `set(timeout,elapsed)`
2412 * set a timer's state
2413 * `timeout` is in seconds, and supports fractional values (0.1 etc)
2414 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
2415 * will trigger the node's `on_timer` function after `timeout`-elapsed seconds
2418 * equivalent to `set(timeout,0)`
2421 * `get_timeout()`: returns current timeout in seconds
2422 * if `timeout` equals `0`, timer is inactive
2423 * `get_elapsed()`: returns current elapsed time in seconds
2424 * the node's `on_timer` function will be called after `timeout`-elapsed seconds
2425 * `is_started()`: returns boolean state of timer
2426 * returns `true` if timer is started, otherwise `false`
2429 Moving things in the game are generally these.
2431 This is basically a reference to a C++ `ServerActiveObject`
2434 * `remove()`: remove object (after returning from Lua)
2435 * Note: Doesn't work on players, use minetest.kick_player instead
2436 * `getpos()`: returns `{x=num, y=num, z=num}`
2437 * `setpos(pos)`; `pos`=`{x=num, y=num, z=num}`
2438 * `moveto(pos, continuous=false)`: interpolated move
2439 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
2440 * `puncher` = another `ObjectRef`,
2441 * `time_from_last_punch` = time since last punch action of the puncher
2442 * `direction`: can be `nil`
2443 * `right_click(clicker)`; `clicker` is another `ObjectRef`
2444 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
2445 * `set_hp(hp)`: set number of hitpoints (2 * number of hearts)
2446 * `get_inventory()`: returns an `InvRef`
2447 * `get_wield_list()`: returns the name of the inventory list the wielded item is in
2448 * `get_wield_index()`: returns the index of the wielded item
2449 * `get_wielded_item()`: returns an `ItemStack`
2450 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if successful
2451 * `set_armor_groups({group1=rating, group2=rating, ...})`
2452 * `get_armor_groups()`: returns a table with the armor group ratings
2453 * `set_animation({x=1,y=1}, frame_speed=15, frame_blend=0, frame_loop=true)`
2454 * `get_animation()`: returns range, frame_speed, frame_blend and frame_loop
2455 * `set_attach(parent, bone, position, rotation)`
2457 * `position`: `{x=num, y=num, z=num}` (relative)
2458 * `rotation`: `{x=num, y=num, z=num}`
2459 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't attached
2461 * `set_bone_position(bone, position, rotation)`
2463 * `position`: `{x=num, y=num, z=num}` (relative)
2464 * `rotation`: `{x=num, y=num, z=num}`
2465 * `get_bone_position(bone)`: returns position and rotation of the bone
2466 * `set_properties(object property table)`
2467 * `get_properties()`: returns object property table
2468 * `is_player()`: returns true for players, false otherwise
2470 ##### LuaEntitySAO-only (no-op for other objects)
2471 * `setvelocity({x=num, y=num, z=num})`
2472 * `getvelocity()`: returns `{x=num, y=num, z=num}`
2473 * `setacceleration({x=num, y=num, z=num})`
2474 * `getacceleration()`: returns `{x=num, y=num, z=num}`
2476 * `getyaw()`: returns number in radians
2477 * `settexturemod(mod)`
2478 * `setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
2479 select_horiz_by_yawpitch=false)`
2480 * Select sprite from spritesheet with optional animation and DM-style
2481 texture selection based on yaw relative to camera
2482 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
2485 ##### Player-only (no-op for other objects)
2486 * `get_player_name()`: returns `""` if is not a player
2487 * `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
2488 * `get_look_dir()`: get camera direction as a unit vector
2489 * `get_look_pitch()`: pitch in radians
2490 * `get_look_yaw()`: yaw in radians (wraps around pretty randomly as of now)
2491 * `set_look_pitch(radians)`: sets look pitch
2492 * `set_look_yaw(radians)`: sets look yaw
2493 * `get_breath()`: returns players breath
2494 * `set_breath(value)`: sets players breath
2496 * `0`: player is drowning,
2497 * `1`-`10`: remaining number of bubbles
2498 * `11`: bubbles bar is not shown
2499 * `set_inventory_formspec(formspec)`
2500 * Redefine player's inventory form
2501 * Should usually be called in on_joinplayer
2502 * `get_inventory_formspec()`: returns a formspec string
2503 * `get_player_control()`: returns table with player pressed keys
2504 * `{jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}`
2505 * `get_player_control_bits()`: returns integer with bit packed player pressed keys
2506 * bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
2507 * `set_physics_override(override_table)`
2508 * `override_table` is a table with the following fields:
2509 * `speed`: multiplier to default walking speed value (default: `1`)
2510 * `jump`: multiplier to default jump value (default: `1`)
2511 * `gravity`: multiplier to default gravity value (default: `1`)
2512 * `sneak`: whether player can sneak (default: `true`)
2513 * `sneak_glitch`: whether player can use the sneak glitch (default: `true`)
2514 * `get_physics_override()`: returns the table given to set_physics_override
2515 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
2517 * `hud_remove(id)`: remove the HUD element of the specified id
2518 * `hud_change(id, stat, value)`: change a value of a previously added HUD element
2519 * element `stat` values: `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
2520 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
2521 * `hud_set_flags(flags)`: sets specified HUD flags to `true`/`false`
2522 * `flags`: (is visible) `hotbar`, `healthbar`, `crosshair`, `wielditem`
2523 * pass a table containing a `true`/`false` value of each flag to be set or unset
2524 * if a flag equals `nil`, the flag is not modified
2525 * `hud_get_flags()`: returns a table containing status of hud flags
2526 * returns `{ hotbar=true, healthbar=true, crosshair=true, wielditem=true, breathbar=true }`
2527 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
2528 * `count`: number of items, must be between `1` and `23`
2529 * `hud_get_hotbar_itemcount`: returns number of visible items
2530 * `hud_set_hotbar_image(texturename)`
2531 * sets background image for hotbar
2532 * `hud_get_hotbar_image`: returns texturename
2533 * `hud_set_hotbar_selected_image(texturename)`
2534 * sets image for selected item of hotbar
2535 * `hud_get_hotbar_selected_image`: returns texturename
2536 * `hud_replace_builtin(name, hud_definition)`
2537 * replace definition of a builtin hud element
2538 * `name`: `"breath"` or `"health"`
2539 * `hud_definition`: definition to replace builtin definition
2540 * `set_sky(bgcolor, type, {texture names})`
2541 * `bgcolor`: ColorSpec, defaults to white
2543 * `"regular"`: Uses 0 textures, `bgcolor` ignored
2544 * `"skybox"`: Uses 6 textures, `bgcolor` used
2545 * `"plain"`: Uses 0 textures, `bgcolor` used
2546 * **Note**: currently does not work directly in `on_joinplayer`; use
2547 `minetest.after(0)` in there.
2548 * `get_sky()`: returns bgcolor, type and a table with the textures
2549 * `override_day_night_ratio(ratio or nil)`
2550 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific amount
2551 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
2552 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
2553 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`
2555 set animation for player model in third person view
2557 set_local_animation({x=0, y=79}, -- < stand/idle animation key frames
2558 {x=168, y=187}, -- < walk animation key frames
2559 {x=189, y=198}, -- < dig animation key frames
2560 {x=200, y=219}, -- < walk+dig animation key frames
2561 frame_speed=30): -- < animation frame speed
2562 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and frame_speed
2563 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for camera per player
2564 * in first person view
2565 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
2566 * `get_eye_offset()`: returns offset_first and offset_third
2567 * `get_nametag_attributes()`
2568 * returns a table with the attributes of the nametag of the player
2570 color = {a=0..255, r=0..255, g=0..255, b=0..255},
2572 * `set_nametag_attributes(attributes)`
2573 * sets the attributes of the nametag of the player
2580 An `InvRef` is a reference to an inventory.
2583 * `is_empty(listname)`: return `true` if list is empty
2584 * `get_size(listname)`: get size of a list
2585 * `set_size(listname, size)`: set size of a list
2586 * returns `false` on error (e.g. invalid `listname` or `size`)
2587 * `get_width(listname)`: get width of a list
2588 * `set_width(listname, width)`: set width of list; currently used for crafting
2589 * `get_stack(listname, i)`: get a copy of stack index `i` in list
2590 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
2591 * `get_list(listname)`: return full list
2592 * `set_list(listname, list)`: set full list (size will not change)
2593 * `get_lists()`: returns list of inventory lists
2594 * `set_lists(lists)`: sets inventory lists (size will not change)
2595 * `add_item(listname, stack)`: add item somewhere in list, returns leftover `ItemStack`
2596 * `room_for_item(listname, stack):` returns `true` if the stack of items
2597 can be fully added to the list
2598 * `contains_item(listname, stack)`: returns `true` if the stack of items
2599 can be fully taken from the list
2600 * `remove_item(listname, stack)`: take as many items as specified from the list,
2601 returns the items that were actually removed (as an `ItemStack`) -- note that
2602 any item metadata is ignored, so attempting to remove a specific unique
2603 item this way will likely remove the wrong one -- to do that use `set_stack`
2604 with an empty `ItemStack`
2605 * `get_location()`: returns a location compatible to `minetest.get_inventory(location)`
2606 * returns `{type="undefined"}` in case location is not known
2609 A fast access data structure to store areas, and find areas near a given position or area.
2610 Every area has a `data` string attribute to store additional information.
2611 You can create an empty `AreaStore` by calling `AreaStore()`, or `AreaStore(type_name)`.
2612 If you chose the parameter-less constructor, a fast implementation will be automatically chosen for you.
2615 * `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.
2616 * `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.
2617 * `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.
2618 * `insert_area(edge1, edge2, data)`: inserts an area into the store. Returns the id if successful, nil otherwise. The (inclusive) positions `edge1` and `edge2` describe the area, `data`
2619 is a string stored with the area.
2620 * `reserve(count)`: reserves resources for at most `count` many contained areas. Only needed for efficiency, and only some implementations profit.
2621 * `remove_area(id)`: removes the area with the given id from the store, returns success.
2622 * `set_cache_params(params)`: sets params for the included prefiltering cache. Calling invalidates the cache, so that its elements have to be newly generated.
2625 enabled = boolean, -- whether to enable, default true
2626 block_radius = number, -- the radius (in nodes) of the areas the cache generates prefiltered lists for, minimum 16, default 64
2627 limit = number, -- the cache's size, minimum 20, default 1000
2631 An `ItemStack` is a stack of items.
2633 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
2634 an itemstring, a table or `nil`.
2637 * `is_empty()`: Returns `true` if stack is empty.
2638 * `get_name()`: Returns item name (e.g. `"default:stone"`).
2639 * `set_name(item_name)`: Returns boolean success.
2640 Clears item on failure.
2641 * `get_count()`: Returns number of items on the stack.
2642 * `set_count(count)`
2643 * `get_wear()`: Returns tool wear (`0`-`65535`), `0` for non-tools.
2644 * `set_wear(wear)`: Returns boolean success.
2645 Clears item on failure.
2646 * `get_metadata()`: Returns metadata (a string attached to an item stack).
2647 * `set_metadata(metadata)`: Returns true.
2648 * `clear()`: removes all items from the stack, making it empty.
2649 * `replace(item)`: replace the contents of this stack.
2650 * `item` can also be an itemstring or table.
2651 * `to_string()`: Returns the stack in itemstring form.
2652 * `to_table()`: Returns the stack in Lua table form.
2653 * `get_stack_max()`: Returns the maximum size of the stack (depends on the item).
2654 * `get_free_space()`: Returns `get_stack_max() - get_count()`.
2655 * `is_known()`: Returns `true` if the item name refers to a defined item type.
2656 * `get_definition()`: Returns the item definition table.
2657 * `get_tool_capabilities()`: Returns the digging properties of the item,
2658 or those of the hand if none are defined for this item type
2659 * `add_wear(amount)`: Increases wear by `amount` if the item is a tool.
2660 * `add_item(item)`: Put some item or stack onto this stack.
2661 Returns leftover `ItemStack`.
2662 * `item_fits(item)`: Returns `true` if item or stack can be fully added to
2664 * `take_item(n=1)`: Take (and remove) up to `n` items from this stack.
2665 Returns taken `ItemStack`.
2666 * `peek_item(n=1)`: copy (don't remove) up to `n` items from this stack.
2667 Returns taken `ItemStack`.
2670 A 16-bit pseudorandom number generator.
2671 Uses a well-known LCG algorithm introduced by K&R.
2673 It can be created via `PseudoRandom(seed)`.
2676 * `next()`: return next integer random number [`0`...`32767`]
2677 * `next(min, max)`: return next integer random number [`min`...`max`]
2678 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
2679 due to the simple implementation making bad distribution otherwise.
2682 A 32-bit pseudorandom number generator.
2683 Uses PCG32, an algorithm of the permuted congruential generator family, offering very strong randomness.
2685 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
2688 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
2689 * `next(min, max)`: return next integer random number [`min`...`max`]
2690 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed random number [`min`...`max`]
2691 * This is only a rough approximation of a normal distribution with mean=(max-min)/2 and variance=1
2692 * Increasing num_trials improves accuracy of the approximation
2695 A perlin noise generator.
2696 It can be created via `PerlinNoise(seed, octaves, persistence, scale)`
2697 or `PerlinNoise(noiseparams)`.
2698 Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
2699 or `minetest.get_perlin(noiseparams)`.
2702 * `get2d(pos)`: returns 2D noise value at `pos={x=,y=}`
2703 * `get3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
2705 ### `PerlinNoiseMap`
2706 A fast, bulk perlin noise generator.
2708 It can be created via `PerlinNoiseMap(noiseparams, size)` or
2709 `minetest.get_perlin_map(noiseparams, size)`.
2711 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` conponent is ommitted
2712 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
2715 For each of the functions with an optional `buffer` parameter: If `buffer` is not
2716 nil, this table will be used to store the result instead of creating a new table.
2720 * `get2dMap(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
2721 with values starting at `pos={x=,y=}`
2722 * `get3dMap(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>` 3D array
2723 of 3D noise with values starting at `pos={x=,y=,z=}`
2724 * `get2dMap_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element array of 2D noise
2725 with values starting at `pos={x=,y=}`
2726 * `get3dMap_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
2727 * `calc2dMap(pos)`: Calculates the 2d noise map starting at `pos`. The result is stored internally.
2728 * `calc3dMap(pos)`: Calculates the 3d noise map starting at `pos`. The result is stored internally.
2729 * `getMapSlice(slice_offset, slice_size, buffer)`: In the form of an array, returns a slice of the
2730 most recently computed noise results. The result slice begins at coordinates `slice_offset` and
2731 takes a chunk of `slice_size`.
2732 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer offset y = 20:
2733 `noisevals = noise:getMapSlice({y=20}, {y=2})`
2734 It is important to note that `slice_offset` offset coordinates begin at 1, and are relative to
2735 the starting position of the most recently calculated noise.
2736 To grab a single vertical column of noise starting at map coordinates x = 1023, y=1000, z = 1000:
2737 `noise:calc3dMap({x=1000, y=1000, z=1000})`
2738 `noisevals = noise:getMapSlice({x=24, z=1}, {x=1, z=1})`
2741 An interface to the `MapVoxelManipulator` for Lua.
2743 It can be created via `VoxelManip()` or `minetest.get_voxel_manip()`.
2744 The map will be pre-loaded if two positions are passed to either.
2747 * `read_from_map(p1, p2)`: Reads a chunk of map from the map containing the
2748 region formed by `p1` and `p2`.
2749 * returns actual emerged `pmin`, actual emerged `pmax`
2750 * `write_to_map()`: Writes the data loaded from the `VoxelManip` back to the map.
2751 * **important**: data must be set using `VoxelManip:set_data` before calling this
2752 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
2753 the `VoxelManip` at that position
2754 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
2756 * `get_data(buffer)`: Gets the data read into the `VoxelManip` object
2757 * returns raw node data in the form of an array of node content IDs
2758 * if the param `buffer` is present, this table will be used to store the result instead
2759 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
2760 * `update_map()`: Update map after writing chunk back to map.
2761 * To be used only by `VoxelManip` objects created by the mod itself;
2762 not a `VoxelManip` that was retrieved from `minetest.get_mapgen_object`
2763 * `set_lighting(light, p1, p2)`: Set the lighting within the `VoxelManip` to a uniform value
2764 * `light` is a table, `{day=<0...15>, night=<0...15>}`
2765 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
2766 * (`p1`, `p2`) is the area in which lighting is set;
2767 defaults to the whole area if left out
2768 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
2769 * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
2770 * Each value is the bitwise combination of day and night light values (`0` to `15` each)
2771 * `light = day + (night * 16)`
2772 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
2774 * expects lighting data in the same format that `get_light_data()` returns
2775 * `get_param2_data()`: Gets the raw `param2` data read into the `VoxelManip` object
2776 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in the `VoxelManip`
2777 * `calc_lighting(p1, p2)`: Calculate lighting within the `VoxelManip`
2778 * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
2779 * (`p1`, `p2`) is the area in which lighting is set; defaults to the whole area
2781 * `update_liquids()`: Update liquid flow
2782 * `was_modified()`: Returns `true` or `false` if the data in the voxel manipulator
2783 had been modified since the last read from map, due to a call to
2784 `minetest.set_data()` on the loaded area elsewhere
2785 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
2788 A helper class for voxel areas.
2789 It can be created via `VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}`.
2790 The coordinates are *inclusive*, like most other things in Minetest.
2793 * `getExtent()`: returns a 3D vector containing the size of the area formed by
2794 `MinEdge` and `MaxEdge`
2795 * `getVolume()`: returns the volume of the area formed by `MinEdge` and `MaxEdge`
2796 * `index(x, y, z)`: returns the index of an absolute position in a flat array starting at `1`
2797 * useful for things like `VoxelManip`, raw Schematic specifiers,
2798 `PerlinNoiseMap:get2d`/`3dMap`, and so on
2799 * `indexp(p)`: same as above, except takes a vector
2800 * `position(i)`: returns the absolute position vector corresponding to index `i`
2801 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by `MinEdge` and `MaxEdge`
2802 * `containsp(p)`: same as above, except takes a vector
2803 * `containsi(i)`: same as above, except takes an index `i`
2804 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns indices
2805 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of `[z [y [x]]]`
2806 * `iterp(minp, maxp)`: same as above, except takes a vector
2809 An interface to read config files in the format of `minetest.conf`.
2811 It can be created via `Settings(filename)`.
2814 * `get(key)`: returns a value
2815 * `get_bool(key)`: returns a boolean
2817 * `remove(key)`: returns a boolean (`true` for success)
2818 * `get_names()`: returns `{key1,...}`
2819 * `write()`: returns a boolean (`true` for success)
2820 * write changes to file
2821 * `to_table()`: returns `{[key1]=value1,...}`
2825 A mapgen object is a construct used in map generation. Mapgen objects can be used
2826 by an `on_generate` callback to speed up operations by avoiding unnecessary
2827 recalculations; these can be retrieved using the `minetest.get_mapgen_object()`
2828 function. If the requested Mapgen object is unavailable, or `get_mapgen_object()`
2829 was called outside of an `on_generate()` callback, `nil` is returned.
2831 The following Mapgen objects are currently available:
2834 This returns three values; the `VoxelManip` object to be used, minimum and maximum
2835 emerged position, in that order. All mapgens support this object.
2838 Returns an array containing the y coordinates of the ground levels of nodes in
2839 the most recently generated chunk by the current mapgen.
2842 Returns an array containing the biome IDs of nodes in the most recently
2843 generated chunk by the current mapgen.
2846 Returns an array containing the temperature values of nodes in the most
2847 recently generated chunk by the current mapgen.
2850 Returns an array containing the humidity values of nodes in the most recently
2851 generated chunk by the current mapgen.
2854 Returns a table mapping requested generation notification types to arrays of
2855 positions at which the corresponding generated structures are located at within
2856 the current chunk. To set the capture of positions of interest to be recorded
2857 on generate, use `minetest.set_gen_notify()`.
2859 Possible fields of the table returned are:
2865 * `large_cave_begin`
2869 Decorations have a key in the format of `"decoration#id"`, where `id` is the
2870 numeric unique decoration ID.
2874 * Functions receive a "luaentity" as `self`:
2875 * It has the member `.name`, which is the registered name `("mod:thing")`
2876 * It has the member `.object`, which is an `ObjectRef` pointing to the object
2877 * The original prototype stuff is visible directly via a metatable
2879 * `on_activate(self, staticdata)`
2880 * Called when the object is instantiated.
2881 * `on_step(self, dtime)`
2882 * Called on every server tick, after movement and collision processing.
2883 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
2885 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir`
2886 * Called when somebody punches the object.
2887 * Note that you probably want to handle most punches using the
2888 automatic armor group system.
2889 * `puncher`: an `ObjectRef` (can be `nil`)
2890 * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be `nil`)
2891 * `tool_capabilities`: capability table of used tool (can be `nil`)
2892 * `dir`: unit vector of direction of punch. Always defined. Points from
2893 the puncher to the punched.
2894 * `on_rightclick(self, clicker)`
2895 * `get_staticdata(self)`
2896 * Should return a string that will be passed to `on_activate` when
2897 the object is instantiated the next time.
2905 axiom, --string initial tree axiom
2906 rules_a, --string rules set A
2907 rules_b, --string rules set B
2908 rules_c, --string rules set C
2909 rules_d, --string rules set D
2910 trunk, --string trunk node name
2911 leaves, --string leaves node name
2912 leaves2, --string secondary leaves node name
2913 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
2914 angle, --num angle in deg
2915 iterations, --num max # of iterations, usually 2 -5
2916 random_level, --num factor to lower nr of iterations, usually 0 - 3
2917 trunk_type, --string single/double/crossed) type of trunk: 1 node,
2918 -- 2x2 nodes or 3x3 in cross shape
2919 thin_branches, --boolean true -> use thin (1 node) branches
2920 fruit, --string fruit node name
2921 fruit_chance, --num chance (0-100) to replace leaves with fruit node
2922 seed, --num random seed; if no seed is provided, the engine will create one
2925 ### Key for Special L-System Symbols used in Axioms
2927 * `G`: move forward one unit with the pen up
2928 * `F`: move forward one unit with the pen down drawing trunks and branches
2929 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
2930 * `T`: move forward one unit with the pen down drawing trunks only
2931 * `R`: move forward one unit with the pen down placing fruit
2932 * `A`: replace with rules set A
2933 * `B`: replace with rules set B
2934 * `C`: replace with rules set C
2935 * `D`: replace with rules set D
2936 * `a`: replace with rules set A, chance 90%
2937 * `b`: replace with rules set B, chance 80%
2938 * `c`: replace with rules set C, chance 70%
2939 * `d`: replace with rules set D, chance 60%
2940 * `+`: yaw the turtle right by `angle` parameter
2941 * `-`: yaw the turtle left by `angle` parameter
2942 * `&`: pitch the turtle down by `angle` parameter
2943 * `^`: pitch the turtle up by `angle` parameter
2944 * `/`: roll the turtle to the right by `angle` parameter
2945 * `*`: roll the turtle to the left by `angle` parameter
2946 * `[`: save in stack current state info
2947 * `]`: recover from stack state info
2950 Spawn a small apple tree:
2952 pos = {x=230,y=20,z=4}
2955 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
2956 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
2957 trunk="default:tree",
2958 leaves="default:leaves",
2962 trunk_type="single",
2965 fruit="default:apple"
2967 minetest.spawn_tree(pos,apple_tree)
2972 ### Object Properties
2977 collide_with_objects = true, -- collide with other objects if physical=true
2979 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
2980 visual = "cube"/"sprite"/"upright_sprite"/"mesh"/"wielditem",
2981 visual_size = {x=1, y=1},
2983 textures = {}, -- number of required textures depends on visual
2984 colors = {}, -- number of required colors depends on visual
2985 spritediv = {x=1, y=1},
2986 initial_sprite_basepos = {x=0, y=0},
2988 makes_footstep_sound = false,
2989 automatic_rotate = false,
2991 automatic_face_movement_dir = 0.0,
2992 -- ^ automatically set yaw to movement direction; offset in degrees; false to disable
2995 ### Entity definition (`register_entity`)
2998 -- Deprecated: Everything in object properties is read directly from here
3000 initial_properties = --[[<initial object properties>]],
3002 on_activate = function(self, staticdata, dtime_s),
3003 on_step = function(self, dtime),
3004 on_punch = function(self, hitter),
3005 on_rightclick = function(self, clicker),
3006 get_staticdata = function(self),
3007 -- ^ Called sometimes; the string returned is passed to on_activate when
3008 -- the entity is re-activated from static state
3010 -- Also you can define arbitrary member variables here
3011 myvariable = whatever,
3014 ### ABM (ActiveBlockModifier) definition (`register_abm`)
3017 -- In the following two fields, also group:groupname will work.
3018 nodenames = {"default:lava_source"},
3019 neighbors = {"default:water_source", "default:water_flowing"}, -- (any of these)
3020 -- ^ If left out or empty, any neighbor will do
3021 interval = 1.0, -- (operation interval)
3022 chance = 1, -- (chance of trigger is 1.0/this)
3023 action = func(pos, node, active_object_count, active_object_count_wider),
3026 ### Item definition (`register_node`, `register_craftitem`, `register_tool`)
3029 description = "Steel Axe",
3030 groups = {}, -- key=name, value=rating; rating=1..3.
3031 if rating not applicable, use 1.
3032 e.g. {wool=1, fluffy=3}
3033 {soil=2, outerspace=1, crumbly=1}
3034 {bendy=2, snappy=1},
3035 {hard=1, metal=1, spikes=1}
3036 inventory_image = "default_tool_steelaxe.png",
3038 wield_scale = {x=1,y=1,z=1},
3041 liquids_pointable = false,
3042 tool_capabilities = {
3043 full_punch_interval = 1.0,
3047 snappy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
3048 choppy={times={[3]=0.90}, maxwear=0.05, maxlevel=0}
3050 damage_groups = {groupname=damage},
3052 node_placement_prediction = nil,
3054 ^ If nil and item is node, prediction is made automatically
3055 ^ If nil and item is not a node, no prediction is made
3056 ^ If "" and item is anything, no prediction is made
3057 ^ Otherwise should be name of node which the client immediately places
3058 on ground when the player places the item. Server will always update
3059 actual result to client in a short moment.
3062 place = --[[<SimpleSoundSpec>]],
3065 on_place = func(itemstack, placer, pointed_thing),
3067 ^ Shall place item and return the leftover itemstack
3068 ^ default: minetest.item_place ]]
3069 on_drop = func(itemstack, dropper, pos),
3071 ^ Shall drop item and return the leftover itemstack
3072 ^ default: minetest.item_drop ]]
3073 on_use = func(itemstack, user, pointed_thing),
3076 ^ Function must return either nil if no item shall be removed from
3077 inventory, or an itemstack to replace the original itemstack.
3078 e.g. itemstack:take_item(); return itemstack
3079 ^ Otherwise, the function is free to do what it wants.
3080 ^ The default functions handle regular use cases.
3082 after_use = func(itemstack, user, node, digparams),
3085 ^ If defined, should return an itemstack and will be called instead of
3086 wearing out the tool. If returns nil, does nothing.
3087 If after_use doesn't exist, it is the same as:
3088 function(itemstack, user, node, digparams)
3089 itemstack:add_wear(digparams.wear)
3097 * `{name="image.png", animation={Tile Animation definition}}`
3098 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
3099 tileable_horizontal=bool}`
3100 * backface culling only supported in special tiles.
3101 * tileable flags are info for shaders, how they should treat texture
3102 when displacement mapping is used
3103 Directions are from the point of view of the tile texture,
3104 not the node it's on
3105 * deprecated, yet still supported field names:
3108 ### Tile animation definition
3109 * `{type="vertical_frames", aspect_w=16, aspect_h=16, length=3.0}`
3111 ### Node definition (`register_node`)
3114 -- <all fields allowed in item definitions>,
3116 drawtype = "normal", -- See "Node drawtypes"
3117 visual_scale = 1.0, --[[
3118 ^ Supported for drawtypes "plantlike", "signlike", "torchlike", "mesh".
3119 ^ For plantlike, the image will start at the bottom of the node; for the
3120 ^ other drawtypes, the image will be centered on the node.
3121 ^ Note that positioning for "torchlike" may still change. ]]
3122 tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
3123 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
3124 ^ List can be shortened to needed length ]]
3125 special_tiles = {tile definition 1, Tile definition 2}, --[[
3126 ^ Special textures of node; used rarely (old field name: special_materials)
3127 ^ List can be shortened to needed length ]]
3129 use_texture_alpha = false, -- Use texture's alpha channel
3130 post_effect_color = "green#0F", -- If player is inside node, see "ColorSpec"
3131 paramtype = "none", -- See "Nodes" --[[
3132 ^ paramtype = "light" allows light to propagate from or through the node with light value
3133 ^ falling by 1 per node. This line is essential for a light source node to spread its light. ]]
3134 paramtype2 = "none", -- See "Nodes"
3135 is_ground_content = true, -- If false, the cave generator will not carve through this
3136 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
3137 walkable = true, -- If true, objects collide with node
3138 pointable = true, -- If true, can be pointed at
3139 diggable = true, -- If false, can never be dug
3140 climbable = false, -- If true, can be climbed on (ladder)
3141 buildable_to = false, -- If true, placed nodes can replace this node
3142 liquidtype = "none", -- "none"/"source"/"flowing"
3143 liquid_alternative_flowing = "", -- Flowing version of source liquid
3144 liquid_alternative_source = "", -- Source version of flowing liquid
3145 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
3146 liquid_renewable = true, -- Can new liquid source be created by placing two or more sources nearby?
3148 ^ Block contains level in param2. Value is default level, used for snow.
3149 ^ Don't forget to use "leveled" type nodebox. ]]
3150 liquid_range = 8, -- number of flowing nodes around source (max. 8)
3151 drowning = 0, -- Player will take this amount of damage if no bubbles are left
3152 light_source = 0, -- Amount of light emitted by node
3153 damage_per_second = 0, -- If player is inside node, this damage is caused
3154 node_box = {type="regular"}, -- See "Node boxes"
3156 selection_box = {type="regular"}, -- See "Node boxes" --[[
3157 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used. ]]
3158 legacy_facedir_simple = false, -- Support maps made in and before January 2012
3159 legacy_wallmounted = false, -- Support maps made in and before January 2012
3161 footstep = <SimpleSoundSpec>,
3162 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
3163 dug = <SimpleSoundSpec>,
3164 place = <SimpleSoundSpec>,
3166 drop = "", -- Name of dropped node when dug. Default is the node itself.
3169 max_items = 1, -- Maximum number of items to drop.
3170 items = { -- Choose max_items randomly from this list.
3172 items = {"foo:bar", "baz:frob"}, -- Choose one item randomly from this list.
3173 rarity = 1, -- Probability of getting is 1 / rarity.
3178 on_construct = func(pos), --[[
3179 ^ Node constructor; always called after adding node
3180 ^ Can set up metadata and stuff like that
3182 on_destruct = func(pos), --[[
3183 ^ Node destructor; always called before removing node
3185 after_destruct = func(pos, oldnode), --[[
3186 ^ Node destructor; always called after removing node
3189 after_place_node = func(pos, placer, itemstack, pointed_thing) --[[
3190 ^ Called after constructing node when node was placed using
3191 minetest.item_place_node / minetest.place_node
3192 ^ If return true no item is taken from itemstack
3194 after_dig_node = func(pos, oldnode, oldmetadata, digger), --[[
3195 ^ oldmetadata is in table format
3196 ^ Called after destructing node when node was dug using
3197 minetest.node_dig / minetest.dig_node
3199 can_dig = function(pos, [player]) --[[
3200 ^ returns true if node can be dug, or false if not
3203 on_punch = func(pos, node, puncher, pointed_thing), --[[
3204 ^ default: minetest.node_punch
3205 ^ By default: Calls minetest.register_on_punchnode callbacks ]]
3206 on_rightclick = func(pos, node, clicker, itemstack, pointed_thing), --[[
3208 ^ if defined, itemstack will hold clicker's wielded item
3209 ^ Shall return the leftover itemstack
3210 ^ Note: pointed_thing can be nil, if a mod calls this function ]]
3212 on_dig = func(pos, node, digger), --[[
3213 ^ default: minetest.node_dig
3214 ^ By default: checks privileges, wears out tool and removes node ]]
3216 on_timer = function(pos,elapsed), --[[
3218 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
3219 ^ elapsed is the total time passed since the timer was started
3220 ^ return true to run the timer for another cycle with the same timeout value ]]
3222 on_receive_fields = func(pos, formname, fields, sender), --[[
3223 ^ fields = {name1 = value1, name2 = value2, ...}
3224 ^ Called when an UI form (e.g. sign text input) returns data
3227 allow_metadata_inventory_move = func(pos, from_list, from_index,
3228 to_list, to_index, count, player), --[[
3229 ^ Called when a player wants to move items inside the inventory
3230 ^ Return value: number of items allowed to move ]]
3232 allow_metadata_inventory_put = func(pos, listname, index, stack, player), --[[
3233 ^ Called when a player wants to put something into the inventory
3234 ^ Return value: number of items allowed to put
3235 ^ Return value: -1: Allow and don't modify item count in inventory ]]
3237 allow_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
3238 ^ Called when a player wants to take something out of the inventory
3239 ^ Return value: number of items allowed to take
3240 ^ Return value: -1: Allow and don't modify item count in inventory ]]
3242 on_metadata_inventory_move = func(pos, from_list, from_index,
3243 to_list, to_index, count, player),
3244 on_metadata_inventory_put = func(pos, listname, index, stack, player),
3245 on_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
3246 ^ Called after the actual action has happened, according to what was allowed.
3247 ^ No return value ]]
3249 on_blast = func(pos, intensity), --[[
3250 ^ intensity: 1.0 = mid range of regular TNT
3251 ^ If defined, called when an explosion touches the node, instead of
3252 removing the node ]]
3255 ### Recipe for `register_craft` (shaped)
3258 output = 'default:pick_stone',
3260 {'default:cobble', 'default:cobble', 'default:cobble'},
3261 {'', 'default:stick', ''},
3262 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
3264 replacements = --[[<optional list of item pairs,
3265 replace one input item with another item on crafting>]]
3268 ### Recipe for `register_craft` (shapeless)
3272 output = 'mushrooms:mushroom_stew',
3275 "mushrooms:mushroom_brown",
3276 "mushrooms:mushroom_red",
3278 replacements = --[[<optional list of item pairs,
3279 replace one input item with another item on crafting>]]
3282 ### Recipe for `register_craft` (tool repair)
3285 type = "toolrepair",
3286 additional_wear = -0.02,
3289 ### Recipe for `register_craft` (cooking)
3293 output = "default:glass",
3294 recipe = "default:sand",
3298 ### Recipe for `register_craft` (furnace fuel)
3302 recipe = "default:leaves",
3306 ### Ore definition (`register_ore`)
3309 ore_type = "scatter", -- See "Ore types"
3310 ore = "default:stone_with_coal",
3311 wherein = "default:stone",
3312 -- ^ a list of nodenames is supported too
3313 clust_scarcity = 8*8*8,
3314 -- ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
3315 -- ^ This value should be *MUCH* higher than your intuition might tell you!
3317 -- ^ Number of ores in a cluster
3319 -- ^ Size of the bounding box of the cluster
3320 -- ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
3324 -- ^ Attributes for this ore generation
3325 noise_threshhold = 0.5,
3326 -- ^ If noise is above this threshold, ore is placed. Not needed for a uniform distribution
3327 noise_params = {offset=0, scale=1, spread={x=100, y=100, z=100}, seed=23, octaves=3, persist=0.70}
3328 -- ^ NoiseParams structure describing the perlin noise used for ore distribution.
3329 -- ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
3330 random_factor = 1.0,
3331 -- ^ Multiplier of the randomness contribution to the noise value at any
3332 -- given point to decide if ore should be placed. Set to 0 for solid veins.
3333 -- ^ This parameter is only valid for ore_type == "vein".
3334 biomes = {"desert", "rainforest"}
3335 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
3336 -- ^ and ignored if the Mapgen being used does not support biomes.
3337 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
3340 ### Decoration definition (`register_decoration`)
3343 deco_type = "simple", -- See "Decoration types"
3344 place_on = "default:dirt_with_grass",
3345 -- ^ Node that decoration can be placed on
3347 -- ^ Size of divisions made in the chunk being generated.
3348 -- ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
3350 -- ^ Ratio of the area to be uniformly filled by the decoration.
3351 -- ^ Used only if noise_params is not specified.
3352 noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
3353 -- ^ NoiseParams structure describing the perlin noise used for decoration distribution.
3354 -- ^ The result of this is multiplied by the 2d area of the division being decorated.
3355 biomes = {"Oceanside", "Hills", "Plains"},
3356 -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
3357 -- ^ and ignored if the Mapgen being used does not support biomes.
3358 -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
3361 -- ^ Minimum and maximum `y` positions these decorations can be generated at.
3362 -- ^ This parameter refers to the `y` position of the decoration base, so
3363 -- the actual maximum height would be `height_max + size.Y`.
3365 ----- Simple-type parameters
3366 decoration = "default:grass",
3367 -- ^ The node name used as the decoration.
3368 -- ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
3370 -- ^ Number of nodes high the decoration is made.
3371 -- ^ If height_max is not 0, this is the lower bound of the randomly selected height.
3373 -- ^ Number of nodes the decoration can be at maximum.
3374 -- ^ If absent, the parameter 'height' is used as a constant.
3375 spawn_by = "default:water",
3376 -- ^ Node that the decoration only spawns next to.
3377 -- ^ The neighbours checked are the 8 nodes horizontally surrounding the lowest node of the
3378 -- ^ decoration, and the 8 nodes horizontally surrounding the ground node below the decoration.
3380 -- ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
3381 -- ^ If absent or -1, decorations occur next to any nodes.
3383 ----- Schematic-type parameters
3384 schematic = "foobar.mts",
3385 -- ^ If schematic is a string, it is the filepath relative to the current working directory of the
3386 -- ^ specified Minetest schematic file.
3387 -- ^ - OR -, could be the ID of a previously registered schematic
3388 -- ^ - OR -, could instead be a table containing two mandatory fields, size and data,
3389 -- ^ and an optional table yslice_prob:
3391 size = {x=4, y=6, z=4},
3393 {name="default:cobble", param1=255, param2=0},
3394 {name="default:dirt_with_grass", param1=255, param2=0},
3395 {name="ignore", param1=255, param2=0},
3396 {name="air", param1=255, param2=0},
3405 -- ^ See 'Schematic specifier' for details.
3406 replacements = {["oldname"] = "convert_to", ...},
3407 flags = "place_center_x, place_center_y, place_center_z, force_placement",
3408 -- ^ Flags for schematic decorations. See 'Schematic attributes'.
3409 rotation = "90" -- rotate schematic 90 degrees on placement
3410 -- ^ Rotation can be "0", "90", "180", "270", or "random".
3413 ### Chat command definition (`register_chatcommand`)
3416 params = "<name> <privilege>", -- Short parameter description
3417 description = "Remove privilege from player", -- Full description
3418 privs = {privs=true}, -- Require the "privs" privilege to run
3419 func = function(name, param), -- Called when command is run.
3420 -- Returns boolean success and text output.
3423 ### Detached inventory callbacks
3426 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
3427 -- ^ Called when a player wants to move items inside the inventory
3428 -- ^ Return value: number of items allowed to move
3430 allow_put = func(inv, listname, index, stack, player),
3431 -- ^ Called when a player wants to put something into the inventory
3432 -- ^ Return value: number of items allowed to put
3433 -- ^ Return value: -1: Allow and don't modify item count in inventory
3435 allow_take = func(inv, listname, index, stack, player),
3436 -- ^ Called when a player wants to take something out of the inventory
3437 -- ^ Return value: number of items allowed to take
3438 -- ^ Return value: -1: Allow and don't modify item count in inventory
3440 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
3441 on_put = func(inv, listname, index, stack, player),
3442 on_take = func(inv, listname, index, stack, player),
3443 -- ^ Called after the actual action has happened, according to what was allowed.
3444 -- ^ No return value
3447 ### HUD Definition (`hud_add`, `hud_get`)
3450 hud_elem_type = "image", -- see HUD element types
3451 -- ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
3452 position = {x=0.5, y=0.5},
3453 -- ^ Left corner position of element
3459 -- ^ Selected item in inventory. 0 for no item selected.
3461 -- ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
3462 alignment = {x=0, y=0},
3463 -- ^ See "HUD Element Types"
3464 offset = {x=0, y=0},
3465 -- ^ See "HUD Element Types"
3466 size = { x=100, y=100 },
3467 -- ^ Size of element in pixels
3470 ### Particle definition (`add_particle`)
3473 pos = {x=0, y=0, z=0},
3474 velocity = {x=0, y=0, z=0},
3475 acceleration = {x=0, y=0, z=0},
3476 -- ^ Spawn particle at pos with velocity and acceleration
3478 -- ^ Disappears after expirationtime seconds
3480 collisiondetection = false,
3481 -- ^ collisiondetection: if true collides with physical objects
3483 -- ^ vertical: if true faces player using y axis only
3484 texture = "image.png",
3485 -- ^ Uses texture (string)
3486 playername = "singleplayer"
3487 -- ^ optional, if specified spawns particle only on the player's client
3490 ### `ParticleSpawner` definition (`add_particlespawner`)
3495 -- ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
3496 minpos = {x=0, y=0, z=0},
3497 maxpos = {x=0, y=0, z=0},
3498 minvel = {x=0, y=0, z=0},
3499 maxvel = {x=0, y=0, z=0},
3500 minacc = {x=0, y=0, z=0},
3501 maxacc = {x=0, y=0, z=0},
3506 -- ^ The particle's properties are random values in between the bounds:
3507 -- ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
3508 -- ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
3509 collisiondetection = false,
3510 -- ^ collisiondetection: if true uses collision detection
3512 -- ^ vertical: if true faces player using y axis only
3513 texture = "image.png",
3514 -- ^ Uses texture (string)
3515 playername = "singleplayer"
3516 -- ^ Playername is optional, if specified spawns particle only on the player's client