1 Minetest Lua Modding API Reference
2 ==================================
4 * More information at <http://www.minetest.net/>
5 * Developer Wiki: <http://dev.minetest.net/>
6 * (Unofficial) Minetest Modding Book by rubenwardy: <https://rubenwardy.com/minetest_modding_book/>
11 Content and functionality can be added to Minetest using Lua scripting
12 in run-time loaded mods.
14 A mod is a self-contained bunch of scripts, textures and other related
15 things, which is loaded by and interfaces with Minetest.
17 Mods are contained and ran solely on the server side. Definitions and media
18 files are automatically transferred to the client.
20 If you see a deficiency in the API, feel free to attempt to add the
21 functionality in the engine and API, and to document it here.
26 If you have any difficulty in understanding this, please read
27 [Programming in Lua](http://www.lua.org/pil/).
32 Mods are loaded during server startup from the mod load paths by running
33 the `init.lua` scripts in a shared environment.
38 * `RUN_IN_PLACE=1` (Windows release, local build)
39 * `$path_user`: `<build directory>`
40 * `$path_share`: `<build directory>`
41 * `RUN_IN_PLACE=0`: (Linux release)
43 * Linux: `/usr/share/minetest`
44 * Windows: `<install directory>/minetest-0.4.x`
46 * Linux: `$HOME/.minetest`
47 * Windows: `C:/users/<user>/AppData/minetest` (maybe)
55 Games are looked up from:
57 * `$path_share/games/<gameid>/`
58 * `$path_user/games/<gameid>/`
60 Where `<gameid>` is unique to each game.
62 The game directory can contain the following files:
64 * `game.conf`, with the following keys:
65 * `name`: Required, a human readable title to address the game, e.g. `name = Minetest`.
66 * `description`: Short description to be shown in the content tab
67 * `allowed_mapgens = <comma-separated mapgens>`
68 e.g. `allowed_mapgens = v5,v6,flat`
69 Mapgens not in this list are removed from the list of mapgens for the
71 If not specified, all mapgens are allowed.
72 * `disallowed_mapgens = <comma-separated mapgens>`
73 e.g. `disallowed_mapgens = v5,v6,flat`
74 These mapgens are removed from the list of mapgens for the game.
75 When both `allowed_mapgens` and `disallowed_mapgens` are
76 specified, `allowed_mapgens` is applied before
78 * `disallowed_mapgen_settings= <comma-separated mapgen settings>`
79 e.g. `disallowed_mapgen_settings = mgv5_spflags`
80 These settings are hidden for this game in the world creation
81 dialog and game start menu.
82 * `author`: The author of the game. It only appears when downloaded from
84 * `release`: Ignore this: Should only ever be set by ContentDB, as it is
85 an internal ID used to track versions.
87 Used to set default settings when running this game.
89 In the same format as the one in builtin.
90 This settingtypes.txt will be parsed by the menu and the settings will be
91 displayed in the "Games" category in the advanced settings tab.
92 * If the game contains a folder called `textures` the server will load it as a
93 texturepack, overriding mod textures.
94 Any server texturepack will override mod textures and the game texturepack.
99 Games can provide custom main menu images. They are put inside a `menu`
100 directory inside the game directory.
102 The images are named `$identifier.png`, where `$identifier` is one of
103 `overlay`, `background`, `footer`, `header`.
104 If you want to specify multiple images for one identifier, add additional
105 images named like `$identifier.$n.png`, with an ascending number $n starting
106 with 1, and a random image will be chosen from the provided ones.
117 Paths are relative to the directories listed in the [Paths] section above.
119 * `games/<gameid>/mods/`
121 * `worlds/<worldname>/worldmods/`
126 It is possible to include a game in a world; in this case, no mods or
127 games are loaded or checked from anywhere else.
129 This is useful for e.g. adventure worlds and happens if the `<worldname>/game/`
132 Mods should then be placed in `<worldname>/game/mods/`.
137 Mods can be put in a subdirectory, if the parent directory, which otherwise
138 should be a mod, contains a file named `modpack.conf`.
139 The file is a key-value store of modpack details.
141 * `name`: The modpack name. Allows Minetest to determine the modpack name even
142 if the folder is wrongly named.
143 * `description`: Description of mod to be shown in the Mods tab of the main
145 * `author`: The author of the modpack. It only appears when downloaded from
147 * `release`: Ignore this: Should only ever be set by ContentDB, as it is an
148 internal ID used to track versions.
149 * `title`: A human-readable title to address the modpack.
151 Note: to support 0.4.x, please also create an empty modpack.txt file.
153 Mod directory structure
154 -----------------------
160 │ ├── settingtypes.txt
164 │ │ ├── modname_stuff.png
165 │ │ ├── modname_stuff_normal.png
166 │ │ ├── modname_something_else.png
167 │ │ ├── subfolder_foo
168 │ │ │ ├── modname_more_stuff.png
169 │ │ │ └── another_subfolder
170 │ │ └── bar_subfolder
179 The location of this directory can be fetched by using
180 `minetest.get_modpath(modname)`.
184 A `Settings` file that provides meta information about the mod.
186 * `name`: The mod name. Allows Minetest to determine the mod name even if the
187 folder is wrongly named.
188 * `description`: Description of mod to be shown in the Mods tab of the main
190 * `depends`: A comma separated list of dependencies. These are mods that must be
191 loaded before this mod.
192 * `optional_depends`: A comma separated list of optional dependencies.
193 Like a dependency, but no error if the mod doesn't exist.
194 * `author`: The author of the mod. It only appears when downloaded from
196 * `release`: Ignore this: Should only ever be set by ContentDB, as it is an
197 internal ID used to track versions.
198 * `title`: A human-readable title to address the mod.
200 Note: to support 0.4.x, please also provide depends.txt.
204 A screenshot shown in the mod manager within the main menu. It should
205 have an aspect ratio of 3:2 and a minimum size of 300×200 pixels.
209 **Deprecated:** you should use mod.conf instead.
211 This file is used if there are no dependencies in mod.conf.
213 List of mods that have to be loaded before loading this mod.
215 A single line contains a single modname.
217 Optional dependencies can be defined by appending a question mark
218 to a single modname. This means that if the specified mod
219 is missing, it does not prevent this mod from being loaded.
221 ### `description.txt`
223 **Deprecated:** you should use mod.conf instead.
225 This file is used if there is no description in mod.conf.
227 A file containing a description to be shown in the Mods tab of the main menu.
229 ### `settingtypes.txt`
231 The format is documented in `builtin/settingtypes.txt`.
232 It is parsed by the main menu settings dialogue to list mod-specific
233 settings in the "Mods" category.
237 The main Lua script. Running this script should register everything it
238 wants to register. Subsequent execution depends on minetest calling the
239 registered callbacks.
241 `minetest.settings` can be used to read custom or existing settings at load
242 time, if necessary. (See [`Settings`])
244 ### `textures`, `sounds`, `media`, `models`, `locale`
246 Media files (textures, sounds, whatever) that will be transferred to the
247 client and will be available for use by the mod and translation files for
248 the clients (see [Translations]).
250 It is suggested to use the folders for the purpous they are thought for,
251 eg. put textures into `textures`, translation files into `locale`,
252 models for entities or meshnodes into `models` et cetera.
254 These folders and subfolders can contain subfolders.
255 Subfolders with names starting with `_` or `.` are ignored.
256 If a subfolder contains a media file with the same name as a media file
257 in one of its parents, the parent's file is used.
262 Registered names should generally be in this format:
266 `<whatever>` can have these characters:
270 This is to prevent conflicting names from corrupting maps and is
271 enforced by the mod loader.
273 Registered names can be overridden by prefixing the name with `:`. This can
274 be used for overriding the registrations of some other mod.
276 The `:` prefix can also be used for maintaining backwards compatibility.
280 In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
281 So the name should be `experimental:tnt`.
283 Any mod can redefine `experimental:tnt` by using the name
287 when registering it. That mod is required to have `experimental` as a
296 Aliases of itemnames can be added by using
297 `minetest.register_alias(alias, original_name)` or
298 `minetest.register_alias_force(alias, original_name)`.
300 This adds an alias `alias` for the item called `original_name`.
301 From now on, you can use `alias` to refer to the item `original_name`.
303 The only difference between `minetest.register_alias` and
304 `minetest.register_alias_force` is that if an item named `alias` already exists,
305 `minetest.register_alias` will do nothing while
306 `minetest.register_alias_force` will unregister it.
308 This can be used for maintaining backwards compatibility.
310 This can also set quick access names for things, e.g. if
311 you have an item called `epiclylongmodname:stuff`, you could do
313 minetest.register_alias("stuff", "epiclylongmodname:stuff")
315 and be able to use `/giveme stuff`.
320 In a game, a certain number of these must be set to tell core mapgens which
321 of the game's nodes are to be used for core mapgen generation. For example:
323 minetest.register_alias("mapgen_stone", "default:stone")
325 ### Aliases for non-V6 mapgens
327 #### Essential aliases
330 * mapgen_water_source
331 * mapgen_river_water_source
333 `mapgen_river_water_source` is required for mapgens with sloping rivers where
334 it is necessary to have a river liquid node with a short `liquid_range` and
335 `liquid_renewable = false` to avoid flooding.
337 #### Optional aliases
341 Fallback lava node used if cave liquids are not defined in biome definitions.
342 Deprecated for non-V6 mapgens, define cave liquids in biome definitions instead.
346 Fallback node used if dungeon nodes are not defined in biome definitions.
347 Deprecated for non-V6 mapgens, define dungeon nodes in biome definitions instead.
349 ### Aliases needed for Mapgen V6
352 * mapgen_water_source
355 * mapgen_dirt_with_grass
358 * mapgen_desert_stone
360 * mapgen_dirt_with_snow
369 * mapgen_jungleleaves
372 * mapgen_pine_needles
375 * mapgen_stair_cobble
377 * mapgen_stair_desert_stone
379 ### Setting the node used in Mapgen Singlenode
381 By default the world is filled with air nodes. To set a different node use, for
384 minetest.register_alias("mapgen_singlenode", "default:stone")
392 Mods should generally prefix their textures with `modname_`, e.g. given
393 the mod name `foomod`, a texture could be called:
397 Textures are referred to by their complete name, or alternatively by
398 stripping out the file extension:
400 * e.g. `foomod_foothing.png`
401 * e.g. `foomod_foothing`
407 If shaders and bumpmapping or parallax occlusion is enabled, Minetest tries
409 Those image files have to end with `_normal.png` and start with the same name
410 as their corresponding texture.
411 For example a normalmap for `foomod_foothing.png` has to be called
412 `foomod_foothing_normal.png`.
414 The sRGB R, G and B colour values of a normalmap pixel are each directly
415 mapped from `{0, ..., 255}` to `[-1, 1]` and, taken together,
416 define the normal vector.
417 The alpha channel defines the heightmap for parallax occlusion.
418 To be safe, the alpha values should always be bigger than zero
419 because the colour values, which define the normal vector,
420 may be undefined for image formats where colour is discarded in fully
423 Bumpmapping and parallax occlusion are currently experimental features:
425 * Bumpmapping in Minetest happens in an obscure way; there are no light sources
426 defined in the shaders except the sunlight direction.
427 * Parallax occlusion with relief-mapping mode does not yet work correctly
428 together with Minetest's Fastfaces.
429 * The normalmap files must end with `.png`, so other image files are not
436 There are various texture modifiers that can be used
437 to generate textures on-the-fly.
439 ### Texture overlaying
441 Textures can be overlaid by putting a `^` between them.
445 default_dirt.png^default_grass_side.png
447 `default_grass_side.png` is overlaid over `default_dirt.png`.
448 The texture with the lower resolution will be automatically upscaled to
449 the higher resolution texture.
453 Textures can be grouped together by enclosing them in `(` and `)`.
455 Example: `cobble.png^(thing1.png^thing2.png)`
457 A texture for `thing1.png^thing2.png` is created and the resulting
458 texture is overlaid on top of `cobble.png`.
462 Modifiers that accept texture names (e.g. `[combine`) accept escaping to allow
463 passing complex texture names as arguments. Escaping is done with backslash and
464 is required for `^` and `:`.
466 Example: `cobble.png^[lowpart:50:color.png\^[mask\:trans.png`
468 The lower 50 percent of `color.png^[mask:trans.png` are overlaid
469 on top of `cobble.png`.
471 ### Advanced texture modifiers
477 * `[crack:<t>:<n>:<p>`
478 * `[cracko:<t>:<n>:<p>`
482 * `<t>`: tile count (in each direction)
483 * `<n>`: animation frame count
484 * `<p>`: current animation frame
486 Draw a step of the crack animation on the texture.
487 `crack` draws it normally, while `cracko` lays it over, keeping transparent
492 default_cobble.png^[crack:10:1
494 #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
500 * `<file>`: texture to combine
502 Creates a texture of size `<w>` times `<h>` and blits the listed files to their
503 specified coordinates.
507 [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
509 #### `[resize:<w>x<h>`
511 Resizes the texture to the given dimensions.
515 default_sandstone.png^[resize:16x16
519 Makes the base image transparent according to the given ratio.
521 `r` must be between 0 (transparent) and 255 (opaque).
525 default_sandstone.png^[opacity:127
527 #### `[invert:<mode>`
529 Inverts the given channels of the base image.
530 Mode may contain the characters "r", "g", "b", "a".
531 Only the channels that are mentioned in the mode string will be inverted.
535 default_apple.png^[invert:rgb
539 Brightens the texture.
543 tnt_tnt_side.png^[brighten
547 Makes the texture completely opaque.
551 default_leaves.png^[noalpha
553 #### `[makealpha:<r>,<g>,<b>`
555 Convert one color to transparency.
559 default_cobble.png^[makealpha:128,128,128
563 * `<t>`: transformation(s) to apply
565 Rotates and/or flips the image.
567 `<t>` can be a number (between 0 and 7) or a transform name.
568 Rotations are counter-clockwise.
571 1 R90 rotate by 90 degrees
572 2 R180 rotate by 180 degrees
573 3 R270 rotate by 270 degrees
575 5 FXR90 flip X then rotate by 90 degrees
577 7 FYR90 flip Y then rotate by 90 degrees
581 default_stone.png^[transformFXR90
583 #### `[inventorycube{<top>{<left>{<right>`
585 Escaping does not apply here and `^` is replaced by `&` in texture names
588 Create an inventory cube texture using the side textures.
592 [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
594 Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
595 `dirt.png^grass_side.png` textures
597 #### `[lowpart:<percent>:<file>`
599 Blit the lower `<percent>`% part of `<file>` on the texture.
603 base.png^[lowpart:25:overlay.png
605 #### `[verticalframe:<t>:<n>`
607 * `<t>`: animation frame count
608 * `<n>`: current animation frame
610 Crops the texture to a frame of a vertical animation.
614 default_torch_animated.png^[verticalframe:16:8
618 Apply a mask to the base image.
620 The mask is applied using binary AND.
622 #### `[sheet:<w>x<h>:<x>,<y>`
624 Retrieves a tile at position x,y from the base image
625 which it assumes to be a tilesheet with dimensions w,h.
627 #### `[colorize:<color>:<ratio>`
629 Colorize the textures with the given color.
630 `<color>` is specified as a `ColorString`.
631 `<ratio>` is an int ranging from 0 to 255 or the word "`alpha`". If
632 it is an int, then it specifies how far to interpolate between the
633 colors where 0 is only the texture color and 255 is only `<color>`. If
634 omitted, the alpha of `<color>` will be used as the ratio. If it is
635 the word "`alpha`", then each texture pixel will contain the RGB of
636 `<color>` and the alpha of `<color>` multiplied by the alpha of the
639 #### `[multiply:<color>`
641 Multiplies texture colors with the given color.
642 `<color>` is specified as a `ColorString`.
643 Result is more like what you'd expect if you put a color on top of another
644 color, meaning white surfaces get a lot of your new color while black parts
645 don't change very much.
650 The goal of hardware coloring is to simplify the creation of
651 colorful nodes. If your textures use the same pattern, and they only
652 differ in their color (like colored wool blocks), you can use hardware
653 coloring instead of creating and managing many texture files.
654 All of these methods use color multiplication (so a white-black texture
655 with red coloring will result in red-black color).
659 This method is useful if you wish to create nodes/items with
660 the same texture, in different colors, each in a new node/item definition.
664 When you register an item or node, set its `color` field (which accepts a
665 `ColorSpec`) to the desired color.
667 An `ItemStack`'s static color can be overwritten by the `color` metadata
668 field. If you set that field to a `ColorString`, that color will be used.
672 Each tile may have an individual static color, which overwrites every
673 other coloring method. To disable the coloring of a face,
674 set its color to white (because multiplying with white does nothing).
675 You can set the `color` property of the tiles in the node's definition
676 if the tile is in table format.
680 For nodes and items which can have many colors, a palette is more
681 suitable. A palette is a texture, which can contain up to 256 pixels.
682 Each pixel is one possible color for the node/item.
683 You can register one node/item, which can have up to 256 colors.
685 #### Palette indexing
687 When using palettes, you always provide a pixel index for the given
688 node or `ItemStack`. The palette is read from left to right and from
689 top to bottom. If the palette has less than 256 pixels, then it is
690 stretched to contain exactly 256 pixels (after arranging the pixels
691 to one line). The indexing starts from 0.
695 * 16x16 palette, index = 0: the top left corner
696 * 16x16 palette, index = 4: the fifth pixel in the first row
697 * 16x16 palette, index = 16: the pixel below the top left corner
698 * 16x16 palette, index = 255: the bottom right corner
699 * 2 (width) x 4 (height) palette, index = 31: the top left corner.
700 The palette has 8 pixels, so each pixel is stretched to 32 pixels,
701 to ensure the total 256 pixels.
702 * 2x4 palette, index = 32: the top right corner
703 * 2x4 palette, index = 63: the top right corner
704 * 2x4 palette, index = 64: the pixel below the top left corner
706 #### Using palettes with items
708 When registering an item, set the item definition's `palette` field to
709 a texture. You can also use texture modifiers.
711 The `ItemStack`'s color depends on the `palette_index` field of the
712 stack's metadata. `palette_index` is an integer, which specifies the
713 index of the pixel to use.
715 #### Linking palettes with nodes
717 When registering a node, set the item definition's `palette` field to
718 a texture. You can also use texture modifiers.
719 The node's color depends on its `param2`, so you also must set an
720 appropriate `paramtype2`:
722 * `paramtype2 = "color"` for nodes which use their full `param2` for
723 palette indexing. These nodes can have 256 different colors.
724 The palette should contain 256 pixels.
725 * `paramtype2 = "colorwallmounted"` for nodes which use the first
726 five bits (most significant) of `param2` for palette indexing.
727 The remaining three bits are describing rotation, as in `wallmounted`
728 paramtype2. Division by 8 yields the palette index (without stretching the
729 palette). These nodes can have 32 different colors, and the palette
730 should contain 32 pixels.
732 * `param2 = 17` is 2 * 8 + 1, so the rotation is 1 and the third (= 2 + 1)
733 pixel will be picked from the palette.
734 * `param2 = 35` is 4 * 8 + 3, so the rotation is 3 and the fifth (= 4 + 1)
735 pixel will be picked from the palette.
736 * `paramtype2 = "colorfacedir"` for nodes which use the first
737 three bits of `param2` for palette indexing. The remaining
738 five bits are describing rotation, as in `facedir` paramtype2.
739 Division by 32 yields the palette index (without stretching the
740 palette). These nodes can have 8 different colors, and the
741 palette should contain 8 pixels.
743 * `param2 = 17` is 0 * 32 + 17, so the rotation is 17 and the
744 first (= 0 + 1) pixel will be picked from the palette.
745 * `param2 = 35` is 1 * 32 + 3, so the rotation is 3 and the
746 second (= 1 + 1) pixel will be picked from the palette.
748 To colorize a node on the map, set its `param2` value (according
749 to the node's paramtype2).
751 ### Conversion between nodes in the inventory and on the map
753 Static coloring is the same for both cases, there is no need
756 If the `ItemStack`'s metadata contains the `color` field, it will be
757 lost on placement, because nodes on the map can only use palettes.
759 If the `ItemStack`'s metadata contains the `palette_index` field, it is
760 automatically transferred between node and item forms by the engine,
761 when a player digs or places a colored node.
762 You can disable this feature by setting the `drop` field of the node
763 to itself (without metadata).
764 To transfer the color to a special drop, you need a drop table.
768 minetest.register_node("mod:stone", {
769 description = "Stone",
770 tiles = {"default_stone.png"},
771 paramtype2 = "color",
772 palette = "palette.png",
775 -- assume that mod:cobblestone also has the same palette
776 {items = {"mod:cobblestone"}, inherit_color = true },
781 ### Colored items in craft recipes
783 Craft recipes only support item strings, but fortunately item strings
784 can also contain metadata. Example craft recipe registration:
786 minetest.register_craft({
787 output = minetest.itemstring_with_palette("wool:block", 3),
795 To set the `color` field, you can use `minetest.itemstring_with_color`.
797 Metadata field filtering in the `recipe` field are not supported yet,
798 so the craft output is independent of the color of the ingredients.
803 Sometimes hardware coloring is not enough, because it affects the
804 whole tile. Soft texture overlays were added to Minetest to allow
805 the dynamic coloring of only specific parts of the node's texture.
806 For example a grass block may have colored grass, while keeping the
809 These overlays are 'soft', because unlike texture modifiers, the layers
810 are not merged in the memory, but they are simply drawn on top of each
811 other. This allows different hardware coloring, but also means that
812 tiles with overlays are drawn slower. Using too much overlays might
815 For inventory and wield images you can specify overlays which
816 hardware coloring does not modify. You have to set `inventory_overlay`
817 and `wield_overlay` fields to an image name.
819 To define a node overlay, simply set the `overlay_tiles` field of the node
820 definition. These tiles are defined in the same way as plain tiles:
821 they can have a texture name, color etc.
822 To skip one face, set that overlay tile to an empty string.
824 Example (colored grass block):
826 minetest.register_node("default:dirt_with_grass", {
827 description = "Dirt with Grass",
828 -- Regular tiles, as usual
829 -- The dirt tile disables palette coloring
830 tiles = {{name = "default_grass.png"},
831 {name = "default_dirt.png", color = "white"}},
832 -- Overlay tiles: define them in the same style
833 -- The top and bottom tile does not have overlay
834 overlay_tiles = {"", "",
835 {name = "default_grass_side.png", tileable_vertical = false}},
836 -- Global color, used in inventory
838 -- Palette in the world
839 paramtype2 = "color",
840 palette = "default_foilage.png",
849 Only Ogg Vorbis files are supported.
851 For positional playing of sounds, only single-channel (mono) files are
852 supported. Otherwise OpenAL will play them non-positionally.
854 Mods should generally prefix their sounds with `modname_`, e.g. given
855 the mod name "`foomod`", a sound could be called:
859 Sounds are referred to by their name with a dot, a single digit and the
860 file extension stripped out. When a sound is played, the actual sound file
861 is chosen randomly from the matching sounds.
863 When playing the sound `foomod_foosound`, the sound is chosen randomly
864 from the available ones of the following files:
866 * `foomod_foosound.ogg`
867 * `foomod_foosound.0.ogg`
868 * `foomod_foosound.1.ogg`
870 * `foomod_foosound.9.ogg`
872 Examples of sound parameter tables:
874 -- Play locationless on all clients
876 gain = 1.0, -- default
877 fade = 0.0, -- default, change to a value > 0 to fade the sound in
878 pitch = 1.0, -- default
880 -- Play locationless to one player
883 gain = 1.0, -- default
884 fade = 0.0, -- default, change to a value > 0 to fade the sound in
885 pitch = 1.0, -- default
887 -- Play locationless to one player, looped
890 gain = 1.0, -- default
893 -- Play at a location
895 pos = {x = 1, y = 2, z = 3},
896 gain = 1.0, -- default
897 max_hear_distance = 32, -- default, uses an euclidean metric
899 -- Play connected to an object, looped
901 object = <an ObjectRef>,
902 gain = 1.0, -- default
903 max_hear_distance = 32, -- default, uses an euclidean metric
906 -- Play at a location, heard by anyone *but* the given player
908 pos = {x = 32, y = 0, z = 100},
909 max_hear_distance = 40,
910 exclude_player = name,
913 Looped sounds must either be connected to an object or played locationless to
914 one player using `to_player = name`.
916 A positional sound will only be heard by players that are within
917 `max_hear_distance` of the sound position, at the start of the sound.
919 `exclude_player = name` can be applied to locationless, positional and object-
920 bound sounds to exclude a single player from hearing them.
925 Specifies a sound name, gain (=volume) and pitch.
926 This is either a string or a table.
928 In string form, you just specify the sound name or
929 the empty string for no sound.
931 Table form has the following fields:
934 * `gain`: Volume (`1.0` = 100%)
935 * `pitch`: Pitch (`1.0` = 100%)
937 `gain` and `pitch` are optional and default to `1.0`.
943 * `"default_place_node"`: Play e.g. `default_place_node.ogg`
944 * `{name = "default_place_node"}`: Same as above
945 * `{name = "default_place_node", gain = 0.5}`: 50% volume
946 * `{name = "default_place_node", gain = 0.9, pitch = 1.1}`: 90% volume, 110% pitch
951 These sound files are played back by the engine if provided.
953 * `player_damage`: Played when the local player takes damage (gain = 0.5)
954 * `player_falling_damage`: Played when the local player takes
955 damage by falling (gain = 0.5)
956 * `player_jump`: Played when the local player jumps
957 * `default_dig_<groupname>`: Default node digging sound
958 (see node sound definition for details)
960 Registered definitions
961 ======================
963 Anything added using certain [Registration functions] gets added to one or more
964 of the global [Registered definition tables].
966 Note that in some cases you will stumble upon things that are not contained
967 in these tables (e.g. when a mod has been removed). Always check for
968 existence before trying to access the fields.
972 All nodes register with `minetest.register_node` get added to the table
973 `minetest.registered_nodes`.
975 If you want to check the drawtype of a node, you could do:
977 local function get_nodedef_field(nodename, fieldname)
978 if not minetest.registered_nodes[nodename] then
981 return minetest.registered_nodes[nodename][fieldname]
983 local drawtype = get_nodedef_field(nodename, "drawtype")
991 Nodes are the bulk data of the world: cubes and other things that take the
992 space of a cube. Huge amounts of them are handled efficiently, but they
995 The definition of a node is stored and can be accessed by using
997 minetest.registered_nodes[node.name]
999 See [Registered definitions].
1001 Nodes are passed by value between Lua and the engine.
1002 They are represented by a table:
1004 {name="name", param1=num, param2=num}
1006 `param1` and `param2` are 8-bit integers ranging from 0 to 255. The engine uses
1007 them for certain automated functions. If you don't use these functions, you can
1008 use them to store arbitrary values.
1013 The functions of `param1` and `param2` are determined by certain fields in the
1016 The function of `param1` is determined by `paramtype` in node definition.
1017 `param1` is reserved for the engine when `paramtype != "none"`.
1019 * `paramtype = "light"`
1020 * The value stores light with and without sun in its upper and lower 4 bits
1022 * Required by a light source node to enable spreading its light.
1023 * Required by the following drawtypes as they determine their visual
1024 brightness from their internal light value:
1034 * `paramtype = "none"`
1035 * `param1` will not be used by the engine and can be used to store
1038 The function of `param2` is determined by `paramtype2` in node definition.
1039 `param2` is reserved for the engine when `paramtype2 != "none"`.
1041 * `paramtype2 = "flowingliquid"`
1042 * Used by `drawtype = "flowingliquid"` and `liquidtype = "flowing"`
1043 * The liquid level and a flag of the liquid are stored in `param2`
1044 * Bits 0-2: Liquid level (0-7). The higher, the more liquid is in this node
1045 * Bit 3: If set, liquid is flowing downwards (no graphical effect)
1046 * `paramtype2 = "wallmounted"`
1047 * Supported drawtypes: "torchlike", "signlike", "normal", "nodebox", "mesh"
1048 * The rotation of the node is stored in `param2`
1049 * You can make this value by using `minetest.dir_to_wallmounted()`
1050 * Values range 0 - 5
1051 * The value denotes at which direction the node is "mounted":
1052 0 = y+, 1 = y-, 2 = x+, 3 = x-, 4 = z+, 5 = z-
1053 * `paramtype2 = "facedir"`
1054 * Supported drawtypes: "normal", "nodebox", "mesh"
1055 * The rotation of the node is stored in `param2`. Furnaces and chests are
1056 rotated this way. Can be made by using `minetest.dir_to_facedir()`.
1057 * Values range 0 - 23
1058 * facedir / 4 = axis direction:
1059 0 = y+, 1 = z+, 2 = z-, 3 = x+, 4 = x-, 5 = y-
1060 * facedir modulo 4 = rotation around that axis
1061 * `paramtype2 = "leveled"`
1062 * Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
1064 * The level of the top face of the nodebox is stored in `param2`.
1065 * The other faces are defined by 'fixed = {}' like 'type = "fixed"'
1067 * The nodebox height is (`param2` / 64) nodes.
1068 * The maximum accepted value of `param2` is 127.
1070 * The height of the 'plantlike' section is stored in `param2`.
1071 * The height is (`param2` / 16) nodes.
1072 * `paramtype2 = "degrotate"`
1073 * Only valid for "plantlike" drawtype. The rotation of the node is stored in
1075 * Values range 0 - 179. The value stored in `param2` is multiplied by two to
1076 get the actual rotation in degrees of the node.
1077 * `paramtype2 = "meshoptions"`
1078 * Only valid for "plantlike" drawtype. `param2` encodes the shape and
1079 optional modifiers of the "plant". `param2` is a bitfield.
1080 * Bits 0 to 2 select the shape.
1081 Use only one of the values below:
1082 * 0 = a "x" shaped plant (ordinary plant)
1083 * 1 = a "+" shaped plant (just rotated 45 degrees)
1084 * 2 = a "*" shaped plant with 3 faces instead of 2
1085 * 3 = a "#" shaped plant with 4 faces instead of 2
1086 * 4 = a "#" shaped plant with 4 faces that lean outwards
1087 * 5-7 are unused and reserved for future meshes.
1088 * Bits 3 to 7 are used to enable any number of optional modifiers.
1089 Just add the corresponding value(s) below to `param2`:
1090 * 8 - Makes the plant slightly vary placement horizontally
1091 * 16 - Makes the plant mesh 1.4x larger
1092 * 32 - Moves each face randomly a small bit down (1/8 max)
1093 * values 64 and 128 (bits 6-7) are reserved for future use.
1094 * Example: `param2 = 0` selects a normal "x" shaped plant
1095 * Example: `param2 = 17` selects a "+" shaped plant, 1.4x larger (1+16)
1096 * `paramtype2 = "color"`
1097 * `param2` tells which color is picked from the palette.
1098 The palette should have 256 pixels.
1099 * `paramtype2 = "colorfacedir"`
1100 * Same as `facedir`, but with colors.
1101 * The first three bits of `param2` tells which color is picked from the
1102 palette. The palette should have 8 pixels.
1103 * `paramtype2 = "colorwallmounted"`
1104 * Same as `wallmounted`, but with colors.
1105 * The first five bits of `param2` tells which color is picked from the
1106 palette. The palette should have 32 pixels.
1107 * `paramtype2 = "glasslikeliquidlevel"`
1108 * Only valid for "glasslike_framed" or "glasslike_framed_optional"
1110 * `param2` values 0-63 define 64 levels of internal liquid, 0 being empty
1112 * Liquid texture is defined using `special_tiles = {"modname_tilename.png"}`
1113 * `paramtype2 = "none"`
1114 * `param2` will not be used by the engine and can be used to store
1117 Nodes can also contain extra data. See [Node Metadata].
1122 There are a bunch of different looking node types.
1124 Look for examples in `games/devtest` or `games/minetest_game`.
1127 * A node-sized cube.
1129 * Invisible, uses no texture.
1131 * The cubic source node for a liquid.
1133 * The flowing version of a liquid, appears with various heights and slopes.
1135 * Often used for partially-transparent nodes.
1136 * Only external sides of textures are visible.
1137 * `glasslike_framed`
1138 * All face-connected nodes are drawn as one volume within a surrounding
1140 * The frame appearance is generated from the edges of the first texture
1141 specified in `tiles`. The width of the edges used are 1/16th of texture
1142 size: 1 pixel for 16x16, 2 pixels for 32x32 etc.
1143 * The glass 'shine' (or other desired detail) on each node face is supplied
1144 by the second texture specified in `tiles`.
1145 * `glasslike_framed_optional`
1146 * This switches between the above 2 drawtypes according to the menu setting
1149 * Often used for partially-transparent nodes.
1150 * External and internal sides of textures are visible.
1151 * `allfaces_optional`
1152 * Often used for leaves nodes.
1153 * This switches between `normal`, `glasslike` and `allfaces` according to
1154 the menu setting: Opaque Leaves / Simple Leaves / Fancy Leaves.
1155 * With 'Simple Leaves' selected, the texture specified in `special_tiles`
1156 is used instead, if present. This allows a visually thicker texture to be
1157 used to compensate for how `glasslike` reduces visual thickness.
1159 * A single vertical texture.
1160 * If placed on top of a node, uses the first texture specified in `tiles`.
1161 * If placed against the underside of a node, uses the second texture
1162 specified in `tiles`.
1163 * If placed on the side of a node, uses the third texture specified in
1164 `tiles` and is perpendicular to that node.
1166 * A single texture parallel to, and mounted against, the top, underside or
1169 * Two vertical and diagonal textures at right-angles to each other.
1170 * See `paramtype2 = "meshoptions"` above for other options.
1172 * When above a flat surface, appears as 6 textures, the central 2 as
1173 `plantlike` plus 4 more surrounding those.
1174 * If not above a surface the central 2 do not appear, but the texture
1175 appears against the faces of surrounding nodes if they are present.
1177 * A 3D model suitable for a wooden fence.
1178 * One placed node appears as a single vertical post.
1179 * Adjacently-placed nodes cause horizontal bars to appear between them.
1181 * Often used for tracks for mining carts.
1182 * Requires 4 textures to be specified in `tiles`, in order: Straight,
1183 curved, t-junction, crossing.
1184 * Each placed node automatically switches to a suitable rotated texture
1185 determined by the adjacent `raillike` nodes, in order to create a
1186 continuous track network.
1187 * Becomes a sloping node if placed against stepped nodes.
1189 * Often used for stairs and slabs.
1190 * Allows defining nodes consisting of an arbitrary number of boxes.
1191 * See [Node boxes] below for more information.
1193 * Uses models for nodes.
1194 * Tiles should hold model materials textures.
1195 * Only static meshes are implemented.
1196 * For supported model formats see Irrlicht engine documentation.
1197 * `plantlike_rooted`
1198 * Enables underwater `plantlike` without air bubbles around the nodes.
1199 * Consists of a base cube at the co-ordinates of the node plus a
1200 `plantlike` extension above with a height of `param2 / 16` nodes.
1201 * The `plantlike` extension visually passes through any nodes above the
1202 base cube without affecting them.
1203 * The base cube texture tiles are defined as normal, the `plantlike`
1204 extension uses the defined special tile, for example:
1205 `special_tiles = {{name = "default_papyrus.png", tileable_vertical = true}},`
1207 `*_optional` drawtypes need less rendering time if deactivated
1208 (always client-side).
1213 Node selection boxes are defined using "node boxes".
1215 A nodebox is defined as any of:
1218 -- A normal cube; the default in most things
1222 -- A fixed box (or boxes) (facedir param2 is used, if applicable)
1224 fixed = box OR {box1, box2, ...}
1227 -- A variable height box (or boxes) with the top face position defined
1228 -- by the node parameter 'leveled = ', or if 'paramtype2 == "leveled"'
1230 -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
1232 fixed = box OR {box1, box2, ...}
1235 -- A box like the selection box for torches
1236 -- (wallmounted param2 is used, if applicable)
1237 type = "wallmounted",
1243 -- A node that has optional boxes depending on neighbouring nodes'
1244 -- presence and type. See also `connects_to`.
1246 fixed = box OR {box1, box2, ...}
1247 connect_top = box OR {box1, box2, ...}
1248 connect_bottom = box OR {box1, box2, ...}
1249 connect_front = box OR {box1, box2, ...}
1250 connect_left = box OR {box1, box2, ...}
1251 connect_back = box OR {box1, box2, ...}
1252 connect_right = box OR {box1, box2, ...}
1253 -- The following `disconnected_*` boxes are the opposites of the
1254 -- `connect_*` ones above, i.e. when a node has no suitable neighbour
1255 -- on the respective side, the corresponding disconnected box is drawn.
1256 disconnected_top = box OR {box1, box2, ...}
1257 disconnected_bottom = box OR {box1, box2, ...}
1258 disconnected_front = box OR {box1, box2, ...}
1259 disconnected_left = box OR {box1, box2, ...}
1260 disconnected_back = box OR {box1, box2, ...}
1261 disconnected_right = box OR {box1, box2, ...}
1262 disconnected = box OR {box1, box2, ...} -- when there is *no* neighbour
1263 disconnected_sides = box OR {box1, box2, ...} -- when there are *no*
1264 -- neighbours to the sides
1267 A `box` is defined as:
1269 {x1, y1, z1, x2, y2, z2}
1271 A box of a regular node would look like:
1273 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
1278 Map terminology and coordinates
1279 ===============================
1281 Nodes, mapblocks, mapchunks
1282 ---------------------------
1284 A 'node' is the fundamental cubic unit of a world and appears to a player as
1285 roughly 1x1x1 meters in size.
1287 A 'mapblock' (often abbreviated to 'block') is 16x16x16 nodes and is the
1288 fundamental region of a world that is stored in the world database, sent to
1289 clients and handled by many parts of the engine.
1290 'mapblock' is preferred terminology to 'block' to help avoid confusion with
1291 'node', however 'block' often appears in the API.
1293 A 'mapchunk' (sometimes abbreviated to 'chunk') is usually 5x5x5 mapblocks
1294 (80x80x80 nodes) and is the volume of world generated in one operation by
1296 The size in mapblocks has been chosen to optimise map generation.
1301 ### Orientation of axes
1303 For node and mapblock coordinates, +X is East, +Y is up, +Z is North.
1305 ### Node coordinates
1307 Almost all positions used in the API use node coordinates.
1309 ### Mapblock coordinates
1311 Occasionally the API uses 'blockpos' which refers to mapblock coordinates that
1312 specify a particular mapblock.
1313 For example blockpos (0,0,0) specifies the mapblock that extends from
1314 node position (0,0,0) to node position (15,15,15).
1316 #### Converting node position to the containing blockpos
1318 To calculate the blockpos of the mapblock that contains the node at 'nodepos',
1321 * blockpos = math.floor(nodepos / 16)
1323 #### Converting blockpos to min/max node positions
1325 To calculate the min/max node positions contained in the mapblock at 'blockpos',
1329 nodepos = blockpos * 16
1331 nodepos = blockpos * 16 + 15
1342 The position field is used for all element types.
1344 To account for differing resolutions, the position coordinates are the
1345 percentage of the screen, ranging in value from `0` to `1`.
1347 The name field is not yet used, but should contain a description of what the
1348 HUD element represents.
1350 The `direction` field is the direction in which something is drawn.
1351 `0` draws from left to right, `1` draws from right to left, `2` draws from
1352 top to bottom, and `3` draws from bottom to top.
1354 The `alignment` field specifies how the item will be aligned. It is a table
1355 where `x` and `y` range from `-1` to `1`, with `0` being central. `-1` is
1356 moved to the left/up, and `1` is to the right/down. Fractional values can be
1359 The `offset` field specifies a pixel offset from the position. Contrary to
1360 position, the offset is not scaled to screen size. This allows for some
1361 precisely positioned items in the HUD.
1363 **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
1366 The `z_index` field specifies the order of HUD elements from back to front.
1367 Lower z-index elements are displayed behind higher z-index elements. Elements
1368 with same z-index are displayed in an arbitrary order. Default 0.
1369 Supports negative values. By convention, the following values are recommended:
1371 * -400: Graphical effects, such as vignette
1372 * -300: Name tags, waypoints
1374 * -100: Things that block the player's view, e.g. masks
1375 * 0: Default. For standard in-game HUD elements like crosshair, hotbar,
1376 minimap, builtin statbars, etc.
1377 * 100: Temporary text messages or notification icons
1378 * 1000: Full-screen effects such as full-black screen or credits.
1379 This includes effects that cover the entire screen
1380 * Other: If your HUD element doesn't fit into any category, pick a number
1381 between the suggested values
1385 Below are the specific uses for fields in each type; fields not listed for that
1390 Displays an image on the HUD.
1392 * `scale`: The scale of the image, with 1 being the original texture size.
1393 Only the X coordinate scale is used (positive values).
1394 Negative values represent that percentage of the screen it
1395 should take; e.g. `x=-100` means 100% (width).
1396 * `text`: The name of the texture that is displayed.
1397 * `alignment`: The alignment of the image.
1398 * `offset`: offset in pixels from position.
1402 Displays text on the HUD.
1404 * `scale`: Defines the bounding rectangle of the text.
1405 A value such as `{x=100, y=100}` should work.
1406 * `text`: The text to be displayed in the HUD element.
1407 * `number`: An integer containing the RGB value of the color used to draw the
1408 text. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
1409 * `alignment`: The alignment of the text.
1410 * `offset`: offset in pixels from position.
1411 * `size`: size of the text.
1412 The player-set font size is multiplied by size.x (y value isn't used).
1416 Displays a horizontal bar made up of half-images with an optional background.
1418 * `text`: The name of the texture to use.
1419 * `text2`: Optional texture name to enable a background / "off state"
1420 texture (useful to visualize the maximal value). Both textures
1421 must have the same size.
1422 * `number`: The number of half-textures that are displayed.
1423 If odd, will end with a vertically center-split texture.
1424 * `item`: Same as `number` but for the "off state" texture
1425 * `direction`: To which direction the images will extend to
1426 * `offset`: offset in pixels from position.
1427 * `size`: If used, will force full-image size to this value (override texture
1432 * `text`: The name of the inventory list to be displayed.
1433 * `number`: Number of items in the inventory to be displayed.
1434 * `item`: Position of item that is selected.
1436 * `offset`: offset in pixels from position.
1440 Displays distance to selected world position.
1442 * `name`: The name of the waypoint.
1443 * `text`: Distance suffix. Can be blank.
1444 * `precision`: Waypoint precision, integer >= 0. Defaults to 10.
1445 If set to 0, distance is not shown. Shown value is `floor(distance*precision)/precision`.
1446 When the precision is an integer multiple of 10, there will be `log_10(precision)` digits after the decimal point.
1447 `precision = 1000`, for example, will show 3 decimal places (eg: `0.999`).
1448 `precision = 2` will show multiples of `0.5`; precision = 5 will show multiples of `0.2` and so on:
1449 `precision = n` will show multiples of `1/n`
1450 * `number:` An integer containing the RGB value of the color used to draw the
1452 * `world_pos`: World position of the waypoint.
1453 * `offset`: offset in pixels from position.
1454 * `alignment`: The alignment of the waypoint.
1456 ### `image_waypoint`
1458 Same as `image`, but does not accept a `position`; the position is instead determined by `world_pos`, the world position of the waypoint.
1460 * `scale`: The scale of the image, with 1 being the original texture size.
1461 Only the X coordinate scale is used (positive values).
1462 Negative values represent that percentage of the screen it
1463 should take; e.g. `x=-100` means 100% (width).
1464 * `text`: The name of the texture that is displayed.
1465 * `alignment`: The alignment of the image.
1466 * `world_pos`: World position of the waypoint.
1467 * `offset`: offset in pixels from position.
1471 Displays an image oriented or translated according to current heading direction.
1473 * `size`: The size of this element. Negative values represent percentage
1474 of the screen; e.g. `x=-100` means 100% (width).
1475 * `scale`: Scale of the translated image (used only for dir = 2 or dir = 3).
1476 * `text`: The name of the texture to use.
1477 * `alignment`: The alignment of the image.
1478 * `offset`: Offset in pixels from position.
1479 * `dir`: How the image is rotated/translated:
1480 * 0 - Rotate as heading direction
1481 * 1 - Rotate in reverse direction
1482 * 2 - Translate as landscape direction
1483 * 3 - Translate in reverse direction
1485 If translation is chosen, texture is repeated horizontally to fill the whole element.
1487 Representations of simple things
1488 ================================
1493 {x=num, y=num, z=num}
1495 For helper functions see [Spatial Vectors].
1500 * `{type="nothing"}`
1501 * `{type="node", under=pos, above=pos}`
1502 * Indicates a pointed node selection box.
1503 * `under` refers to the node position behind the pointed face.
1504 * `above` refers to the node position in front of the pointed face.
1505 * `{type="object", ref=ObjectRef}`
1507 Exact pointing location (currently only `Raycast` supports these fields):
1509 * `pointed_thing.intersection_point`: The absolute world coordinates of the
1510 point on the selection box which is pointed at. May be in the selection box
1511 if the pointer is in the box too.
1512 * `pointed_thing.box_id`: The ID of the pointed selection box (counting starts
1514 * `pointed_thing.intersection_normal`: Unit vector, points outwards of the
1515 selected selection box. This specifies which face is pointed at.
1516 Is a null vector `{x = 0, y = 0, z = 0}` when the pointer is inside the
1522 Flag Specifier Format
1523 =====================
1525 Flags using the standardized flag specifier format can be specified in either
1526 of two ways, by string or table.
1528 The string format is a comma-delimited set of flag names; whitespace and
1529 unrecognized flag fields are ignored. Specifying a flag in the string sets the
1530 flag, and specifying a flag prefixed by the string `"no"` explicitly
1531 clears the flag from whatever the default may be.
1533 In addition to the standard string flag format, the schematic flags field can
1534 also be a table of flag names to boolean values representing whether or not the
1535 flag is set. Additionally, if a field with the flag name prefixed with `"no"`
1536 is present, mapped to a boolean of any value, the specified flag is unset.
1538 E.g. A flag field of value
1540 {place_center_x = true, place_center_y=false, place_center_z=true}
1544 {place_center_x = true, noplace_center_y=true, place_center_z=true}
1546 which is equivalent to
1548 "place_center_x, noplace_center_y, place_center_z"
1552 "place_center_x, place_center_z"
1554 since, by default, no schematic attributes are set.
1565 There are three kinds of items: nodes, tools and craftitems.
1567 * Node: Can be placed in the world's voxel grid
1568 * Tool: Has a wear property but cannot be stacked. The default use action is to
1569 dig nodes or hit objects according to its tool capabilities.
1570 * Craftitem: Cannot dig nodes or be placed
1575 All item stacks have an amount between 0 and 65535. It is 1 by
1576 default. Tool item stacks can not have an amount greater than 1.
1578 Tools use a wear (damage) value ranging from 0 to 65535. The
1579 value 0 is the default and is used for unworn tools. The values
1580 1 to 65535 are used for worn tools, where a higher value stands for
1581 a higher wear. Non-tools always have a wear value of 0.
1586 Items and item stacks can exist in three formats: Serializes, table format
1589 When an item must be passed to a function, it can usually be in any of
1594 This is called "stackstring" or "itemstring". It is a simple string with
1595 1-3 components: the full item identifier, an optional amount and an optional
1598 <identifier> [<amount>[ <wear>]]
1602 * `'default:apple'`: 1 apple
1603 * `'default:dirt 5'`: 5 dirt
1604 * `'default:pick_stone'`: a new stone pickaxe
1605 * `'default:pick_wood 1 21323'`: a wooden pickaxe, ca. 1/3 worn out
1613 {name="default:dirt", count=5, wear=0, metadata=""}
1615 A wooden pick about 1/3 worn out:
1617 {name="default:pick_wood", count=1, wear=21323, metadata=""}
1621 {name="default:apple", count=1, wear=0, metadata=""}
1625 A native C++ format with many helper methods. Useful for converting
1626 between formats. See the [Class reference] section for details.
1634 In a number of places, there is a group table. Groups define the
1635 properties of a thing (item, node, armor of entity, capabilities of
1636 tool) in such a way that the engine and other mods can can interact with
1637 the thing without actually knowing what the thing is.
1642 Groups are stored in a table, having the group names with keys and the
1643 group ratings as values. Group ratings are integer values within the
1644 range [-32767, 32767]. For example:
1647 groups = {crumbly=3, soil=1}
1649 -- A more special dirt-kind of thing
1650 groups = {crumbly=2, soil=1, level=2, outerspace=1}
1652 Groups always have a rating associated with them. If there is no
1653 useful meaning for a rating for an enabled group, it shall be `1`.
1655 When not defined, the rating of a group defaults to `0`. Thus when you
1656 read groups, you must interpret `nil` and `0` as the same value, `0`.
1658 You can read the rating of a group for an item or a node by using
1660 minetest.get_item_group(itemname, groupname)
1665 Groups of items can define what kind of an item it is (e.g. wool).
1670 In addition to the general item things, groups are used to define whether
1671 a node is destroyable and how long it takes to destroy by a tool.
1676 For entities, groups are, as of now, used only for calculating damage.
1677 The rating is the percentage of damage caused by tools with this damage group.
1678 See [Entity damage mechanism].
1680 object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
1681 object.set_armor_groups({fleshy=30, cracky=80})
1686 Groups in tools define which groups of nodes and entities they are
1689 Groups in crafting recipes
1690 --------------------------
1692 An example: Make meat soup from any meat, any water and any bowl:
1695 output = 'food:meat_soup_raw',
1701 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
1704 Another example: Make red wool from white wool and red dye:
1708 output = 'wool:red',
1709 recipe = {'wool:white', 'group:dye,basecolor_red'},
1715 The asterisk `(*)` after a group name describes that there is no engine
1716 functionality bound to it, and implementation is left up as a suggestion
1719 ### Node, item and tool groups
1721 * `not_in_creative_inventory`: (*) Special group for inventory mods to indicate
1722 that the item should be hidden in item lists.
1725 ### Node-only groups
1727 * `attached_node`: if the node under it is not a walkable block the node will be
1728 dropped as an item. If the node is wallmounted the wallmounted direction is
1730 * `bouncy`: value is bounce speed in percent
1731 * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
1732 connect to each other
1733 * `dig_immediate`: Player can always pick up node without reducing tool wear
1734 * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
1735 * `3`: the node always gets the digging time 0 seconds (torch)
1736 * `disable_jump`: Player (and possibly other things) cannot jump from node
1737 or if their feet are in the node. Note: not supported for `new_move = false`
1738 * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
1739 * `falling_node`: if there is no walkable block under the node it will fall
1740 * `float`: the node will not fall through liquids
1741 * `level`: Can be used to give an additional sense of progression in the game.
1742 * A larger level will cause e.g. a weapon of a lower level make much less
1743 damage, and get worn out much faster, or not be able to get drops
1744 from destroyed nodes.
1745 * `0` is something that is directly accessible at the start of gameplay
1746 * There is no upper limit
1747 * See also: `leveldiff` in [Tools]
1748 * `slippery`: Players and items will slide on the node.
1749 Slipperiness rises steadily with `slippery` value, starting at 1.
1752 ### Tool-only groups
1754 * `disable_repair`: If set to 1 for a tool, it cannot be repaired using the
1755 `"toolrepair"` crafting recipe
1758 ### `ObjectRef` groups
1760 * `immortal`: Skips all damage and breath handling for an object. This group
1761 will also hide the integrated HUD status bars for players, and is
1762 automatically set to all players when damage is disabled on the server.
1763 * `punch_operable`: For entities; disables the regular damage mechanism for
1764 players punching it by hand or a non-tool item, so that it can do something
1765 else than take damage.
1769 Known damage and digging time defining groups
1770 ---------------------------------------------
1772 * `crumbly`: dirt, sand
1773 * `cracky`: tough but crackable stuff like stone.
1774 * `snappy`: something that can be cut using fine tools; e.g. leaves, small
1775 plants, wire, sheets of metal
1776 * `choppy`: something that can be cut using force; e.g. trees, wooden planks
1777 * `fleshy`: Living things like animals and the player. This could imply
1778 some blood effects when hitting.
1779 * `explody`: Especially prone to explosions
1780 * `oddly_breakable_by_hand`:
1781 Can be added to nodes that shouldn't logically be breakable by the
1782 hand but are. Somewhat similar to `dig_immediate`, but times are more
1783 like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
1784 speed of a tool if the tool can dig at a faster speed than this
1785 suggests for the hand.
1787 Examples of custom groups
1788 -------------------------
1790 Item groups are often used for defining, well, _groups of items_.
1792 * `meat`: any meat-kind of a thing (rating might define the size or healing
1793 ability or be irrelevant -- it is not defined as of yet)
1794 * `eatable`: anything that can be eaten. Rating might define HP gain in half
1796 * `flammable`: can be set on fire. Rating might define the intensity of the
1797 fire, affecting e.g. the speed of the spreading of an open fire.
1798 * `wool`: any wool (any origin, any color)
1799 * `metal`: any metal
1800 * `weapon`: any weapon
1801 * `heavy`: anything considerably heavy
1803 Digging time calculation specifics
1804 ----------------------------------
1806 Groups such as `crumbly`, `cracky` and `snappy` are used for this
1807 purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
1808 faster digging time.
1810 The `level` group is used to limit the toughness of nodes a tool can dig
1811 and to scale the digging times / damage to a greater extent.
1813 **Please do understand this**, otherwise you cannot use the system to it's
1816 Tools define their properties by a list of parameters for groups. They
1817 cannot dig other groups; thus it is important to use a standard bunch of
1818 groups to enable interaction with tools.
1831 * Full punch interval
1832 * Maximum drop level
1833 * For an arbitrary list of groups:
1834 * Uses (until the tool breaks)
1835 * Maximum level (usually `0`, `1`, `2` or `3`)
1839 ### Full punch interval
1841 When used as a weapon, the tool will do full damage if this time is spent
1842 between punches. If e.g. half the time is spent, the tool will do half
1845 ### Maximum drop level
1847 Suggests the maximum level of node, when dug with the tool, that will drop
1848 it's useful item. (e.g. iron ore to drop a lump of iron).
1850 This is not automated; it is the responsibility of the node definition
1855 Determines how many uses the tool has when it is used for digging a node,
1856 of this group, of the maximum level. For lower leveled nodes, the use count
1857 is multiplied by `3^leveldiff`.
1858 `leveldiff` is the difference of the tool's `maxlevel` `groupcaps` and the
1859 node's `level` group. The node cannot be dug if `leveldiff` is less than zero.
1861 * `uses=10, leveldiff=0`: actual uses: 10
1862 * `uses=10, leveldiff=1`: actual uses: 30
1863 * `uses=10, leveldiff=2`: actual uses: 90
1867 Tells what is the maximum level of a node of this group that the tool will
1872 List of digging times for different ratings of the group, for nodes of the
1875 For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
1876 result in the tool to be able to dig nodes that have a rating of `2` or `3`
1877 for this group, and unable to dig the rating `1`, which is the toughest.
1878 Unless there is a matching group that enables digging otherwise.
1880 If the result digging time is 0, a delay of 0.15 seconds is added between
1881 digging nodes; If the player releases LMB after digging, this delay is set to 0,
1882 i.e. players can more quickly click the nodes away instead of holding LMB.
1886 List of damage for groups of entities. See [Entity damage mechanism].
1888 Example definition of the capabilities of a tool
1889 ------------------------------------------------
1891 tool_capabilities = {
1892 full_punch_interval=1.5,
1895 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
1897 damage_groups = {fleshy=2},
1900 This makes the tool be able to dig nodes that fulfil both of these:
1902 * Have the `crumbly` group
1903 * Have a `level` group less or equal to `2`
1905 Table of resulting digging times:
1907 crumbly 0 1 2 3 4 <- level
1909 1 0.80 1.60 1.60 - -
1910 2 0.60 1.20 1.20 - -
1911 3 0.40 0.80 0.80 - -
1913 level diff: 2 1 0 -1 -2
1915 Table of resulting tool uses:
1924 * At `crumbly==0`, the node is not diggable.
1925 * At `crumbly==3`, the level difference digging time divider kicks in and makes
1926 easy nodes to be quickly breakable.
1927 * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
1932 Entity damage mechanism
1933 =======================
1938 foreach group in cap.damage_groups:
1939 damage += cap.damage_groups[group]
1940 * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
1941 * (object.armor_groups[group] / 100.0)
1942 -- Where object.armor_groups[group] is 0 for inexistent values
1945 Client predicts damage based on damage groups. Because of this, it is able to
1946 give an immediate response when an entity is damaged or dies; the response is
1947 pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
1949 Currently a smoke puff will appear when an entity dies.
1951 The group `immortal` completely disables normal damage.
1953 Entities can define a special armor group, which is `punch_operable`. This
1954 group disables the regular damage mechanism for players punching it by hand or
1955 a non-tool item, so that it can do something else than take damage.
1957 On the Lua side, every punch calls:
1959 entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction,
1962 This should never be called directly, because damage is usually not handled by
1965 * `puncher` is the object performing the punch. Can be `nil`. Should never be
1966 accessed unless absolutely required, to encourage interoperability.
1967 * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
1968 * `tool_capabilities` can be `nil`.
1969 * `direction` is a unit vector, pointing from the source of the punch to
1971 * `damage` damage that will be done to entity
1972 Return value of this function will determine if damage is done by this function
1973 (retval true) or shall be done by engine (retval false)
1975 To punch an entity/object in Lua, call:
1977 object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
1979 * Return value is tool wear.
1980 * Parameters are equal to the above callback.
1981 * If `direction` equals `nil` and `puncher` does not equal `nil`, `direction`
1982 will be automatically filled in based on the location of `puncher`.
1993 The instance of a node in the world normally only contains the three values
1994 mentioned in [Nodes]. However, it is possible to insert extra data into a node.
1995 It is called "node metadata"; See `NodeMetaRef`.
1997 Node metadata contains two things:
2002 Some of the values in the key-value store are handled specially:
2004 * `formspec`: Defines a right-click inventory menu. See [Formspec].
2005 * `infotext`: Text shown on the screen when the node is pointed at
2009 local meta = minetest.get_meta(pos)
2010 meta:set_string("formspec",
2012 "list[context;main;0,0;8,4;]"..
2013 "list[current_player;main;0,5;8,4;]")
2014 meta:set_string("infotext", "Chest");
2015 local inv = meta:get_inventory()
2016 inv:set_size("main", 8*4)
2017 print(dump(meta:to_table()))
2020 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
2021 [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
2022 [10] = "", [11] = "", [12] = "", [13] = "",
2023 [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
2024 [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
2025 [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
2026 [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
2030 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
2038 Item stacks can store metadata too. See [`ItemStackMetaRef`].
2040 Item metadata only contains a key-value store.
2042 Some of the values in the key-value store are handled specially:
2044 * `description`: Set the item stack's description. Defaults to
2046 * `color`: A `ColorString`, which sets the stack's color.
2047 * `palette_index`: If the item has a palette, this is used to get the
2048 current color from the palette.
2052 local meta = stack:get_meta()
2053 meta:set_string("key", "value")
2054 print(dump(meta:to_table()))
2062 Formspec defines a menu. This supports inventories and some of the
2063 typical widgets like buttons, checkboxes, text input fields, etc.
2064 It is a string, with a somewhat strange format.
2066 A formspec is made out of formspec elements, which includes widgets
2067 like buttons but also can be used to set stuff like background color.
2069 Many formspec elements have a `name`, which is a unique identifier which
2070 is used when the server receives user input. You must not use the name
2071 "quit" for formspec elements.
2073 Spaces and newlines can be inserted between the blocks, as is used in the
2076 Position and size units are inventory slots unless the new coordinate system
2077 is enabled. `X` and `Y` position the formspec element relative to the top left
2078 of the menu or container. `W` and `H` are its width and height values.
2080 If the new system is enabled, all elements have unified coordinates for all
2081 elements with no padding or spacing in between. This is highly recommended
2082 for new forms. See `real_coordinates[<bool>]` and `Migrating to Real
2085 Inventories with a `player:<name>` inventory location are only sent to the
2086 player named `<name>`.
2088 When displaying text which can contain formspec code, e.g. text set by a player,
2089 use `minetest.formspec_escape`.
2090 For coloured text you can use `minetest.colorize`.
2092 Since formspec version 3, elements drawn in the order they are defined. All
2093 background elements are drawn before all other elements.
2095 **WARNING**: do _not_ use a element name starting with `key_`; those names are
2096 reserved to pass key press events to formspec!
2098 **WARNING**: Minetest allows you to add elements to every single formspec instance
2099 using `player:set_formspec_prepend()`, which may be the reason backgrounds are
2100 appearing when you don't expect them to, or why things are styled differently
2101 to normal. See [`no_prepend[]`] and [Styling Formspecs].
2109 list[context;main;0,0;8,4;]
2110 list[current_player;main;0,5;8,4;]
2115 list[context;fuel;2,3;1,1;]
2116 list[context;src;2,1;1,1;]
2117 list[context;dst;5,1;2,2;]
2118 list[current_player;main;0,5;8,4;]
2120 ### Minecraft-like player inventory
2123 image[1,0.6;1,2;player.png]
2124 list[current_player;main;0,3.5;8,4;]
2125 list[current_player;craft;3,0;3,3;]
2126 list[current_player;craftpreview;7,1;1,1;]
2131 ### `formspec_version[<version>]`
2133 * Set the formspec version to a certain number. If not specified,
2134 version 1 is assumed.
2135 * Must be specified before `size` element.
2136 * Clients older than this version can neither show newer elements nor display
2137 elements with new arguments correctly.
2138 * Available since feature `formspec_version_element`.
2140 ### `size[<W>,<H>,<fixed_size>]`
2142 * Define the size of the menu in inventory slots
2143 * `fixed_size`: `true`/`false` (optional)
2144 * deprecated: `invsize[<W>,<H>;]`
2146 ### `position[<X>,<Y>]`
2148 * Must be used after `size` element.
2149 * Defines the position on the game window of the formspec's `anchor` point.
2150 * For X and Y, 0.0 and 1.0 represent opposite edges of the game window,
2152 * [0.0, 0.0] sets the position to the top left corner of the game window.
2153 * [1.0, 1.0] sets the position to the bottom right of the game window.
2154 * Defaults to the center of the game window [0.5, 0.5].
2156 ### `anchor[<X>,<Y>]`
2158 * Must be used after both `size` and `position` (if present) elements.
2159 * Defines the location of the anchor point within the formspec.
2160 * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec,
2162 * [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
2163 * [1.0, 0.0] sets the anchor to the top right of the formspec.
2164 * Defaults to the center of the formspec [0.5, 0.5].
2166 * `position` and `anchor` elements need suitable values to avoid a formspec
2167 extending off the game window due to particular game window sizes.
2171 * Must be used after the `size`, `position`, and `anchor` elements (if present).
2172 * Disables player:set_formspec_prepend() from applying to this formspec.
2174 ### `real_coordinates[<bool>]`
2176 * INFORMATION: Enable it automatically using `formspec_version` version 2 or newer.
2177 * When set to true, all following formspec elements will use the new coordinate system.
2178 * If used immediately after `size`, `position`, `anchor`, and `no_prepend` elements
2179 (if present), the form size will use the new coordinate system.
2180 * **Note**: Formspec prepends are not affected by the coordinates in the main form.
2181 They must enable it explicitly.
2182 * For information on converting forms to the new coordinate system, see `Migrating
2183 to Real Coordinates`.
2185 ### `container[<X>,<Y>]`
2187 * Start of a container block, moves all physical elements in the container by
2189 * Must have matching `container_end`
2190 * Containers can be nested, in which case the offsets are added
2191 (child containers are relative to parent containers)
2193 ### `container_end[]`
2195 * End of a container, following elements are no longer relative to this
2198 ### `scroll_container[<X>,<Y>;<W>,<H>;<scrollbar name>;<orientation>;<scroll factor>]`
2200 * Start of a scroll_container block. All contained elements will ...
2201 * take the scroll_container coordinate as position origin,
2202 * be additionally moved by the current value of the scrollbar with the name
2203 `scrollbar name` times `scroll factor` along the orientation `orientation` and
2204 * be clipped to the rectangle defined by `X`, `Y`, `W` and `H`.
2205 * `orientation`: possible values are `vertical` and `horizontal`.
2206 * `scroll factor`: optional, defaults to `0.1`.
2207 * Nesting is possible.
2208 * Some elements might work a little different if they are in a scroll_container.
2209 * Note: If you want the scroll_container to actually work, you also need to add a
2210 scrollbar element with the specified name. Furthermore, it is highly recommended
2211 to use a scrollbaroptions element on this scrollbar.
2213 ### `scroll_container_end[]`
2215 * End of a scroll_container, following elements are no longer bound to this
2218 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
2220 * Show an inventory list if it has been sent to the client. Nothing will
2221 be shown if the inventory list is of size 0.
2222 * **Note**: With the new coordinate system, the spacing between inventory
2223 slots is one-fourth the size of an inventory slot.
2225 ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
2227 * Show an inventory list if it has been sent to the client. Nothing will
2228 be shown if the inventory list is of size 0.
2229 * **Note**: With the new coordinate system, the spacing between inventory
2230 slots is one-fourth the size of an inventory slot.
2232 ### `listring[<inventory location>;<list name>]`
2234 * Allows to create a ring of inventory lists
2235 * Shift-clicking on items in one element of the ring
2236 will send them to the next inventory list inside the ring
2237 * The first occurrence of an element inside the ring will
2238 determine the inventory where items will be sent to
2242 * Shorthand for doing `listring[<inventory location>;<list name>]`
2243 for the last two inventory lists added by list[...]
2245 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
2247 * Sets background color of slots as `ColorString`
2248 * Sets background color of slots on mouse hovering
2250 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
2252 * Sets background color of slots as `ColorString`
2253 * Sets background color of slots on mouse hovering
2254 * Sets color of slots border
2256 ### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
2258 * Sets background color of slots as `ColorString`
2259 * Sets background color of slots on mouse hovering
2260 * Sets color of slots border
2261 * Sets default background color of tooltips
2262 * Sets default font color of tooltips
2264 ### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2266 * Adds tooltip for an element
2267 * `bgcolor` tooltip background color as `ColorString` (optional)
2268 * `fontcolor` tooltip font color as `ColorString` (optional)
2270 ### `tooltip[<X>,<Y>;<W>,<H>;<tooltip_text>;<bgcolor>;<fontcolor>]`
2272 * Adds tooltip for an area. Other tooltips will take priority when present.
2273 * `bgcolor` tooltip background color as `ColorString` (optional)
2274 * `fontcolor` tooltip font color as `ColorString` (optional)
2276 ### `image[<X>,<Y>;<W>,<H>;<texture name>]`
2280 ### `animated_image[<X>,<Y>;<W>,<H>;<name>;<texture name>;<frame count>;<frame duration>;<frame start>]`
2282 * Show an animated image. The image is drawn like a "vertical_frames" tile
2283 animation (See [Tile animation definition]), but uses a frame count/duration
2285 * `name`: Element name to send when an event occurs. The event value is the index of the current frame.
2286 * `texture name`: The image to use.
2287 * `frame count`: The number of frames animating the image.
2288 * `frame duration`: Milliseconds between each frame. `0` means the frames don't advance.
2289 * `frame start` (Optional): The index of the frame to start on. Default `1`.
2291 ### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
2293 * Show an inventory image of registered item/node
2295 ### `bgcolor[<bgcolor>;<fullscreen>;<fbgcolor>]`
2297 * Sets background color of formspec.
2298 * `bgcolor` and `fbgcolor` (optional) are `ColorString`s, they define the color
2299 of the non-fullscreen and the fullscreen background.
2300 * `fullscreen` (optional) can be one of the following:
2301 * `false`: Only the non-fullscreen background color is drawn. (default)
2302 * `true`: Only the fullscreen background color is drawn.
2303 * `both`: The non-fullscreen and the fullscreen background color are drawn.
2304 * `neither`: No background color is drawn.
2305 * Note: Leave a parameter empty to not modify the value.
2306 * Note: `fbgcolor`, leaving parameters empty and values for `fullscreen` that
2307 are not bools are only available since formspec version 3.
2309 ### `background[<X>,<Y>;<W>,<H>;<texture name>]`
2311 * Example for formspec 8x4 in 16x resolution: image shall be sized
2312 8 times 16px times 4 times 16px.
2314 ### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
2316 * Example for formspec 8x4 in 16x resolution:
2317 image shall be sized 8 times 16px times 4 times 16px
2318 * If `auto_clip` is `true`, the background is clipped to the formspec size
2319 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2321 ### `background9[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>;<middle>]`
2323 * 9-sliced background. See https://en.wikipedia.org/wiki/9-slice_scaling
2324 * Middle is a rect which defines the middle of the 9-slice.
2325 * `x` - The middle will be x pixels from all sides.
2326 * `x,y` - The middle will be x pixels from the horizontal and y from the vertical.
2327 * `x,y,x2,y2` - The middle will start at x,y, and end at x2, y2. Negative x2 and y2 values
2328 will be added to the width and height of the texture, allowing it to be used as the
2329 distance from the far end.
2330 * All numbers in middle are integers.
2331 * Example for formspec 8x4 in 16x resolution:
2332 image shall be sized 8 times 16px times 4 times 16px
2333 * If `auto_clip` is `true`, the background is clipped to the formspec size
2334 (`x` and `y` are used as offset values, `w` and `h` are ignored)
2335 * Available since formspec version 2
2337 ### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
2339 * Textual password style field; will be sent to server when a button is clicked
2340 * When enter is pressed in field, fields.key_enter_field will be sent with the
2342 * With the old coordinate system, fields are a set height, but will be vertically
2343 centred on `H`. With the new coordinate system, `H` will modify the height.
2344 * `name` is the name of the field as returned in fields to `on_receive_fields`
2345 * `label`, if not blank, will be text printed on the top left above the field
2346 * See `field_close_on_enter` to stop enter closing the formspec
2348 ### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2350 * Textual field; will be sent to server when a button is clicked
2351 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2352 the name of this field.
2353 * With the old coordinate system, fields are a set height, but will be vertically
2354 centred on `H`. With the new coordinate system, `H` will modify the height.
2355 * `name` is the name of the field as returned in fields to `on_receive_fields`
2356 * `label`, if not blank, will be text printed on the top left above the field
2357 * `default` is the default value of the field
2358 * `default` may contain variable references such as `${text}` which
2359 will fill the value from the metadata value `text`
2360 * **Note**: no extra text or more than a single variable is supported ATM.
2361 * See `field_close_on_enter` to stop enter closing the formspec
2363 ### `field[<name>;<label>;<default>]`
2365 * As above, but without position/size units
2366 * When enter is pressed in field, `fields.key_enter_field` will be sent with
2367 the name of this field.
2368 * Special field for creating simple forms, such as sign text input
2369 * Must be used without a `size[]` element
2370 * A "Proceed" button will be added automatically
2371 * See `field_close_on_enter` to stop enter closing the formspec
2373 ### `field_close_on_enter[<name>;<close_on_enter>]`
2375 * <name> is the name of the field
2376 * if <close_on_enter> is false, pressing enter in the field will submit the
2377 form but not close it.
2378 * defaults to true when not specified (ie: no tag for a field)
2380 ### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
2382 * Same as fields above, but with multi-line input
2383 * If the text overflows, a vertical scrollbar is added.
2384 * If the name is empty, the textarea is read-only and
2385 the background is not shown, which corresponds to a multi-line label.
2387 ### `label[<X>,<Y>;<label>]`
2389 * The label formspec element displays the text set in `label`
2390 at the specified position.
2391 * **Note**: If the new coordinate system is enabled, labels are
2392 positioned from the center of the text, not the top.
2393 * The text is displayed directly without automatic line breaking,
2394 so label should not be used for big text chunks. Newlines can be
2395 used to make labels multiline.
2396 * **Note**: With the new coordinate system, newlines are spaced with
2397 half a coordinate. With the old system, newlines are spaced 2/5 of
2400 ### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]`
2401 * Displays a static formatted text with hyperlinks.
2402 * **Note**: This element is currently unstable and subject to change.
2403 * `x`, `y`, `w` and `h` work as per field
2404 * `name` is the name of the field as returned in fields to `on_receive_fields` in case of action in text.
2405 * `text` is the formatted text using `Markup Language` described below.
2407 ### `vertlabel[<X>,<Y>;<label>]`
2408 * Textual label drawn vertically
2409 * `label` is the text on the label
2410 * **Note**: If the new coordinate system is enabled, vertlabels are
2411 positioned from the center of the text, not the left.
2413 ### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
2415 * Clickable button. When clicked, fields will be sent.
2416 * With the old coordinate system, buttons are a set height, but will be vertically
2417 centred on `H`. With the new coordinate system, `H` will modify the height.
2418 * `label` is the text on the button
2420 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2422 * `texture name` is the filename of an image
2423 * **Note**: Height is supported on both the old and new coordinate systems
2426 ### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
2428 * `texture name` is the filename of an image
2429 * `noclip=true` means the image button doesn't need to be within specified
2431 * `drawborder`: draw button border or not
2432 * `pressed texture name` is the filename of an image on pressed state
2434 ### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
2436 * `item name` is the registered name of an item/node
2437 * The item description will be used as the tooltip. This can be overridden with
2440 ### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
2442 * When clicked, fields will be sent and the form will quit.
2443 * Same as `button` in all other respects.
2445 ### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
2447 * When clicked, fields will be sent and the form will quit.
2448 * Same as `image_button` in all other respects.
2450 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
2452 * Scrollable item list showing arbitrary text elements
2453 * `name` fieldname sent to server on doubleclick value is current selected
2455 * `listelements` can be prepended by #color in hexadecimal format RRGGBB
2457 * if you want a listelement to start with "#" write "##".
2459 ### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
2461 * Scrollable itemlist showing arbitrary text elements
2462 * `name` fieldname sent to server on doubleclick value is current selected
2464 * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
2465 * if you want a listelement to start with "#" write "##"
2466 * Index to be selected within textlist
2467 * `true`/`false`: draw transparent background
2468 * See also `minetest.explode_textlist_event`
2469 (main menu: `core.explode_textlist_event`).
2471 ### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2473 * Show a tab**header** at specific position (ignores formsize)
2474 * `X` and `Y`: position of the tabheader
2475 * *Note*: Width and height are automatically chosen with this syntax
2476 * `name` fieldname data is transferred to Lua
2477 * `caption 1`...: name shown on top of tab
2478 * `current_tab`: index of selected tab 1...
2479 * `transparent` (optional): if true, tabs are semi-transparent
2480 * `draw_border` (optional): if true, draw a thin line at tab base
2482 ### `tabheader[<X>,<Y>;<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2484 * Show a tab**header** at specific position (ignores formsize)
2485 * **Important note**: This syntax for tabheaders can only be used with the
2486 new coordinate system.
2487 * `X` and `Y`: position of the tabheader
2488 * `H`: height of the tabheader. Width is automatically determined with this syntax.
2489 * `name` fieldname data is transferred to Lua
2490 * `caption 1`...: name shown on top of tab
2491 * `current_tab`: index of selected tab 1...
2492 * `transparent` (optional): show transparent
2493 * `draw_border` (optional): draw border
2495 ### `tabheader[<X>,<Y>;<W>,<H>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
2497 * Show a tab**header** at specific position (ignores formsize)
2498 * **Important note**: This syntax for tabheaders can only be used with the
2499 new coordinate system.
2500 * `X` and `Y`: position of the tabheader
2501 * `W` and `H`: width and height of the tabheader
2502 * `name` fieldname data is transferred to Lua
2503 * `caption 1`...: name shown on top of tab
2504 * `current_tab`: index of selected tab 1...
2505 * `transparent` (optional): show transparent
2506 * `draw_border` (optional): draw border
2508 ### `box[<X>,<Y>;<W>,<H>;<color>]`
2510 * Simple colored box
2511 * `color` is color specified as a `ColorString`.
2512 If the alpha component is left blank, the box will be semitransparent.
2513 If the color is not specified, the box will use the options specified by
2514 its style. If the color is specified, all styling options will be ignored.
2516 ### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
2518 * Show a dropdown field
2519 * **Important note**: There are two different operation modes:
2520 1. handle directly on change (only changed dropdown is submitted)
2521 2. read the value on pressing a button (all dropdown values are available)
2522 * `X` and `Y`: position of the dropdown
2523 * `W`: width of the dropdown. Height is automatically chosen with this syntax.
2524 * Fieldname data is transferred to Lua
2525 * Items to be shown in dropdown
2526 * Index of currently selected dropdown item
2527 * `index event` (optional, allowed parameter since formspec version 4): Specifies the
2528 event field value for selected items.
2529 * `true`: Selected item index
2530 * `false` (default): Selected item value
2532 ### `dropdown[<X>,<Y>;<W>,<H>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
2534 * Show a dropdown field
2535 * **Important note**: This syntax for dropdowns can only be used with the
2536 new coordinate system.
2537 * **Important note**: There are two different operation modes:
2538 1. handle directly on change (only changed dropdown is submitted)
2539 2. read the value on pressing a button (all dropdown values are available)
2540 * `X` and `Y`: position of the dropdown
2541 * `W` and `H`: width and height of the dropdown
2542 * Fieldname data is transferred to Lua
2543 * Items to be shown in dropdown
2544 * Index of currently selected dropdown item
2545 * `index event` (optional, allowed parameter since formspec version 4): Specifies the
2546 event field value for selected items.
2547 * `true`: Selected item index
2548 * `false` (default): Selected item value
2550 ### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
2553 * `name` fieldname data is transferred to Lua
2554 * `label` to be shown left of checkbox
2555 * `selected` (optional): `true`/`false`
2556 * **Note**: If the new coordinate system is enabled, checkboxes are
2557 positioned from the center of the checkbox, not the top.
2559 ### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
2561 * Show a scrollbar using options defined by the previous `scrollbaroptions[]`
2562 * There are two ways to use it:
2563 1. handle the changed event (only changed scrollbar is available)
2564 2. read the value on pressing a button (all scrollbars are available)
2565 * `orientation`: `vertical`/`horizontal`. Default horizontal.
2566 * Fieldname data is transferred to Lua
2567 * Value of this trackbar is set to (`0`-`1000`) by default
2568 * See also `minetest.explode_scrollbar_event`
2569 (main menu: `core.explode_scrollbar_event`).
2571 ### `scrollbaroptions[opt1;opt2;...]`
2572 * Sets options for all following `scrollbar[]` elements
2574 * Sets scrollbar minimum value, defaults to `0`.
2576 * Sets scrollbar maximum value, defaults to `1000`.
2577 If the max is equal to the min, the scrollbar will be disabled.
2579 * Sets scrollbar step value when the arrows are clicked or the mouse wheel is
2581 * If this is set to a negative number, the value will be reset to `10`.
2583 * Sets scrollbar step value used by page up and page down.
2584 * If this is set to a negative number, the value will be reset to `100`.
2586 * Sets size of the thumb on the scrollbar. Size is calculated in the number of
2587 units the thumb spans out of the range of the scrollbar values.
2588 * Example: If a scrollbar has a `min` of 1 and a `max` of 100, a thumbsize of 10
2589 would span a tenth of the scrollbar space.
2590 * If this is set to zero or less, the value will be reset to `1`.
2591 * `arrows=<show/hide/default>`
2592 * Whether to show the arrow buttons on the scrollbar. `default` hides the arrows
2593 when the scrollbar gets too small, but shows them otherwise.
2595 ### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
2597 * Show scrollable table using options defined by the previous `tableoptions[]`
2598 * Displays cells as defined by the previous `tablecolumns[]`
2599 * `name`: fieldname sent to server on row select or doubleclick
2600 * `cell 1`...`cell n`: cell contents given in row-major order
2601 * `selected idx`: index of row to be selected within table (first row = `1`)
2602 * See also `minetest.explode_table_event`
2603 (main menu: `core.explode_table_event`).
2605 ### `tableoptions[<opt 1>;<opt 2>;...]`
2607 * Sets options for `table[]`
2609 * default text color (`ColorString`), defaults to `#FFFFFF`
2610 * `background=#RRGGBB`
2611 * table background color (`ColorString`), defaults to `#000000`
2612 * `border=<true/false>`
2613 * should the table be drawn with a border? (default: `true`)
2614 * `highlight=#RRGGBB`
2615 * highlight background color (`ColorString`), defaults to `#466432`
2616 * `highlight_text=#RRGGBB`
2617 * highlight text color (`ColorString`), defaults to `#FFFFFF`
2618 * `opendepth=<value>`
2619 * all subtrees up to `depth < value` are open (default value = `0`)
2620 * only useful when there is a column of type "tree"
2622 ### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
2624 * Sets columns for `table[]`
2625 * Types: `text`, `image`, `color`, `indent`, `tree`
2626 * `text`: show cell contents as text
2627 * `image`: cell contents are an image index, use column options to define
2629 * `color`: cell contents are a ColorString and define color of following
2631 * `indent`: cell contents are a number and define indentation of following
2633 * `tree`: same as indent, but user can open and close subtrees
2637 * for `text` and `image`: content alignment within cells.
2638 Available values: `left` (default), `center`, `right`, `inline`
2640 * for `text` and `image`: minimum width in em (default: `0`)
2641 * for `indent` and `tree`: indent width in em (default: `1.5`)
2642 * `padding=<value>`: padding left of the column, in em (default `0.5`).
2643 Exception: defaults to 0 for indent columns
2644 * `tooltip=<value>`: tooltip text (default: empty)
2645 * `image` column options:
2646 * `0=<value>` sets image for image index 0
2647 * `1=<value>` sets image for image index 1
2648 * `2=<value>` sets image for image index 2
2649 * and so on; defined indices need not be contiguous empty or
2650 non-numeric cells are treated as `0`.
2651 * `color` column options:
2652 * `span=<value>`: number of following columns to affect
2653 (default: infinite).
2655 ### `style[<selector 1>,<selector 2>;<prop1>;<prop2>;...]`
2657 * Set the style for the element(s) matching `selector` by name.
2658 * `selector` can be one of:
2659 * `<name>` - An element name. Includes `*`, which represents every element.
2660 * `<name>:<state>` - An element name, a colon, and one or more states.
2661 * `state` is a list of states separated by the `+` character.
2662 * If a state is provided, the style will only take effect when the element is in that state.
2663 * All provided states must be active for the style to apply.
2664 * Note: this **must** be before the element is defined.
2665 * See [Styling Formspecs].
2668 ### `style_type[<selector 1>,<selector 2>;<prop1>;<prop2>;...]`
2670 * Set the style for the element(s) matching `selector` by type.
2671 * `selector` can be one of:
2672 * `<type>` - An element type. Includes `*`, which represents every element.
2673 * `<type>:<state>` - An element type, a colon, and one or more states.
2674 * `state` is a list of states separated by the `+` character.
2675 * If a state is provided, the style will only take effect when the element is in that state.
2676 * All provided states must be active for the style to apply.
2677 * See [Styling Formspecs].
2679 ### `set_focus[<name>;<force>]`
2681 * Sets the focus to the element with the same `name` parameter.
2682 * **Note**: This element must be placed before the element it focuses.
2683 * `force` (optional, default `false`): By default, focus is not applied for
2684 re-sent formspecs with the same name so that player-set focus is kept.
2685 `true` sets the focus to the specified element for every sent formspec.
2686 * The following elements have the ability to be focused:
2701 Migrating to Real Coordinates
2702 -----------------------------
2704 In the old system, positions included padding and spacing. Padding is a gap between
2705 the formspec window edges and content, and spacing is the gaps between items. For
2706 example, two `1x1` elements at `0,0` and `1,1` would have a spacing of `5/4` between them,
2707 and a padding of `3/8` from the formspec edge. It may be easiest to recreate old layouts
2708 in the new coordinate system from scratch.
2710 To recreate an old layout with padding, you'll need to pass the positions and sizes
2711 through the following formula to re-introduce padding:
2714 pos = (oldpos + 1)*spacing + padding
2720 You'll need to change the `size[]` tag like this:
2723 size = (oldsize-1)*spacing + padding*2 + 1
2726 A few elements had random offsets in the old system. Here is a table which shows these
2727 offsets when migrating:
2729 | Element | Position | Size | Notes
2730 |---------|------------|---------|-------
2731 | box | +0.3, +0.1 | 0, -0.4 |
2732 | button | | | Buttons now support height, so set h = 2 * 15/13 * 0.35, and reposition if h ~= 15/13 * 0.35 before
2733 | list | | | Spacing is now 0.25 for both directions, meaning lists will be taller in height
2734 | label | 0, +0.3 | | The first line of text is now positioned centered exactly at the position specified
2739 Formspec elements can be themed using the style elements:
2741 style[<name 1>,<name 2>;<prop1>;<prop2>;...]
2742 style[<name 1>:<state>,<name 2>:<state>;<prop1>;<prop2>;...]
2743 style_type[<type 1>,<type 2>;<prop1>;<prop2>;...]
2744 style_type[<type 1>:<state>,<type 2>:<state>;<prop1>;<prop2>;...]
2748 property_name=property_value
2752 style_type[button;bgcolor=#006699]
2753 style[world_delete;bgcolor=red;textcolor=yellow]
2754 button[4,3.95;2.6,1;world_delete;Delete]
2756 A name/type can optionally be a comma separated list of names/types, like so:
2758 world_delete,world_create,world_configure
2761 A `*` type can be used to select every element in the formspec.
2763 Any name/type in the list can also be accompanied by a `+`-separated list of states, like so:
2765 world_delete:hovered+pressed
2768 States allow you to apply styles in response to changes in the element, instead of applying at all times.
2770 Setting a property to nothing will reset it to the default value. For example:
2772 style_type[button;bgimg=button.png;bgimg_pressed=button_pressed.png;border=false]
2773 style[btn_exit;bgimg=;bgimg_pressed=;border=;bgcolor=red]
2776 ### Supported Element Types
2778 Some types may inherit styles from parent types.
2780 * animated_image, inherits from image
2783 * button_exit, inherits from button
2791 * pwdfield, inherits from field
2797 * vertlabel, inherits from label
2800 ### Valid Properties
2803 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2805 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2806 * Defaults to false in formspec_version version 3 or higher
2807 * **Note**: `colors`, `bordercolors`, and `borderwidths` accept multiple input types:
2808 * Single value (e.g. `#FF0`): All corners/borders.
2809 * Two values (e.g. `red,#FFAAFF`): top-left and bottom-right,top-right and bottom-left/
2810 top and bottom,left and right.
2811 * Four values (e.g. `blue,#A0F,green,#FFFA`): top-left/top and rotates clockwise.
2812 * These work similarly to CSS borders.
2813 * colors - `ColorString`. Sets the color(s) of the box corners. Default `black`.
2814 * bordercolors - `ColorString`. Sets the color(s) of the borders. Default `black`.
2815 * borderwidths - Integer. Sets the width(s) of the borders in pixels. If the width is
2816 negative, the border will extend inside the box, whereas positive extends outside
2817 the box. A width of zero results in no border; this is default.
2818 * button, button_exit, image_button, item_image_button
2819 * alpha - boolean, whether to draw alpha in bgimg. Default true.
2820 * bgcolor - color, sets button tint.
2821 * bgcolor_hovered - color when hovered. Defaults to a lighter bgcolor when not provided.
2822 * This is deprecated, use states instead.
2823 * bgcolor_pressed - color when pressed. Defaults to a darker bgcolor when not provided.
2824 * This is deprecated, use states instead.
2825 * bgimg - standard background image. Defaults to none.
2826 * bgimg_hovered - background image when hovered. Defaults to bgimg when not provided.
2827 * This is deprecated, use states instead.
2828 * bgimg_middle - Makes the bgimg textures render in 9-sliced mode and defines the middle rect.
2829 See background9[] documentation for more details. This property also pads the
2830 button's content when set.
2831 * bgimg_pressed - background image when pressed. Defaults to bgimg when not provided.
2832 * This is deprecated, use states instead.
2833 * font - Sets font type. This is a comma separated list of options. Valid options:
2834 * Main font type options. These cannot be combined with each other:
2835 * `normal`: Default font
2836 * `mono`: Monospaced font
2837 * Font modification options. If used without a main font type, `normal` is used:
2838 * `bold`: Makes font bold.
2839 * `italic`: Makes font italic.
2841 * font_size - Sets font size. Default is user-set. Can have multiple values:
2842 * `<number>`: Sets absolute font size to `number`.
2843 * `+<number>`/`-<number>`: Offsets default font size by `number` points.
2844 * `*<number>`: Multiplies default font size by `number`, similar to CSS `em`.
2845 * border - boolean, draw border. Set to false to hide the bevelled button pane. Default true.
2846 * content_offset - 2d vector, shifts the position of the button's content without resizing it.
2847 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2848 * padding - rect, adds space between the edges of the button and the content. This value is
2849 relative to bgimg_middle.
2850 * textcolor - color, default white.
2852 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2854 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2855 * field, pwdfield, textarea
2856 * border - set to false to hide the textbox background and border. Default true.
2857 * font - Sets font type. See button `font` property for more information.
2858 * font_size - Sets font size. See button `font_size` property for more information.
2859 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2860 * textcolor - color. Default white.
2862 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2863 * Default to false in formspec_version version 3 or higher
2865 * noclip - boolean, set to true to allow the element to exceed formspec bounds. Default to false.
2867 * font - Sets font type. See button `font` property for more information.
2868 * font_size - Sets font size. See button `font_size` property for more information.
2869 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2870 * image_button (additional properties)
2871 * fgimg - standard image. Defaults to none.
2872 * fgimg_hovered - image when hovered. Defaults to fgimg when not provided.
2873 * This is deprecated, use states instead.
2874 * fgimg_pressed - image when pressed. Defaults to fgimg when not provided.
2875 * This is deprecated, use states instead.
2876 * NOTE: The parameters of any given image_button will take precedence over fgimg/fgimg_pressed
2878 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2880 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2881 * textcolor - color. Default white.
2883 * font - Sets font type. See button `font` property for more information.
2884 * font_size - Sets font size. See button `font_size` property for more information.
2885 * noclip - boolean, set to true to allow the element to exceed formspec bounds.
2890 * default - Equivalent to providing no states
2891 * button, button_exit, image_button, item_image_button
2892 * hovered - Active when the mouse is hovering over the element
2893 * pressed - Active when the button is pressed
2898 Markup language used in `hypertext[]` elements uses tags that look like HTML tags.
2899 The markup language is currently unstable and subject to change. Use with caution.
2900 Some tags can enclose text, they open with `<tagname>` and close with `</tagname>`.
2901 Tags can have attributes, in that case, attributes are in the opening tag in
2902 form of a key/value separated with equal signs. Attribute values should not be quoted.
2904 These are the technically basic tags but see below for usual tags. Base tags are:
2906 `<style color=... font=... size=...>...</style>`
2908 Changes the style of the text.
2910 * `color`: Text color. Given color is a `colorspec`.
2911 * `size`: Text size.
2912 * `font`: Text font (`mono` or `normal`).
2914 `<global background=... margin=... valign=... color=... hovercolor=... size=... font=... halign=... >`
2919 * `background`: Text background, a `colorspec` or `none`.
2920 * `margin`: Page margins in pixel.
2921 * `valign`: Text vertical alignment (`top`, `middle`, `bottom`).
2923 Inheriting styles (affects child elements):
2924 * `color`: Default text color. Given color is a `colorspec`.
2925 * `hovercolor`: Color of <action> tags when mouse is over.
2926 * `size`: Default text size.
2927 * `font`: Default text font (`mono` or `normal`).
2928 * `halign`: Default text horizontal alignment (`left`, `right`, `center`, `justify`).
2930 This tag needs to be placed only once as it changes the global settings of the
2931 text. Anyway, if several tags are placed, each changed will be made in the order
2934 `<tag name=... color=... hovercolor=... font=... size=...>`
2936 Defines or redefines tag style. This can be used to define new tags.
2937 * `name`: Name of the tag to define or change.
2938 * `color`: Text color. Given color is a `colorspec`.
2939 * `hovercolor`: Text color when element hovered (only for `action` tags). Given color is a `colorspec`.
2940 * `size`: Text size.
2941 * `font`: Text font (`mono` or `normal`).
2943 Following tags are the usual tags for text layout. They are defined by default.
2944 Other tags can be added using `<tag ...>` tag.
2946 `<normal>...</normal>`: Normal size text
2948 `<big>...</big>`: Big text
2950 `<bigger>...</bigger>`: Bigger text
2952 `<center>...</center>`: Centered text
2954 `<left>...</left>`: Left-aligned text
2956 `<right>...</right>`: Right-aligned text
2958 `<justify>...</justify>`: Justified text
2960 `<mono>...</mono>`: Monospaced font
2962 `<b>...</b>`, `<i>...</i>`, `<u>...</u>`: Bold, italic, underline styles.
2964 `<action name=...>...</action>`
2966 Make that text a clickable text triggering an action.
2968 * `name`: Name of the action (mandatory).
2970 When clicked, the formspec is send to the server. The value of the text field
2971 sent to `on_player_receive_fields` will be "action:" concatenated to the action
2974 `<img name=... float=... width=... height=...>`
2976 Draws an image which is present in the client media cache.
2978 * `name`: Name of the texture (mandatory).
2979 * `float`: If present, makes the image floating (`left` or `right`).
2980 * `width`: Force image width instead of taking texture width.
2981 * `height`: Force image height instead of taking texture height.
2983 If only width or height given, texture aspect is kept.
2985 `<item name=... float=... width=... height=... rotate=...>`
2987 Draws an item image.
2989 * `name`: Item string of the item to draw (mandatory).
2990 * `float`: If present, makes the image floating (`left` or `right`).
2991 * `width`: Item image width.
2992 * `height`: Item image height.
2993 * `rotate`: Rotate item image if set to `yes` or `X,Y,Z`. X, Y and Z being
2994 rotation speeds in percent of standard speed (-1000 to 1000). Works only if
2995 `inventory_items_animations` is set to true.
2996 * `angle`: Angle in which the item image is shown. Value has `X,Y,Z` form.
2997 X, Y and Z being angles around each three axes. Works only if
2998 `inventory_items_animations` is set to true.
3006 * `"context"`: Selected node metadata (deprecated: `"current_name"`)
3007 * `"current_player"`: Player to whom the menu is shown
3008 * `"player:<name>"`: Any player
3009 * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
3010 * `"detached:<name>"`: A detached inventory
3012 Player Inventory lists
3013 ----------------------
3015 * `main`: list containing the default inventory
3016 * `craft`: list containing the craft input
3017 * `craftpreview`: list containing the craft prediction
3018 * `craftresult`: list containing the crafted output
3019 * `hand`: list containing an override for the empty hand
3020 * Is not created automatically, use `InvRef:set_size`
3021 * Is only used to enhance the empty hand's tool capabilities
3029 `#RGB` defines a color in hexadecimal format.
3031 `#RGBA` defines a color in hexadecimal format and alpha channel.
3033 `#RRGGBB` defines a color in hexadecimal format.
3035 `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
3037 Named colors are also supported and are equivalent to
3038 [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
3039 To specify the value of the alpha channel, append `#AA` to the end of the color
3040 name (e.g. `colorname#08`). For named colors the hexadecimal string
3041 representing the alpha value must (always) be two hexadecimal digits.
3046 A ColorSpec specifies a 32-bit color. It can be written in any of the following
3049 * table form: Each element ranging from 0..255 (a, if absent, defaults to 255):
3050 * `colorspec = {a=255, r=0, g=255, b=0}`
3051 * numerical form: The raw integer value of an ARGB8 quad:
3052 * `colorspec = 0xFF00FF00`
3053 * string form: A ColorString (defined above):
3054 * `colorspec = "green"`
3062 Most text can contain escape sequences, that can for example color the text.
3063 There are a few exceptions: tab headers, dropdowns and vertical labels can't.
3064 The following functions provide escape sequences:
3066 * `minetest.get_color_escape_sequence(color)`:
3067 * `color` is a ColorString
3068 * The escape sequence sets the text color to `color`
3069 * `minetest.colorize(color, message)`:
3071 `minetest.get_color_escape_sequence(color) ..
3073 minetest.get_color_escape_sequence("#ffffff")`
3074 * `minetest.get_background_escape_sequence(color)`
3075 * `color` is a ColorString
3076 * The escape sequence sets the background of the whole text element to
3077 `color`. Only defined for item descriptions and tooltips.
3078 * `minetest.strip_foreground_colors(str)`
3079 * Removes foreground colors added by `get_color_escape_sequence`.
3080 * `minetest.strip_background_colors(str)`
3081 * Removes background colors added by `get_background_escape_sequence`.
3082 * `minetest.strip_colors(str)`
3083 * Removes all color escape sequences.
3090 A spatial vector is similar to a position, but instead using
3091 absolute world coordinates, it uses *relative* coordinates, relative to
3092 no particular point.
3094 Internally, it is implemented as a table with the 3 fields
3095 `x`, `y` and `z`. Example: `{x = 0, y = 1, z = 0}`.
3097 For the following functions, `v`, `v1`, `v2` are vectors,
3098 `p1`, `p2` are positions,
3099 `s` is a scalar (a number):
3101 * `vector.new(a[, b, c])`:
3103 * A copy of `a` if `a` is a vector.
3104 * `{x = a, y = b, z = c}`, if all of `a`, `b`, `c` are defined numbers.
3105 * `vector.direction(p1, p2)`:
3106 * Returns a vector of length 1 with direction `p1` to `p2`.
3107 * If `p1` and `p2` are identical, returns `{x = 0, y = 0, z = 0}`.
3108 * `vector.distance(p1, p2)`:
3109 * Returns zero or a positive number, the distance between `p1` and `p2`.
3110 * `vector.length(v)`:
3111 * Returns zero or a positive number, the length of vector `v`.
3112 * `vector.normalize(v)`:
3113 * Returns a vector of length 1 with direction of vector `v`.
3114 * If `v` has zero length, returns `{x = 0, y = 0, z = 0}`.
3115 * `vector.floor(v)`:
3116 * Returns a vector, each dimension rounded down.
3117 * `vector.round(v)`:
3118 * Returns a vector, each dimension rounded to nearest integer.
3119 * `vector.apply(v, func)`:
3120 * Returns a vector where the function `func` has been applied to each
3122 * `vector.equals(v1, v2)`:
3123 * Returns a boolean, `true` if the vectors are identical.
3124 * `vector.sort(v1, v2)`:
3125 * Returns in order minp, maxp vectors of the cuboid defined by `v1`, `v2`.
3126 * `vector.angle(v1, v2)`:
3127 * Returns the angle between `v1` and `v2` in radians.
3128 * `vector.dot(v1, v2)`:
3129 * Returns the dot product of `v1` and `v2`.
3130 * `vector.cross(v1, v2)`:
3131 * Returns the cross product of `v1` and `v2`.
3132 * `vector.offset(v, x, y, z)`:
3133 * Returns the sum of the vectors `v` and `{x = x, y = y, z = z}`.
3135 For the following functions `x` can be either a vector or a number:
3137 * `vector.add(v, x)`:
3139 * If `x` is a vector: Returns the sum of `v` and `x`.
3140 * If `x` is a number: Adds `x` to each component of `v`.
3141 * `vector.subtract(v, x)`:
3143 * If `x` is a vector: Returns the difference of `v` subtracted by `x`.
3144 * If `x` is a number: Subtracts `x` from each component of `v`.
3145 * `vector.multiply(v, s)`:
3146 * Returns a scaled vector.
3147 * Deprecated: If `s` is a vector: Returns the Schur product.
3148 * `vector.divide(v, s)`:
3149 * Returns a scaled vector.
3150 * Deprecated: If `s` is a vector: Returns the Schur quotient.
3152 For the following functions `a` is an angle in radians and `r` is a rotation
3153 vector ({x = <pitch>, y = <yaw>, z = <roll>}) where pitch, yaw and roll are
3156 * `vector.rotate(v, r)`:
3157 * Applies the rotation `r` to `v` and returns the result.
3158 * `vector.rotate({x = 0, y = 0, z = 1}, r)` and
3159 `vector.rotate({x = 0, y = 1, z = 0}, r)` return vectors pointing
3160 forward and up relative to an entity's rotation `r`.
3161 * `vector.rotate_around_axis(v1, v2, a)`:
3162 * Returns `v1` rotated around axis `v2` by `a` radians according to
3163 the right hand rule.
3164 * `vector.dir_to_rotation(direction[, up])`:
3165 * Returns a rotation vector for `direction` pointing forward using `up`
3167 * If `up` is omitted, the roll of the returned vector defaults to zero.
3168 * Otherwise `direction` and `up` need to be vectors in a 90 degree angle to each other.
3176 * `dump2(obj, name, dumped)`: returns a string which makes `obj`
3177 human-readable, handles reference loops.
3178 * `obj`: arbitrary variable
3179 * `name`: string, default: `"_"`
3180 * `dumped`: table, default: `{}`
3181 * `dump(obj, dumped)`: returns a string which makes `obj` human-readable
3182 * `obj`: arbitrary variable
3183 * `dumped`: table, default: `{}`
3184 * `math.hypot(x, y)`
3185 * Get the hypotenuse of a triangle with legs x and y.
3186 Useful for distance calculation.
3187 * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
3188 * Get the sign of a number.
3189 * tolerance: number, default: `0.0`
3190 * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
3192 * `math.factorial(x)`: returns the factorial of `x`
3193 * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
3194 * `separator`: string, default: `","`
3195 * `include_empty`: boolean, default: `false`
3196 * `max_splits`: number, if it's negative, splits aren't limited,
3198 * `sep_is_pattern`: boolean, it specifies whether separator is a plain
3199 string or a pattern (regex), default: `false`
3200 * e.g. `"a,b":split","` returns `{"a","b"}`
3201 * `string:trim()`: returns the string without whitespace pre- and suffixes
3202 * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
3203 * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
3204 * Adds newlines to the string to keep it within the specified character
3206 * Note that the returned lines may be longer than the limit since it only
3207 splits at word borders.
3208 * `limit`: number, maximal amount of characters in one line
3209 * `as_table`: boolean, if set to true, a table of lines instead of a string
3210 is returned, default: `false`
3211 * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
3212 * `pos`: table {x=X, y=Y, z=Z}
3213 * Converts the position `pos` to a human-readable, printable string
3214 * `decimal_places`: number, if specified, the x, y and z values of
3215 the position are rounded to the given decimal place.
3216 * `minetest.string_to_pos(string)`: returns a position or `nil`
3217 * Same but in reverse.
3218 * If the string can't be parsed to a position, nothing is returned.
3219 * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
3220 * Converts a string representing an area box into two positions
3221 * `minetest.formspec_escape(string)`: returns a string
3222 * escapes the characters "[", "]", "\", "," and ";", which can not be used
3224 * `minetest.is_yes(arg)`
3225 * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
3226 * `minetest.is_nan(arg)`
3227 * returns true when the passed number represents NaN.
3228 * `minetest.get_us_time()`
3229 * returns time with microsecond precision. May not return wall time.
3230 * `table.copy(table)`: returns a table
3231 * returns a deep copy of `table`
3232 * `table.indexof(list, val)`: returns the smallest numerical index containing
3233 the value `val` in the table `list`. Non-numerical indices are ignored.
3234 If `val` could not be found, `-1` is returned. `list` must not have
3236 * `table.insert_all(table, other_table)`:
3237 * Appends all values in `other_table` to `table` - uses `#table + 1` to
3239 * `table.key_value_swap(t)`: returns a table with keys and values swapped
3240 * If multiple keys in `t` map to the same value, the result is undefined.
3241 * `table.shuffle(table, [from], [to], [random_func])`:
3242 * Shuffles elements `from` to `to` in `table` in place
3243 * `from` defaults to `1`
3244 * `to` defaults to `#table`
3245 * `random_func` defaults to `math.random`. This function receives two
3246 integers as arguments and should return a random integer inclusively
3248 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
3250 * returns the exact position on the surface of a pointed node
3251 * `minetest.get_dig_params(groups, tool_capabilities)`: Simulates a tool
3253 Returns a table with the following fields:
3254 * `diggable`: `true` if node can be dug, `false` otherwise.
3255 * `time`: Time it would take to dig the node.
3256 * `wear`: How much wear would be added to the tool.
3257 `time` and `wear` are meaningless if node's not diggable
3259 * `groups`: Table of the node groups of the node that would be dug
3260 * `tool_capabilities`: Tool capabilities table of the tool
3261 * `minetest.get_hit_params(groups, tool_capabilities [, time_from_last_punch])`:
3262 Simulates an item that punches an object.
3263 Returns a table with the following fields:
3264 * `hp`: How much damage the punch would cause.
3265 * `wear`: How much wear would be added to the tool.
3267 * `groups`: Damage groups of the object
3268 * `tool_capabilities`: Tool capabilities table of the item
3269 * `time_from_last_punch`: time in seconds since last punch action
3277 Texts can be translated client-side with the help of `minetest.translate` and
3280 Translating a string
3281 --------------------
3283 Two functions are provided to translate strings: `minetest.translate` and
3284 `minetest.get_translator`.
3286 * `minetest.get_translator(textdomain)` is a simple wrapper around
3287 `minetest.translate`, and `minetest.get_translator(textdomain)(str, ...)` is
3288 equivalent to `minetest.translate(textdomain, str, ...)`.
3289 It is intended to be used in the following way, so that it avoids verbose
3290 repetitions of `minetest.translate`:
3292 local S = minetest.get_translator(textdomain)
3295 As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
3297 * `minetest.translate(textdomain, str, ...)` translates the string `str` with
3298 the given `textdomain` for disambiguation. The textdomain must match the
3299 textdomain specified in the translation file in order to get the string
3300 translated. This can be used so that a string is translated differently in
3302 It is advised to use the name of the mod as textdomain whenever possible, to
3303 avoid clashes with other mods.
3304 This function must be given a number of arguments equal to the number of
3305 arguments the translated string expects.
3306 Arguments are literal strings -- they will not be translated, so if you want
3307 them to be, they need to come as outputs of `minetest.translate` as well.
3309 For instance, suppose we want to translate "@1 Wool" with "@1" being replaced
3310 by the translation of "Red". We can do the following:
3312 local S = minetest.get_translator()
3313 S("@1 Wool", S("Red"))
3315 This will be displayed as "Red Wool" on old clients and on clients that do
3316 not have localization enabled. However, if we have for instance a translation
3317 file named `wool.fr.tr` containing the following:
3322 this will be displayed as "Laine Rouge" on clients with a French locale.
3324 Operations on translated strings
3325 --------------------------------
3327 The output of `minetest.translate` is a string, with escape sequences adding
3328 additional information to that string so that it can be translated on the
3329 different clients. In particular, you can't expect operations like string.length
3330 to work on them like you would expect them to, or string.gsub to work in the
3331 expected manner. However, string concatenation will still work as expected
3332 (note that you should only use this for things like formspecs; do not translate
3333 sentences by breaking them into parts; arguments should be used instead), and
3334 operations such as `minetest.colorize` which are also concatenation.
3336 Translation file format
3337 -----------------------
3339 A translation file has the suffix `.[lang].tr`, where `[lang]` is the language
3340 it corresponds to. It must be put into the `locale` subdirectory of the mod.
3341 The file should be a text file, with the following format:
3343 * Lines beginning with `# textdomain:` (the space is significant) can be used
3344 to specify the text domain of all following translations in the file.
3345 * All other empty lines or lines beginning with `#` are ignored.
3346 * Other lines should be in the format `original=translated`. Both `original`
3347 and `translated` can contain escape sequences beginning with `@` to insert
3348 arguments, literal `@`, `=` or newline (See [Escapes] below).
3349 There must be no extraneous whitespace around the `=` or at the beginning or
3350 the end of the line.
3355 Strings that need to be translated can contain several escapes, preceded by `@`.
3357 * `@@` acts as a literal `@`.
3358 * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated
3359 string that will be inlined when translated. Due to how translations are
3360 implemented, the original translation string **must** have its arguments in
3361 increasing order, without gaps or repetitions, starting from 1.
3362 * `@=` acts as a literal `=`. It is not required in strings given to
3363 `minetest.translate`, but is in translation files to avoid being confused
3364 with the `=` separating the original from the translation.
3365 * `@\n` (where the `\n` is a literal newline) acts as a literal newline.
3366 As with `@=`, this escape is not required in strings given to
3367 `minetest.translate`, but is in translation files.
3368 * `@n` acts as a literal newline as well.
3370 Server side translations
3371 ------------------------
3373 On some specific cases, server translation could be useful. For example, filter
3374 a list on labels and send results to client. A method is supplied to achieve
3377 `minetest.get_translated_string(lang_code, string)`: Translates `string` using
3378 translations for `lang_code` language. It gives the same result as if the string
3379 was translated by the client.
3381 The `lang_code` to use for a given player can be retrieved from
3382 the table returned by `minetest.get_player_information(name)`.
3384 IMPORTANT: This functionality should only be used for sorting, filtering or similar purposes.
3385 You do not need to use this to get translated strings to show up on the client.
3390 Perlin noise creates a continuously-varying value depending on the input values.
3391 Usually in Minetest the input values are either 2D or 3D co-ordinates in nodes.
3392 The result is used during map generation to create the terrain shape, vary heat
3393 and humidity to distribute biomes, vary the density of decorations or vary the
3396 Structure of perlin noise
3397 -------------------------
3399 An 'octave' is a simple noise generator that outputs a value between -1 and 1.
3400 The smooth wavy noise it generates has a single characteristic scale, almost
3401 like a 'wavelength', so on its own does not create fine detail.
3402 Due to this perlin noise combines several octaves to create variation on
3403 multiple scales. Each additional octave has a smaller 'wavelength' than the
3406 This combination results in noise varying very roughly between -2.0 and 2.0 and
3407 with an average value of 0.0, so `scale` and `offset` are then used to multiply
3408 and offset the noise variation.
3410 The final perlin noise variation is created as follows:
3412 noise = offset + scale * (octave1 +
3413 octave2 * persistence +
3414 octave3 * persistence ^ 2 +
3415 octave4 * persistence ^ 3 +
3421 Noise Parameters are commonly called `NoiseParams`.
3425 After the multiplication by `scale` this is added to the result and is the final
3426 step in creating the noise value.
3427 Can be positive or negative.
3431 Once all octaves have been combined, the result is multiplied by this.
3432 Can be positive or negative.
3436 For octave1, this is roughly the change of input value needed for a very large
3437 variation in the noise value generated by octave1. It is almost like a
3438 'wavelength' for the wavy noise variation.
3439 Each additional octave has a 'wavelength' that is smaller than the previous
3440 octave, to create finer detail. `spread` will therefore roughly be the typical
3441 size of the largest structures in the final noise variation.
3443 `spread` is a vector with values for x, y, z to allow the noise variation to be
3444 stretched or compressed in the desired axes.
3445 Values are positive numbers.
3449 This is a whole number that determines the entire pattern of the noise
3450 variation. Altering it enables different noise patterns to be created.
3451 With other parameters equal, different seeds produce different noise patterns
3452 and identical seeds produce identical noise patterns.
3454 For this parameter you can randomly choose any whole number. Usually it is
3455 preferable for this to be different from other seeds, but sometimes it is useful
3456 to be able to create identical noise patterns.
3458 In some noise APIs the world seed is added to the seed specified in noise
3459 parameters. This is done to make the resulting noise pattern vary in different
3460 worlds, and be 'world-specific'.
3464 The number of simple noise generators that are combined.
3465 A whole number, 1 or more.
3466 Each additional octave adds finer detail to the noise but also increases the
3467 noise calculation load.
3468 3 is a typical minimum for a high quality, complex and natural-looking noise
3469 variation. 1 octave has a slight 'gridlike' appearence.
3471 Choose the number of octaves according to the `spread` and `lacunarity`, and the
3472 size of the finest detail you require. For example:
3473 if `spread` is 512 nodes, `lacunarity` is 2.0 and finest detail required is 16
3474 nodes, octaves will be 6 because the 'wavelengths' of the octaves will be
3475 512, 256, 128, 64, 32, 16 nodes.
3476 Warning: If the 'wavelength' of any octave falls below 1 an error will occur.
3480 Each additional octave has an amplitude that is the amplitude of the previous
3481 octave multiplied by `persistence`, to reduce the amplitude of finer details,
3482 as is often helpful and natural to do so.
3483 Since this controls the balance of fine detail to large-scale detail
3484 `persistence` can be thought of as the 'roughness' of the noise.
3486 A positive or negative non-zero number, often between 0.3 and 1.0.
3487 A common medium value is 0.5, such that each octave has half the amplitude of
3488 the previous octave.
3489 This may need to be tuned when altering `lacunarity`; when doing so consider
3490 that a common medium value is 1 / lacunarity.
3494 Each additional octave has a 'wavelength' that is the 'wavelength' of the
3495 previous octave multiplied by 1 / lacunarity, to create finer detail.
3496 'lacunarity' is often 2.0 so 'wavelength' often halves per octave.
3498 A positive number no smaller than 1.0.
3499 Values below 2.0 create higher quality noise at the expense of requiring more
3500 octaves to cover a paticular range of 'wavelengths'.
3504 Leave this field unset for no special handling.
3505 Currently supported are `defaults`, `eased` and `absvalue`:
3509 Specify this if you would like to keep auto-selection of eased/not-eased while
3510 specifying some other flags.
3514 Maps noise gradient values onto a quintic S-curve before performing
3515 interpolation. This results in smooth, rolling noise.
3516 Disable this (`noeased`) for sharp-looking noise with a slightly gridded
3518 If no flags are specified (or defaults is), 2D noise is eased and 3D noise is
3520 Easing a 3D noise significantly increases the noise calculation load, so use
3525 The absolute value of each octave's noise variation is used when combining the
3526 octaves. The final perlin noise variation is created as follows:
3528 noise = offset + scale * (abs(octave1) +
3529 abs(octave2) * persistence +
3530 abs(octave3) * persistence ^ 2 +
3531 abs(octave4) * persistence ^ 3 +
3536 For 2D or 3D perlin noise or perlin noise maps:
3541 spread = {x = 500, y = 500, z = 500},
3546 flags = "defaults, absvalue",
3549 For 2D noise the Z component of `spread` is still defined but is ignored.
3550 A single noise parameter table can be used for 2D or 3D noise.
3561 These tell in what manner the ore is generated.
3563 All default ores are of the uniformly-distributed scatter type.
3567 Randomly chooses a location and generates a cluster of ore.
3569 If `noise_params` is specified, the ore will be placed if the 3D perlin noise
3570 at that point is greater than the `noise_threshold`, giving the ability to
3571 create a non-equal distribution of ore.
3575 Creates a sheet of ore in a blob shape according to the 2D perlin noise
3576 described by `noise_params` and `noise_threshold`. This is essentially an
3577 improved version of the so-called "stratus" ore seen in some unofficial mods.
3579 This sheet consists of vertical columns of uniform randomly distributed height,
3580 varying between the inclusive range `column_height_min` and `column_height_max`.
3581 If `column_height_min` is not specified, this parameter defaults to 1.
3582 If `column_height_max` is not specified, this parameter defaults to `clust_size`
3583 for reverse compatibility. New code should prefer `column_height_max`.
3585 The `column_midpoint_factor` parameter controls the position of the column at
3586 which ore emanates from.
3587 If 1, columns grow upward. If 0, columns grow downward. If 0.5, columns grow
3588 equally starting from each direction.
3589 `column_midpoint_factor` is a decimal number ranging in value from 0 to 1. If
3590 this parameter is not specified, the default is 0.5.
3592 The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this
3597 Creates a sheet of ore in a cloud-like puff shape.
3599 As with the `sheet` ore type, the size and shape of puffs are described by
3600 `noise_params` and `noise_threshold` and are placed at random vertical
3601 positions within the currently generated chunk.
3603 The vertical top and bottom displacement of each puff are determined by the
3604 noise parameters `np_puff_top` and `np_puff_bottom`, respectively.
3608 Creates a deformed sphere of ore according to 3d perlin noise described by
3609 `noise_params`. The maximum size of the blob is `clust_size`, and
3610 `clust_scarcity` has the same meaning as with the `scatter` type.
3614 Creates veins of ore varying in density by according to the intersection of two
3615 instances of 3d perlin noise with different seeds, both described by
3618 `random_factor` varies the influence random chance has on placement of an ore
3619 inside the vein, which is `1` by default. Note that modifying this parameter
3620 may require adjusting `noise_threshold`.
3622 The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
3625 This ore type is difficult to control since it is sensitive to small changes.
3626 The following is a decent set of parameters to work from:
3631 spread = {x=200, y=200, z=200},
3638 noise_threshold = 1.6
3640 **WARNING**: Use this ore type *very* sparingly since it is ~200x more
3641 computationally expensive than any other ore.
3645 Creates a single undulating ore stratum that is continuous across mapchunk
3646 borders and horizontally spans the world.
3648 The 2D perlin noise described by `noise_params` defines the Y co-ordinate of
3649 the stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
3650 defines the stratum's vertical thickness (in units of nodes). Due to being
3651 continuous across mapchunk borders the stratum's vertical thickness is
3654 If the noise parameter `noise_params` is omitted the ore will occur from y_min
3655 to y_max in a simple horizontal stratum.
3657 A parameter `stratum_thickness` can be provided instead of the noise parameter
3658 `np_stratum_thickness`, to create a constant thickness.
3660 Leaving out one or both noise parameters makes the ore generation less
3661 intensive, useful when adding multiple strata.
3663 `y_min` and `y_max` define the limits of the ore generation and for performance
3664 reasons should be set as close together as possible but without clipping the
3665 stratum's Y variation.
3667 Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
3668 solid-ore stratum would require a `clust_scarcity` of 1.
3670 The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
3671 `random_factor` are ignored by this ore type.
3676 See section [Flag Specifier Format].
3678 Currently supported flags:
3679 `puff_cliffs`, `puff_additive_composition`.
3683 If set, puff ore generation will not taper down large differences in
3684 displacement when approaching the edge of a puff. This flag has no effect for
3685 ore types other than `puff`.
3687 ### `puff_additive_composition`
3689 By default, when noise described by `np_puff_top` or `np_puff_bottom` results
3690 in a negative displacement, the sub-column at that point is not generated. With
3691 this attribute set, puff ore generation will instead generate the absolute
3692 difference in noise displacement values. This flag has no effect for ore types
3701 The varying types of decorations that can be placed.
3706 Creates a 1 times `H` times 1 column of a specified node (or a random node from
3707 a list, if a decoration list is specified). Can specify a certain node it must
3708 spawn next to, such as water or lava, for example. Can also generate a
3709 decoration of random height between a specified lower and upper bound.
3710 This type of decoration is intended for placement of grass, flowers, cacti,
3711 papyri, waterlilies and so on.
3716 Copies a box of `MapNodes` from a specified schematic file (or raw description).
3717 Can specify a probability of a node randomly appearing when placed.
3718 This decoration type is intended to be used for multi-node sized discrete
3719 structures, such as trees, cave spikes, rocks, and so on.
3728 --------------------
3730 A schematic specifier identifies a schematic by either a filename to a
3731 Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
3732 in the form of a table. This table specifies the following fields:
3734 * The `size` field is a 3D vector containing the dimensions of the provided
3735 schematic. (required field)
3736 * The `yslice_prob` field is a table of {ypos, prob} slice tables. A slice table
3737 sets the probability of a particular horizontal slice of the schematic being
3738 placed. (optional field)
3739 `ypos` = 0 for the lowest horizontal slice of a schematic.
3740 The default of `prob` is 255.
3741 * The `data` field is a flat table of MapNode tables making up the schematic,
3742 in the order of `[z [y [x]]]`. (required field)
3743 Each MapNode table contains:
3744 * `name`: the name of the map node to place (required)
3745 * `prob` (alias `param1`): the probability of this node being placed
3747 * `param2`: the raw param2 value of the node being placed onto the map
3749 * `force_place`: boolean representing if the node should forcibly overwrite
3750 any previous contents (default: false)
3752 About probability values:
3754 * A probability value of `0` or `1` means that node will never appear
3756 * A probability value of `254` or `255` means the node will always appear
3758 * If the probability value `p` is greater than `1`, then there is a
3759 `(p / 256 * 100)` percent chance that node will appear when the schematic is
3762 Schematic attributes
3763 --------------------
3765 See section [Flag Specifier Format].
3767 Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
3770 * `place_center_x`: Placement of this decoration is centered along the X axis.
3771 * `place_center_y`: Placement of this decoration is centered along the Y axis.
3772 * `place_center_z`: Placement of this decoration is centered along the Z axis.
3773 * `force_placement`: Schematic nodes other than "ignore" will replace existing
3779 Lua Voxel Manipulator
3780 =====================
3785 VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator'
3786 facility. The purpose of this object is for fast, low-level, bulk access to
3787 reading and writing Map content. As such, setting map nodes through VoxelManip
3788 will lack many of the higher level features and concepts you may be used to
3789 with other methods of setting nodes. For example, nodes will not have their
3790 construction and destruction callbacks run, and no rollback information is
3793 It is important to note that VoxelManip is designed for speed, and *not* ease
3794 of use or flexibility. If your mod requires a map manipulation facility that
3795 will handle 100% of all edge cases, or the use of high level node placement
3796 features, perhaps `minetest.set_node()` is better suited for the job.
3798 In addition, VoxelManip might not be faster, or could even be slower, for your
3799 specific use case. VoxelManip is most effective when setting large areas of map
3800 at once - for example, if only setting a 3x3x3 node area, a
3801 `minetest.set_node()` loop may be more optimal. Always profile code using both
3802 methods of map manipulation to determine which is most appropriate for your
3805 A recent simple test of setting cubic areas showed that `minetest.set_node()`
3806 is faster than a VoxelManip for a 3x3x3 node cube or smaller.
3811 A VoxelManip object can be created any time using either:
3812 `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
3814 If the optional position parameters are present for either of these routines,
3815 the specified region will be pre-loaded into the VoxelManip object on creation.
3816 Otherwise, the area of map you wish to manipulate must first be loaded into the
3817 VoxelManip object using `VoxelManip:read_from_map()`.
3819 Note that `VoxelManip:read_from_map()` returns two position vectors. The region
3820 formed by these positions indicate the minimum and maximum (respectively)
3821 positions of the area actually loaded in the VoxelManip, which may be larger
3822 than the area requested. For convenience, the loaded area coordinates can also
3823 be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
3825 Now that the VoxelManip object is populated with map data, your mod can fetch a
3826 copy of this data using either of two methods. `VoxelManip:get_node_at()`,
3827 which retrieves an individual node in a MapNode formatted table at the position
3828 requested is the simplest method to use, but also the slowest.
3830 Nodes in a VoxelManip object may also be read in bulk to a flat array table
3833 * `VoxelManip:get_data()` for node content (in Content ID form, see section
3835 * `VoxelManip:get_light_data()` for node light levels, and
3836 * `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
3838 See section [Flat array format] for more details.
3840 It is very important to understand that the tables returned by any of the above
3841 three functions represent a snapshot of the VoxelManip's internal state at the
3842 time of the call. This copy of the data will not magically update itself if
3843 another function modifies the internal VoxelManip state.
3844 Any functions that modify a VoxelManip's contents work on the VoxelManip's
3845 internal state unless otherwise explicitly stated.
3847 Once the bulk data has been edited to your liking, the internal VoxelManip
3848 state can be set using:
3850 * `VoxelManip:set_data()` for node content (in Content ID form, see section
3852 * `VoxelManip:set_light_data()` for node light levels, and
3853 * `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
3855 The parameter to each of the above three functions can use any table at all in
3856 the same flat array format as produced by `get_data()` etc. and is not required
3857 to be a table retrieved from `get_data()`.
3859 Once the internal VoxelManip state has been modified to your liking, the
3860 changes can be committed back to the map by calling `VoxelManip:write_to_map()`
3862 ### Flat array format
3865 `Nx = p2.X - p1.X + 1`,
3866 `Ny = p2.Y - p1.Y + 1`, and
3867 `Nz = p2.Z - p1.Z + 1`.
3869 Then, for a loaded region of p1..p2, this array ranges from `1` up to and
3870 including the value of the expression `Nx * Ny * Nz`.
3872 Positions offset from p1 are present in the array with the format of:
3875 (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
3876 (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
3878 (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
3879 (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
3881 (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
3883 (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
3886 and the array index for a position p contained completely in p1..p2 is:
3888 `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
3890 Note that this is the same "flat 3D array" format as
3891 `PerlinNoiseMap:get3dMap_flat()`.
3892 VoxelArea objects (see section [`VoxelArea`]) can be used to simplify calculation
3893 of the index for a single point in a flat VoxelManip array.
3897 A Content ID is a unique integer identifier for a specific node type.
3898 These IDs are used by VoxelManip in place of the node name string for
3899 `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
3900 `minetest.get_content_id()` to look up the Content ID for the specified node
3901 name, and `minetest.get_name_from_content_id()` to look up the node name string
3902 for a given Content ID.
3903 After registration of a node, its Content ID will remain the same throughout
3904 execution of the mod.
3905 Note that the node being queried needs to have already been been registered.
3907 The following builtin node types have their Content IDs defined as constants:
3909 * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
3910 * `minetest.CONTENT_AIR`: ID for "air" nodes
3911 * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
3913 ### Mapgen VoxelManip objects
3915 Inside of `on_generated()` callbacks, it is possible to retrieve the same
3916 VoxelManip object used by the core's Map Generator (commonly abbreviated
3917 Mapgen). Most of the rules previously described still apply but with a few
3920 * The Mapgen VoxelManip object is retrieved using:
3921 `minetest.get_mapgen_object("voxelmanip")`
3922 * This VoxelManip object already has the region of map just generated loaded
3923 into it; it's not necessary to call `VoxelManip:read_from_map()` before using
3924 a Mapgen VoxelManip.
3925 * The `on_generated()` callbacks of some mods may place individual nodes in the
3926 generated area using non-VoxelManip map modification methods. Because the
3927 same Mapgen VoxelManip object is passed through each `on_generated()`
3928 callback, it becomes necessary for the Mapgen VoxelManip object to maintain
3929 consistency with the current map state. For this reason, calling any of the
3930 following functions:
3931 `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
3932 will also update the Mapgen VoxelManip object's internal state active on the
3934 * After modifying the Mapgen VoxelManip object's internal buffer, it may be
3935 necessary to update lighting information using either:
3936 `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
3938 ### Other API functions operating on a VoxelManip
3940 If any VoxelManip contents were set to a liquid node,
3941 `VoxelManip:update_liquids()` must be called for these liquid nodes to begin
3942 flowing. It is recommended to call this function only after having written all
3943 buffered data back to the VoxelManip object, save for special situations where
3944 the modder desires to only have certain liquid nodes begin flowing.
3946 The functions `minetest.generate_ores()` and `minetest.generate_decorations()`
3947 will generate all registered decorations and ores throughout the full area
3948 inside of the specified VoxelManip object.
3950 `minetest.place_schematic_on_vmanip()` is otherwise identical to
3951 `minetest.place_schematic()`, except instead of placing the specified schematic
3952 directly on the map at the specified position, it will place the schematic
3953 inside the VoxelManip.
3957 * Attempting to read data from a VoxelManip object before map is read will
3958 result in a zero-length array table for `VoxelManip:get_data()`, and an
3959 "ignore" node at any position for `VoxelManip:get_node_at()`.
3960 * If either a region of map has not yet been generated or is out-of-bounds of
3961 the map, that region is filled with "ignore" nodes.
3962 * Other mods, or the core itself, could possibly modify the area of map
3963 currently loaded into a VoxelManip object. With the exception of Mapgen
3964 VoxelManips (see above section), the internal buffers are not updated. For
3965 this reason, it is strongly encouraged to complete the usage of a particular
3966 VoxelManip object in the same callback it had been created.
3967 * If a VoxelManip object will be used often, such as in an `on_generated()`
3968 callback, consider passing a file-scoped table as the optional parameter to
3969 `VoxelManip:get_data()`, which serves as a static buffer the function can use
3970 to write map data to instead of returning a new table each call. This greatly
3971 enhances performance by avoiding unnecessary memory allocations.
3976 * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object
3977 containing the region formed by `p1` and `p2`.
3978 * returns actual emerged `pmin`, actual emerged `pmax`
3979 * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to
3981 * **important**: data must be set using `VoxelManip:set_data()` before
3983 * if `light` is true, then lighting is automatically recalculated.
3984 The default value is true.
3985 If `light` is false, no light calculations happen, and you should correct
3986 all modified blocks with `minetest.fix_light()` as soon as possible.
3987 Keep in mind that modifying the map where light is incorrect can cause
3989 * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
3990 the `VoxelManip` at that position
3991 * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at
3993 * `get_data([buffer])`: Retrieves the node content data loaded into the
3994 `VoxelManip` object.
3995 * returns raw node data in the form of an array of node content IDs
3996 * if the param `buffer` is present, this table will be used to store the
3998 * `set_data(data)`: Sets the data contents of the `VoxelManip` object
3999 * `update_map()`: Does nothing, kept for compatibility.
4000 * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to
4002 * `light` is a table, `{day=<0...15>, night=<0...15>}`
4003 * To be used only by a `VoxelManip` object from
4004 `minetest.get_mapgen_object`.
4005 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4007 * `get_light_data()`: Gets the light data read into the `VoxelManip` object
4008 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4010 * Each value is the bitwise combination of day and night light values
4012 * `light = day + (night * 16)`
4013 * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
4014 in the `VoxelManip`.
4015 * expects lighting data in the same format that `get_light_data()` returns
4016 * `get_param2_data([buffer])`: Gets the raw `param2` data read into the
4017 `VoxelManip` object.
4018 * Returns an array (indices 1 to volume) of integers ranging from `0` to
4020 * If the param `buffer` is present, this table will be used to store the
4022 * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in
4024 * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the
4026 * To be used only by a `VoxelManip` object from
4027 `minetest.get_mapgen_object`.
4028 * (`p1`, `p2`) is the area in which lighting is set, defaults to the whole
4029 area if left out or nil. For almost all uses these should be left out
4030 or nil to use the default.
4031 * `propagate_shadow` is an optional boolean deciding whether shadows in a
4032 generated mapchunk above are propagated down into the mapchunk, defaults
4033 to `true` if left out.
4034 * `update_liquids()`: Update liquid flow
4035 * `was_modified()`: Returns `true` or `false` if the data in the voxel
4036 manipulator had been modified since the last read from map, due to a call to
4037 `minetest.set_data()` on the loaded area elsewhere.
4038 * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
4043 A helper class for voxel areas.
4044 It can be created via `VoxelArea:new{MinEdge = pmin, MaxEdge = pmax}`.
4045 The coordinates are *inclusive*, like most other things in Minetest.
4049 * `getExtent()`: returns a 3D vector containing the size of the area formed by
4050 `MinEdge` and `MaxEdge`.
4051 * `getVolume()`: returns the volume of the area formed by `MinEdge` and
4053 * `index(x, y, z)`: returns the index of an absolute position in a flat array
4055 * `x`, `y` and `z` must be integers to avoid an incorrect index result.
4056 * The position (x, y, z) is not checked for being inside the area volume,
4057 being outside can cause an incorrect index result.
4058 * Useful for things like `VoxelManip`, raw Schematic specifiers,
4059 `PerlinNoiseMap:get2d`/`3dMap`, and so on.
4060 * `indexp(p)`: same functionality as `index(x, y, z)` but takes a vector.
4061 * As with `index(x, y, z)`, the components of `p` must be integers, and `p`
4062 is not checked for being inside the area volume.
4063 * `position(i)`: returns the absolute position vector corresponding to index
4065 * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by
4066 `MinEdge` and `MaxEdge`.
4067 * `containsp(p)`: same as above, except takes a vector
4068 * `containsi(i)`: same as above, except takes an index `i`
4069 * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns
4071 * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of
4073 * `iterp(minp, maxp)`: same as above, except takes a vector
4075 ### Y stride and z stride of a flat array
4077 For a particular position in a voxel area, whose flat array index is known,
4078 it is often useful to know the index of a neighboring or nearby position.
4079 The table below shows the changes of index required for 1 node movements along
4080 the axes in a voxel area:
4082 Movement Change of index
4092 local area = VoxelArea:new{MinEdge = emin, MaxEdge = emax}
4094 The values of `ystride` and `zstride` can be obtained using `area.ystride` and
4103 A mapgen object is a construct used in map generation. Mapgen objects can be
4104 used by an `on_generate` callback to speed up operations by avoiding
4105 unnecessary recalculations, these can be retrieved using the
4106 `minetest.get_mapgen_object()` function. If the requested Mapgen object is
4107 unavailable, or `get_mapgen_object()` was called outside of an `on_generate()`
4108 callback, `nil` is returned.
4110 The following Mapgen objects are currently available:
4114 This returns three values; the `VoxelManip` object to be used, minimum and
4115 maximum emerged position, in that order. All mapgens support this object.
4119 Returns an array containing the y coordinates of the ground levels of nodes in
4120 the most recently generated chunk by the current mapgen.
4124 Returns an array containing the biome IDs of nodes in the most recently
4125 generated chunk by the current mapgen.
4129 Returns an array containing the temperature values of nodes in the most
4130 recently generated chunk by the current mapgen.
4134 Returns an array containing the humidity values of nodes in the most recently
4135 generated chunk by the current mapgen.
4139 Returns a table mapping requested generation notification types to arrays of
4140 positions at which the corresponding generated structures are located within
4141 the current chunk. To set the capture of positions of interest to be recorded
4142 on generate, use `minetest.set_gen_notify()`.
4143 For decorations, the returned positions are the ground surface 'place_on'
4144 nodes, not the decorations themselves. A 'simple' type decoration is often 1
4145 node above the returned position and possibly displaced by 'place_offset_y'.
4147 Possible fields of the table returned are:
4153 * `large_cave_begin`
4157 Decorations have a key in the format of `"decoration#id"`, where `id` is the
4158 numeric unique decoration ID as returned by `minetest.get_decoration_id`.
4166 Functions receive a "luaentity" as `self`:
4168 * It has the member `.name`, which is the registered name `("mod:thing")`
4169 * It has the member `.object`, which is an `ObjectRef` pointing to the object
4170 * The original prototype stuff is visible directly via a metatable
4174 * `on_activate(self, staticdata, dtime_s)`
4175 * Called when the object is instantiated.
4176 * `dtime_s` is the time passed since the object was unloaded, which can be
4177 used for updating the entity state.
4178 * `on_step(self, dtime)`
4179 * Called on every server tick, after movement and collision processing.
4180 `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
4182 * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)`
4183 * Called when somebody punches the object.
4184 * Note that you probably want to handle most punches using the automatic
4186 * `puncher`: an `ObjectRef` (can be `nil`)
4187 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4189 * `tool_capabilities`: capability table of used tool (can be `nil`)
4190 * `dir`: unit vector of direction of punch. Always defined. Points from the
4191 puncher to the punched.
4192 * `damage`: damage that will be done to entity.
4193 * Can return `true` to prevent the default damage mechanism.
4194 * `on_death(self, killer)`
4195 * Called when the object dies.
4196 * `killer`: an `ObjectRef` (can be `nil`)
4197 * `on_rightclick(self, clicker)`
4198 * `on_attach_child(self, child)`
4199 * `child`: an `ObjectRef` of the child that attaches
4200 * `on_detach_child(self, child)`
4201 * `child`: an `ObjectRef` of the child that detaches
4202 * `on_detach(self, parent)`
4203 * `parent`: an `ObjectRef` (can be `nil`) from where it got detached
4204 * This happens before the parent object is removed from the world
4205 * `get_staticdata(self)`
4206 * Should return a string that will be passed to `on_activate` when the
4207 object is instantiated the next time.
4219 axiom, --string initial tree axiom
4220 rules_a, --string rules set A
4221 rules_b, --string rules set B
4222 rules_c, --string rules set C
4223 rules_d, --string rules set D
4224 trunk, --string trunk node name
4225 leaves, --string leaves node name
4226 leaves2, --string secondary leaves node name
4227 leaves2_chance,--num chance (0-100) to replace leaves with leaves2
4228 angle, --num angle in deg
4229 iterations, --num max # of iterations, usually 2 -5
4230 random_level, --num factor to lower nr of iterations, usually 0 - 3
4231 trunk_type, --string single/double/crossed) type of trunk: 1 node,
4232 -- 2x2 nodes or 3x3 in cross shape
4233 thin_branches, --boolean true -> use thin (1 node) branches
4234 fruit, --string fruit node name
4235 fruit_chance, --num chance (0-100) to replace leaves with fruit node
4236 seed, --num random seed, if no seed is provided, the engine
4240 Key for special L-System symbols used in axioms
4241 -----------------------------------------------
4243 * `G`: move forward one unit with the pen up
4244 * `F`: move forward one unit with the pen down drawing trunks and branches
4245 * `f`: move forward one unit with the pen down drawing leaves (100% chance)
4246 * `T`: move forward one unit with the pen down drawing trunks only
4247 * `R`: move forward one unit with the pen down placing fruit
4248 * `A`: replace with rules set A
4249 * `B`: replace with rules set B
4250 * `C`: replace with rules set C
4251 * `D`: replace with rules set D
4252 * `a`: replace with rules set A, chance 90%
4253 * `b`: replace with rules set B, chance 80%
4254 * `c`: replace with rules set C, chance 70%
4255 * `d`: replace with rules set D, chance 60%
4256 * `+`: yaw the turtle right by `angle` parameter
4257 * `-`: yaw the turtle left by `angle` parameter
4258 * `&`: pitch the turtle down by `angle` parameter
4259 * `^`: pitch the turtle up by `angle` parameter
4260 * `/`: roll the turtle to the right by `angle` parameter
4261 * `*`: roll the turtle to the left by `angle` parameter
4262 * `[`: save in stack current state info
4263 * `]`: recover from stack state info
4268 Spawn a small apple tree:
4270 pos = {x=230,y=20,z=4}
4273 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
4274 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
4275 trunk="default:tree",
4276 leaves="default:leaves",
4280 trunk_type="single",
4283 fruit="default:apple"
4285 minetest.spawn_tree(pos,apple_tree)
4290 'minetest' namespace reference
4291 ==============================
4296 * `minetest.get_current_modname()`: returns the currently loading mod's name,
4298 * `minetest.get_modpath(modname)`: returns e.g.
4299 `"/home/user/.minetest/usermods/modname"`.
4300 * Useful for loading additional `.lua` modules or static data from mod
4301 * `minetest.get_modnames()`: returns a list of installed mods
4302 * Return a list of installed mods, sorted alphabetically
4303 * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
4304 * Useful for storing custom data
4305 * `minetest.is_singleplayer()`
4306 * `minetest.features`: Table containing API feature flags
4309 glasslike_framed = true, -- 0.4.7
4310 nodebox_as_selectionbox = true, -- 0.4.7
4311 get_all_craft_recipes_works = true, -- 0.4.7
4312 -- The transparency channel of textures can optionally be used on
4314 use_texture_alpha = true,
4315 -- Tree and grass ABMs are no longer done from C++ (0.4.8)
4316 no_legacy_abms = true,
4317 -- Texture grouping is possible using parentheses (0.4.11)
4318 texture_names_parens = true,
4319 -- Unique Area ID for AreaStore:insert_area (0.4.14)
4320 area_store_custom_ids = true,
4321 -- add_entity supports passing initial staticdata to on_activate
4323 add_entity_with_staticdata = true,
4324 -- Chat messages are no longer predicted (0.4.16)
4325 no_chat_message_prediction = true,
4326 -- The transparency channel of textures can optionally be used on
4327 -- objects (ie: players and lua entities) (5.0.0)
4328 object_use_texture_alpha = true,
4329 -- Object selectionbox is settable independently from collisionbox
4331 object_independent_selectionbox = true,
4332 -- Specifies whether binary data can be uploaded or downloaded using
4333 -- the HTTP API (5.1.0)
4334 httpfetch_binary_data = true,
4335 -- Whether formspec_version[<version>] may be used (5.1.0)
4336 formspec_version_element = true,
4337 -- Whether AreaStore's IDs are kept on save/load (5.1.0)
4338 area_store_persistent_ids = true,
4339 -- Whether minetest.find_path is functional (5.2.0)
4340 pathfinder_works = true,
4341 -- Whether Collision info is available to an objects' on_step (5.3.0)
4342 object_step_has_moveresult = true,
4343 -- Whether get_velocity() and add_velocity() can be used on players (5.4.0)
4344 direct_velocity_on_players = true,
4347 * `minetest.has_feature(arg)`: returns `boolean, missing_features`
4348 * `arg`: string or table in format `{foo=true, bar=true}`
4349 * `missing_features`: `{foo=true, bar=true}`
4350 * `minetest.get_player_information(player_name)`: Table containing information
4351 about a player. Example return value:
4354 address = "127.0.0.1", -- IP address of client
4355 ip_version = 4, -- IPv4 / IPv6
4356 connection_uptime = 200, -- seconds since client connected
4357 protocol_version = 32, -- protocol version used by client
4358 formspec_version = 2, -- supported formspec version
4359 lang_code = "fr" -- Language code used for translation
4360 -- the following keys can be missing if no stats have been collected yet
4361 min_rtt = 0.01, -- minimum round trip time
4362 max_rtt = 0.2, -- maximum round trip time
4363 avg_rtt = 0.02, -- average round trip time
4364 min_jitter = 0.01, -- minimum packet time jitter
4365 max_jitter = 0.5, -- maximum packet time jitter
4366 avg_jitter = 0.03, -- average packet time jitter
4367 -- the following information is available in a debug build only!!!
4368 -- DO NOT USE IN MODS
4369 --ser_vers = 26, -- serialization version used by client
4370 --major = 0, -- major version number
4371 --minor = 4, -- minor version number
4372 --patch = 10, -- patch version number
4373 --vers_string = "0.4.9-git", -- full version string
4374 --state = "Active" -- current client state
4377 * `minetest.mkdir(path)`: returns success.
4378 * Creates a directory specified by `path`, creating parent directories
4379 if they don't exist.
4380 * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
4382 * nil: return all entries,
4383 * true: return only subdirectory names, or
4384 * false: return only file names.
4385 * `minetest.safe_file_write(path, content)`: returns boolean indicating success
4386 * Replaces contents of file at path with new contents in a safe (atomic)
4387 way. Use this instead of below code when writing e.g. database files:
4388 `local f = io.open(path, "wb"); f:write(content); f:close()`
4389 * `minetest.get_version()`: returns a table containing components of the
4390 engine version. Components:
4391 * `project`: Name of the project, eg, "Minetest"
4392 * `string`: Simple version, eg, "1.2.3-dev"
4393 * `hash`: Full git version (only set if available),
4394 eg, "1.2.3-dev-01234567-dirty".
4395 Use this for informational purposes only. The information in the returned
4396 table does not represent the capabilities of the engine, nor is it
4397 reliable or verifiable. Compatible forks will have a different name and
4398 version entirely. To check for the presence of engine features, test
4399 whether the functions exported by the wanted features exist. For example:
4400 `if minetest.check_for_falling then ... end`.
4401 * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
4402 * `data`: string of data to hash
4403 * `raw`: return raw bytes instead of hex digits, default: false
4408 * `minetest.debug(...)`
4409 * Equivalent to `minetest.log(table.concat({...}, "\t"))`
4410 * `minetest.log([level,] text)`
4411 * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
4412 `"info"`, or `"verbose"`. Default is `"none"`.
4414 Registration functions
4415 ----------------------
4417 Call these functions only at load time!
4421 * `minetest.register_node(name, node definition)`
4422 * `minetest.register_craftitem(name, item definition)`
4423 * `minetest.register_tool(name, item definition)`
4424 * `minetest.override_item(name, redefinition)`
4425 * Overrides fields of an item registered with register_node/tool/craftitem.
4426 * Note: Item must already be defined, (opt)depend on the mod defining it.
4427 * Example: `minetest.override_item("default:mese",
4428 {light_source=minetest.LIGHT_MAX})`
4429 * `minetest.unregister_item(name)`
4430 * Unregisters the item from the engine, and deletes the entry with key
4431 `name` from `minetest.registered_items` and from the associated item table
4432 according to its nature: `minetest.registered_nodes`, etc.
4433 * `minetest.register_entity(name, entity definition)`
4434 * `minetest.register_abm(abm definition)`
4435 * `minetest.register_lbm(lbm definition)`
4436 * `minetest.register_alias(alias, original_name)`
4437 * Also use this to set the 'mapgen aliases' needed in a game for the core
4438 mapgens. See [Mapgen aliases] section above.
4439 * `minetest.register_alias_force(alias, original_name)`
4440 * `minetest.register_ore(ore definition)`
4441 * Returns an integer object handle uniquely identifying the registered
4443 * The order of ore registrations determines the order of ore generation.
4444 * `minetest.register_biome(biome definition)`
4445 * Returns an integer object handle uniquely identifying the registered
4446 biome on success. To get the biome ID, use `minetest.get_biome_id`.
4447 * `minetest.unregister_biome(name)`
4448 * Unregisters the biome from the engine, and deletes the entry with key
4449 `name` from `minetest.registered_biomes`.
4450 * Warning: This alters the biome to biome ID correspondences, so any
4451 decorations or ores using the 'biomes' field must afterwards be cleared
4453 * `minetest.register_decoration(decoration definition)`
4454 * Returns an integer object handle uniquely identifying the registered
4455 decoration on success. To get the decoration ID, use
4456 `minetest.get_decoration_id`.
4457 * The order of decoration registrations determines the order of decoration
4459 * `minetest.register_schematic(schematic definition)`
4460 * Returns an integer object handle uniquely identifying the registered
4461 schematic on success.
4462 * If the schematic is loaded from a file, the `name` field is set to the
4464 * If the function is called when loading the mod, and `name` is a relative
4465 path, then the current mod path will be prepended to the schematic
4467 * `minetest.clear_registered_biomes()`
4468 * Clears all biomes currently registered.
4469 * Warning: Clearing and re-registering biomes alters the biome to biome ID
4470 correspondences, so any decorations or ores using the 'biomes' field must
4471 afterwards be cleared and re-registered.
4472 * `minetest.clear_registered_decorations()`
4473 * Clears all decorations currently registered.
4474 * `minetest.clear_registered_ores()`
4475 * Clears all ores currently registered.
4476 * `minetest.clear_registered_schematics()`
4477 * Clears all schematics currently registered.
4481 * `minetest.register_craft(recipe)`
4482 * Check recipe table syntax for different types below.
4483 * `minetest.clear_craft(recipe)`
4484 * Will erase existing craft based either on output item or on input recipe.
4485 * Specify either output or input only. If you specify both, input will be
4486 ignored. For input use the same recipe table syntax as for
4487 `minetest.register_craft(recipe)`. For output specify only the item,
4489 * Returns false if no erase candidate could be found, otherwise returns true.
4490 * **Warning**! The type field ("shaped", "cooking" or any other) will be
4491 ignored if the recipe contains output. Erasing is then done independently
4492 from the crafting method.
4493 * `minetest.register_chatcommand(cmd, chatcommand definition)`
4494 * `minetest.override_chatcommand(name, redefinition)`
4495 * Overrides fields of a chatcommand registered with `register_chatcommand`.
4496 * `minetest.unregister_chatcommand(name)`
4497 * Unregisters a chatcommands registered with `register_chatcommand`.
4498 * `minetest.register_privilege(name, definition)`
4499 * `definition` can be a description or a definition table (see [Privilege
4501 * If it is a description, the priv will be granted to singleplayer and admin
4503 * To allow players with `basic_privs` to grant, see the `basic_privs`
4504 minetest.conf setting.
4505 * `minetest.register_authentication_handler(authentication handler definition)`
4506 * Registers an auth handler that overrides the builtin one.
4507 * This function can be called by a single mod once only.
4509 Global callback registration functions
4510 --------------------------------------
4512 Call these functions only at load time!
4514 * `minetest.register_globalstep(function(dtime))`
4515 * Called every server step, usually interval of 0.1s
4516 * `minetest.register_on_mods_loaded(function())`
4517 * Called after mods have finished loading and before the media is cached or the
4519 * `minetest.register_on_shutdown(function())`
4520 * Called before server shutdown
4521 * **Warning**: If the server terminates abnormally (i.e. crashes), the
4522 registered callbacks **will likely not be run**. Data should be saved at
4523 semi-frequent intervals as well as on server shutdown.
4524 * `minetest.register_on_placenode(function(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
4525 * Called when a node has been placed
4526 * If return `true` no item is taken from `itemstack`
4527 * `placer` may be any valid ObjectRef or nil.
4528 * **Not recommended**; use `on_construct` or `after_place_node` in node
4529 definition whenever possible.
4530 * `minetest.register_on_dignode(function(pos, oldnode, digger))`
4531 * Called when a node has been dug.
4532 * **Not recommended**; Use `on_destruct` or `after_dig_node` in node
4533 definition whenever possible.
4534 * `minetest.register_on_punchnode(function(pos, node, puncher, pointed_thing))`
4535 * Called when a node is punched
4536 * `minetest.register_on_generated(function(minp, maxp, blockseed))`
4537 * Called after generating a piece of world. Modifying nodes inside the area
4538 is a bit faster than usually.
4539 * `minetest.register_on_newplayer(function(ObjectRef))`
4540 * Called when a new player enters the world for the first time
4541 * `minetest.register_on_punchplayer(function(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
4542 * Called when a player is punched
4543 * Note: This callback is invoked even if the punched player is dead.
4544 * `player`: ObjectRef - Player that was punched
4545 * `hitter`: ObjectRef - Player that hit
4546 * `time_from_last_punch`: Meant for disallowing spamming of clicks
4548 * `tool_capabilities`: Capability table of used tool (can be nil)
4549 * `dir`: Unit vector of direction of punch. Always defined. Points from
4550 the puncher to the punched.
4551 * `damage`: Number that represents the damage calculated by the engine
4552 * should return `true` to prevent the default damage mechanism
4553 * `minetest.register_on_player_hpchange(function(player, hp_change, reason), modifier)`
4554 * Called when the player gets damaged or healed
4555 * `player`: ObjectRef of the player
4556 * `hp_change`: the amount of change. Negative when it is damage.
4557 * `reason`: a PlayerHPChangeReason table.
4558 * The `type` field will have one of the following values:
4559 * `set_hp`: A mod or the engine called `set_hp` without
4560 giving a type - use this for custom damage types.
4561 * `punch`: Was punched. `reason.object` will hold the puncher, or nil if none.
4563 * `node_damage`: `damage_per_second` from a neighbouring node.
4564 `reason.node` will hold the node name or nil.
4567 * Any of the above types may have additional fields from mods.
4568 * `reason.from` will be `mod` or `engine`.
4569 * `modifier`: when true, the function should return the actual `hp_change`.
4570 Note: modifiers only get a temporary `hp_change` that can be modified by later modifiers.
4571 Modifiers can return true as a second argument to stop the execution of further functions.
4572 Non-modifiers receive the final HP change calculated by the modifiers.
4573 * `minetest.register_on_dieplayer(function(ObjectRef, reason))`
4574 * Called when a player dies
4575 * `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
4576 * `minetest.register_on_respawnplayer(function(ObjectRef))`
4577 * Called when player is to be respawned
4578 * Called _before_ repositioning of player occurs
4579 * return true in func to disable regular player placement
4580 * `minetest.register_on_prejoinplayer(function(name, ip))`
4581 * Called when a client connects to the server, prior to authentication
4582 * If it returns a string, the client is disconnected with that string as
4584 * `minetest.register_on_joinplayer(function(ObjectRef, last_login))`
4585 * Called when a player joins the game
4586 * `last_login`: The timestamp of the previous login, or nil if player is new
4587 * `minetest.register_on_leaveplayer(function(ObjectRef, timed_out))`
4588 * Called when a player leaves the game
4589 * `timed_out`: True for timeout, false for other reasons.
4590 * `minetest.register_on_authplayer(function(name, ip, is_success))`
4591 * Called when a client attempts to log into an account.
4592 * `name`: The name of the account being authenticated.
4593 * `ip`: The IP address of the client
4594 * `is_success`: Whether the client was successfully authenticated
4595 * For newly registered accounts, `is_success` will always be true
4596 * `minetest.register_on_auth_fail(function(name, ip))`
4597 * Deprecated: use `minetest.register_on_authplayer(name, ip, is_success)` instead.
4598 * `minetest.register_on_cheat(function(ObjectRef, cheat))`
4599 * Called when a player cheats
4600 * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
4602 * `interacted_too_far`
4603 * `interacted_while_dead`
4604 * `finished_unknown_dig`
4607 * `minetest.register_on_chat_message(function(name, message))`
4608 * Called always when a player says something
4609 * Return `true` to mark the message as handled, which means that it will
4610 not be sent to other players.
4611 * `minetest.register_on_chatcommand(function(name, command, params))`
4612 * Called always when a chatcommand is triggered, before `minetest.registered_chatcommands`
4613 is checked to see if the command exists, but after the input is parsed.
4614 * Return `true` to mark the command as handled, which means that the default
4615 handlers will be prevented.
4616 * `minetest.register_on_player_receive_fields(function(player, formname, fields))`
4617 * Called when the server received input from `player` in a formspec with
4618 the given `formname`. Specifically, this is called on any of the
4620 * a button was pressed,
4621 * Enter was pressed while the focus was on a text field
4622 * a checkbox was toggled,
4623 * something was selected in a dropdown list,
4624 * a different tab was selected,
4625 * selection was changed in a textlist or table,
4626 * an entry was double-clicked in a textlist or table,
4627 * a scrollbar was moved, or
4628 * the form was actively closed by the player.
4629 * Fields are sent for formspec elements which define a field. `fields`
4630 is a table containing each formspecs element value (as string), with
4631 the `name` parameter as index for each. The value depends on the
4632 formspec element type:
4633 * `animated_image`: Returns the index of the current frame.
4634 * `button` and variants: If pressed, contains the user-facing button
4635 text as value. If not pressed, is `nil`
4636 * `field`, `textarea` and variants: Text in the field
4637 * `dropdown`: Either the index or value, depending on the `index event`
4639 * `tabheader`: Tab index, starting with `"1"` (only if tab changed)
4640 * `checkbox`: `"true"` if checked, `"false"` if unchecked
4641 * `textlist`: See `minetest.explode_textlist_event`
4642 * `table`: See `minetest.explode_table_event`
4643 * `scrollbar`: See `minetest.explode_scrollbar_event`
4644 * Special case: `["quit"]="true"` is sent when the user actively
4645 closed the form by mouse click, keypress or through a button_exit[]
4647 * Special case: `["key_enter"]="true"` is sent when the user pressed
4648 the Enter key and the focus was either nowhere (causing the formspec
4649 to be closed) or on a button. If the focus was on a text field,
4650 additionally, the index `key_enter_field` contains the name of the
4651 text field. See also: `field_close_on_enter`.
4652 * Newest functions are called first
4653 * If function returns `true`, remaining functions are not called
4654 * `minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv))`
4655 * Called when `player` crafts something
4656 * `itemstack` is the output
4657 * `old_craft_grid` contains the recipe (Note: the one in the inventory is
4659 * `craft_inv` is the inventory with the crafting grid
4660 * Return either an `ItemStack`, to replace the output, or `nil`, to not
4662 * `minetest.register_craft_predict(function(itemstack, player, old_craft_grid, craft_inv))`
4663 * The same as before, except that it is called before the player crafts, to
4664 make craft prediction, and it should not change anything.
4665 * `minetest.register_allow_player_inventory_action(function(player, action, inventory, inventory_info))`
4666 * Determines how much of a stack may be taken, put or moved to a
4668 * `player` (type `ObjectRef`) is the player who modified the inventory
4669 `inventory` (type `InvRef`).
4670 * List of possible `action` (string) values and their
4671 `inventory_info` (table) contents:
4672 * `move`: `{from_list=string, to_list=string, from_index=number, to_index=number, count=number}`
4673 * `put`: `{listname=string, index=number, stack=ItemStack}`
4674 * `take`: Same as `put`
4675 * Return a numeric value to limit the amount of items to be taken, put or
4676 moved. A value of `-1` for `take` will make the source stack infinite.
4677 * `minetest.register_on_player_inventory_action(function(player, action, inventory, inventory_info))`
4678 * Called after a take, put or move event from/to/in a player inventory
4679 * Function arguments: see `minetest.register_allow_player_inventory_action`
4680 * Does not accept or handle any return value.
4681 * `minetest.register_on_protection_violation(function(pos, name))`
4682 * Called by `builtin` and mods when a player violates protection at a
4683 position (eg, digs a node or punches a protected entity).
4684 * The registered functions can be called using
4685 `minetest.record_protection_violation`.
4686 * The provided function should check that the position is protected by the
4687 mod calling this function before it prints a message, if it does, to
4688 allow for multiple protection mods.
4689 * `minetest.register_on_item_eat(function(hp_change, replace_with_item, itemstack, user, pointed_thing))`
4690 * Called when an item is eaten, by `minetest.item_eat`
4691 * Return `itemstack` to cancel the default item eat response (i.e.: hp increase).
4692 * `minetest.register_on_priv_grant(function(name, granter, priv))`
4693 * Called when `granter` grants the priv `priv` to `name`.
4694 * Note that the callback will be called twice if it's done by a player,
4695 once with granter being the player name, and again with granter being nil.
4696 * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
4697 * Called when `revoker` revokes the priv `priv` from `name`.
4698 * Note that the callback will be called twice if it's done by a player,
4699 once with revoker being the player name, and again with revoker being nil.
4700 * `minetest.register_can_bypass_userlimit(function(name, ip))`
4701 * Called when `name` user connects with `ip`.
4702 * Return `true` to by pass the player limit
4703 * `minetest.register_on_modchannel_message(function(channel_name, sender, message))`
4704 * Called when an incoming mod channel message is received
4705 * You should have joined some channels to receive events.
4706 * If message comes from a server mod, `sender` field is an empty string.
4711 * `minetest.settings`: Settings object containing all of the settings from the
4712 main config file (`minetest.conf`).
4713 * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
4714 parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
4719 * `minetest.string_to_privs(str[, delim])`:
4720 * Converts string representation of privs into table form
4721 * `delim`: String separating the privs. Defaults to `","`.
4722 * Returns `{ priv1 = true, ... }`
4723 * `minetest.privs_to_string(privs[, delim])`:
4724 * Returns the string representation of `privs`
4725 * `delim`: String to delimit privs. Defaults to `","`.
4726 * `minetest.get_player_privs(name) -> {priv1=true,...}`
4727 * `minetest.check_player_privs(player_or_name, ...)`:
4728 returns `bool, missing_privs`
4729 * A quickhand for checking privileges.
4730 * `player_or_name`: Either a Player object or the name of a player.
4731 * `...` is either a list of strings, e.g. `"priva", "privb"` or
4732 a table, e.g. `{ priva = true, privb = true }`.
4734 * `minetest.check_password_entry(name, entry, password)`
4735 * Returns true if the "password entry" for a player with name matches given
4736 password, false otherwise.
4737 * The "password entry" is the password representation generated by the
4738 engine as returned as part of a `get_auth()` call on the auth handler.
4739 * Only use this function for making it possible to log in via password from
4740 external protocols such as IRC, other uses are frowned upon.
4741 * `minetest.get_password_hash(name, raw_password)`
4742 * Convert a name-password pair to a password hash that Minetest can use.
4743 * The returned value alone is not a good basis for password checks based
4744 on comparing the password hash in the database with the password hash
4745 from the function, with an externally provided password, as the hash
4746 in the db might use the new SRP verifier format.
4747 * For this purpose, use `minetest.check_password_entry` instead.
4748 * `minetest.get_player_ip(name)`: returns an IP address string for the player
4750 * The player needs to be online for this to be successful.
4752 * `minetest.get_auth_handler()`: Return the currently active auth handler
4753 * See the [Authentication handler definition]
4754 * Use this to e.g. get the authentication data for a player:
4755 `local auth_data = minetest.get_auth_handler().get_auth(playername)`
4756 * `minetest.notify_authentication_modified(name)`
4757 * Must be called by the authentication handler for privilege changes.
4758 * `name`: string; if omitted, all auth data should be considered modified
4759 * `minetest.set_player_password(name, password_hash)`: Set password hash of
4761 * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player
4763 * `minetest.auth_reload()`
4764 * See `reload()` in authentication handler definition
4766 `minetest.set_player_password`, `minetest.set_player_privs`,
4767 `minetest.get_player_privs` and `minetest.auth_reload` call the authentication
4773 * `minetest.chat_send_all(text)`
4774 * `minetest.chat_send_player(name, text)`
4775 * `minetest.format_chat_message(name, message)`
4776 * Used by the server to format a chat message, based on the setting `chat_message_format`.
4777 Refer to the documentation of the setting for a list of valid placeholders.
4778 * Takes player name and message, and returns the formatted string to be sent to players.
4779 * Can be redefined by mods if required, for things like colored names or messages.
4780 * **Only** the first occurrence of each placeholder will be replaced.
4785 * `minetest.set_node(pos, node)`
4786 * `minetest.add_node(pos, node)`: alias to `minetest.set_node`
4787 * Set node at position `pos`
4788 * `node`: table `{name=string, param1=number, param2=number}`
4789 * If param1 or param2 is omitted, it's set to `0`.
4790 * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
4791 * `minetest.bulk_set_node({pos1, pos2, pos3, ...}, node)`
4792 * Set node on all positions set in the first argument.
4793 * e.g. `minetest.bulk_set_node({{x=0, y=1, z=1}, {x=1, y=2, z=2}}, {name="default:stone"})`
4794 * For node specification or position syntax see `minetest.set_node` call
4795 * Faster than set_node due to single call, but still considerably slower
4796 than Lua Voxel Manipulators (LVM) for large numbers of nodes.
4797 Unlike LVMs, this will call node callbacks. It also allows setting nodes
4798 in spread out positions which would cause LVMs to waste memory.
4799 For setting a cube, this is 1.3x faster than set_node whereas LVM is 20
4801 * `minetest.swap_node(pos, node)`
4802 * Set node at position, but don't remove metadata
4803 * `minetest.remove_node(pos)`
4804 * By default it does the same as `minetest.set_node(pos, {name="air"})`
4805 * `minetest.get_node(pos)`
4806 * Returns the node at the given position as table in the format
4807 `{name="node_name", param1=0, param2=0}`,
4808 returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
4809 * `minetest.get_node_or_nil(pos)`
4810 * Same as `get_node` but returns `nil` for unloaded areas.
4811 * `minetest.get_node_light(pos, timeofday)`
4812 * Gets the light value at the given position. Note that the light value
4813 "inside" the node at the given position is returned, so you usually want
4814 to get the light value of a neighbor.
4815 * `pos`: The position where to measure the light.
4816 * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
4817 * Returns a number between `0` and `15` or `nil`
4818 * `minetest.place_node(pos, node)`
4819 * Place node with the same effects that a player would cause
4820 * `minetest.dig_node(pos)`
4821 * Dig node with the same effects that a player would cause
4822 * Returns `true` if successful, `false` on failure (e.g. protected location)
4823 * `minetest.punch_node(pos)`
4824 * Punch node with the same effects that a player would cause
4825 * `minetest.spawn_falling_node(pos)`
4826 * Change node into falling node
4827 * Returns `true` if successful, `false` on failure
4829 * `minetest.find_nodes_with_meta(pos1, pos2)`
4830 * Get a table of positions of nodes that have metadata within a region
4832 * `minetest.get_meta(pos)`
4833 * Get a `NodeMetaRef` at that position
4834 * `minetest.get_node_timer(pos)`
4835 * Get `NodeTimerRef`
4837 * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at
4839 * Returns `ObjectRef`, or `nil` if failed
4840 * `minetest.add_item(pos, item)`: Spawn item
4841 * Returns `ObjectRef`, or `nil` if failed
4842 * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
4843 * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of
4845 * `radius`: using an euclidean metric
4846 * `minetest.set_timeofday(val)`
4847 * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
4848 * `minetest.get_timeofday()`
4849 * `minetest.get_gametime()`: returns the time, in seconds, since the world was
4851 * `minetest.get_day_count()`: returns number days elapsed since world was
4853 * accounts for time changes.
4854 * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns
4856 * `radius`: using a maximum metric
4857 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4858 * `search_center` is an optional boolean (default: `false`)
4859 If true `pos` is also checked for the nodes
4860 * `minetest.find_nodes_in_area(pos1, pos2, nodenames, [grouped])`
4861 * `pos1` and `pos2` are the min and max positions of the area to search.
4862 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4863 * If `grouped` is true the return value is a table indexed by node name
4864 which contains lists of positions.
4865 * If `grouped` is false or absent the return values are as follows:
4866 first value: Table with all node positions
4867 second value: Table with the count of each node with the node name
4869 * Area volume is limited to 4,096,000 nodes
4870 * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a
4872 * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
4873 * Return value: Table with all node positions with a node air above
4874 * Area volume is limited to 4,096,000 nodes
4875 * `minetest.get_perlin(noiseparams)`
4876 * Return world-specific perlin noise.
4877 * The actual seed used is the noiseparams seed plus the world seed.
4878 * `minetest.get_perlin(seeddiff, octaves, persistence, spread)`
4879 * Deprecated: use `minetest.get_perlin(noiseparams)` instead.
4880 * Return world-specific perlin noise.
4881 * `minetest.get_voxel_manip([pos1, pos2])`
4882 * Return voxel manipulator object.
4883 * Loads the manipulator from the map if positions are passed.
4884 * `minetest.set_gen_notify(flags, {deco_ids})`
4885 * Set the types of on-generate notifications that should be collected.
4886 * `flags` is a flag field with the available flags:
4894 * The second parameter is a list of IDs of decorations which notification
4896 * `minetest.get_gen_notify()`
4897 * Returns a flagstring and a table with the `deco_id`s.
4898 * `minetest.get_decoration_id(decoration_name)`
4899 * Returns the decoration ID number for the provided decoration name string,
4900 or `nil` on failure.
4901 * `minetest.get_mapgen_object(objectname)`
4902 * Return requested mapgen object if available (see [Mapgen objects])
4903 * `minetest.get_heat(pos)`
4904 * Returns the heat at the position, or `nil` on failure.
4905 * `minetest.get_humidity(pos)`
4906 * Returns the humidity at the position, or `nil` on failure.
4907 * `minetest.get_biome_data(pos)`
4908 * Returns a table containing:
4909 * `biome` the biome id of the biome at that position
4910 * `heat` the heat at the position
4911 * `humidity` the humidity at the position
4912 * Or returns `nil` on failure.
4913 * `minetest.get_biome_id(biome_name)`
4914 * Returns the biome id, as used in the biomemap Mapgen object and returned
4915 by `minetest.get_biome_data(pos)`, for a given biome_name string.
4916 * `minetest.get_biome_name(biome_id)`
4917 * Returns the biome name string for the provided biome id, or `nil` on
4919 * If no biomes have been registered, such as in mgv6, returns `default`.
4920 * `minetest.get_mapgen_params()`
4921 * Deprecated: use `minetest.get_mapgen_setting(name)` instead.
4922 * Returns a table containing:
4928 * `minetest.set_mapgen_params(MapgenParams)`
4929 * Deprecated: use `minetest.set_mapgen_setting(name, value, override)`
4931 * Set map generation parameters.
4932 * Function cannot be called after the registration period; only
4933 initialization and `on_mapgen_init`.
4934 * Takes a table as an argument with the fields:
4940 * Leave field unset to leave that parameter unchanged.
4941 * `flags` contains a comma-delimited string of flags to set, or if the
4942 prefix `"no"` is attached, clears instead.
4943 * `flags` is in the same format and has the same options as `mg_flags` in
4945 * `minetest.get_mapgen_setting(name)`
4946 * Gets the *active* mapgen setting (or nil if none exists) in string
4947 format with the following order of precedence:
4948 1) Settings loaded from map_meta.txt or overrides set during mod
4950 2) Settings set by mods without a metafile override
4951 3) Settings explicitly set in the user config file, minetest.conf
4952 4) Settings set as the user config default
4953 * `minetest.get_mapgen_setting_noiseparams(name)`
4954 * Same as above, but returns the value as a NoiseParams table if the
4955 setting `name` exists and is a valid NoiseParams.
4956 * `minetest.set_mapgen_setting(name, value, [override_meta])`
4957 * Sets a mapgen param to `value`, and will take effect if the corresponding
4958 mapgen setting is not already present in map_meta.txt.
4959 * `override_meta` is an optional boolean (default: `false`). If this is set
4960 to true, the setting will become the active setting regardless of the map
4962 * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`.
4963 * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
4964 * Same as above, except value is a NoiseParams table.
4965 * `minetest.set_noiseparams(name, noiseparams, set_default)`
4966 * Sets the noiseparams setting of `name` to the noiseparams table specified
4968 * `set_default` is an optional boolean (default: `true`) that specifies
4969 whether the setting should be applied to the default config or current
4971 * `minetest.get_noiseparams(name)`
4972 * Returns a table of the noiseparams for name.
4973 * `minetest.generate_ores(vm, pos1, pos2)`
4974 * Generate all registered ores within the VoxelManip `vm` and in the area
4975 from `pos1` to `pos2`.
4976 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
4977 * `minetest.generate_decorations(vm, pos1, pos2)`
4978 * Generate all registered decorations within the VoxelManip `vm` and in the
4979 area from `pos1` to `pos2`.
4980 * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
4981 * `minetest.clear_objects([options])`
4982 * Clear all objects in the environment
4983 * Takes an optional table as an argument with the field `mode`.
4984 * mode = `"full"` : Load and go through every mapblock, clearing
4986 * mode = `"quick"`: Clear objects immediately in loaded mapblocks,
4987 clear objects in unloaded mapblocks only when the
4988 mapblocks are next activated.
4989 * `minetest.load_area(pos1[, pos2])`
4990 * Load the mapblocks containing the area from `pos1` to `pos2`.
4991 `pos2` defaults to `pos1` if not specified.
4992 * This function does not trigger map generation.
4993 * `minetest.emerge_area(pos1, pos2, [callback], [param])`
4994 * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be
4995 asynchronously fetched from memory, loaded from disk, or if inexistent,
4997 * If `callback` is a valid Lua function, this will be called for each block
4999 * The function signature of callback is:
5000 `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
5001 * `blockpos` is the *block* coordinates of the block that had been
5003 * `action` could be one of the following constant values:
5004 * `minetest.EMERGE_CANCELLED`
5005 * `minetest.EMERGE_ERRORED`
5006 * `minetest.EMERGE_FROM_MEMORY`
5007 * `minetest.EMERGE_FROM_DISK`
5008 * `minetest.EMERGE_GENERATED`
5009 * `calls_remaining` is the number of callbacks to be expected after
5011 * `param` is the user-defined parameter passed to emerge_area (or
5012 nil if the parameter was absent).
5013 * `minetest.delete_area(pos1, pos2)`
5014 * delete all mapblocks in the area from pos1 to pos2, inclusive
5015 * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
5016 * Checks if there is anything other than air between pos1 and pos2.
5017 * Returns false if something is blocking the sight.
5018 * Returns the position of the blocking node when `false`
5019 * `pos1`: First position
5020 * `pos2`: Second position
5021 * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
5022 * Creates a `Raycast` object.
5023 * `pos1`: start of the ray
5024 * `pos2`: end of the ray
5025 * `objects`: if false, only nodes will be returned. Default is `true`.
5026 * `liquids`: if false, liquid nodes won't be returned. Default is `false`.
5027 * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
5028 * returns table containing path that can be walked on
5029 * returns a table of 3D points representing a path from `pos1` to `pos2` or
5031 * Reasons for failure:
5032 * No path exists at all
5033 * No path exists within `searchdistance` (see below)
5034 * Start or end pos is buried in land
5035 * `pos1`: start position
5036 * `pos2`: end position
5037 * `searchdistance`: maximum distance from the search positions to search in.
5038 In detail: Path must be completely inside a cuboid. The minimum
5039 `searchdistance` of 1 will confine search between `pos1` and `pos2`.
5040 Larger values will increase the size of this cuboid in all directions
5041 * `max_jump`: maximum height difference to consider walkable
5042 * `max_drop`: maximum height difference to consider droppable
5043 * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`.
5044 Difference between `"A*"` and `"A*_noprefetch"` is that
5045 `"A*"` will pre-calculate the cost-data, the other will calculate it
5047 * `minetest.spawn_tree (pos, {treedef})`
5048 * spawns L-system tree at given `pos` with definition in `treedef` table
5049 * `minetest.transforming_liquid_add(pos)`
5050 * add node to liquid update queue
5051 * `minetest.get_node_max_level(pos)`
5052 * get max available level for leveled node
5053 * `minetest.get_node_level(pos)`
5054 * get level of leveled node (water, snow)
5055 * `minetest.set_node_level(pos, level)`
5056 * set level of leveled node, default `level` equals `1`
5057 * if `totallevel > maxlevel`, returns rest (`total-max`).
5058 * `minetest.add_node_level(pos, level)`
5059 * increase level of leveled node by level, default `level` equals `1`
5060 * if `totallevel > maxlevel`, returns rest (`total-max`)
5061 * `level` must be between -127 and 127
5062 * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
5063 * resets the light in a cuboid-shaped part of
5064 the map and removes lighting bugs.
5065 * Loads the area if it is not loaded.
5066 * `pos1` is the corner of the cuboid with the least coordinates
5067 (in node coordinates), inclusive.
5068 * `pos2` is the opposite corner of the cuboid, inclusive.
5069 * The actual updated cuboid might be larger than the specified one,
5070 because only whole map blocks can be updated.
5071 The actual updated area consists of those map blocks that intersect
5072 with the given cuboid.
5073 * However, the neighborhood of the updated area might change
5074 as well, as light can spread out of the cuboid, also light
5076 * returns `false` if the area is not fully generated,
5078 * `minetest.check_single_for_falling(pos)`
5079 * causes an unsupported `group:falling_node` node to fall and causes an
5080 unattached `group:attached_node` node to fall.
5081 * does not spread these updates to neighbours.
5082 * `minetest.check_for_falling(pos)`
5083 * causes an unsupported `group:falling_node` node to fall and causes an
5084 unattached `group:attached_node` node to fall.
5085 * spread these updates to neighbours and can cause a cascade
5087 * `minetest.get_spawn_level(x, z)`
5088 * Returns a player spawn y co-ordinate for the provided (x, z)
5089 co-ordinates, or `nil` for an unsuitable spawn point.
5090 * For most mapgens a 'suitable spawn point' is one with y between
5091 `water_level` and `water_level + 16`, and in mgv7 well away from rivers,
5092 so `nil` will be returned for many (x, z) co-ordinates.
5093 * The spawn level returned is for a player spawn in unmodified terrain.
5094 * The spawn level is intentionally above terrain level to cope with
5095 full-node biome 'dust' nodes.
5100 You can find mod channels communication scheme in `doc/mod_channels.png`.
5102 * `minetest.mod_channel_join(channel_name)`
5103 * Server joins channel `channel_name`, and creates it if necessary. You
5104 should listen for incoming messages with
5105 `minetest.register_on_modchannel_message`
5110 `minetest.get_inventory(location)`: returns an `InvRef`
5113 * `{type="player", name="celeron55"}`
5114 * `{type="node", pos={x=, y=, z=}}`
5115 * `{type="detached", name="creative"}`
5116 * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns
5118 * `callbacks`: See [Detached inventory callbacks]
5119 * `player_name`: Make detached inventory available to one player
5120 exclusively, by default they will be sent to every player (even if not
5122 Note that this parameter is mostly just a workaround and will be removed
5124 * Creates a detached inventory. If it already exists, it is cleared.
5125 * `minetest.remove_detached_inventory(name)`
5126 * Returns a `boolean` indicating whether the removal succeeded.
5127 * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
5128 returns left over ItemStack.
5129 * See `minetest.item_eat` and `minetest.register_on_item_eat`
5134 * `minetest.show_formspec(playername, formname, formspec)`
5135 * `playername`: name of player to show formspec
5136 * `formname`: name passed to `on_player_receive_fields` callbacks.
5137 It should follow the `"modname:<whatever>"` naming convention
5138 * `formspec`: formspec to display
5139 * `minetest.close_formspec(playername, formname)`
5140 * `playername`: name of player to close formspec
5141 * `formname`: has to exactly match the one given in `show_formspec`, or the
5142 formspec will not close.
5143 * calling `show_formspec(playername, formname, "")` is equal to this
5145 * to close a formspec regardless of the formname, call
5146 `minetest.close_formspec(playername, "")`.
5147 **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
5148 * `minetest.formspec_escape(string)`: returns a string
5149 * escapes the characters "[", "]", "\", "," and ";", which can not be used
5151 * `minetest.explode_table_event(string)`: returns a table
5152 * returns e.g. `{type="CHG", row=1, column=2}`
5154 * `"INV"`: no row selected
5156 * `"DCL"`: double-click
5157 * `minetest.explode_textlist_event(string)`: returns a table
5158 * returns e.g. `{type="CHG", index=1}`
5160 * `"INV"`: no row selected
5162 * `"DCL"`: double-click
5163 * `minetest.explode_scrollbar_event(string)`: returns a table
5164 * returns e.g. `{type="CHG", value=500}`
5166 * `"INV"`: something failed
5167 * `"CHG"`: has been changed
5168 * `"VAL"`: not changed
5173 * `minetest.inventorycube(img1, img2, img3)`
5174 * Returns a string for making an image of a cube (useful as an item image)
5175 * `minetest.get_pointed_thing_position(pointed_thing, above)`
5176 * Returns the position of a `pointed_thing` or `nil` if the `pointed_thing`
5177 does not refer to a node or entity.
5178 * If the optional `above` parameter is true and the `pointed_thing` refers
5179 to a node, then it will return the `above` position of the `pointed_thing`.
5180 * `minetest.dir_to_facedir(dir, is6d)`
5181 * Convert a vector to a facedir value, used in `param2` for
5182 `paramtype2="facedir"`.
5183 * passing something non-`nil`/`false` for the optional second parameter
5184 causes it to take the y component into account.
5185 * `minetest.facedir_to_dir(facedir)`
5186 * Convert a facedir back into a vector aimed directly out the "back" of a
5188 * `minetest.dir_to_wallmounted(dir)`
5189 * Convert a vector to a wallmounted value, used for
5190 `paramtype2="wallmounted"`.
5191 * `minetest.wallmounted_to_dir(wallmounted)`
5192 * Convert a wallmounted value back into a vector aimed directly out the
5194 * `minetest.dir_to_yaw(dir)`
5195 * Convert a vector into a yaw (angle)
5196 * `minetest.yaw_to_dir(yaw)`
5197 * Convert yaw (angle) to a vector
5198 * `minetest.is_colored_paramtype(ptype)`
5199 * Returns a boolean. Returns `true` if the given `paramtype2` contains
5200 color information (`color`, `colorwallmounted` or `colorfacedir`).
5201 * `minetest.strip_param2_color(param2, paramtype2)`
5202 * Removes everything but the color information from the
5203 given `param2` value.
5204 * Returns `nil` if the given `paramtype2` does not contain color
5206 * `minetest.get_node_drops(node, toolname)`
5207 * Returns list of itemstrings that are dropped by `node` when dug
5209 * `node`: node as table or node name
5210 * `toolname`: name of the tool item (can be `nil`)
5211 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
5212 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
5213 * `input.width` = for example `3`
5214 * `input.items` = for example
5215 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
5216 * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
5217 * `output.time` = a number, if unsuccessful: `0`
5218 * `output.replacements` = List of replacement `ItemStack`s that couldn't be
5219 placed in `decremented_input.items`. Replacements can be placed in
5220 `decremented_input` if the stack of the replaced item has a count of 1.
5221 * `decremented_input` = like `input`
5222 * `minetest.get_craft_recipe(output)`: returns input
5223 * returns last registered recipe for output item (node)
5224 * `output` is a node or item type such as `"default:torch"`
5225 * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
5226 * `input.width` = for example `3`
5227 * `input.items` = for example
5228 `{stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9}`
5229 * `input.items` = `nil` if no recipe found
5230 * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
5231 * returns indexed table with all registered recipes for query item (node)
5232 or `nil` if no recipe was found.
5233 * recipe entry table:
5234 * `method`: 'normal' or 'cooking' or 'fuel'
5235 * `width`: 0-3, 0 means shapeless recipe
5236 * `items`: indexed [1-9] table with recipe items
5237 * `output`: string with item name and quantity
5238 * Example query for `"default:gold_ingot"` will return table:
5241 [1]={method = "cooking", width = 3, output = "default:gold_ingot",
5242 items = {1 = "default:gold_lump"}},
5243 [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
5244 items = {1 = "default:goldblock"}}
5246 * `minetest.handle_node_drops(pos, drops, digger)`
5247 * `drops`: list of itemstrings
5248 * Handles drops from nodes after digging: Default action is to put them
5249 into digger's inventory.
5250 * Can be overridden to get different functionality (e.g. dropping items on
5252 * `minetest.itemstring_with_palette(item, palette_index)`: returns an item
5254 * Creates an item string which contains palette index information
5255 for hardware colorization. You can use the returned string
5256 as an output in a craft recipe.
5257 * `item`: the item stack which becomes colored. Can be in string,
5258 table and native form.
5259 * `palette_index`: this index is added to the item stack
5260 * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
5261 * Creates an item string which contains static color information
5262 for hardware colorization. Use this method if you wish to colorize
5263 an item that does not own a palette. You can use the returned string
5264 as an output in a craft recipe.
5265 * `item`: the item stack which becomes colored. Can be in string,
5266 table and native form.
5267 * `colorstring`: the new color of the item stack
5272 * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
5273 returns `{{actor, pos, time, oldnode, newnode}, ...}`
5274 * Find who has done something to a node, or near a node
5275 * `actor`: `"player:<name>"`, also `"liquid"`.
5276 * `minetest.rollback_revert_actions_by(actor, seconds)`: returns
5277 `boolean, log_messages`.
5278 * Revert latest actions of someone
5279 * `actor`: `"player:<name>"`, also `"liquid"`.
5281 Defaults for the `on_place` and `on_drop` item definition functions
5282 -------------------------------------------------------------------
5284 * `minetest.item_place_node(itemstack, placer, pointed_thing[, param2, prevent_after_place])`
5285 * Place item as a node
5286 * `param2` overrides `facedir` and wallmounted `param2`
5287 * `prevent_after_place`: if set to `true`, `after_place_node` is not called
5288 for the newly placed node to prevent a callback and placement loop
5289 * returns `itemstack, position`
5290 * `position`: the location the node was placed to. `nil` if nothing was placed.
5291 * `minetest.item_place_object(itemstack, placer, pointed_thing)`
5293 * returns the leftover itemstack
5294 * **Note**: This function is deprecated and will never be called.
5295 * `minetest.item_place(itemstack, placer, pointed_thing[, param2])`
5296 * Wrapper that calls `minetest.item_place_node` if appropriate
5297 * Calls `on_rightclick` of `pointed_thing.under` if defined instead
5298 * **Note**: is not called when wielded item overrides `on_place`
5299 * `param2` overrides facedir and wallmounted `param2`
5300 * returns `itemstack, position`
5301 * `position`: the location the node was placed to. `nil` if nothing was placed.
5302 * `minetest.item_drop(itemstack, dropper, pos)`
5304 * returns the leftover itemstack
5305 * `minetest.item_eat(hp_change[, replace_with_item])`
5306 * Returns `function(itemstack, user, pointed_thing)` as a
5307 function wrapper for `minetest.do_item_eat`.
5308 * `replace_with_item` is the itemstring which is added to the inventory.
5309 If the player is eating a stack, then replace_with_item goes to a
5312 Defaults for the `on_punch` and `on_dig` node definition callbacks
5313 ------------------------------------------------------------------
5315 * `minetest.node_punch(pos, node, puncher, pointed_thing)`
5316 * Calls functions registered by `minetest.register_on_punchnode()`
5317 * `minetest.node_dig(pos, node, digger)`
5318 * Checks if node can be dug, puts item into inventory, removes node
5319 * Calls functions registered by `minetest.registered_on_dignodes()`
5324 * `minetest.sound_play(spec, parameters, [ephemeral])`: returns a handle
5325 * `spec` is a `SimpleSoundSpec`
5326 * `parameters` is a sound parameter table
5327 * `ephemeral` is a boolean (default: false)
5328 Ephemeral sounds will not return a handle and can't be stopped or faded.
5329 It is recommend to use this for short sounds that happen in response to
5330 player actions (e.g. door closing).
5331 * `minetest.sound_stop(handle)`
5332 * `handle` is a handle returned by `minetest.sound_play`
5333 * `minetest.sound_fade(handle, step, gain)`
5334 * `handle` is a handle returned by `minetest.sound_play`
5335 * `step` determines how fast a sound will fade.
5336 The gain will change by this much per second,
5337 until it reaches the target gain.
5338 Note: Older versions used a signed step. This is deprecated, but old
5339 code will still work. (the client uses abs(step) to correct it)
5340 * `gain` the target gain for the fade.
5341 Fading to zero will delete the sound.
5346 * `minetest.after(time, func, ...)` : returns job table to use as below.
5347 * Call the function `func` after `time` seconds, may be fractional
5348 * Optional: Variable number of arguments that are passed to `func`
5351 * Cancels the job function from being called
5356 * `minetest.request_shutdown([message],[reconnect],[delay])`: request for
5357 server shutdown. Will display `message` to clients.
5358 * `reconnect` == true displays a reconnect button
5359 * `delay` adds an optional delay (in seconds) before shutdown.
5360 Negative delay cancels the current active shutdown.
5361 Zero delay triggers an immediate shutdown.
5362 * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
5363 * `minetest.get_server_status(name, joined)`
5364 * Returns the server status string when a player joins or when the command
5365 `/status` is called. Returns `nil` or an empty string when the message is
5367 * `joined`: Boolean value, indicates whether the function was called when
5369 * This function may be overwritten by mods to customize the status message.
5370 * `minetest.get_server_uptime()`: returns the server uptime in seconds
5371 * `minetest.remove_player(name)`: remove player from database (if they are not
5373 * As auth data is not removed, minetest.player_exists will continue to
5374 return true. Call the below method as well if you want to remove auth
5376 * Returns a code (0: successful, 1: no such player, 2: player is connected)
5377 * `minetest.remove_player_auth(name)`: remove player authentication data
5378 * Returns boolean indicating success (false if player nonexistant)
5379 * `minetest.dynamic_add_media(filepath)`
5380 * Adds the file at the given path to the media sent to clients by the server
5381 on startup and also pushes this file to already connected clients.
5382 The file must be a supported image, sound or model format. It must not be
5383 modified, deleted, moved or renamed after calling this function.
5384 The list of dynamically added media is not persisted.
5385 * Returns boolean indicating success (duplicate files count as error)
5386 * The media will be ready to use (in e.g. entity textures, sound_play)
5387 immediately after calling this function.
5388 Old clients that lack support for this feature will not see the media
5389 unless they reconnect to the server.
5390 * Since media transferred this way does not use client caching or HTTP
5391 transfers, dynamic media should not be used with big files or performance
5397 * `minetest.get_ban_list()`: returns a list of all bans formatted as string
5398 * `minetest.get_ban_description(ip_or_name)`: returns list of bans matching
5399 IP address or name formatted as string
5400 * `minetest.ban_player(name)`: ban the IP of a currently connected player
5401 * Returns boolean indicating success
5402 * `minetest.unban_player_or_ip(ip_or_name)`: remove ban record matching
5404 * `minetest.kick_player(name, [reason])`: disconnect a player with an optional
5406 * Returns boolean indicating success (false if player nonexistant)
5411 * `minetest.add_particle(particle definition)`
5412 * Deprecated: `minetest.add_particle(pos, velocity, acceleration,
5413 expirationtime, size, collisiondetection, texture, playername)`
5415 * `minetest.add_particlespawner(particlespawner definition)`
5416 * Add a `ParticleSpawner`, an object that spawns an amount of particles
5417 over `time` seconds.
5418 * Returns an `id`, and -1 if adding didn't succeed
5419 * Deprecated: `minetest.add_particlespawner(amount, time,
5423 minexptime, maxexptime,
5425 collisiondetection, texture, playername)`
5427 * `minetest.delete_particlespawner(id, player)`
5428 * Delete `ParticleSpawner` with `id` (return value from
5429 `minetest.add_particlespawner`).
5430 * If playername is specified, only deletes on the player's client,
5431 otherwise on all clients.
5436 * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
5437 * Create a schematic from the volume of map specified by the box formed by
5439 * Apply the specified probability and per-node force-place to the specified
5440 nodes according to the `probability_list`.
5441 * `probability_list` is an array of tables containing two fields, `pos`
5443 * `pos` is the 3D vector specifying the absolute coordinates of the
5444 node being modified,
5445 * `prob` is an integer value from `0` to `255` that encodes
5446 probability and per-node force-place. Probability has levels
5447 0-127, then 128 may be added to encode per-node force-place.
5448 For probability stated as 0-255, divide by 2 and round down to
5449 get values 0-127, then add 128 to apply per-node force-place.
5450 * If there are two or more entries with the same pos value, the
5452 * If `pos` is not inside the box formed by `p1` and `p2`, it is
5454 * If `probability_list` equals `nil`, no probabilities are applied.
5455 * Apply the specified probability to the specified horizontal slices
5456 according to the `slice_prob_list`.
5457 * `slice_prob_list` is an array of tables containing two fields, `ypos`
5459 * `ypos` indicates the y position of the slice with a probability
5460 applied, the lowest slice being `ypos = 0`.
5461 * If slice probability list equals `nil`, no slice probabilities
5463 * Saves schematic in the Minetest Schematic format to filename.
5465 * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement, flags)`
5466 * Place the schematic specified by schematic (see [Schematic specifier]) at
5468 * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
5469 * If the `rotation` parameter is omitted, the schematic is not rotated.
5470 * `replacements` = `{["old_name"] = "convert_to", ...}`
5471 * `force_placement` is a boolean indicating whether nodes other than `air`
5472 and `ignore` are replaced by the schematic.
5473 * Returns nil if the schematic could not be loaded.
5474 * **Warning**: Once you have loaded a schematic from a file, it will be
5475 cached. Future calls will always use the cached version and the
5476 replacement list defined for it, regardless of whether the file or the
5477 replacement list parameter have changed. The only way to load the file
5478 anew is to restart the server.
5479 * `flags` is a flag field with the available flags:
5484 * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement, flags)`:
5485 * This function is analogous to minetest.place_schematic, but places a
5486 schematic onto the specified VoxelManip object `vmanip` instead of the
5488 * Returns false if any part of the schematic was cut-off due to the
5489 VoxelManip not containing the full area required, and true if the whole
5490 schematic was able to fit.
5491 * Returns nil if the schematic could not be loaded.
5492 * After execution, any external copies of the VoxelManip contents are
5494 * `flags` is a flag field with the available flags:
5499 * `minetest.serialize_schematic(schematic, format, options)`
5500 * Return the serialized schematic specified by schematic
5501 (see [Schematic specifier])
5502 * in the `format` of either "mts" or "lua".
5503 * "mts" - a string containing the binary MTS data used in the MTS file
5505 * "lua" - a string containing Lua code representing the schematic in table
5507 * `options` is a table containing the following optional parameters:
5508 * If `lua_use_comments` is true and `format` is "lua", the Lua code
5509 generated will have (X, Z) position comments for every X row
5510 generated in the schematic data for easier reading.
5511 * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua",
5512 the Lua code generated will use that number of spaces as indentation
5513 instead of a tab character.
5515 * `minetest.read_schematic(schematic, options)`
5516 * Returns a Lua table representing the schematic (see: [Schematic specifier])
5517 * `schematic` is the schematic to read (see: [Schematic specifier])
5518 * `options` is a table containing the following optional parameters:
5519 * `write_yslice_prob`: string value:
5520 * `none`: no `write_yslice_prob` table is inserted,
5521 * `low`: only probabilities that are not 254 or 255 are written in
5522 the `write_ylisce_prob` table,
5523 * `all`: write all probabilities to the `write_yslice_prob` table.
5524 * The default for this option is `all`.
5525 * Any invalid value will be interpreted as `all`.
5530 * `minetest.request_http_api()`:
5531 * returns `HTTPApiTable` containing http functions if the calling mod has
5532 been granted access by being listed in the `secure.http_mods` or
5533 `secure.trusted_mods` setting, otherwise returns `nil`.
5534 * The returned table contains the functions `fetch`, `fetch_async` and
5535 `fetch_async_get` described below.
5536 * Only works at init time and must be called from the mod's main scope
5537 (not from a function).
5538 * Function only exists if minetest server was built with cURL support.
5539 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
5541 * `HTTPApiTable.fetch(HTTPRequest req, callback)`
5542 * Performs given request asynchronously and calls callback upon completion
5543 * callback: `function(HTTPRequestResult res)`
5544 * Use this HTTP function if you are unsure, the others are for advanced use
5545 * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
5546 * Performs given request asynchronously and returns handle for
5547 `HTTPApiTable.fetch_async_get`
5548 * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
5549 * Return response data for given asynchronous HTTP request
5554 * `minetest.get_mod_storage()`:
5555 * returns reference to mod private `StorageRef`
5556 * must be called during mod load time
5561 * `minetest.get_connected_players()`: returns list of `ObjectRefs`
5562 * `minetest.is_player(obj)`: boolean, whether `obj` is a player
5563 * `minetest.player_exists(name)`: boolean, whether player exists
5564 (regardless of online status)
5565 * `minetest.hud_replace_builtin(name, hud_definition)`
5566 * Replaces definition of a builtin hud element
5567 * `name`: `"breath"` or `"health"`
5568 * `hud_definition`: definition to replace builtin definition
5569 * `minetest.send_join_message(player_name)`
5570 * This function can be overridden by mods to change the join message.
5571 * `minetest.send_leave_message(player_name, timed_out)`
5572 * This function can be overridden by mods to change the leave message.
5573 * `minetest.hash_node_position(pos)`: returns an 48-bit integer
5574 * `pos`: table {x=number, y=number, z=number},
5575 * Gives a unique hash number for a node position (16+16+16=48bit)
5576 * `minetest.get_position_from_hash(hash)`: returns a position
5577 * Inverse transform of `minetest.hash_node_position`
5578 * `minetest.get_item_group(name, group)`: returns a rating
5579 * Get rating of a group of an item. (`0` means: not in group)
5580 * `minetest.get_node_group(name, group)`: returns a rating
5581 * Deprecated: An alias for the former.
5582 * `minetest.raillike_group(name)`: returns a rating
5583 * Returns rating of the connect_to_raillike group corresponding to name
5584 * If name is not yet the name of a connect_to_raillike group, a new group
5585 id is created, with that name.
5586 * `minetest.get_content_id(name)`: returns an integer
5587 * Gets the internal content ID of `name`
5588 * `minetest.get_name_from_content_id(content_id)`: returns a string
5589 * Gets the name of the content with that content ID
5590 * `minetest.parse_json(string[, nullvalue])`: returns something
5591 * Convert a string containing JSON data into the Lua equivalent
5592 * `nullvalue`: returned in place of the JSON null; defaults to `nil`
5593 * On success returns a table, a string, a number, a boolean or `nullvalue`
5594 * On failure outputs an error message and returns `nil`
5595 * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
5596 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error
5598 * Convert a Lua table into a JSON string
5599 * styled: Outputs in a human-readable format if this is set, defaults to
5601 * Unserializable things like functions and userdata will cause an error.
5602 * **Warning**: JSON is more strict than the Lua table format.
5603 1. You can only use strings and positive integers of at least one as
5605 2. You can not mix string and integer keys.
5606 This is due to the fact that JSON has two distinct array and object
5608 * Example: `write_json({10, {a = false}})`,
5609 returns `"[10, {\"a\": false}]"`
5610 * `minetest.serialize(table)`: returns a string
5611 * Convert a table containing tables, strings, numbers, booleans and `nil`s
5612 into string form readable by `minetest.deserialize`
5613 * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
5614 * `minetest.deserialize(string[, safe])`: returns a table
5615 * Convert a string returned by `minetest.serialize` into a table
5616 * `string` is loaded in an empty sandbox environment.
5617 * Will load functions if safe is false or omitted. Although these functions
5618 cannot directly access the global environment, they could bypass this
5619 restriction with maliciously crafted Lua bytecode if mod security is
5621 * This function should not be used on untrusted data, regardless of the
5622 value of `safe`. It is fine to serialize then deserialize user-provided
5623 data, but directly providing user input to deserialize is always unsafe.
5624 * Example: `deserialize('return { ["foo"] = "bar" }')`,
5625 returns `{foo='bar'}`
5626 * Example: `deserialize('print("foo")')`, returns `nil`
5627 (function call fails), returns
5628 `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
5629 * `minetest.compress(data, method, ...)`: returns `compressed_data`
5630 * Compress a string of data.
5631 * `method` is a string identifying the compression method to be used.
5632 * Supported compression methods:
5633 * Deflate (zlib): `"deflate"`
5634 * `...` indicates method-specific arguments. Currently defined arguments
5636 * Deflate: `level` - Compression level, `0`-`9` or `nil`.
5637 * `minetest.decompress(compressed_data, method, ...)`: returns data
5638 * Decompress a string of data (using ZLib).
5639 * See documentation on `minetest.compress()` for supported compression
5641 * `...` indicates method-specific arguments. Currently, no methods use this
5642 * `minetest.rgba(red, green, blue[, alpha])`: returns a string
5643 * Each argument is a 8 Bit unsigned integer
5644 * Returns the ColorString from rgb or rgba values
5645 * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
5646 * `minetest.encode_base64(string)`: returns string encoded in base64
5647 * Encodes a string in base64.
5648 * `minetest.decode_base64(string)`: returns string or nil for invalid base64
5649 * Decodes a string encoded in base64.
5650 * `minetest.is_protected(pos, name)`: returns boolean
5651 * Returning `true` restricts the player `name` from modifying (i.e. digging,
5652 placing) the node at position `pos`.
5653 * `name` will be `""` for non-players or unknown players.
5654 * This function should be overridden by protection mods. It is highly
5655 recommended to grant access to players with the `protection_bypass` privilege.
5656 * Cache and call the old version of this function if the position is
5657 not protected by the mod. This will allow using multiple protection mods.
5660 local old_is_protected = minetest.is_protected
5661 function minetest.is_protected(pos, name)
5662 if mymod:position_protected_from(pos, name) then
5665 return old_is_protected(pos, name)
5667 * `minetest.record_protection_violation(pos, name)`
5668 * This function calls functions registered with
5669 `minetest.register_on_protection_violation`.
5670 * `minetest.is_creative_enabled(name)`: returns boolean
5671 * Returning `true` means that Creative Mode is enabled for player `name`.
5672 * `name` will be `""` for non-players or if the player is unknown.
5673 * This function should be overridden by Creative Mode-related mods to
5674 implement a per-player Creative Mode.
5675 * By default, this function returns `true` if the setting
5676 `creative_mode` is `true` and `false` otherwise.
5677 * `minetest.is_area_protected(pos1, pos2, player_name, interval)`
5678 * Returns the position of the first node that `player_name` may not modify
5679 in the specified cuboid between `pos1` and `pos2`.
5680 * Returns `false` if no protections were found.
5681 * Applies `is_protected()` to a 3D lattice of points in the defined volume.
5682 The points are spaced evenly throughout the volume and have a spacing
5683 similar to, but no larger than, `interval`.
5684 * All corners and edges of the defined volume are checked.
5685 * `interval` defaults to 4.
5686 * `interval` should be carefully chosen and maximised to avoid an excessive
5687 number of points being checked.
5688 * Like `minetest.is_protected`, this function may be extended or
5689 overwritten by mods to provide a faster implementation to check the
5690 cuboid for intersections.
5691 * `minetest.rotate_and_place(itemstack, placer, pointed_thing[, infinitestacks,
5692 orient_flags, prevent_after_place])`
5693 * Attempt to predict the desired orientation of the facedir-capable node
5694 defined by `itemstack`, and place it accordingly (on-wall, on the floor,
5695 or hanging from the ceiling).
5696 * `infinitestacks`: if `true`, the itemstack is not changed. Otherwise the
5697 stacks are handled normally.
5698 * `orient_flags`: Optional table containing extra tweaks to the placement code:
5699 * `invert_wall`: if `true`, place wall-orientation on the ground and
5700 ground-orientation on the wall.
5701 * `force_wall` : if `true`, always place the node in wall orientation.
5702 * `force_ceiling`: if `true`, always place on the ceiling.
5703 * `force_floor`: if `true`, always place the node on the floor.
5704 * `force_facedir`: if `true`, forcefully reset the facedir to north
5705 when placing on the floor or ceiling.
5706 * The first four options are mutually-exclusive; the last in the list
5707 takes precedence over the first.
5708 * `prevent_after_place` is directly passed to `minetest.item_place_node`
5709 * Returns the new itemstack after placement
5710 * `minetest.rotate_node(itemstack, placer, pointed_thing)`
5711 * calls `rotate_and_place()` with `infinitestacks` set according to the state
5712 of the creative mode setting, checks for "sneak" to set the `invert_wall`
5713 parameter and `prevent_after_place` set to `true`.
5715 * `minetest.calculate_knockback(player, hitter, time_from_last_punch,
5716 tool_capabilities, dir, distance, damage)`
5717 * Returns the amount of knockback applied on the punched player.
5718 * Arguments are equivalent to `register_on_punchplayer`, except the following:
5719 * `distance`: distance between puncher and punched player
5720 * This function can be overriden by mods that wish to modify this behaviour.
5721 * You may want to cache and call the old function to allow multiple mods to
5722 change knockback behaviour.
5724 * `minetest.forceload_block(pos[, transient])`
5725 * forceloads the position `pos`.
5726 * returns `true` if area could be forceloaded
5727 * If `transient` is `false` or absent, the forceload will be persistent
5728 (saved between server runs). If `true`, the forceload will be transient
5729 (not saved between server runs).
5731 * `minetest.forceload_free_block(pos[, transient])`
5732 * stops forceloading the position `pos`
5733 * If `transient` is `false` or absent, frees a persistent forceload.
5734 If `true`, frees a transient forceload.
5736 * `minetest.request_insecure_environment()`: returns an environment containing
5737 insecure functions if the calling mod has been listed as trusted in the
5738 `secure.trusted_mods` setting or security is disabled, otherwise returns
5740 * Only works at init time and must be called from the mod's main scope
5741 (ie: the init.lua of the mod, not from another Lua file or within a function).
5742 * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE
5743 IT IN A LOCAL VARIABLE!**
5745 * `minetest.global_exists(name)`
5746 * Checks if a global variable has been set, without triggering a warning.
5751 * `minetest.env`: `EnvRef` of the server environment and world.
5752 * Any function in the minetest namespace can be called using the syntax
5753 `minetest.env:somefunction(somearguments)`
5754 instead of `minetest.somefunction(somearguments)`
5755 * Deprecated, but support is not to be dropped soon
5760 ### Registered definition tables
5762 * `minetest.registered_items`
5763 * Map of registered items, indexed by name
5764 * `minetest.registered_nodes`
5765 * Map of registered node definitions, indexed by name
5766 * `minetest.registered_craftitems`
5767 * Map of registered craft item definitions, indexed by name
5768 * `minetest.registered_tools`
5769 * Map of registered tool definitions, indexed by name
5770 * `minetest.registered_entities`
5771 * Map of registered entity prototypes, indexed by name
5772 * Values in this table may be modified directly.
5773 Note: changes to initial properties will only affect entities spawned afterwards,
5774 as they are only read when spawning.
5775 * `minetest.object_refs`
5776 * Map of object references, indexed by active object id
5777 * `minetest.luaentities`
5778 * Map of Lua entities, indexed by active object id
5779 * `minetest.registered_abms`
5780 * List of ABM definitions
5781 * `minetest.registered_lbms`
5782 * List of LBM definitions
5783 * `minetest.registered_aliases`
5784 * Map of registered aliases, indexed by name
5785 * `minetest.registered_ores`
5786 * Map of registered ore definitions, indexed by the `name` field.
5787 * If `name` is nil, the key is the object handle returned by
5788 `minetest.register_ore`.
5789 * `minetest.registered_biomes`
5790 * Map of registered biome definitions, indexed by the `name` field.
5791 * If `name` is nil, the key is the object handle returned by
5792 `minetest.register_biome`.
5793 * `minetest.registered_decorations`
5794 * Map of registered decoration definitions, indexed by the `name` field.
5795 * If `name` is nil, the key is the object handle returned by
5796 `minetest.register_decoration`.
5797 * `minetest.registered_schematics`
5798 * Map of registered schematic definitions, indexed by the `name` field.
5799 * If `name` is nil, the key is the object handle returned by
5800 `minetest.register_schematic`.
5801 * `minetest.registered_chatcommands`
5802 * Map of registered chat command definitions, indexed by name
5803 * `minetest.registered_privileges`
5804 * Map of registered privilege definitions, indexed by name
5805 * Registered privileges can be modified directly in this table.
5807 ### Registered callback tables
5809 All callbacks registered with [Global callback registration functions] are added
5810 to corresponding `minetest.registered_*` tables.
5818 Sorted alphabetically.
5823 A fast access data structure to store areas, and find areas near a given
5825 Every area has a `data` string attribute to store additional information.
5826 You can create an empty `AreaStore` by calling `AreaStore()`, or
5827 `AreaStore(type_name)`. The mod decides where to save and load AreaStore.
5828 If you chose the parameter-less constructor, a fast implementation will be
5829 automatically chosen for you.
5833 * `get_area(id, include_borders, include_data)`
5834 * Returns the area information about the specified ID.
5835 * Returned values are either of these:
5837 nil -- Area not found
5838 true -- Without `include_borders` and `include_data`
5840 min = pos, max = pos -- `include_borders == true`
5841 data = string -- `include_data == true`
5844 * `get_areas_for_pos(pos, include_borders, include_data)`
5845 * Returns all areas as table, indexed by the area ID.
5846 * Table values: see `get_area`.
5847 * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`
5848 * Returns all areas that contain all nodes inside the area specified by `edge1`
5849 and `edge2` (inclusive).
5850 * `accept_overlap`: if `true`, areas are returned that have nodes in
5851 common (intersect) with the specified area.
5852 * Returns the same values as `get_areas_for_pos`.
5853 * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store.
5854 * Returns the new area's ID, or nil if the insertion failed.
5855 * The (inclusive) positions `edge1` and `edge2` describe the area.
5856 * `data` is a string stored with the area.
5857 * `id` (optional): will be used as the internal area ID if it is an unique
5858 number between 0 and 2^32-2.
5859 * `reserve(count)`: reserves resources for at most `count` many contained
5861 Only needed for efficiency, and only some implementations profit.
5862 * `remove_area(id)`: removes the area with the given id from the store, returns
5864 * `set_cache_params(params)`: sets params for the included prefiltering cache.
5865 Calling invalidates the cache, so that its elements have to be newly
5867 * `params` is a table with the following fields:
5869 enabled = boolean, -- Whether to enable, default true
5870 block_radius = int, -- The radius (in nodes) of the areas the cache
5871 -- generates prefiltered lists for, minimum 16,
5873 limit = int, -- The cache size, minimum 20, default 1000
5874 * `to_string()`: Experimental. Returns area store serialized as a (binary)
5876 * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to
5878 * `from_string(str)`: Experimental. Deserializes string and loads it into the
5880 Returns success and, optionally, an error message.
5881 * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data
5887 An `InvRef` is a reference to an inventory.
5891 * `is_empty(listname)`: return `true` if list is empty
5892 * `get_size(listname)`: get size of a list
5893 * `set_size(listname, size)`: set size of a list
5894 * returns `false` on error (e.g. invalid `listname` or `size`)
5895 * `get_width(listname)`: get width of a list
5896 * `set_width(listname, width)`: set width of list; currently used for crafting
5897 * `get_stack(listname, i)`: get a copy of stack index `i` in list
5898 * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
5899 * `get_list(listname)`: return full list
5900 * `set_list(listname, list)`: set full list (size will not change)
5901 * `get_lists()`: returns list of inventory lists
5902 * `set_lists(lists)`: sets inventory lists (size will not change)
5903 * `add_item(listname, stack)`: add item somewhere in list, returns leftover
5905 * `room_for_item(listname, stack):` returns `true` if the stack of items
5906 can be fully added to the list
5907 * `contains_item(listname, stack, [match_meta])`: returns `true` if
5908 the stack of items can be fully taken from the list.
5909 If `match_meta` is false, only the items' names are compared
5911 * `remove_item(listname, stack)`: take as many items as specified from the
5912 list, returns the items that were actually removed (as an `ItemStack`)
5913 -- note that any item metadata is ignored, so attempting to remove a specific
5914 unique item this way will likely remove the wrong one -- to do that use
5915 `set_stack` with an empty `ItemStack`.
5916 * `get_location()`: returns a location compatible to
5917 `minetest.get_inventory(location)`.
5918 * returns `{type="undefined"}` in case location is not known
5922 Detached & nodemeta inventories provide the following callbacks for move actions:
5926 The `allow_*` callbacks return how many items can be moved.
5928 * `allow_move`/`allow_metadata_inventory_move`: Moving items in the inventory
5929 * `allow_take`/`allow_metadata_inventory_take`: Taking items from the inventory
5930 * `allow_put`/`allow_metadata_inventory_put`: Putting items to the inventory
5934 The `on_*` callbacks are called after the items have been placed in the inventories.
5936 * `on_move`/`on_metadata_inventory_move`: Moving items in the inventory
5937 * `on_take`/`on_metadata_inventory_take`: Taking items from the inventory
5938 * `on_put`/`on_metadata_inventory_put`: Putting items to the inventory
5942 When a player tries to put an item to a place where another item is, the items are *swapped*.
5943 This means that all callbacks will be called twice (once for each action).
5948 An `ItemStack` is a stack of items.
5950 It can be created via `ItemStack(x)`, where x is an `ItemStack`,
5951 an itemstring, a table or `nil`.
5955 * `is_empty()`: returns `true` if stack is empty.
5956 * `get_name()`: returns item name (e.g. `"default:stone"`).
5957 * `set_name(item_name)`: returns a boolean indicating whether the item was
5959 * `get_count()`: Returns number of items on the stack.
5960 * `set_count(count)`: returns a boolean indicating whether the item was cleared
5961 * `count`: number, unsigned 16 bit integer
5962 * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
5963 * `set_wear(wear)`: returns boolean indicating whether item was cleared
5964 * `wear`: number, unsigned 16 bit integer
5965 * `get_meta()`: returns ItemStackMetaRef. See section for more details
5966 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
5968 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
5969 * `get_description()`: returns the description shown in inventory list tooltips.
5970 * `clear()`: removes all items from the stack, making it empty.
5971 * `replace(item)`: replace the contents of this stack.
5972 * `item` can also be an itemstring or table.
5973 * `to_string()`: returns the stack in itemstring form.
5974 * `to_table()`: returns the stack in Lua table form.
5975 * `get_stack_max()`: returns the maximum size of the stack (depends on the
5977 * `get_free_space()`: returns `get_stack_max() - get_count()`.
5978 * `is_known()`: returns `true` if the item name refers to a defined item type.
5979 * `get_definition()`: returns the item definition table.
5980 * `get_tool_capabilities()`: returns the digging properties of the item,
5981 or those of the hand if none are defined for this item type
5982 * `add_wear(amount)`
5983 * Increases wear by `amount` if the item is a tool
5984 * `amount`: number, integer
5985 * `add_item(item)`: returns leftover `ItemStack`
5986 * Put some item or stack onto this stack
5987 * `item_fits(item)`: returns `true` if item or stack can be fully added to
5989 * `take_item(n)`: returns taken `ItemStack`
5990 * Take (and remove) up to `n` items from this stack
5991 * `n`: number, default: `1`
5992 * `peek_item(n)`: returns taken `ItemStack`
5993 * Copy (don't remove) up to `n` items from this stack
5994 * `n`: number, default: `1`
5999 ItemStack metadata: reference extra data and functionality stored in a stack.
6000 Can be obtained via `item:get_meta()`.
6004 * All methods in MetaDataRef
6005 * `set_tool_capabilities([tool_capabilities])`
6006 * Overrides the item's tool capabilities
6007 * A nil value will clear the override data and restore the original
6013 Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],
6014 and [`PlayerMetaRef`].
6018 * `contains(key)`: Returns true if key present, otherwise false.
6019 * Returns `nil` when the MetaData is inexistent.
6020 * `get(key)`: Returns `nil` if key not present, else the stored string.
6021 * `set_string(key, value)`: Value of `""` will delete the key.
6022 * `get_string(key)`: Returns `""` if key not present.
6023 * `set_int(key, value)`
6024 * `get_int(key)`: Returns `0` if key not present.
6025 * `set_float(key, value)`
6026 * `get_float(key)`: Returns `0` if key not present.
6027 * `to_table()`: returns `nil` or a table with keys:
6028 * `fields`: key-value storage
6029 * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
6030 * `from_table(nil or {})`
6031 * Any non-table value will clear the metadata
6032 * See [Node Metadata] for an example
6033 * returns `true` on success
6035 * returns `true` if this metadata has the same key-value pairs as `other`
6040 An interface to use mod channels on client and server
6044 * `leave()`: leave the mod channel.
6045 * Server leaves channel `channel_name`.
6046 * No more incoming or outgoing messages can be sent to this channel from
6048 * This invalidate all future object usage.
6049 * Ensure you set mod_channel to nil after that to free Lua resources.
6050 * `is_writeable()`: returns true if channel is writeable and mod can send over
6052 * `send_all(message)`: Send `message` though the mod channel.
6053 * If mod channel is not writeable or invalid, message will be dropped.
6054 * Message size is limited to 65535 characters by protocol.
6059 Node metadata: reference extra data and functionality stored in a node.
6060 Can be obtained via `minetest.get_meta(pos)`.
6064 * All methods in MetaDataRef
6065 * `get_inventory()`: returns `InvRef`
6066 * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
6067 This will prevent them from being sent to the client. Note that the "private"
6068 status will only be remembered if an associated key-value pair exists,
6069 meaning it's best to call this when initializing all other meta (e.g.
6075 Node Timers: a high resolution persistent per-node timer.
6076 Can be gotten via `minetest.get_node_timer(pos)`.
6080 * `set(timeout,elapsed)`
6081 * set a timer's state
6082 * `timeout` is in seconds, and supports fractional values (0.1 etc)
6083 * `elapsed` is in seconds, and supports fractional values (0.1 etc)
6084 * will trigger the node's `on_timer` function after `(timeout - elapsed)`
6088 * equivalent to `set(timeout,0)`
6091 * `get_timeout()`: returns current timeout in seconds
6092 * if `timeout` equals `0`, timer is inactive
6093 * `get_elapsed()`: returns current elapsed time in seconds
6094 * the node's `on_timer` function will be called after `(timeout - elapsed)`
6096 * `is_started()`: returns boolean state of timer
6097 * returns `true` if timer is started, otherwise `false`
6102 Moving things in the game are generally these.
6103 This is basically a reference to a C++ `ServerActiveObject`.
6105 ### Advice on handling `ObjectRefs`
6107 When you receive an `ObjectRef` as a callback argument or from another API
6108 function, it is possible to store the reference somewhere and keep it around.
6109 It will keep functioning until the object is unloaded or removed.
6111 However, doing this is **NOT** recommended as there is (intentionally) no method
6112 to test if a previously acquired `ObjectRef` is still valid.
6113 Instead, `ObjectRefs` should be "let go" of as soon as control is returned from
6114 Lua back to the engine.
6115 Doing so is much less error-prone and you will never need to wonder if the
6116 object you are working with still exists.
6121 * `get_pos()`: returns `{x=num, y=num, z=num}`
6122 * `set_pos(pos)`: `pos`=`{x=num, y=num, z=num}`
6123 * `get_velocity()`: returns the velocity, a vector.
6124 * `add_velocity(vel)`
6125 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
6126 * In comparison to using get_velocity, adding the velocity and then using
6127 set_velocity, add_velocity is supposed to avoid synchronization problems.
6128 Additionally, players also do not support set_velocity.
6130 * Does not apply during free_move.
6131 * Note that since the player speed is normalized at each move step,
6132 increasing e.g. Y velocity beyond what would usually be achieved
6133 (see: physics overrides) will cause existing X/Z velocity to be reduced.
6134 * Example: `add_velocity({x=0, y=6.5, z=0})` is equivalent to
6135 pressing the jump key (assuming default settings)
6136 * `move_to(pos, continuous=false)`
6137 * Does an interpolated move for Lua entities for visually smooth transitions.
6138 * If `continuous` is true, the Lua entity will not be moved to the current
6139 position before starting the interpolated move.
6140 * For players this does the same as `set_pos`,`continuous` is ignored.
6141 * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
6142 * `puncher` = another `ObjectRef`,
6143 * `time_from_last_punch` = time since last punch action of the puncher
6144 * `direction`: can be `nil`
6145 * `right_click(clicker)`; `clicker` is another `ObjectRef`
6146 * `get_hp()`: returns number of hitpoints (2 * number of hearts)
6147 * `set_hp(hp, reason)`: set number of hitpoints (2 * number of hearts).
6148 * See reason in register_on_player_hpchange
6149 * Is limited to the range of 0 ... 65535 (2^16 - 1)
6150 * For players: HP are also limited by `hp_max` specified in the player's
6152 * `get_inventory()`: returns an `InvRef` for players, otherwise returns `nil`
6153 * `get_wield_list()`: returns the name of the inventory list the wielded item
6155 * `get_wield_index()`: returns the index of the wielded item
6156 * `get_wielded_item()`: returns an `ItemStack`
6157 * `set_wielded_item(item)`: replaces the wielded item, returns `true` if
6159 * `set_armor_groups({group1=rating, group2=rating, ...})`
6160 * `get_armor_groups()`: returns a table with the armor group ratings
6161 * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
6162 * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
6163 * `frame_speed`: number, default: `15.0`
6164 * `frame_blend`: number, default: `0.0`
6165 * `frame_loop`: boolean, default: `true`
6166 * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and
6168 * `set_animation_frame_speed(frame_speed)`
6169 * `frame_speed`: number, default: `15.0`
6170 * `set_attach(parent, bone, position, rotation)`
6172 * `position`: `{x=num, y=num, z=num}` (relative)
6173 * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees
6174 * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't
6177 * `set_bone_position(bone, position, rotation)`
6179 * `position`: `{x=num, y=num, z=num}` (relative)
6180 * `rotation`: `{x=num, y=num, z=num}`
6181 * `get_bone_position(bone)`: returns position and rotation of the bone
6182 * `set_properties(object property table)`
6183 * `get_properties()`: returns object property table
6184 * `is_player()`: returns true for players, false otherwise
6185 * `get_nametag_attributes()`
6186 * returns a table with the attributes of the nametag of an object
6188 color = {a=0..255, r=0..255, g=0..255, b=0..255},
6191 * `set_nametag_attributes(attributes)`
6192 * sets the attributes of the nametag of an object
6196 text = "My Nametag",
6199 #### Lua entity only (no-op for other objects)
6201 * `remove()`: remove object
6202 * The object is removed after returning from Lua. However the `ObjectRef`
6203 itself instantly becomes unusable with all further method calls having
6204 no effect and returning `nil`.
6205 * `set_velocity(vel)`
6206 * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
6207 * `set_acceleration(acc)`
6209 * `get_acceleration()`: returns the acceleration, a vector
6210 * `set_rotation(rot)`
6211 * `rot` is a vector (radians). X is pitch (elevation), Y is yaw (heading)
6212 and Z is roll (bank).
6213 * `get_rotation()`: returns the rotation, a vector (radians)
6214 * `set_yaw(radians)`: sets the yaw (heading).
6215 * `get_yaw()`: returns number in radians
6216 * `set_texture_mod(mod)`
6217 * Set a texture modifier to the base texture, for sprites and meshes.
6218 * When calling `set_texture_mod` again, the previous one is discarded.
6219 * `mod` the texture modifier. See [Texture modifiers].
6220 * `get_texture_mod()` returns current texture modifier
6221 * `set_sprite(p, num_frames, framelength, select_x_by_camera)`
6222 * Specifies and starts a sprite animation
6223 * Animations iterate along the frame `y` position.
6224 * `p`: {x=column number, y=row number}, the coordinate of the first frame
6225 default: `{x=0, y=0}`
6226 * `num_frames`: Total frames in the texture, default: `1`
6227 * `framelength`: Time per animated frame in seconds, default: `0.2`
6228 * `select_x_by_camera`: Only for visual = `sprite`. Changes the frame `x`
6229 position according to the view direction. default: `false`.
6230 * First column: subject facing the camera
6231 * Second column: subject looking to the left
6232 * Third column: subject backing the camera
6233 * Fourth column: subject looking to the right
6234 * Fifth column: subject viewed from above
6235 * Sixth column: subject viewed from below
6236 * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
6239 #### Player only (no-op for other objects)
6241 * `get_player_name()`: returns `""` if is not a player
6242 * `get_player_velocity()`: **DEPRECATED**, use get_velocity() instead.
6243 table {x, y, z} representing the player's instantaneous velocity in nodes/s
6244 * `add_player_velocity(vel)`: **DEPRECATED**, use add_velocity(vel) instead.
6245 * `get_look_dir()`: get camera direction as a unit vector
6246 * `get_look_vertical()`: pitch in radians
6247 * Angle ranges between -pi/2 and pi/2, which are straight up and down
6249 * `get_look_horizontal()`: yaw in radians
6250 * Angle is counter-clockwise from the +z direction.
6251 * `set_look_vertical(radians)`: sets look pitch
6252 * radians: Angle from looking forward, where positive is downwards.
6253 * `set_look_horizontal(radians)`: sets look yaw
6254 * radians: Angle from the +z direction, where positive is counter-clockwise.
6255 * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use
6256 `get_look_vertical`.
6257 * Angle ranges between -pi/2 and pi/2, which are straight down and up
6259 * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use
6260 `get_look_horizontal`.
6261 * Angle is counter-clockwise from the +x direction.
6262 * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use
6263 `set_look_vertical`.
6264 * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use
6265 `set_look_horizontal`.
6266 * `get_breath()`: returns player's breath
6267 * `set_breath(value)`: sets player's breath
6269 * `0`: player is drowning
6270 * max: bubbles bar is not shown
6271 * See [Object properties] for more information
6272 * Is limited to range 0 ... 65535 (2^16 - 1)
6273 * `set_fov(fov, is_multiplier, transition_time)`: Sets player's FOV
6275 * `is_multiplier`: Set to `true` if the FOV value is a multiplier.
6276 Defaults to `false`.
6277 * `transition_time`: If defined, enables smooth FOV transition.
6278 Interpreted as the time (in seconds) to reach target FOV.
6279 If set to 0, FOV change is instantaneous. Defaults to 0.
6280 * Set `fov` to 0 to clear FOV override.
6281 * `get_fov()`: Returns the following:
6282 * Server-sent FOV value. Returns 0 if an FOV override doesn't exist.
6283 * Boolean indicating whether the FOV value is a multiplier.
6284 * Time (in seconds) taken for the FOV transition. Set by `set_fov`.
6285 * `set_attribute(attribute, value)`: DEPRECATED, use get_meta() instead
6286 * Sets an extra attribute with value on player.
6287 * `value` must be a string, or a number which will be converted to a
6289 * If `value` is `nil`, remove attribute from player.
6290 * `get_attribute(attribute)`: DEPRECATED, use get_meta() instead
6291 * Returns value (a string) for extra attribute.
6292 * Returns `nil` if no attribute found.
6293 * `get_meta()`: Returns a PlayerMetaRef.
6294 * `set_inventory_formspec(formspec)`
6295 * Redefine player's inventory form
6296 * Should usually be called in `on_joinplayer`
6297 * `get_inventory_formspec()`: returns a formspec string
6298 * `set_formspec_prepend(formspec)`:
6299 * the formspec string will be added to every formspec shown to the user,
6300 except for those with a no_prepend[] tag.
6301 * This should be used to set style elements such as background[] and
6302 bgcolor[], any non-style elements (eg: label) may result in weird behaviour.
6303 * Only affects formspecs shown after this is called.
6304 * `get_formspec_prepend(formspec)`: returns a formspec string.
6305 * `get_player_control()`: returns table with player pressed keys
6306 * The table consists of fields with the following boolean values
6307 representing the pressed keys: `up`, `down`, `left`, `right`, `jump`,
6308 `aux1`, `sneak`, `dig`, `place`, `LMB`, `RMB`, and `zoom`.
6309 * The fields `LMB` and `RMB` are equal to `dig` and `place` respectively,
6310 and exist only to preserve backwards compatibility.
6311 * `get_player_control_bits()`: returns integer with bit packed player pressed
6323 * `set_physics_override(override_table)`
6324 * `override_table` is a table with the following fields:
6325 * `speed`: multiplier to default walking speed value (default: `1`)
6326 * `jump`: multiplier to default jump value (default: `1`)
6327 * `gravity`: multiplier to default gravity value (default: `1`)
6328 * `sneak`: whether player can sneak (default: `true`)
6329 * `sneak_glitch`: whether player can use the new move code replications
6330 of the old sneak side-effects: sneak ladders and 2 node sneak jump
6332 * `new_move`: use new move/sneak code. When `false` the exact old code
6333 is used for the specific old sneak behaviour (default: `true`)
6334 * `get_physics_override()`: returns the table given to `set_physics_override`
6335 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
6337 * `hud_remove(id)`: remove the HUD element of the specified id
6338 * `hud_change(id, stat, value)`: change a value of a previously added HUD
6340 * element `stat` values:
6341 `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
6342 * `hud_get(id)`: gets the HUD element definition structure of the specified ID
6343 * `hud_set_flags(flags)`: sets specified HUD flags of player.
6344 * `flags`: A table with the following fields set to boolean values
6352 * If a flag equals `nil`, the flag is not modified
6353 * `minimap`: Modifies the client's permission to view the minimap.
6354 The client may locally elect to not view the minimap.
6355 * `minimap_radar` is only usable when `minimap` is true
6356 * `hud_get_flags()`: returns a table of player HUD flags with boolean values.
6357 * See `hud_set_flags` for a list of flags that can be toggled.
6358 * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
6359 * `count`: number of items, must be between `1` and `32`
6360 * `hud_get_hotbar_itemcount`: returns number of visible items
6361 * `hud_set_hotbar_image(texturename)`
6362 * sets background image for hotbar
6363 * `hud_get_hotbar_image`: returns texturename
6364 * `hud_set_hotbar_selected_image(texturename)`
6365 * sets image for selected item of hotbar
6366 * `hud_get_hotbar_selected_image`: returns texturename
6367 * `set_sky(parameters)`
6368 * `parameters` is a table with the following optional fields:
6369 * `base_color`: ColorSpec, changes fog in "skybox" and "plain".
6370 * `type`: Available types:
6371 * `"regular"`: Uses 0 textures, `base_color` ignored
6372 * `"skybox"`: Uses 6 textures, `base_color` used as fog.
6373 * `"plain"`: Uses 0 textures, `base_color` used as both fog and sky.
6374 * `textures`: A table containing up to six textures in the following
6375 order: Y+ (top), Y- (bottom), X- (west), X+ (east), Z+ (north), Z- (south).
6376 * `clouds`: Boolean for whether clouds appear. (default: `true`)
6377 * `sky_color`: A table containing the following values, alpha is ignored:
6378 * `day_sky`: ColorSpec, for the top half of the `"regular"`
6379 sky during the day. (default: `#8cbafa`)
6380 * `day_horizon`: ColorSpec, for the bottom half of the
6381 `"regular"` sky during the day. (default: `#9bc1f0`)
6382 * `dawn_sky`: ColorSpec, for the top half of the `"regular"`
6383 sky during dawn/sunset. (default: `#b4bafa`)
6384 The resulting sky color will be a darkened version of the ColorSpec.
6385 Warning: The darkening of the ColorSpec is subject to change.
6386 * `dawn_horizon`: ColorSpec, for the bottom half of the `"regular"`
6387 sky during dawn/sunset. (default: `#bac1f0`)
6388 The resulting sky color will be a darkened version of the ColorSpec.
6389 Warning: The darkening of the ColorSpec is subject to change.
6390 * `night_sky`: ColorSpec, for the top half of the `"regular"`
6391 sky during the night. (default: `#006aff`)
6392 The resulting sky color will be a dark version of the ColorSpec.
6393 Warning: The darkening of the ColorSpec is subject to change.
6394 * `night_horizon`: ColorSpec, for the bottom half of the `"regular"`
6395 sky during the night. (default: `#4090ff`)
6396 The resulting sky color will be a dark version of the ColorSpec.
6397 Warning: The darkening of the ColorSpec is subject to change.
6398 * `indoors`: ColorSpec, for when you're either indoors or
6399 underground. Only applies to the `"regular"` sky.
6400 (default: `#646464`)
6401 * `fog_sun_tint`: ColorSpec, changes the fog tinting for the sun
6402 at sunrise and sunset.
6403 * `fog_moon_tint`: ColorSpec, changes the fog tinting for the moon
6404 at sunrise and sunset.
6405 * `fog_tint_type`: string, changes which mode the directional fog
6406 abides by, `"custom"` uses `sun_tint` and `moon_tint`, while
6407 `"default"` uses the classic Minetest sun and moon tinting.
6408 Will use tonemaps, if set to `"default"`. (default: `"default"`)
6409 * `get_sky()`: returns base_color, type, table of textures, clouds.
6410 * `get_sky_color()`: returns a table with the `sky_color` parameters as in
6412 * `set_sun(parameters)`:
6413 * `parameters` is a table with the following optional fields:
6414 * `visible`: Boolean for whether the sun is visible.
6416 * `texture`: A regular texture for the sun. Setting to `""`
6417 will re-enable the mesh sun. (default: `"sun.png"`)
6418 * `tonemap`: A 512x1 texture containing the tonemap for the sun
6419 (default: `"sun_tonemap.png"`)
6420 * `sunrise`: A regular texture for the sunrise texture.
6421 (default: `"sunrisebg.png"`)
6422 * `sunrise_visible`: Boolean for whether the sunrise texture is visible.
6424 * `scale`: Float controlling the overall size of the sun. (default: `1`)
6425 * `get_sun()`: returns a table with the current sun parameters as in
6427 * `set_moon(parameters)`:
6428 * `parameters` is a table with the following optional fields:
6429 * `visible`: Boolean for whether the moon is visible.
6431 * `texture`: A regular texture for the moon. Setting to `""`
6432 will re-enable the mesh moon. (default: `"moon.png"`)
6433 * `tonemap`: A 512x1 texture containing the tonemap for the moon
6434 (default: `"moon_tonemap.png"`)
6435 * `scale`: Float controlling the overall size of the moon (default: `1`)
6436 * `get_moon()`: returns a table with the current moon parameters as in
6438 * `set_stars(parameters)`:
6439 * `parameters` is a table with the following optional fields:
6440 * `visible`: Boolean for whether the stars are visible.
6442 * `count`: Integer number to set the number of stars in
6443 the skybox. Only applies to `"skybox"` and `"regular"` sky types.
6445 * `star_color`: ColorSpec, sets the colors of the stars,
6446 alpha channel is used to set overall star brightness.
6447 (default: `#ebebff69`)
6448 * `scale`: Float controlling the overall size of the stars (default: `1`)
6449 * `get_stars()`: returns a table with the current stars parameters as in
6451 * `set_clouds(parameters)`: set cloud parameters
6452 * `parameters` is a table with the following optional fields:
6453 * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
6454 * `color`: basic cloud color with alpha channel, ColorSpec
6455 (default `#fff0f0e5`).
6456 * `ambient`: cloud color lower bound, use for a "glow at night" effect.
6457 ColorSpec (alpha ignored, default `#000000`)
6458 * `height`: cloud height, i.e. y of cloud base (default per conf,
6460 * `thickness`: cloud thickness in nodes (default `16`)
6461 * `speed`: 2D cloud speed + direction in nodes per second
6462 (default `{x=0, z=-2}`).
6463 * `get_clouds()`: returns a table with the current cloud parameters as in
6465 * `override_day_night_ratio(ratio or nil)`
6466 * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific
6468 * `nil`: Disables override, defaulting to sunlight based on day-night cycle
6469 * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
6470 * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`:
6471 set animation for player model in third person view
6473 set_local_animation({x=0, y=79}, -- stand/idle animation key frames
6474 {x=168, y=187}, -- walk animation key frames
6475 {x=189, y=198}, -- dig animation key frames
6476 {x=200, y=219}, -- walk+dig animation key frames
6477 frame_speed=30) -- animation frame speed
6478 * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and
6480 * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for
6482 * in first person view
6483 * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
6484 * `get_eye_offset()`: returns `offset_first` and `offset_third`
6485 * `send_mapblock(blockpos)`:
6486 * Sends a server-side loaded mapblock to the player.
6487 * Returns `false` if failed.
6488 * Resource intensive - use sparsely
6489 * To get blockpos, integer divide pos by 16
6494 A 32-bit pseudorandom number generator.
6495 Uses PCG32, an algorithm of the permuted congruential generator family,
6496 offering very strong randomness.
6498 It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
6502 * `next()`: return next integer random number [`-2147483648`...`2147483647`]
6503 * `next(min, max)`: return next integer random number [`min`...`max`]
6504 * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed
6505 random number [`min`...`max`].
6506 * This is only a rough approximation of a normal distribution with:
6507 * `mean = (max - min) / 2`, and
6508 * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
6509 * Increasing `num_trials` improves accuracy of the approximation
6514 A perlin noise generator.
6515 It can be created via `PerlinNoise()` or `minetest.get_perlin()`.
6516 For `minetest.get_perlin()`, the actual seed used is the noiseparams seed
6517 plus the world seed, to create world-specific noise.
6519 `PerlinNoise(noiseparams)`
6520 `PerlinNoise(seed, octaves, persistence, spread)` (Deprecated).
6522 `minetest.get_perlin(noiseparams)`
6523 `minetest.get_perlin(seeddiff, octaves, persistence, spread)` (Deprecated).
6527 * `get_2d(pos)`: returns 2D noise value at `pos={x=,y=}`
6528 * `get_3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
6533 A fast, bulk perlin noise generator.
6535 It can be created via `PerlinNoiseMap(noiseparams, size)` or
6536 `minetest.get_perlin_map(noiseparams, size)`.
6537 For `minetest.get_perlin_map()`, the actual seed used is the noiseparams seed
6538 plus the world seed, to create world-specific noise.
6540 Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
6541 for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
6544 For each of the functions with an optional `buffer` parameter: If `buffer` is
6545 not nil, this table will be used to store the result instead of creating a new
6550 * `get_2d_map(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
6551 with values starting at `pos={x=,y=}`
6552 * `get_3d_map(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>`
6553 3D array of 3D noise with values starting at `pos={x=,y=,z=}`.
6554 * `get_2d_map_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element
6555 array of 2D noise with values starting at `pos={x=,y=}`
6556 * `get_3d_map_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
6557 * `calc_2d_map(pos)`: Calculates the 2d noise map starting at `pos`. The result
6558 is stored internally.
6559 * `calc_3d_map(pos)`: Calculates the 3d noise map starting at `pos`. The result
6560 is stored internally.
6561 * `get_map_slice(slice_offset, slice_size, buffer)`: In the form of an array,
6562 returns a slice of the most recently computed noise results. The result slice
6563 begins at coordinates `slice_offset` and takes a chunk of `slice_size`.
6564 E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer
6566 `noisevals = noise:get_map_slice({y=20}, {y=2})`
6567 It is important to note that `slice_offset` offset coordinates begin at 1,
6568 and are relative to the starting position of the most recently calculated
6570 To grab a single vertical column of noise starting at map coordinates
6571 x = 1023, y=1000, z = 1000:
6572 `noise:calc_3d_map({x=1000, y=1000, z=1000})`
6573 `noisevals = noise:get_map_slice({x=24, z=1}, {x=1, z=1})`
6579 Uses the same method of storage as the deprecated player attribute API, so
6580 data there will also be in player meta.
6581 Can be obtained using `player:get_meta()`.
6585 * All methods in MetaDataRef
6590 A 16-bit pseudorandom number generator.
6591 Uses a well-known LCG algorithm introduced by K&R.
6593 It can be created via `PseudoRandom(seed)`.
6597 * `next()`: return next integer random number [`0`...`32767`]
6598 * `next(min, max)`: return next integer random number [`min`...`max`]
6599 * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
6600 due to the simple implementation making bad distribution otherwise.
6605 A raycast on the map. It works with selection boxes.
6606 Can be used as an iterator in a for loop as:
6608 local ray = Raycast(...)
6609 for pointed_thing in ray do
6613 The map is loaded as the ray advances. If the map is modified after the
6614 `Raycast` is created, the changes may or may not have an effect on the object.
6616 It can be created via `Raycast(pos1, pos2, objects, liquids)` or
6617 `minetest.raycast(pos1, pos2, objects, liquids)` where:
6619 * `pos1`: start of the ray
6620 * `pos2`: end of the ray
6621 * `objects`: if false, only nodes will be returned. Default is true.
6622 * `liquids`: if false, liquid nodes won't be returned. Default is false.
6626 * `next()`: returns a `pointed_thing` with exact pointing location
6627 * Returns the next thing pointed by the ray or nil.
6632 Interface for the operating system's crypto-secure PRNG.
6634 It can be created via `SecureRandom()`. The constructor returns nil if a
6635 secure random device cannot be found on the system.
6639 * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many
6640 random bytes, as a string.
6645 An interface to read config files in the format of `minetest.conf`.
6647 It can be created via `Settings(filename)`.
6651 * `get(key)`: returns a value
6652 * `get_bool(key, [default])`: returns a boolean
6653 * `default` is the value returned if `key` is not found.
6654 * Returns `nil` if `key` is not found and `default` not specified.
6655 * `get_np_group(key)`: returns a NoiseParams table
6657 * Returns `{flag = true/false, ...}` according to the set flags.
6658 * Is currently limited to mapgen flags `mg_flags` and mapgen-specific
6659 flags like `mgv5_spflags`.
6661 * Setting names can't contain whitespace or any of `="{}#`.
6662 * Setting values can't contain the sequence `\n"""`.
6663 * Setting names starting with "secure." can't be set on the main settings
6664 object (`minetest.settings`).
6665 * `set_bool(key, value)`
6666 * See documentation for set() above.
6667 * `set_np_group(key, value)`
6668 * `value` is a NoiseParams table.
6669 * Also, see documentation for set() above.
6670 * `remove(key)`: returns a boolean (`true` for success)
6671 * `get_names()`: returns `{key1,...}`
6672 * `write()`: returns a boolean (`true` for success)
6673 * Writes changes to file.
6674 * `to_table()`: returns `{[key1]=value1,...}`
6678 The settings have the format `key = value`. Example:
6690 Mod metadata: per mod metadata, saved automatically.
6691 Can be obtained via `minetest.get_mod_storage()` during load time.
6693 WARNING: This storage backend is incaptable to save raw binary data due
6694 to restrictions of JSON.
6698 * All methods in MetaDataRef
6709 Used by `ObjectRef` methods. Part of an Entity definition.
6710 These properties are not persistent, but are applied automatically to the
6711 corresponding Lua entity using the given registration fields.
6712 Player properties need to be saved manually.
6716 -- For players only. Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`.
6719 -- For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`.
6722 -- For players only. Zoom FOV in degrees.
6723 -- Note that zoom loads and/or generates world beyond the server's
6724 -- maximum send and generate distances, so acts like a telescope.
6725 -- Smaller zoom_fov values increase the distance loaded/generated.
6726 -- Defaults to 15 in creative mode, 0 in survival mode.
6727 -- zoom_fov = 0 disables zooming for the player.
6730 -- For players only. Camera height above feet position in nodes.
6731 -- Defaults to 1.625.
6734 -- Collide with `walkable` nodes.
6736 collide_with_objects = true,
6737 -- Collide with other objects if physical = true
6739 collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5}, -- Default
6740 selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
6741 -- Selection box uses collision box dimensions when not set.
6742 -- For both boxes: {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from
6746 -- Overrides selection box when false
6748 visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem" / "item",
6749 -- "cube" is a node-sized cube.
6750 -- "sprite" is a flat texture always facing the player.
6751 -- "upright_sprite" is a vertical flat texture.
6752 -- "mesh" uses the defined mesh model.
6753 -- "wielditem" is used for dropped items.
6754 -- (see builtin/game/item_entity.lua).
6755 -- For this use 'wield_item = itemname' (Deprecated: 'textures = {itemname}').
6756 -- If the item has a 'wield_image' the object will be an extrusion of
6758 -- If 'itemname' is a cubic node or nodebox the object will appear
6759 -- identical to 'itemname'.
6760 -- If 'itemname' is a plantlike node the object will be an extrusion
6762 -- Otherwise for non-node items, the object will be an extrusion of
6763 -- 'inventory_image'.
6764 -- If 'itemname' contains a ColorString or palette index (e.g. from
6765 -- `minetest.itemstring_with_palette()`), the entity will inherit the color.
6766 -- "item" is similar to "wielditem" but ignores the 'wield_image' parameter.
6768 visual_size = {x = 1, y = 1, z = 1},
6769 -- Multipliers for the visual size. If `z` is not specified, `x` will be used
6770 -- to scale the entity along both horizontal axes.
6773 -- File name of mesh when using "mesh" visual
6776 -- Number of required textures depends on visual.
6777 -- "cube" uses 6 textures just like a node, but all 6 must be defined.
6778 -- "sprite" uses 1 texture.
6779 -- "upright_sprite" uses 2 textures: {front, back}.
6780 -- "wielditem" expects 'textures = {itemname}' (see 'visual' above).
6783 -- Number of required colors depends on visual
6785 use_texture_alpha = false,
6786 -- Use texture's alpha channel.
6787 -- Excludes "upright_sprite" and "wielditem".
6788 -- Note: currently causes visual issues when viewed through other
6789 -- semi-transparent materials such as water.
6791 spritediv = {x = 1, y = 1},
6792 -- Used with spritesheet textures for animation and/or frame selection
6793 -- according to position relative to player.
6794 -- Defines the number of columns and rows in the spritesheet:
6797 initial_sprite_basepos = {x = 0, y = 0},
6798 -- Used with spritesheet textures.
6799 -- Defines the {column, row} position of the initially used frame in the
6803 -- If false, object is invisible and can't be pointed.
6805 makes_footstep_sound = false,
6806 -- If true, is able to make footstep sounds of nodes
6807 -- (see node sound definition for details).
6809 automatic_rotate = 0,
6810 -- Set constant rotation in radians per second, positive or negative.
6811 -- Object rotates along the local Y-axis, and works with set_rotation.
6812 -- Set to 0 to disable constant rotation.
6815 -- If positive number, object will climb upwards when it moves
6816 -- horizontally against a `walkable` node, if the height difference
6817 -- is within `stepheight`.
6819 automatic_face_movement_dir = 0.0,
6820 -- Automatically set yaw to movement direction, offset in degrees.
6821 -- 'false' to disable.
6823 automatic_face_movement_max_rotation_per_sec = -1,
6824 -- Limit automatic rotation to this value in degrees per second.
6825 -- No limit if value <= 0.
6827 backface_culling = true,
6828 -- Set to false to disable backface_culling for model
6831 -- Add this much extra lighting when calculating texture color.
6832 -- Value < 0 disables light's effect on texture color.
6833 -- For faking self-lighting, UI style entities, or programmatic coloring
6837 -- By default empty, for players their name is shown if empty
6839 nametag_color = <ColorSpec>,
6840 -- Sets color of nametag
6843 -- By default empty, text to be shown when pointed at object
6846 -- If false, never save this object statically. It will simply be
6847 -- deleted when the block gets unloaded.
6848 -- The get_staticdata() callback is never called then.
6849 -- Defaults to 'true'.
6851 damage_texture_modifier = "^[brighten",
6852 -- Texture modifier to be applied for a short duration when object is hit
6855 -- Setting this to 'false' disables diffuse lighting of entity
6861 Used by `minetest.register_entity`.
6864 initial_properties = {
6866 mesh = "boats_boat.obj",
6869 -- A table of object properties, see the `Object properties` section.
6870 -- Object properties being read directly from the entity definition
6871 -- table is deprecated. Define object properties in this
6872 -- `initial_properties` table instead.
6874 on_activate = function(self, staticdata, dtime_s),
6876 on_step = function(self, dtime, moveresult),
6877 -- Called every server step
6878 -- dtime: Elapsed time
6879 -- moveresult: Table with collision info (only available if physical=true)
6881 on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
6883 on_rightclick = function(self, clicker),
6885 get_staticdata = function(self),
6886 -- Called sometimes; the string returned is passed to on_activate when
6887 -- the entity is re-activated from static state
6889 _custom_field = whatever,
6890 -- You can define arbitrary member variables here (see Item definition
6891 -- for more info) by using a '_' prefix
6894 Collision info passed to `on_step`:
6897 touching_ground = boolean,
6899 standing_on_object = boolean,
6902 type = string, -- "node" or "object",
6903 axis = string, -- "x", "y" or "z"
6904 node_pos = vector, -- if type is "node"
6905 object = ObjectRef, -- if type is "object"
6906 old_velocity = vector,
6907 new_velocity = vector,
6913 ABM (ActiveBlockModifier) definition
6914 ------------------------------------
6916 Used by `minetest.register_abm`.
6919 label = "Lava cooling",
6920 -- Descriptive label for profiling purposes (optional).
6921 -- Definitions with identical labels will be listed as one.
6923 nodenames = {"default:lava_source"},
6924 -- Apply `action` function to these nodes.
6925 -- `group:groupname` can also be used here.
6927 neighbors = {"default:water_source", "default:water_flowing"},
6928 -- Only apply `action` to nodes that have one of, or any
6929 -- combination of, these neighbors.
6930 -- If left out or empty, any neighbor will do.
6931 -- `group:groupname` can also be used here.
6934 -- Operation interval in seconds
6937 -- Chance of triggering `action` per-node per-interval is 1.0 / this
6941 -- If true, catch-up behaviour is enabled: The `chance` value is
6942 -- temporarily reduced when returning to an area to simulate time lost
6943 -- by the area being unattended. Note that the `chance` value can often
6946 action = function(pos, node, active_object_count, active_object_count_wider),
6947 -- Function triggered for each qualifying node.
6948 -- `active_object_count` is number of active objects in the node's
6950 -- `active_object_count_wider` is number of active objects in the node's
6951 -- mapblock plus all 26 neighboring mapblocks. If any neighboring
6952 -- mapblocks are unloaded an estmate is calculated for them based on
6953 -- loaded mapblocks.
6956 LBM (LoadingBlockModifier) definition
6957 -------------------------------------
6959 Used by `minetest.register_lbm`.
6961 A loading block modifier (LBM) is used to define a function that is called for
6962 specific nodes (defined by `nodenames`) when a mapblock which contains such nodes
6966 label = "Upgrade legacy doors",
6967 -- Descriptive label for profiling purposes (optional).
6968 -- Definitions with identical labels will be listed as one.
6970 name = "modname:replace_legacy_door",
6972 nodenames = {"default:lava_source"},
6973 -- List of node names to trigger the LBM on.
6974 -- Also non-registered nodes will work.
6975 -- Groups (as of group:groupname) will work as well.
6977 run_at_every_load = false,
6978 -- Whether to run the LBM's action every time a block gets loaded,
6979 -- and not only the first time the block gets loaded after the LBM
6982 action = function(pos, node),
6989 * `{name="image.png", animation={Tile Animation definition}}`
6990 * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
6991 tileable_horizontal=bool, align_style="node"/"world"/"user", scale=int}`
6992 * backface culling enabled by default for most nodes
6993 * tileable flags are info for shaders, how they should treat texture
6994 when displacement mapping is used.
6995 Directions are from the point of view of the tile texture,
6996 not the node it's on.
6997 * align style determines whether the texture will be rotated with the node
6998 or kept aligned with its surroundings. "user" means that client
6999 setting will be used, similar to `glasslike_framed_optional`.
7000 Note: supported by solid nodes and nodeboxes only.
7001 * scale is used to make texture span several (exactly `scale`) nodes,
7002 instead of just one, in each direction. Works for world-aligned
7004 Note that as the effect is applied on per-mapblock basis, `16` should
7005 be equally divisible by `scale` or you may get wrong results.
7006 * `{name="image.png", color=ColorSpec}`
7007 * the texture's color will be multiplied with this color.
7008 * the tile's color overrides the owning node's color in all cases.
7009 * deprecated, yet still supported field names:
7012 Tile animation definition
7013 -------------------------
7016 type = "vertical_frames",
7019 -- Width of a frame in pixels
7022 -- Height of a frame in pixels
7032 -- Width in number of frames
7035 -- Height in number of frames
7038 -- Length of a single frame
7044 Used by `minetest.register_node`, `minetest.register_craftitem`, and
7045 `minetest.register_tool`.
7048 description = "Steel Axe",
7051 -- key = name, value = rating; rating = 1..3.
7052 -- If rating not applicable, use 1.
7053 -- e.g. {wool = 1, fluffy = 3}
7054 -- {soil = 2, outerspace = 1, crumbly = 1}
7055 -- {bendy = 2, snappy = 1},
7056 -- {hard = 1, metal = 1, spikes = 1}
7058 inventory_image = "default_tool_steelaxe.png",
7060 inventory_overlay = "overlay.png",
7061 -- An overlay which does not get colorized
7068 -- An image file containing the palette of a node.
7069 -- You can set the currently used color as the "palette_index" field of
7070 -- the item stack metadata.
7071 -- The palette is always stretched to fit indices between 0 and 255, to
7072 -- ensure compatibility with "colorfacedir" and "colorwallmounted" nodes.
7074 color = "0xFFFFFFFF",
7075 -- The color of the item. The palette overrides this.
7077 wield_scale = {x = 1, y = 1, z = 1},
7079 -- The default value of 99 may be configured by
7080 -- users using the setting "default_stack_max"
7085 liquids_pointable = false,
7088 -- When used for nodes: Defines amount of light emitted by node.
7089 -- Otherwise: Defines texture glow when viewed as a dropped item
7090 -- To set the maximum (14), use the value 'minetest.LIGHT_MAX'.
7091 -- A value outside the range 0 to minetest.LIGHT_MAX causes undefined
7094 -- See "Tools" section for an example including explanation
7095 tool_capabilities = {
7096 full_punch_interval = 1.0,
7100 choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00},
7101 uses = 20, maxlevel = 2},
7103 damage_groups = {groupname = damage},
7104 -- Damage values must be between -32768 and 32767 (2^15)
7106 punch_attack_uses = nil,
7107 -- Amount of uses this tool has for attacking players and entities
7108 -- by punching them (0 = infinite uses).
7109 -- For compatibility, this is automatically set from the first
7110 -- suitable groupcap using the forumla "uses * 3^(maxlevel - 1)".
7111 -- It is recommend to set this explicitly instead of relying on the
7112 -- fallback behavior.
7115 node_placement_prediction = nil,
7116 -- If nil and item is node, prediction is made automatically.
7117 -- If nil and item is not a node, no prediction is made.
7118 -- If "" and item is anything, no prediction is made.
7119 -- Otherwise should be name of node which the client immediately places
7120 -- on ground when the player places the item. Server will always update
7121 -- actual result to client in a short moment.
7123 node_dig_prediction = "air",
7124 -- if "", no prediction is made.
7125 -- if "air", node is removed.
7126 -- Otherwise should be name of node which the client immediately places
7127 -- upon digging. Server will always update actual result shortly.
7130 -- Definition of items sounds to be played at various events.
7131 -- All fields in this table are optional.
7133 breaks = <SimpleSoundSpec>,
7134 -- When tool breaks due to wear. Ignored for non-tools
7136 eat = <SimpleSoundSpec>,
7137 -- When item is eaten with `minetest.do_item_eat`
7140 on_place = function(itemstack, placer, pointed_thing),
7141 -- Shall place item and return the leftover itemstack.
7142 -- The placer may be any ObjectRef or nil.
7143 -- default: minetest.item_place
7145 on_secondary_use = function(itemstack, user, pointed_thing),
7146 -- Same as on_place but called when not pointing at a node.
7147 -- The user may be any ObjectRef or nil.
7150 on_drop = function(itemstack, dropper, pos),
7151 -- Shall drop item and return the leftover itemstack.
7152 -- The dropper may be any ObjectRef or nil.
7153 -- default: minetest.item_drop
7155 on_use = function(itemstack, user, pointed_thing),
7157 -- Function must return either nil if no item shall be removed from
7158 -- inventory, or an itemstack to replace the original itemstack.
7159 -- e.g. itemstack:take_item(); return itemstack
7160 -- Otherwise, the function is free to do what it wants.
7161 -- The user may be any ObjectRef or nil.
7162 -- The default functions handle regular use cases.
7164 after_use = function(itemstack, user, node, digparams),
7166 -- If defined, should return an itemstack and will be called instead of
7167 -- wearing out the tool. If returns nil, does nothing.
7168 -- If after_use doesn't exist, it is the same as:
7169 -- function(itemstack, user, node, digparams)
7170 -- itemstack:add_wear(digparams.wear)
7173 -- The user may be any ObjectRef or nil.
7175 _custom_field = whatever,
7176 -- Add your own custom fields. By convention, all custom field names
7177 -- should start with `_` to avoid naming collisions with future engine
7184 Used by `minetest.register_node`.
7187 -- <all fields allowed in item definitions>,
7189 drawtype = "normal", -- See "Node drawtypes"
7192 -- Supported for drawtypes "plantlike", "signlike", "torchlike",
7193 -- "firelike", "mesh", "nodebox", "allfaces".
7194 -- For plantlike and firelike, the image will start at the bottom of the
7195 -- node. For torchlike, the image will start at the surface to which the
7196 -- node "attaches". For the other drawtypes the image will be centered
7199 tiles = {tile definition 1, def2, def3, def4, def5, def6},
7200 -- Textures of node; +Y, -Y, +X, -X, +Z, -Z
7201 -- Old field name was 'tile_images'.
7202 -- List can be shortened to needed length.
7204 overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6},
7205 -- Same as `tiles`, but these textures are drawn on top of the base
7206 -- tiles. You can use this to colorize only specific parts of your
7207 -- texture. If the texture name is an empty string, that overlay is not
7208 -- drawn. Since such tiles are drawn twice, it is not recommended to use
7209 -- overlays on very common nodes.
7211 special_tiles = {tile definition 1, Tile definition 2},
7212 -- Special textures of node; used rarely.
7213 -- Old field name was 'special_materials'.
7214 -- List can be shortened to needed length.
7217 -- The node's original color will be multiplied with this color.
7218 -- If the node has a palette, then this setting only has an effect in
7219 -- the inventory and on the wield item.
7221 use_texture_alpha = false,
7222 -- Use texture's alpha channel
7223 -- If this is set to false, the node will be rendered fully opaque
7224 -- regardless of any texture transparency.
7226 palette = "palette.png",
7227 -- The node's `param2` is used to select a pixel from the image.
7228 -- Pixels are arranged from left to right and from top to bottom.
7229 -- The node's color will be multiplied with the selected pixel's color.
7230 -- Tiles can override this behavior.
7231 -- Only when `paramtype2` supports palettes.
7233 post_effect_color = "green#0F",
7234 -- Screen tint if player is inside node, see "ColorSpec"
7236 paramtype = "none", -- See "Nodes"
7238 paramtype2 = "none", -- See "Nodes"
7240 place_param2 = nil, -- Force value for param2 when player places node
7242 is_ground_content = true,
7243 -- If false, the cave generator and dungeon generator will not carve
7244 -- through this node.
7245 -- Specifically, this stops mod-added nodes being removed by caves and
7246 -- dungeons when those generate in a neighbor mapchunk and extend out
7247 -- beyond the edge of that mapchunk.
7249 sunlight_propagates = false,
7250 -- If true, sunlight will go infinitely through this node
7252 walkable = true, -- If true, objects collide with node
7254 pointable = true, -- If true, can be pointed at
7256 diggable = true, -- If false, can never be dug
7258 climbable = false, -- If true, can be climbed on (ladder)
7260 buildable_to = false, -- If true, placed nodes can replace this node
7263 -- If true, liquids flow into and replace this node.
7264 -- Warning: making a liquid node 'floodable' will cause problems.
7266 liquidtype = "none", -- "none" / "source" / "flowing"
7268 liquid_alternative_flowing = "", -- Flowing version of source liquid
7270 liquid_alternative_source = "", -- Source version of flowing liquid
7272 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
7274 liquid_renewable = true,
7275 -- If true, a new liquid source can be created by placing two or more
7279 -- Only valid for "nodebox" drawtype with 'type = "leveled"'.
7280 -- Allows defining the nodebox height without using param2.
7281 -- The nodebox height is 'leveled' / 64 nodes.
7282 -- The maximum value of 'leveled' is `leveled_max`.
7285 -- Maximum value for `leveled` (0-127), enforced in
7286 -- `minetest.set_node_level` and `minetest.add_node_level`.
7288 liquid_range = 8, -- Number of flowing nodes around source (max. 8)
7291 -- Player will take this amount of damage if no bubbles are left
7293 damage_per_second = 0,
7294 -- If player is inside node, this damage is caused
7296 node_box = {type="regular"}, -- See "Node boxes"
7298 connects_to = nodenames,
7299 -- Used for nodebox nodes with the type == "connected".
7300 -- Specifies to what neighboring nodes connections will be drawn.
7301 -- e.g. `{"group:fence", "default:wood"}` or `"default:stone"`
7303 connect_sides = { "top", "bottom", "front", "left", "back", "right" },
7304 -- Tells connected nodebox nodes to connect only to these sides of this
7308 -- File name of mesh when using "mesh" drawtype
7313 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
7316 -- Custom selection box definition. Multiple boxes can be defined.
7317 -- If "nodebox" drawtype is used and selection_box is nil, then node_box
7318 -- definition is used for the selection box.
7323 {-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
7326 -- Custom collision box definition. Multiple boxes can be defined.
7327 -- If "nodebox" drawtype is used and collision_box is nil, then node_box
7328 -- definition is used for the collision box.
7329 -- Both of the boxes above are defined as:
7330 -- {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from node center.
7332 -- Support maps made in and before January 2012
7333 legacy_facedir_simple = false,
7334 legacy_wallmounted = false,
7337 -- Valid for drawtypes:
7338 -- mesh, nodebox, plantlike, allfaces_optional, liquid, flowingliquid.
7339 -- 1 - wave node like plants (node top moves side-to-side, bottom is fixed)
7340 -- 2 - wave node like leaves (whole node moves side-to-side)
7341 -- 3 - wave node like liquids (whole node moves up and down)
7342 -- Not all models will properly wave.
7343 -- plantlike drawtype can only wave like plants.
7344 -- allfaces_optional drawtype can only wave like leaves.
7345 -- liquid, flowingliquid drawtypes can only wave like liquids.
7348 -- Definition of node sounds to be played at various events.
7349 -- All fields in this table are optional.
7351 footstep = <SimpleSoundSpec>,
7352 -- If walkable, played when object walks on it. If node is
7353 -- climbable or a liquid, played when object moves through it
7355 dig = <SimpleSoundSpec> or "__group",
7356 -- While digging node.
7357 -- If `"__group"`, then the sound will be
7358 -- `default_dig_<groupname>`, where `<groupname>` is the
7359 -- name of the tool's digging group with the fastest digging time.
7360 -- In case of a tie, one of the sounds will be played (but we
7361 -- cannot predict which one)
7362 -- Default value: `"__group"`
7364 dug = <SimpleSoundSpec>,
7367 place = <SimpleSoundSpec>,
7368 -- Node was placed. Also played after falling
7370 place_failed = <SimpleSoundSpec>,
7371 -- When node placement failed.
7372 -- Note: This happens if the _built-in_ node placement failed.
7373 -- This sound will still be played if the node is placed in the
7374 -- `on_place` callback manually.
7376 fall = <SimpleSoundSpec>,
7377 -- When node starts to fall or is detached
7381 -- Name of dropped item when dug.
7382 -- Default dropped item is the node itself.
7383 -- Using a table allows multiple items, drop chances and tool filtering.
7384 -- Tool filtering was undocumented until recently, tool filtering by string
7385 -- matching is deprecated.
7388 -- Maximum number of item lists to drop.
7389 -- The entries in 'items' are processed in order. For each:
7390 -- Tool filtering is applied, chance of drop is applied, if both are
7391 -- successful the entire item list is dropped.
7392 -- Entry processing continues until the number of dropped item lists
7393 -- equals 'max_items'.
7394 -- Therefore, entries should progress from low to high drop chance.
7398 -- 1 in 1000 chance of dropping a diamond.
7399 -- Default rarity is '1'.
7401 items = {"default:diamond"},
7404 -- Only drop if using a tool whose name is identical to one
7406 tools = {"default:shovel_mese", "default:shovel_diamond"},
7408 items = {"default:dirt"},
7409 -- Whether all items in the dropped item list inherit the
7410 -- hardware coloring palette color from the dug node.
7411 -- Default is 'false'.
7412 inherit_color = true,
7415 -- Only drop if using a tool whose name contains
7416 -- "default:shovel_" (this tool filtering by string matching
7418 tools = {"~default:shovel_"},
7420 -- The item list dropped.
7421 items = {"default:sand", "default:desert_sand"},
7426 on_construct = function(pos),
7427 -- Node constructor; called after adding node.
7428 -- Can set up metadata and stuff like that.
7429 -- Not called for bulk node placement (i.e. schematics and VoxelManip).
7432 on_destruct = function(pos),
7433 -- Node destructor; called before removing node.
7434 -- Not called for bulk node placement.
7437 after_destruct = function(pos, oldnode),
7438 -- Node destructor; called after removing node.
7439 -- Not called for bulk node placement.
7442 on_flood = function(pos, oldnode, newnode),
7443 -- Called when a liquid (newnode) is about to flood oldnode, if it has
7444 -- `floodable = true` in the nodedef. Not called for bulk node placement
7445 -- (i.e. schematics and VoxelManip) or air nodes. If return true the
7446 -- node is not flooded, but on_flood callback will most likely be called
7447 -- over and over again every liquid update interval.
7449 -- Warning: making a liquid node 'floodable' will cause problems.
7451 preserve_metadata = function(pos, oldnode, oldmeta, drops),
7452 -- Called when oldnode is about be converted to an item, but before the
7453 -- node is deleted from the world or the drops are added. This is
7454 -- generally the result of either the node being dug or an attached node
7455 -- becoming detached.
7456 -- oldmeta is the NodeMetaRef of the oldnode before deletion.
7457 -- drops is a table of ItemStacks, so any metadata to be preserved can
7458 -- be added directly to one or more of the dropped items. See
7459 -- "ItemStackMetaRef".
7462 after_place_node = function(pos, placer, itemstack, pointed_thing),
7463 -- Called after constructing node when node was placed using
7464 -- minetest.item_place_node / minetest.place_node.
7465 -- If return true no item is taken from itemstack.
7466 -- `placer` may be any valid ObjectRef or nil.
7469 after_dig_node = function(pos, oldnode, oldmetadata, digger),
7470 -- oldmetadata is in table format.
7471 -- Called after destructing node when node was dug using
7472 -- minetest.node_dig / minetest.dig_node.
7475 can_dig = function(pos, [player]),
7476 -- Returns true if node can be dug, or false if not.
7479 on_punch = function(pos, node, puncher, pointed_thing),
7480 -- default: minetest.node_punch
7481 -- Called when puncher (an ObjectRef) punches the node at pos.
7482 -- By default calls minetest.register_on_punchnode callbacks.
7484 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing),
7486 -- Called when clicker (an ObjectRef) "rightclicks"
7487 -- ("rightclick" here stands for the placement key) while pointing at
7488 -- the node at pos with 'node' being the node table.
7489 -- itemstack will hold clicker's wielded item.
7490 -- Shall return the leftover itemstack.
7491 -- Note: pointed_thing can be nil, if a mod calls this function.
7492 -- This function does not get triggered by clients <=0.4.16 if the
7493 -- "formspec" node metadata field is set.
7495 on_dig = function(pos, node, digger),
7496 -- default: minetest.node_dig
7497 -- By default checks privileges, wears out tool and removes node.
7499 on_timer = function(pos, elapsed),
7501 -- called by NodeTimers, see minetest.get_node_timer and NodeTimerRef.
7502 -- elapsed is the total time passed since the timer was started.
7503 -- return true to run the timer for another cycle with the same timeout
7506 on_receive_fields = function(pos, formname, fields, sender),
7507 -- fields = {name1 = value1, name2 = value2, ...}
7508 -- Called when an UI form (e.g. sign text input) returns data.
7509 -- See minetest.register_on_player_receive_fields for more info.
7512 allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7513 -- Called when a player wants to move items inside the inventory.
7514 -- Return value: number of items allowed to move.
7516 allow_metadata_inventory_put = function(pos, listname, index, stack, player),
7517 -- Called when a player wants to put something into the inventory.
7518 -- Return value: number of items allowed to put.
7519 -- Return value -1: Allow and don't modify item count in inventory.
7521 allow_metadata_inventory_take = function(pos, listname, index, stack, player),
7522 -- Called when a player wants to take something out of the inventory.
7523 -- Return value: number of items allowed to take.
7524 -- Return value -1: Allow and don't modify item count in inventory.
7526 on_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player),
7527 on_metadata_inventory_put = function(pos, listname, index, stack, player),
7528 on_metadata_inventory_take = function(pos, listname, index, stack, player),
7529 -- Called after the actual action has happened, according to what was
7533 on_blast = function(pos, intensity),
7534 -- intensity: 1.0 = mid range of regular TNT.
7535 -- If defined, called when an explosion touches the node, instead of
7536 -- removing the node.
7542 Used by `minetest.register_craft`.
7547 output = 'default:pick_stone',
7549 {'default:cobble', 'default:cobble', 'default:cobble'},
7550 {'', 'default:stick', ''},
7551 {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
7553 replacements = <list of item pairs>,
7554 -- replacements: replace one input item with another item on crafting
7562 output = 'mushrooms:mushroom_stew',
7565 "mushrooms:mushroom_brown",
7566 "mushrooms:mushroom_red",
7568 replacements = <list of item pairs>,
7574 type = "toolrepair",
7575 additional_wear = -0.02,
7578 Note: Tools with group `disable_repair=1` will not repairable by this recipe.
7584 output = "default:glass",
7585 recipe = "default:sand",
7593 recipe = "bucket:bucket_lava",
7595 replacements = {{"bucket:bucket_lava", "bucket:bucket_empty"}},
7601 Used by `minetest.register_ore`.
7603 See [Ores] section above for essential information.
7606 ore_type = "scatter",
7608 ore = "default:stone_with_coal",
7611 -- Facedir rotation. Default is 0 (unchanged rotation)
7613 wherein = "default:stone",
7614 -- A list of nodenames is supported too
7616 clust_scarcity = 8 * 8 * 8,
7617 -- Ore has a 1 out of clust_scarcity chance of spawning in a node.
7618 -- If the desired average distance between ores is 'd', set this to
7622 -- Number of ores in a cluster
7625 -- Size of the bounding box of the cluster.
7626 -- In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27
7627 -- nodes are coal ore.
7631 -- Lower and upper limits for ore
7634 -- Attributes for the ore generation, see 'Ore attributes' section above
7636 noise_threshold = 0.5,
7637 -- If noise is above this threshold, ore is placed. Not needed for a
7638 -- uniform distribution.
7643 spread = {x = 100, y = 100, z = 100},
7648 -- NoiseParams structure describing one of the perlin noises used for
7649 -- ore distribution.
7650 -- Needed by "sheet", "puff", "blob" and "vein" ores.
7651 -- Omit from "scatter" ore for a uniform ore distribution.
7652 -- Omit from "stratum" ore for a simple horizontal strata from y_min to
7655 biomes = {"desert", "rainforest"},
7656 -- List of biomes in which this ore occurs.
7657 -- Occurs in all biomes if this is omitted, and ignored if the Mapgen
7658 -- being used does not support biomes.
7659 -- Can be a list of (or a single) biome names, IDs, or definitions.
7661 -- Type-specific parameters
7664 column_height_min = 1,
7665 column_height_max = 16,
7666 column_midpoint_factor = 0.5,
7672 spread = {x = 100, y = 100, z = 100},
7680 spread = {x = 100, y = 100, z = 100},
7687 random_factor = 1.0,
7690 np_stratum_thickness = {
7693 spread = {x = 100, y = 100, z = 100},
7698 stratum_thickness = 8,
7704 Used by `minetest.register_biome`.
7706 The maximum number of biomes that can be used is 65535. However, using an
7707 excessive number of biomes will slow down map generation. Depending on desired
7708 performance and computing power the practical limit is much lower.
7713 node_dust = "default:snow",
7714 -- Node dropped onto upper surface after all else is generated
7716 node_top = "default:dirt_with_snow",
7718 -- Node forming surface layer of biome and thickness of this layer
7720 node_filler = "default:permafrost",
7722 -- Node forming lower layer of biome and thickness of this layer
7724 node_stone = "default:bluestone",
7725 -- Node that replaces all stone nodes between roughly y_min and y_max.
7727 node_water_top = "default:ice",
7728 depth_water_top = 10,
7729 -- Node forming a surface layer in seawater with the defined thickness
7732 -- Node that replaces all seawater nodes not in the surface layer
7734 node_river_water = "default:ice",
7735 -- Node that replaces river water in mapgens that use
7736 -- default:river_water
7738 node_riverbed = "default:gravel",
7740 -- Node placed under river water and thickness of this layer
7742 node_cave_liquid = "default:lava_source",
7743 node_cave_liquid = {"default:water_source", "default:lava_source"},
7744 -- Nodes placed inside 50% of the medium size caves.
7745 -- Multiple nodes can be specified, each cave will use a randomly
7746 -- chosen node from the list.
7747 -- If this field is left out or 'nil', cave liquids fall back to
7748 -- classic behaviour of lava and water distributed using 3D noise.
7749 -- For no cave liquid, specify "air".
7751 node_dungeon = "default:cobble",
7752 -- Node used for primary dungeon structure.
7753 -- If absent, dungeon nodes fall back to the 'mapgen_cobble' mapgen
7754 -- alias, if that is also absent, dungeon nodes fall back to the biome
7756 -- If present, the following two nodes are also used.
7758 node_dungeon_alt = "default:mossycobble",
7759 -- Node used for randomly-distributed alternative structure nodes.
7760 -- If alternative structure nodes are not wanted leave this absent for
7761 -- performance reasons.
7763 node_dungeon_stair = "stairs:stair_cobble",
7764 -- Node used for dungeon stairs.
7765 -- If absent, stairs fall back to 'node_dungeon'.
7769 -- Upper and lower limits for biome.
7770 -- Alternatively you can use xyz limits as shown below.
7772 max_pos = {x = 31000, y = 128, z = 31000},
7773 min_pos = {x = -31000, y = 9, z = -31000},
7774 -- xyz limits for biome, an alternative to using 'y_min' and 'y_max'.
7775 -- Biome is limited to a cuboid defined by these positions.
7776 -- Any x, y or z field left undefined defaults to -31000 in 'min_pos' or
7777 -- 31000 in 'max_pos'.
7780 -- Vertical distance in nodes above 'y_max' over which the biome will
7781 -- blend with the biome above.
7782 -- Set to 0 for no vertical blend. Defaults to 0.
7785 humidity_point = 50,
7786 -- Characteristic temperature and humidity for the biome.
7787 -- These values create 'biome points' on a voronoi diagram with heat and
7788 -- humidity as axes. The resulting voronoi cells determine the
7789 -- distribution of the biomes.
7790 -- Heat and humidity have average values of 50, vary mostly between
7791 -- 0 and 100 but can exceed these values.
7794 Decoration definition
7795 ---------------------
7797 See [Decoration types]. Used by `minetest.register_decoration`.
7800 deco_type = "simple",
7802 place_on = "default:dirt_with_grass",
7803 -- Node (or list of nodes) that the decoration can be placed on
7806 -- Size of the square divisions of the mapchunk being generated.
7807 -- Determines the resolution of noise variation if used.
7808 -- If the chunk size is not evenly divisible by sidelen, sidelen is made
7809 -- equal to the chunk size.
7812 -- The value determines 'decorations per surface node'.
7813 -- Used only if noise_params is not specified.
7814 -- If >= 10.0 complete coverage is enabled and decoration placement uses
7815 -- a different and much faster method.
7820 spread = {x = 100, y = 100, z = 100},
7827 -- NoiseParams structure describing the perlin noise used for decoration
7829 -- A noise value is calculated for each square division and determines
7830 -- 'decorations per surface node' within each division.
7831 -- If the noise value >= 10.0 complete coverage is enabled and
7832 -- decoration placement uses a different and much faster method.
7834 biomes = {"Oceanside", "Hills", "Plains"},
7835 -- List of biomes in which this decoration occurs. Occurs in all biomes
7836 -- if this is omitted, and ignored if the Mapgen being used does not
7838 -- Can be a list of (or a single) biome names, IDs, or definitions.
7842 -- Lower and upper limits for decoration.
7843 -- These parameters refer to the Y co-ordinate of the 'place_on' node.
7845 spawn_by = "default:water",
7846 -- Node (or list of nodes) that the decoration only spawns next to.
7847 -- Checks two horizontal planes of 8 neighbouring nodes (including
7848 -- diagonal neighbours), one plane level with the 'place_on' node and a
7849 -- plane one node above that.
7852 -- Number of spawn_by nodes that must be surrounding the decoration
7853 -- position to occur.
7854 -- If absent or -1, decorations occur next to any nodes.
7856 flags = "liquid_surface, force_placement, all_floors, all_ceilings",
7857 -- Flags for all decoration types.
7858 -- "liquid_surface": Instead of placement on the highest solid surface
7859 -- in a mapchunk column, placement is on the highest liquid surface.
7860 -- Placement is disabled if solid nodes are found above the liquid
7862 -- "force_placement": Nodes other than "air" and "ignore" are replaced
7863 -- by the decoration.
7864 -- "all_floors", "all_ceilings": Instead of placement on the highest
7865 -- surface in a mapchunk the decoration is placed on all floor and/or
7866 -- ceiling surfaces, for example in caves and dungeons.
7867 -- Ceiling decorations act as an inversion of floor decorations so the
7868 -- effect of 'place_offset_y' is inverted.
7869 -- Y-slice probabilities do not function correctly for ceiling
7870 -- schematic decorations as the behaviour is unchanged.
7871 -- If a single decoration registration has both flags the floor and
7872 -- ceiling decorations will be aligned vertically.
7874 ----- Simple-type parameters
7876 decoration = "default:grass",
7877 -- The node name used as the decoration.
7878 -- If instead a list of strings, a randomly selected node from the list
7879 -- is placed as the decoration.
7882 -- Decoration height in nodes.
7883 -- If height_max is not 0, this is the lower limit of a randomly
7887 -- Upper limit of the randomly selected height.
7888 -- If absent, the parameter 'height' is used as a constant.
7891 -- Param2 value of decoration nodes.
7892 -- If param2_max is not 0, this is the lower limit of a randomly
7896 -- Upper limit of the randomly selected param2.
7897 -- If absent, the parameter 'param2' is used as a constant.
7900 -- Y offset of the decoration base node relative to the standard base
7902 -- Can be positive or negative. Default is 0.
7903 -- Effect is inverted for "all_ceilings" decorations.
7904 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
7905 -- to the 'place_on' node.
7907 ----- Schematic-type parameters
7909 schematic = "foobar.mts",
7910 -- If schematic is a string, it is the filepath relative to the current
7911 -- working directory of the specified Minetest schematic file.
7912 -- Could also be the ID of a previously registered schematic.
7915 size = {x = 4, y = 6, z = 4},
7917 {name = "default:cobble", param1 = 255, param2 = 0},
7918 {name = "default:dirt_with_grass", param1 = 255, param2 = 0},
7919 {name = "air", param1 = 255, param2 = 0},
7923 {ypos = 2, prob = 128},
7924 {ypos = 5, prob = 64},
7928 -- Alternative schematic specification by supplying a table. The fields
7929 -- size and data are mandatory whereas yslice_prob is optional.
7930 -- See 'Schematic specifier' for details.
7932 replacements = {["oldname"] = "convert_to", ...},
7934 flags = "place_center_x, place_center_y, place_center_z",
7935 -- Flags for schematic decorations. See 'Schematic attributes'.
7938 -- Rotation can be "0", "90", "180", "270", or "random"
7941 -- If the flag 'place_center_y' is set this parameter is ignored.
7942 -- Y offset of the schematic base node layer relative to the 'place_on'
7944 -- Can be positive or negative. Default is 0.
7945 -- Effect is inverted for "all_ceilings" decorations.
7946 -- Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
7947 -- to the 'place_on' node.
7950 Chat command definition
7951 -----------------------
7953 Used by `minetest.register_chatcommand`.
7956 params = "<name> <privilege>", -- Short parameter description
7958 description = "Remove privilege from player", -- Full description
7960 privs = {privs=true}, -- Require the "privs" privilege to run
7962 func = function(name, param),
7963 -- Called when command is run. Returns boolean success and text output.
7964 -- Special case: The help message is shown to the player if `func`
7965 -- returns false without a text output.
7968 Note that in params, use of symbols is as follows:
7970 * `<>` signifies a placeholder to be replaced when the command is used. For
7971 example, when a player name is needed: `<name>`
7972 * `[]` signifies param is optional and not required when the command is used.
7973 For example, if you require param1 but param2 is optional:
7974 `<param1> [<param2>]`
7975 * `|` signifies exclusive or. The command requires one param from the options
7976 provided. For example: `<param1> | <param2>`
7977 * `()` signifies grouping. For example, when param1 and param2 are both
7978 required, or only param3 is required: `(<param1> <param2>) | <param3>`
7980 Privilege definition
7981 --------------------
7983 Used by `minetest.register_privilege`.
7987 -- Privilege description
7989 give_to_singleplayer = true,
7990 -- Whether to grant the privilege to singleplayer.
7992 give_to_admin = true,
7993 -- Whether to grant the privilege to the server admin.
7994 -- Uses value of 'give_to_singleplayer' by default.
7996 on_grant = function(name, granter_name),
7997 -- Called when given to player 'name' by 'granter_name'.
7998 -- 'granter_name' will be nil if the priv was granted by a mod.
8000 on_revoke = function(name, revoker_name),
8001 -- Called when taken from player 'name' by 'revoker_name'.
8002 -- 'revoker_name' will be nil if the priv was revoked by a mod.
8004 -- Note that the above two callbacks will be called twice if a player is
8005 -- responsible, once with the player name, and then with a nil player
8007 -- Return true in the above callbacks to stop register_on_priv_grant or
8008 -- revoke being called.
8011 Detached inventory callbacks
8012 ----------------------------
8014 Used by `minetest.create_detached_inventory`.
8017 allow_move = function(inv, from_list, from_index, to_list, to_index, count, player),
8018 -- Called when a player wants to move items inside the inventory.
8019 -- Return value: number of items allowed to move.
8021 allow_put = function(inv, listname, index, stack, player),
8022 -- Called when a player wants to put something into the inventory.
8023 -- Return value: number of items allowed to put.
8024 -- Return value -1: Allow and don't modify item count in inventory.
8026 allow_take = function(inv, listname, index, stack, player),
8027 -- Called when a player wants to take something out of the inventory.
8028 -- Return value: number of items allowed to take.
8029 -- Return value -1: Allow and don't modify item count in inventory.
8031 on_move = function(inv, from_list, from_index, to_list, to_index, count, player),
8032 on_put = function(inv, listname, index, stack, player),
8033 on_take = function(inv, listname, index, stack, player),
8034 -- Called after the actual action has happened, according to what was
8044 Used by `Player:hud_add`. Returned by `Player:hud_get`.
8047 hud_elem_type = "image", -- See HUD element types
8048 -- Type of element, can be "image", "text", "statbar", "inventory" or "compass"
8050 position = {x=0.5, y=0.5},
8051 -- Left corner position of element
8055 scale = {x = 2, y = 2},
8064 -- Selected item in inventory. 0 for no item selected.
8067 -- Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
8069 alignment = {x=0, y=0},
8071 offset = {x=0, y=0},
8073 size = { x=100, y=100 },
8074 -- Size of element in pixels
8077 -- Z index : lower z-index HUDs are displayed behind higher z-index HUDs
8083 Used by `minetest.add_particle`.
8086 pos = {x=0, y=0, z=0},
8087 velocity = {x=0, y=0, z=0},
8088 acceleration = {x=0, y=0, z=0},
8089 -- Spawn particle at pos with velocity and acceleration
8092 -- Disappears after expirationtime seconds
8095 -- Scales the visual size of the particle texture.
8096 -- If `node` is set, size can be set to 0 to spawn a randomly-sized
8097 -- particle (just like actual node dig particles).
8099 collisiondetection = false,
8100 -- If true collides with `walkable` nodes and, depending on the
8101 -- `object_collision` field, objects too.
8103 collision_removal = false,
8104 -- If true particle is removed when it collides.
8105 -- Requires collisiondetection = true to have any effect.
8107 object_collision = false,
8108 -- If true particle collides with objects that are defined as
8109 -- `physical = true,` and `collide_with_objects = true,`.
8110 -- Requires collisiondetection = true to have any effect.
8113 -- If true faces player using y axis only
8115 texture = "image.png",
8116 -- The texture of the particle
8118 playername = "singleplayer",
8119 -- Optional, if specified spawns particle only on the player's client
8121 animation = {Tile Animation definition},
8122 -- Optional, specifies how to animate the particle texture
8125 -- Optional, specify particle self-luminescence in darkness.
8128 node = {name = "ignore", param2 = 0},
8129 -- Optional, if specified the particle will have the same appearance as
8130 -- node dig particles for the given node.
8131 -- `texture` and `animation` will be ignored if this is set.
8134 -- Optional, only valid in combination with `node`
8135 -- If set to a valid number 1-6, specifies the tile from which the
8136 -- particle texture is picked.
8137 -- Otherwise, the default behavior is used. (currently: any random tile)
8141 `ParticleSpawner` definition
8142 ----------------------------
8144 Used by `minetest.add_particlespawner`.
8148 -- Number of particles spawned over the time period `time`.
8151 -- Lifespan of spawner in seconds.
8152 -- If time is 0 spawner has infinite lifespan and spawns the `amount` on
8153 -- a per-second basis.
8155 minpos = {x=0, y=0, z=0},
8156 maxpos = {x=0, y=0, z=0},
8157 minvel = {x=0, y=0, z=0},
8158 maxvel = {x=0, y=0, z=0},
8159 minacc = {x=0, y=0, z=0},
8160 maxacc = {x=0, y=0, z=0},
8165 -- The particles' properties are random values between the min and max
8167 -- applies to: pos, velocity, acceleration, expirationtime, size
8168 -- If `node` is set, min and maxsize can be set to 0 to spawn
8169 -- randomly-sized particles (just like actual node dig particles).
8171 collisiondetection = false,
8172 -- If true collide with `walkable` nodes and, depending on the
8173 -- `object_collision` field, objects too.
8175 collision_removal = false,
8176 -- If true particles are removed when they collide.
8177 -- Requires collisiondetection = true to have any effect.
8179 object_collision = false,
8180 -- If true particles collide with objects that are defined as
8181 -- `physical = true,` and `collide_with_objects = true,`.
8182 -- Requires collisiondetection = true to have any effect.
8184 attached = ObjectRef,
8185 -- If defined, particle positions, velocities and accelerations are
8186 -- relative to this object's position and yaw
8189 -- If true face player using y axis only
8191 texture = "image.png",
8192 -- The texture of the particle
8194 playername = "singleplayer",
8195 -- Optional, if specified spawns particles only on the player's client
8197 animation = {Tile Animation definition},
8198 -- Optional, specifies how to animate the particles' texture
8201 -- Optional, specify particle self-luminescence in darkness.
8204 node = {name = "ignore", param2 = 0},
8205 -- Optional, if specified the particles will have the same appearance as
8206 -- node dig particles for the given node.
8207 -- `texture` and `animation` will be ignored if this is set.
8210 -- Optional, only valid in combination with `node`
8211 -- If set to a valid number 1-6, specifies the tile from which the
8212 -- particle texture is picked.
8213 -- Otherwise, the default behavior is used. (currently: any random tile)
8216 `HTTPRequest` definition
8217 ------------------------
8219 Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
8222 url = "http://example.org",
8225 -- Timeout for connection in seconds. Default is 3 seconds.
8227 method = "GET", "POST", "PUT" or "DELETE"
8228 -- The http method to use. Defaults to "GET".
8230 data = "Raw request data string" OR {field1 = "data1", field2 = "data2"},
8231 -- Data for the POST, PUT or DELETE request.
8232 -- Accepts both a string and a table. If a table is specified, encodes
8233 -- table as x-www-form-urlencoded key-value pairs.
8235 user_agent = "ExampleUserAgent",
8236 -- Optional, if specified replaces the default minetest user agent with
8239 extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
8240 -- Optional, if specified adds additional headers to the HTTP request.
8241 -- You must make sure that the header strings follow HTTP specification
8245 -- Optional, if true performs a multipart HTTP request.
8246 -- Default is false.
8247 -- Post only, data must be array
8249 post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
8250 -- Deprecated, use `data` instead. Forces `method = "POST"`.
8253 `HTTPRequestResult` definition
8254 ------------------------------
8256 Passed to `HTTPApiTable.fetch` callback. Returned by
8257 `HTTPApiTable.fetch_async_get`.
8261 -- If true, the request has finished (either succeeded, failed or timed
8265 -- If true, the request was successful
8268 -- If true, the request timed out
8276 Authentication handler definition
8277 ---------------------------------
8279 Used by `minetest.register_authentication_handler`.
8282 get_auth = function(name),
8283 -- Get authentication data for existing player `name` (`nil` if player
8285 -- Returns following structure:
8286 -- `{password=<string>, privileges=<table>, last_login=<number or nil>}`
8288 create_auth = function(name, password),
8289 -- Create new auth data for player `name`.
8290 -- Note that `password` is not plain-text but an arbitrary
8291 -- representation decided by the engine.
8293 delete_auth = function(name),
8294 -- Delete auth data of player `name`.
8295 -- Returns boolean indicating success (false if player is nonexistent).
8297 set_password = function(name, password),
8298 -- Set password of player `name` to `password`.
8299 -- Auth data should be created if not present.
8301 set_privileges = function(name, privileges),
8302 -- Set privileges of player `name`.
8303 -- `privileges` is in table form, auth data should be created if not
8306 reload = function(),
8307 -- Reload authentication data from the storage location.
8308 -- Returns boolean indicating success.
8310 record_login = function(name),
8311 -- Called when player joins, used for keeping track of last_login
8313 iterate = function(),
8314 -- Returns an iterator (use with `for` loops) for all player names
8315 -- currently in the auth database