1 Minetest Lua Modding API Reference 0.4.8
2 ========================================
3 More information at http://www.minetest.net/
4 Developer Wiki: http://dev.minetest.net/
8 Content and functionality can be added to Minetest 0.4 by using Lua
9 scripting in run-time loaded mods.
11 A mod is a self-contained bunch of scripts, textures and other related
12 things that is loaded by and interfaces with Minetest.
14 Mods are contained and ran solely on the server side. Definitions and media
15 files are automatically transferred to the client.
17 If you see a deficiency in the API, feel free to attempt to add the
18 functionality in the engine and API. You can send such improvements as
19 source code patches to <celeron55@gmail.com>.
23 If you have any difficulty in understanding this, please read:
24 http://www.lua.org/pil/
28 Mods are loaded during server startup from the mod load paths by running
29 the init.lua scripts in a shared environment.
33 RUN_IN_PLACE=1: (Windows release, local build)
34 $path_user: Linux: <build directory>
35 Windows: <build directory>
36 $path_share: Linux: <build directory>
37 Windows: <build directory>
39 RUN_IN_PLACE=0: (Linux release)
40 $path_share: Linux: /usr/share/minetest
41 Windows: <install directory>/minetest-0.4.x
42 $path_user: Linux: ~/.minetest
43 Windows: C:/users/<user>/AppData/minetest (maybe)
47 Games are looked up from:
48 $path_share/games/gameid/
49 $path_user/games/gameid/
50 where gameid is unique to each game.
52 The game directory contains the file game.conf, which contains these fields:
53 name = <Human-readable full name of the game>
57 The game directory can contain the file minetest.conf, which will be used
58 to set default settings when running the particular game.
63 $path_share/games/gameid/mods/
65 $path_user/games/gameid/mods/
66 $path_user/mods/ <-- User-installed mods
69 In a run-in-place version (eg. the distributed windows version):
70 minetest-0.4.x/games/gameid/mods/
71 minetest-0.4.x/mods/gameid/ <-- User-installed mods
72 minetest-0.4.x/worlds/worldname/worldmods/
74 On an installed version on linux:
75 /usr/share/minetest/games/gameid/mods/
76 ~/.minetest/mods/gameid/ <-- User-installed mods
77 ~/.minetest/worlds/worldname/worldmods
79 Mod load path for world-specific games
80 --------------------------------------
81 It is possible to include a game in a world; in this case, no mods or
82 games are loaded or checked from anywhere else.
84 This is useful for eg. adventure worlds.
86 This happens if the following directory exists:
89 Mods should be then be placed in:
94 Mods can be put in a subdirectory, if the parent directory, which otherwise
95 should be a mod, contains a file named modpack.txt. This file shall be
96 empty, except for lines starting with #, which are comments.
98 Mod directory structure
99 ------------------------
104 | |-- description.txt
107 | | |-- modname_stuff.png
108 | | `-- modname_something_else.png
115 The location of this directory can be fetched by using
116 minetest.get_modpath(modname)
119 List of mods that have to be loaded before loading this mod.
120 A single line contains a single modname.
122 Optional dependencies can be defined by appending a question mark
123 to a single modname. Their meaning is that if the specified mod
124 is missing, that does not prevent this mod from being loaded.
127 A screenshot shown in modmanager within mainmenu.
130 File containing desctiption to be shown within mainmenu.
133 An alternative way of specifying optional dependencies.
134 Like depends.txt, a single line contains a single modname.
136 NOTE: This file exists for compatibility purposes only and
137 support for it will be removed from the engine by the end of 2013.
140 The main Lua script. Running this script should register everything it
141 wants to register. Subsequent execution depends on minetest calling the
142 registered callbacks.
144 minetest.setting_get(name) and minetest.setting_getbool(name) can be used
145 to read custom or existing settings at load time, if necessary.
147 textures, sounds, media:
148 Media files (textures, sounds, whatever) that will be transferred to the
149 client and will be available for use by the mod.
151 Naming convention for registered textual names
152 ----------------------------------------------
153 Registered names should generally be in this format:
154 "modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
156 This is to prevent conflicting names from corrupting maps and is
157 enforced by the mod loader.
159 Example: mod "experimental", ideal item/node/entity name "tnt":
160 -> the name should be "experimental:tnt".
162 Enforcement can be overridden by prefixing the name with ":". This can
163 be used for overriding the registrations of some other mod.
165 Example: Any mod can redefine experimental:tnt by using the name
166 ":experimental:tnt" when registering it.
167 (also that mod is required to have "experimental" as a dependency)
169 The ":" prefix can also be used for maintaining backwards compatibility.
173 Aliases can be added by using minetest.register_alias(name, convert_to)
175 This will make Minetest to convert things called name to things called
178 This can be used for maintaining backwards compatibility.
180 This can be also used for setting quick access names for things, eg. if
181 you have an item called epiclylongmodname:stuff, you could do
182 minetest.register_alias("stuff", "epiclylongmodname:stuff")
183 and be able to use "/giveme stuff".
187 Mods should generally prefix their textures with modname_, eg. given
188 the mod name "foomod", a texture could be called
189 "foomod_foothing.png"
191 Textures are referred to by their complete name, or alternatively by
192 stripping out the file extension:
193 eg. foomod_foothing.png
198 Only OGG files are supported.
200 For positional playing of sounds, only single-channel (mono) files are
201 supported. Otherwise OpenAL will play them non-positionally.
203 Mods should generally prefix their sounds with modname_, eg. given
204 the mod name "foomod", a sound could be called
205 "foomod_foosound.ogg"
207 Sounds are referred to by their name with a dot, a single digit and the
208 file extension stripped out. When a sound is played, the actual sound file
209 is chosen randomly from the matching sounds.
211 When playing the sound "foomod_foosound", the sound is chosen randomly
212 from the available ones of the following files:
214 foomod_foosound.0.ogg
215 foomod_foosound.1.ogg
217 foomod_foosound.9.ogg
219 Examples of sound parameter tables:
220 -- Play locationless on all clients
222 gain = 1.0, -- default
224 -- Play locationless to a player
227 gain = 1.0, -- default
229 -- Play in a location
232 gain = 1.0, -- default
233 max_hear_distance = 32, -- default
235 -- Play connected to an object, looped
237 object = <an ObjectRef>,
238 gain = 1.0, -- default
239 max_hear_distance = 32, -- default
240 loop = true, -- only sounds connected to objects can be looped
245 eg. "default_place_node"
247 eg. {name="default_place_node"}
248 eg. {name="default_place_node", gain=1.0}
250 Registered definitions of stuff
251 --------------------------------
252 Anything added using certain minetest.register_* functions get added to
253 the global minetest.registered_* tables.
255 minetest.register_entity(name, prototype table)
256 -> minetest.registered_entities[name]
258 minetest.register_node(name, node definition)
259 -> minetest.registered_items[name]
260 -> minetest.registered_nodes[name]
262 minetest.register_tool(name, item definition)
263 -> minetest.registered_items[name]
265 minetest.register_craftitem(name, item definition)
266 -> minetest.registered_items[name]
268 Note that in some cases you will stumble upon things that are not contained
269 in these tables (eg. when a mod has been removed). Always check for
270 existence before trying to access the fields.
272 Example: If you want to check the drawtype of a node, you could do:
274 local function get_nodedef_field(nodename, fieldname)
275 if not minetest.registered_nodes[nodename] then
278 return minetest.registered_nodes[nodename][fieldname]
280 local drawtype = get_nodedef_field(nodename, "drawtype")
282 Example: minetest.get_item_group(name, group) has been implemented as:
284 function minetest.get_item_group(name, group)
285 if not minetest.registered_items[name] or not
286 minetest.registered_items[name].groups[group] then
289 return minetest.registered_items[name].groups[group]
294 Nodes are the bulk data of the world: cubes and other things that take the
295 space of a cube. Huge amounts of them are handled efficiently, but they
298 The definition of a node is stored and can be accessed by name in
299 minetest.registered_nodes[node.name]
300 See "Registered definitions of stuff".
302 Nodes are passed by value between Lua and the engine.
303 They are represented by a table:
304 {name="name", param1=num, param2=num}
306 param1 and param2 are 8 bit integers. The engine uses them for certain
307 automated functions. If you don't use these functions, you can use them to
308 store arbitrary values.
310 The functions of param1 and param2 are determined by certain fields in the
312 param1 is reserved for the engine when paramtype != "none":
314 ^ The value stores light with and without sun in it's
315 upper and lower 4 bits.
316 param2 is reserved for the engine when any of these are used:
317 liquidtype == "flowing"
318 ^ The level and some flags of the liquid is stored in param2
319 drawtype == "flowingliquid"
320 ^ The drawn liquid level is read from param2
321 drawtype == "torchlike"
322 drawtype == "signlike"
323 paramtype2 == "wallmounted"
324 ^ The rotation of the node is stored in param2. You can make this value
325 by using minetest.dir_to_wallmounted().
326 paramtype2 == "facedir"
327 ^ The rotation of the node is stored in param2. Furnaces and chests are
328 rotated this way. Can be made by using minetest.dir_to_facedir().
330 facedir modulo 4 = axisdir
331 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
332 facedir's two less significant bits are rotation around the axis
333 paramtype2 == "leveled"
334 ^ The drawn node level is read from param2, like flowingliquid
336 Nodes can also contain extra data. See "Node Metadata".
340 There are a bunch of different looking node types. These are mostly just
341 copied from Minetest 0.3; more may be made in the future.
343 Look for examples in games/minimal or games/minetest_game.
358 - nodebox -- See below. EXPERIMENTAL
362 Node selection boxes are defined using "node boxes"
364 The "nodebox" node drawtype allows defining visual of nodes consisting of
365 arbitrary number of boxes. It allows defining stuff like stairs. Only the
366 "fixed" and "leveled" box type is supported for these.
367 ^ Please note that this is still experimental, and may be incompatibly
368 changed in the future.
370 A nodebox is defined as any of:
372 -- A normal cube; the default in most things
376 -- A fixed box (facedir param2 is used, if applicable)
378 fixed = box OR {box1, box2, ...}
381 -- A box like the selection box for torches
382 -- (wallmounted param2 is used, if applicable)
383 type = "wallmounted",
390 {x1, y1, z1, x2, y2, z2}
391 A box of a regular node would look like:
392 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
394 type = "leveled" is same as "fixed", but y2 will be automaticaly setted to level from param2
398 These tell in what manner the ore is generated.
399 All default ores are of the uniformly-distributed scatter type.
402 Randomly chooses a location and generates a cluster of ore.
403 If noise_params is specified, the ore will be placed if the 3d perlin noise at
404 that point is greater than the noise_threshhold, giving the ability to create a non-equal
407 Creates a sheet of ore in a blob shape according to the 2d perlin noise described by noise_params.
408 The relative height of the sheet can be controlled by the same perlin noise as well, by specifying
409 a non-zero 'scale' parameter in noise_params. IMPORTANT: The noise is not transformed by offset or
410 scale when comparing against the noise threshhold, but scale is used to determine relative height.
411 The height of the blob is randomly scattered, with a maximum height of clust_size.
412 clust_scarcity and clust_num_ores are ignored.
413 This is essentially an improved version of the so-called "stratus" ore seen in some unofficial mods.
414 - claylike - NOT YET IMPLEMENTED
415 Places ore if there are no more than clust_scarcity number of specified nodes within a Von Neumann
416 neighborhood of clust_size radius.
420 Currently supported flags: absheight
422 Also produce this same ore between the height range of -height_max and -height_min.
423 Useful for having ore in sky realms without having to duplicate ore entries.
427 The varying types of decorations that can be placed.
428 The default value is simple, and is currently the only type supported.
431 Creates a 1xHx1 column of a specified node (or a random node from a list, if a decoration
432 list is specified). Can specify a certain node it must spawn next to, such as water or lava,
433 for example. Can also generate a decoration of random height between a specified lower and
434 upper bound. This type of decoration is intended for placement of grass, flowers, cacti,
437 Copies a box of MapNodes from a specified schematic file (or raw description). Can specify a
438 probability of a node randomly appearing when placed. This decoration type is intended to be used
439 for multi-node sized discrete structures, such as trees, cave spikes, rocks, and so on.
443 A schematic specifier identifies a schematic by either a filename to a Minetest Schematic file (.mts)
444 or through raw data supplied through Lua, in the form of a table. This table must specify two fields:
445 - The 'size' field is a 3d vector containing the dimensions of the provided schematic.
446 - The 'data' field is a flat table of MapNodes making up the schematic, in the order of [z [y [x]]].
447 Important: The default value for param1 in MapNodes here is 255, which represents "always place".
449 In the bulk MapNode data, param1, instead of the typical light values, instead represents the
450 probability of that node appearing in the structure.
451 When passed to minetest.create_schematic, probability is an integer value ranging from 0 to 255:
452 - A probability value of 0 means that node will never appear (0% chance).
453 - A probability value of 255 means the node will always appear (100% chance).
454 - If the probability value p is greater than 0, then there is a (p / 256 * 100)% chance that node
455 will appear when the schematic is placed on the map.
457 Important note: Node aliases cannot be used for a raw schematic provided when registering as a decoration.
460 ---------------------
461 Currently supported flags: place_center_x, place_center_y, place_center_z
463 Placement of this decoration is centered along the X axis.
465 Placement of this decoration is centered along the Y axis.
467 Placement of this decoration is centered along the Z axis.
471 The position field is used for all element types.
472 To account for differing resolutions, the position coordinates are the percentage of the screen,
473 ranging in value from 0 to 1.
474 The name field is not yet used, but should contain a description of what the HUD element represents.
475 The direction field is the direction in which something is drawn.
476 0 draws from left to right, 1 draws from right to left, 2 draws from top to bottom, and 3 draws from bottom to top.
477 The alignment field specifies how the item will be aligned. It ranges from -1 to 1,
478 with 0 being the center, -1 is moved to the left/up, and 1 is to the right/down. Fractional
480 The offset field specifies a pixel offset from the position. Contrary to position,
481 the offset is not scaled to screen size. This allows for some precisely-positioned
483 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
485 Note: Future revisions to the HUD API may be incompatible; the HUD API is still in the experimental stages.
488 Displays an image on the HUD.
489 - scale: The scale of the image, with 1 being the original texture size.
490 Only the X coordinate scale is used (positive values)
491 Negative values represent that percentage of the screen it
492 should take; e.g. x=-100 means 100% (width)
493 - text: The name of the texture that is displayed.
494 - alignment: The alignment of the image.
495 - offset: offset in pixels from position.
497 Displays text on the HUD.
498 - scale: Defines the bounding rectangle of the text.
499 A value such as {x=100, y=100} should work.
500 - text: The text to be displayed in the HUD element.
501 - number: An integer containing the RGB value of the color used to draw the text.
502 Specify 0xFFFFFF for white text, 0xFF0000 for red, and so on.
503 - alignment: The alignment of the text.
504 - offset: offset in pixels from position.
506 Displays a horizontal bar made up of half-images.
507 - text: The name of the texture that is used.
508 - number: The number of half-textures that are displayed.
509 If odd, will end with a vertically center-split texture.
511 - offset: offset in pixels from position.
513 - text: The name of the inventory list to be displayed.
514 - number: Number of items in the inventory to be displayed.
515 - item: Position of item that is selected.
518 Representations of simple things
519 --------------------------------
521 {x=num, y=num, z=num}
522 For helper functions see "Vector helpers".
526 {type="node", under=pos, above=pos}
527 {type="object", ref=ObjectRef}
531 Node (register_node):
532 A node from the world
533 Tool (register_tool):
534 A tool/weapon that can dig and damage things according to tool_capabilities
535 Craftitem (register_craftitem):
538 Items and item stacks can exist in three formats:
540 Serialized; This is called stackstring or itemstring:
542 eg. 'default:pick_wood 21323'
546 eg. {name="default:dirt", count=5, wear=0, metadata=""}
548 eg. {name="default:pick_wood", count=1, wear=21323, metadata=""}
549 ^ a wooden pick about 1/3 weared out
550 eg. {name="default:apple", count=1, wear=0, metadata=""}
554 C++ native format with many helper methods. Useful for converting between
555 formats. See the Class reference section for details.
557 When an item must be passed to a function, it can usually be in any of
562 In a number of places, there is a group table. Groups define the
563 properties of a thing (item, node, armor of entity, capabilities of
564 tool) in such a way that the engine and other mods can can interact with
565 the thing without actually knowing what the thing is.
568 - Groups are stored in a table, having the group names with keys and the
569 group ratings as values. For example:
570 groups = {crumbly=3, soil=1}
572 groups = {crumbly=2, soil=1, level=2, outerspace=1}
573 ^ A more special dirt-kind of thing
574 - Groups always have a rating associated with them. If there is no
575 useful meaning for a rating for an enabled group, it shall be 1.
576 - When not defined, the rating of a group defaults to 0. Thus when you
577 read groups, you must interpret nil and 0 as the same value, 0.
579 You can read the rating of a group for an item or a node by using
580 minetest.get_item_group(itemname, groupname)
584 Groups of items can define what kind of an item it is (eg. wool).
588 In addition to the general item things, groups are used to define whether
589 a node is destroyable and how long it takes to destroy by a tool.
593 For entities, groups are, as of now, used only for calculating damage.
594 The rating is the percentage of damage caused by tools with this damage group.
595 See "Entity damage mechanism".
597 object.get_armor_groups() -> a group-rating table (eg. {fleshy=100})
598 object.set_armor_groups({fleshy=30, cracky=80})
602 Groups in tools define which groups of nodes and entities they are
605 Groups in crafting recipes
606 ---------------------------
607 An example: Make meat soup from any meat, any water and any bowl
609 output = 'food:meat_soup_raw',
615 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
617 An another example: Make red wool from white wool and red dye
621 recipe = {'wool:white', 'group:dye,basecolor_red'},
626 - immortal: Disables the group damage system for an entity
627 - level: Can be used to give an additional sense of progression in the game.
628 - A larger level will cause eg. a weapon of a lower level make much less
629 damage, and get weared out much faster, or not be able to get drops
630 from destroyed nodes.
631 - 0 is something that is directly accessible at the start of gameplay
632 - There is no upper limit
633 - dig_immediate: (player can always pick up node without tool wear)
634 - 2: node is removed without tool wear after 0.5 seconds or so
636 - 3: node is removed without tool wear immediately (torch)
637 - disable_jump: Player (and possibly other things) cannot jump from node
638 - fall_damage_add_percent: damage speed = speed * (1 + value/100)
639 - bouncy: value is bounce speed in percent
640 - falling_node: if there is no walkable block under the node it will fall
641 - attached_node: if the node under it is not a walkable block the node will be
642 dropped as an item. If the node is wallmounted the
643 wallmounted direction is checked.
644 - soil: saplings will grow on nodes in this group
645 - connect_to_raillike: makes nodes of raillike drawtype connect to
646 other group members with same drawtype
648 Known damage and digging time defining groups
649 ----------------------------------------------
650 - crumbly: dirt, sand
651 - cracky: tough but crackable stuff like stone.
652 - snappy: something that can be cut using fine tools; eg. leaves, small
653 plants, wire, sheets of metal
654 - choppy: something that can be cut using force; eg. trees, wooden planks
655 - fleshy: Living things like animals and the player. This could imply
656 some blood effects when hitting.
657 - explody: Especially prone to explosions
658 - oddly_breakable_by_hand:
659 Can be added to nodes that shouldn't logically be breakable by the
660 hand but are. Somewhat similar to dig_immediate, but times are more
661 like {[1]=3.50,[2]=2.00,[3]=0.70} and this does not override the
662 speed of a tool if the tool can dig at a faster speed than this
663 suggests for the hand.
665 Examples of custom groups
666 --------------------------
667 Item groups are often used for defining, well, //groups of items//.
668 - meat: any meat-kind of a thing (rating might define the size or healing
669 ability or be irrelevant - it is not defined as of yet)
670 - eatable: anything that can be eaten. Rating might define HP gain in half
672 - flammable: can be set on fire. Rating might define the intensity of the
673 fire, affecting eg. the speed of the spreading of an open fire.
674 - wool: any wool (any origin, any color)
677 - heavy: anything considerably heavy
679 Digging time calculation specifics
680 -----------------------------------
681 Groups such as **crumbly**, **cracky** and **snappy** are used for this
682 purpose. Rating is 1, 2 or 3. A higher rating for such a group implies
685 The **level** group is used to limit the toughness of nodes a tool can dig
686 and to scale the digging times / damage to a greater extent.
688 ^ PLEASE DO UNDERSTAND THIS, otherwise you cannot use the system to it's
691 Tools define their properties by a list of parameters for groups. They
692 cannot dig other groups; thus it is important to use a standard bunch of
693 groups to enable interaction with tools.
696 * Full punch interval
698 * For an arbitrary list of groups:
699 * Uses (until the tool breaks)
700 * Maximum level (usually 0, 1, 2 or 3)
704 **Full punch interval**:
705 When used as a weapon, the tool will do full damage if this time is spent
706 between punches. If eg. half the time is spent, the tool will do half
709 **Maximum drop level**
710 Suggests the maximum level of node, when dug with the tool, that will drop
711 it's useful item. (eg. iron ore to drop a lump of iron).
712 - This is not automated; it is the responsibility of the node definition
716 Determines how many uses the tool has when it is used for digging a node,
717 of this group, of the maximum level. For lower leveled nodes, the use count
718 is multiplied by 3^leveldiff.
719 - uses=10, leveldiff=0 -> actual uses: 10
720 - uses=10, leveldiff=1 -> actual uses: 30
721 - uses=10, leveldiff=2 -> actual uses: 90
724 Tells what is the maximum level of a node of this group that the tool will
728 List of digging times for different ratings of the group, for nodes of the
730 * For example, as a lua table, ''times={2=2.00, 3=0.70}''. This would
731 result in the tool to be able to dig nodes that have a rating of 2 or 3
732 for this group, and unable to dig the rating 1, which is the toughest.
733 Unless there is a matching group that enables digging otherwise.
736 List of damage for groups of entities. See "Entity damage mechanism".
738 Example definition of the capabilities of a tool
739 -------------------------------------------------
740 tool_capabilities = {
741 full_punch_interval=1.5,
744 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
746 damage_groups = {fleshy=2},
749 This makes the tool be able to dig nodes that fullfill both of these:
750 - Have the **crumbly** group
751 - Have a **level** group less or equal to 2
753 Table of resulting digging times:
754 crumbly 0 1 2 3 4 <- level
760 level diff: 2 1 0 -1 -2
762 Table of resulting tool uses:
769 - At crumbly=0, the node is not diggable.
770 - At crumbly=3, the level difference digging time divider kicks in and makes
771 easy nodes to be quickly breakable.
772 - At level > 2, the node is not diggable, because it's level > maxlevel
774 Entity damage mechanism
775 ------------------------
778 foreach group in cap.damage_groups:
779 damage += cap.damage_groups[group] * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
780 * (object.armor_groups[group] / 100.0)
781 -- Where object.armor_groups[group] is 0 for inexisting values
784 Client predicts damage based on damage groups. Because of this, it is able to
785 give an immediate response when an entity is damaged or dies; the response is
786 pre-defined somehow (eg. by defining a sprite animation) (not implemented;
788 - Currently a smoke puff will appear when an entity dies.
790 The group **immortal** completely disables normal damage.
792 Entities can define a special armor group, which is **punch_operable**. This
793 group disables the regular damage mechanism for players punching it by hand or
794 a non-tool item, so that it can do something else than take damage.
796 On the Lua side, every punch calls ''entity:on_punch(puncher,
797 time_from_last_punch, tool_capabilities, direction)''. This should never be
798 called directly, because damage is usually not handled by the entity itself.
799 * ''puncher'' is the object performing the punch. Can be nil. Should never be
800 accessed unless absolutely required, to encourage interoperability.
801 * ''time_from_last_punch'' is time from last punch (by puncher) or nil.
802 * ''tool_capabilities'' can be nil.
803 * ''direction'' is a unit vector, pointing from the source of the punch to
806 To punch an entity/object in Lua, call ''object:punch(puncher,
807 time_from_last_punch, tool_capabilities, direction)''.
808 * Return value is tool wear.
809 * Parameters are equal to the above callback.
810 * If ''direction'' is nil and ''puncher'' is not nil, ''direction'' will be
811 automatically filled in based on the location of ''puncher''.
815 The instance of a node in the world normally only contains the three values
816 mentioned in "Nodes". However, it is possible to insert extra data into a
817 node. It is called "node metadata"; See "NodeMetaRef".
819 Metadata contains two things:
823 Some of the values in the key-value store are handled specially:
824 - formspec: Defines a right-click inventory menu. See "Formspec".
825 - infotext: Text shown on the screen when the node is pointed at
829 local meta = minetest.get_meta(pos)
830 meta:set_string("formspec",
832 "list[context;main;0,0;8,4;]"..
833 "list[current_player;main;0,5;8,4;]")
834 meta:set_string("infotext", "Chest");
835 local inv = meta:get_inventory()
836 inv:set_size("main", 8*4)
837 print(dump(meta:to_table()))
840 main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "", [5] = "", [6] = "", [7] = "", [8] = "", [9] = "", [10] = "", [11] = "", [12] = "", [13] = "", [14] = "default:cobble", [15] = "", [16] = "", [17] = "", [18] = "", [19] = "", [20] = "default:cobble", [21] = "", [22] = "", [23] = "", [24] = "", [25] = "", [26] = "", [27] = "", [28] = "", [29] = "", [30] = "", [31] = "", [32] = ""}
843 formspec = "invsize[8,9;]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
850 Formspec defines a menu. Currently not much else than inventories are
851 supported. It is a string, with a somewhat strange format.
853 Spaces and newlines can be inserted between the blocks, as is used in the
859 list[context;main;0,0;8,4;]
860 list[current_player;main;0,5;8,4;]
863 list[context;fuel;2,3;1,1;]
864 list[context;src;2,1;1,1;]
865 list[context;dst;5,1;2,2;]
866 list[current_player;main;0,5;8,4;]
867 - Minecraft-like player inventory
869 image[1,0.6;1,2;player.png]
870 list[current_player;main;0,3.5;8,4;]
871 list[current_player;craft;3,0;3,3;]
872 list[current_player;craftpreview;7,1;1,1;]
877 ^ Define the size of the menu in inventory slots
878 ^ deprecated: invsize[<W>,<H>;]
880 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]
881 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]
882 ^ Show an inventory list
884 listcolors[<slot_bg_normal>;<slot_bg_hover>]
885 ^ Sets background color of slots in HEX-Color format
886 ^ Sets background color of slots on mouse hovering
888 listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]
889 ^ Sets background color of slots in HEX-Color format
890 ^ Sets background color of slots on mouse hovering
891 ^ Sets color of slots border
893 listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]
894 ^ Sets background color of slots in HEX-Color format
895 ^ Sets background color of slots on mouse hovering
896 ^ Sets color of slots border
897 ^ Sets background color of tooltips
898 ^ Sets font color of tooltips
900 image[<X>,<Y>;<W>,<H>;<texture name>]
902 ^ Position and size units are inventory slots
904 item_image[<X>,<Y>;<W>,<H>;<item name>]
905 ^ Show an inventory image of registered item/node
906 ^ Position and size units are inventory slots
908 bgcolor[<color>;<fullscreen>]
909 ^ Sets background color of formspec in HEX-Color format
910 ^ If true the background color is drawn fullscreen (does not effect the size of the formspec)
912 background[<X>,<Y>;<W>,<H>;<texture name>]
913 ^ Use a background. Inventory rectangles are not drawn then.
914 ^ Position and size units are inventory slots
915 ^ Example for formspec 8x4 in 16x resolution: image shall be sized 8*16px x 4*16px
917 background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]
918 ^ Use a background. Inventory rectangles are not drawn then.
919 ^ Position and size units are inventory slots
920 ^ Example for formspec 8x4 in 16x resolution: image shall be sized 8*16px x 4*16px
921 ^ If true the background is clipped to formspec size (x and y are used as offset values, w and h are ignored)
923 pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]
924 ^ Textual password style field; will be sent to server when a button is clicked
925 ^ x and y position the field relative to the top left of the menu
926 ^ w and h are the size of the field
927 ^ fields are a set height, but will be vertically centred on h
928 ^ Position and size units are inventory slots
929 ^ name is the name of the field as returned in fields to on_receive_fields
930 ^ label, if not blank, will be text printed on the top left above the field
932 field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
933 ^ Textual field; will be sent to server when a button is clicked
934 ^ x and y position the field relative to the top left of the menu
935 ^ w and h are the size of the field
936 ^ fields are a set height, but will be vertically centred on h
937 ^ Position and size units are inventory slots
938 ^ name is the name of the field as returned in fields to on_receive_fields
939 ^ label, if not blank, will be text printed on the top left above the field
940 ^ default is the default value of the field
941 ^ default may contain variable references such as '${text}' which
942 will fill the value from the metadata value 'text'
943 ^ Note: no extra text or more than a single variable is supported ATM.
945 field[<name>;<label>;<default>]
946 ^ as above but without position/size units
947 ^ special field for creating simple forms, such as sign text input
948 ^ must be used without a size[] element
949 ^ a 'Proceed' button will be added automatically
951 textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
952 ^ same as fields above, but with multi-line input
954 label[<X>,<Y>;<label>]
955 ^ x and y work as per field
956 ^ label is the text on the label
957 ^ Position and size units are inventory slots
959 vertlabel[<X>,<Y>;<label>]
960 ^ Textual label drawn verticaly
961 ^ x and y work as per field
962 ^ label is the text on the label
963 ^ Position and size units are inventory slots
965 button[<X>,<Y>;<W>,<H>;<name>;<label>]
966 ^ Clickable button. When clicked, fields will be sent.
967 ^ x, y and name work as per field
968 ^ w and h are the size of the button
969 ^ label is the text on the button
970 ^ Position and size units are inventory slots
972 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
973 ^ x, y, w, h, and name work as per button
974 ^ texture name is the filename of an image
975 ^ Position and size units are inventory slots
977 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>]
978 ^ x, y, w, h, and name work as per button
979 ^ texture name is the filename of an image
980 ^ Position and size units are inventory slots
981 ^ noclip true meand imagebutton doesn't need to be within specified formsize
982 ^ drawborder draw button bodrer or not
984 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]
985 ^ x, y, w, h, and name work as per button
986 ^ texture name is the filename of an image
987 ^ Position and size units are inventory slots
988 ^ noclip true meand imagebutton doesn't need to be within specified formsize
989 ^ drawborder draw button bodrer or not
990 ^ pressed texture name is the filename of an image on pressed state
992 item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]
993 ^ x, y, w, h, name and label work as per button
994 ^ item name is the registered name of an item/node,
995 tooltip will be made out of its descritption
996 ^ Position and size units are inventory slots
998 button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]
999 ^ When clicked, fields will be sent and the form will quit.
1001 image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
1002 ^ When clicked, fields will be sent and the form will quit.
1004 textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]
1005 ^Scrollabel itemlist showing arbitrary text elements
1006 ^ x and y position the itemlist relative to the top left of the menu
1007 ^ w and h are the size of the itemlist
1008 ^ name fieldname sent to server on doubleclick value is current selected element
1009 ^ listelements can be prepended by #color in hexadecimal format RRGGBB (only),
1010 ^ if you want a listelement to start with # write ##
1012 textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]
1013 ^Scrollabel itemlist showing arbitrary text elements
1014 ^ x and y position the itemlist relative to the top left of the menu
1015 ^ w and h are the size of the itemlist
1016 ^ name fieldname sent to server on doubleclick value is current selected element
1017 ^ listelements can be prepended by #RRGGBB (only) in hexadecimal format
1018 ^ if you want a listelement to start with # write ##
1019 ^ index to be selected within textlist
1020 ^ true/false draw transparent background
1022 tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]
1023 ^ show a tabHEADER at specific position (ignores formsize)
1024 ^ x and y position the itemlist relative to the top left of the menu
1025 ^ name fieldname data is transfered to lua
1026 ^ caption 1... name shown on top of tab
1027 ^ current_tab index of selected tab 1...
1028 ^ transparent (optional) show transparent
1029 ^ draw_border (optional) draw border
1031 box[<X>,<Y>;<W>,<H>;<color>]
1032 ^ simple colored semitransparent box
1033 ^ x and y position the box relative to the top left of the menu
1034 ^ w and h are the size of box
1035 ^ color in HEX-Color format
1037 dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]
1038 ^ show a dropdown field
1039 ^ x and y position of dropdown
1041 ^ fieldname data is transfered to lua
1042 ^ items to be shown in dropdown
1043 ^ index of currently selected dropdown item
1044 ^ color in hexadecimal format RRGGBB (only)
1046 checkbox[<X>,<Y>;<name>;<label>;<selected>]
1048 ^ x and y position of checkbox
1049 ^ name fieldname data is transfered to lua
1050 ^ label to be shown left of checkbox
1051 ^ selected (optional) true/false
1053 Note: do NOT use a element name starting with "key_" those names are reserved to
1054 pass key press events to formspec!
1058 - "context": Selected node metadata (deprecated: "current_name")
1059 - "current_player": Player to whom the menu is shown
1060 - "player:<name>": Any player
1061 - "nodemeta:<X>,<Y>,<Z>": Any node metadata
1062 - "detached:<name>": A detached inventory
1067 ^ defines a color in hexadecimal format
1069 ^ defines a color in hexadecimal format and alpha channel
1071 ^ defines a color in hexadecimal format
1073 ^ defines a color in hexadecimal format and alpha channel
1077 vector.new([x[, y, z]]) -> vector
1078 ^ x is a table or the x position.
1079 vector.direction(p1, p2) -> vector
1080 vector.distance(p1, p2) -> number
1081 vector.length(v) -> number
1082 vector.normalize(v) -> vector
1083 vector.round(v) -> vector
1084 vector.equals(v1, v2) -> bool
1085 For the folowing x can be either a vector or a number.
1086 vector.add(v, x) -> vector
1087 vector.subtract(v, x) -> vector
1088 vector.multiply(v, x) -> vector
1089 vector.divide(v, x) -> vector
1093 dump2(obj, name="_", dumped={})
1094 ^ Return object serialized as a string, handles reference loops
1095 dump(obj, dumped={})
1096 ^ Return object serialized as a string
1098 ^ Get the hypotenuse of a triangle with legs x and y.
1099 Usefull for distance calculation.
1100 string:split(separator)
1101 ^ eg. string:split("a,b", ",") == {"a","b"}
1103 ^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
1104 minetest.pos_to_string({x=X,y=Y,z=Z}) -> "(X,Y,Z)"
1105 ^ Convert position to a printable string
1106 minetest.string_to_pos(string) -> position
1107 ^ Same but in reverse
1108 ^ escapes characters [ ] \ , ; that can not be used in formspecs
1109 minetest.is_yes(arg)
1110 ^ returns whether arg can be interpreted as yes
1112 minetest namespace reference
1113 -----------------------------
1115 minetest.get_current_modname() -> string
1116 minetest.get_modpath(modname) -> eg. "/home/user/.minetest/usermods/modname"
1117 ^ Useful for loading additional .lua modules or static data from mod
1118 minetest.get_modnames() -> list of installed mods
1119 ^ Return a list of installed mods, sorted alphabetically
1120 minetest.get_worldpath() -> eg. "/home/user/.minetest/world"
1121 ^ Useful for storing custom data
1122 minetest.is_singleplayer()
1124 ^ table containing API feature flags: {foo=true, bar=true}
1125 minetest.has_feature(arg) -> bool, missing_features
1126 ^ arg: string or table in format {foo=true, bar=true}
1127 ^ missing_features: {foo=true, bar=true}
1130 minetest.debug(line)
1131 ^ Always printed to stderr and logfile (print() is redirected here)
1133 minetest.log(loglevel, line)
1134 ^ loglevel one of "error", "action", "info", "verbose"
1136 Registration functions: (Call these only at load time)
1137 minetest.register_entity(name, prototype table)
1138 minetest.register_abm(abm definition)
1139 minetest.register_node(name, node definition)
1140 minetest.register_tool(name, item definition)
1141 minetest.register_craftitem(name, item definition)
1142 minetest.register_alias(name, convert_to)
1143 minetest.register_craft(recipe)
1144 minetest.register_ore(ore definition)
1145 minetest.register_decoration(decoration definition)
1147 Global callback registration functions: (Call these only at load time)
1148 minetest.register_globalstep(func(dtime))
1149 ^ Called every server step, usually interval of 0.1s
1150 minetest.register_on_shutdown(func())
1151 ^ Called before server shutdown
1152 ^ WARNING: If the server terminates abnormally (i.e. crashes), the registered
1153 callbacks WILL LIKELY NOT BE RUN. Data should be saved at
1154 semi-frequent intervals as well as on server shutdown.
1155 minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack))
1156 ^ Called when a node has been placed
1157 ^ If return true no item is taken from itemstack
1158 ^ Not recommended; use on_construct or after_place_node in node definition
1160 minetest.register_on_dignode(func(pos, oldnode, digger))
1161 ^ Called when a node has been dug.
1162 ^ Not recommended: Use on_destruct or after_dig_node in node definition
1164 minetest.register_on_punchnode(func(pos, node, puncher))
1165 ^ Called when a node is punched
1166 minetest.register_on_generated(func(minp, maxp, blockseed))
1167 ^ Called after generating a piece of world. Modifying nodes inside the area
1168 is a bit faster than usually.
1169 minetest.register_on_newplayer(func(ObjectRef))
1170 ^ Called after a new player has been created
1171 minetest.register_on_dieplayer(func(ObjectRef))
1172 ^ Called when a player dies
1173 minetest.register_on_respawnplayer(func(ObjectRef))
1174 ^ Called when player is to be respawned
1175 ^ Called _before_ repositioning of player occurs
1176 ^ return true in func to disable regular player placement
1177 minetest.register_on_joinplayer(func(ObjectRef))
1178 ^ Called when a player joins the game
1179 minetest.register_on_leaveplayer(func(ObjectRef))
1180 ^ Called when a player leaves the game
1181 minetest.register_on_cheat(func(ObjectRef, cheat))
1182 ^ Called when a player cheats
1183 ^ cheat: {type="moved_too_fast"/"interacted_too_far"/"finished_unknown_dig"/"dug_unbreakable"/"dug_too_fast"}
1184 minetest.register_on_chat_message(func(name, message))
1185 ^ Called always when a player says something
1186 minetest.register_on_player_receive_fields(func(player, formname, fields))
1187 ^ Called when a button is pressed in player's inventory form
1188 ^ Newest functions are called first
1189 ^ If function returns true, remaining functions are not called
1190 minetest.register_on_mapgen_init(func(MapgenParams))
1191 ^ Called just before the map generator is initialized but before the environment is initialized
1192 ^ MapgenParams consists of a table with the fields mgname, seed, water_level, and flags
1193 minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))
1194 ^ Called when player crafts something
1195 ^ itemstack is the output
1196 ^ old_craft_grid contains the recipe (Note: the one in the inventory is cleared)
1197 ^ craft_inv is the inventory with the crafting grid
1198 ^ Return either an ItemStack, to replace the output, or nil, to not modify it
1199 minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))
1200 ^ The same as before, except that it is called before the player crafts, to make
1201 ^ craft prediction, and it should not change anything.
1202 minetest.register_on_protection_violation(func(pos, name))
1203 ^ Called by builtin and mods when a player violates protection at a position
1204 (eg, digs a node or punches a protected entity).
1205 ^ The registered functions can be called using minetest.record_protection_violation
1206 ^ The provided function should check that the position is protected by the mod
1207 calling this function before it prints a message, if it does, to allow for
1208 multiple protection mods.
1210 Other registration functions:
1211 minetest.register_chatcommand(cmd, chatcommand definition)
1212 minetest.register_privilege(name, definition)
1213 ^ definition: "description text"
1215 description = "description text",
1216 give_to_singleplayer = boolean, -- default: true
1218 minetest.register_authentication_handler(handler)
1219 ^ See minetest.builtin_auth_handler in builtin.lua for reference
1222 minetest.setting_set(name, value)
1223 minetest.setting_get(name) -> string or nil
1224 minetest.setting_setbool(name, value)
1225 minetest.setting_getbool(name) -> boolean value or nil
1226 minetest.setting_get_pos(name) -> position or nil
1227 minetest.setting_save() -> nil, save all settings to config file
1230 minetest.notify_authentication_modified(name)
1231 ^ Should be called by the authentication handler if privileges change.
1232 ^ To report everybody, set name=nil.
1233 minetest.get_password_hash(name, raw_password)
1234 ^ Convert a name-password pair to a password hash that minetest can use
1235 minetest.string_to_privs(str) -> {priv1=true,...}
1236 minetest.privs_to_string(privs) -> "priv1,priv2,..."
1237 ^ Convert between two privilege representations
1238 minetest.set_player_password(name, password_hash)
1239 minetest.set_player_privs(name, {priv1=true,...})
1240 minetest.get_player_privs(name) -> {priv1=true,...}
1241 minetest.auth_reload()
1242 ^ These call the authentication handler
1243 minetest.check_player_privs(name, {priv1=true,...}) -> bool, missing_privs
1244 ^ A quickhand for checking privileges
1245 minetest.get_player_ip(name) -> IP address string
1248 minetest.chat_send_all(text)
1249 minetest.chat_send_player(name, text, prepend)
1250 ^ prepend: optional, if it is set to false "Server -!- " will not be prepended to the message
1254 minetest.set_node(pos, node)
1255 minetest.add_node(pos, node): alias set_node(pos, node)
1256 ^ Set node at position (node = {name="foo", param1=0, param2=0})
1257 minetest.swap_node(pos, node)
1258 ^ Set node at position, but don't remove metadata
1259 minetest.remove_node(pos)
1260 ^ Equivalent to set_node(pos, "air")
1261 minetest.get_node(pos)
1262 ^ Returns {name="ignore", ...} for unloaded area
1263 minetest.get_node_or_nil(pos)
1264 ^ Returns nil for unloaded area
1265 minetest.get_node_light(pos, timeofday) -> 0...15 or nil
1266 ^ timeofday: nil = current time, 0 = night, 0.5 = day
1268 minetest.place_node(pos, node)
1269 ^ Place node with the same effects that a player would cause
1270 minetest.dig_node(pos)
1271 ^ Dig node with the same effects that a player would cause
1272 minetest.punch_node(pos)
1273 ^ Punch node with the same effects that a player would cause
1275 minetest.get_meta(pos) -- Get a NodeMetaRef at that position
1276 minetest.get_node_timer(pos) -- Get NodeTimerRef
1278 minetest.add_entity(pos, name): Spawn Lua-defined entity at position
1279 ^ Returns ObjectRef, or nil if failed
1280 minetest.add_item(pos, item): Spawn item
1281 ^ Returns ObjectRef, or nil if failed
1282 minetest.get_player_by_name(name) -- Get an ObjectRef to a player
1283 minetest.get_objects_inside_radius(pos, radius)
1284 minetest.set_timeofday(val): val: 0...1; 0 = midnight, 0.5 = midday
1285 minetest.get_timeofday()
1286 minetest.get_gametime(): returns the time, in seconds, since the world was created
1287 minetest.find_node_near(pos, radius, nodenames) -> pos or nil
1288 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1289 minetest.find_nodes_in_area(minp, maxp, nodenames) -> list of positions
1290 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1291 minetest.get_perlin(seeddiff, octaves, persistence, scale)
1292 ^ Return world-specific perlin noise (int(worldseed)+seeddiff)
1293 minetest.get_voxel_manip()
1294 ^ Return voxel manipulator object
1295 minetest.get_mapgen_object(objectname)
1296 ^ Return requested mapgen object if available (see Mapgen objects)
1297 minetest.set_mapgen_params(MapgenParams)
1298 ^ Set map generation parameters
1299 ^ Function cannot be called after the registration period; only initialization and on_mapgen_init
1300 ^ Takes a table as an argument with the fields mgname, seed, water_level, flags, and flagmask.
1301 ^ Leave field unset to leave that parameter unchanged
1302 ^ flagmask field must be set to all mapgen flags that are being modified
1303 ^ flags contains only the flags that are being set
1304 ^ flags and flagmask are in the same format and have the same options as 'mgflags' in minetest.conf
1305 minetest.clear_objects()
1306 ^ clear all objects in the environments
1307 minetest.line_of_sight(pos1,pos2,stepsize) ->true/false
1308 ^ checkif there is a direct line of sight between pos1 and pos2
1309 ^ pos1 First position
1310 ^ pos2 Second position
1311 ^ stepsize smaller gives more accurate results but requires more computing
1313 minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)
1314 ^ -> table containing path
1315 ^ returns a table of 3d points representing a path from pos1 to pos2 or nil
1316 ^ pos1: start position
1317 ^ pos2: end position
1318 ^ searchdistance: number of blocks to search in each direction
1319 ^ max_jump: maximum height difference to consider walkable
1320 ^ max_drop: maximum height difference to consider droppable
1321 ^ algorithm: A*_noprefetch(default), A*, Dijkstra
1322 minetest.spawn_tree (pos, {treedef})
1323 ^ spawns L-System tree at given pos with definition in treedef table
1324 minetest.transforming_liquid_add(pos)
1325 ^ add node to liquid update queue
1326 minetest.get_node_max_level(pos)
1327 ^ get max available level for leveled node
1328 minetest.get_node_level(pos)
1329 ^ get level of leveled node (water, snow)
1330 minetest.set_node_level(pos, level)
1331 ^ set level of leveled node, default level = 1, if totallevel > maxlevel returns rest (total-max).
1332 minetest.add_node_level(pos, level)
1333 ^ increase level of leveled node by level, default level = 1, if totallevel > maxlevel returns rest (total-max). can be negative for decreasing
1334 minetest.get_heat(pos)
1336 minetest.get_humidity(pos)
1340 minetest.get_inventory(location) -> InvRef
1341 ^ location = eg. {type="player", name="celeron55"}
1342 {type="node", pos={x=, y=, z=}}
1343 {type="detached", name="creative"}
1344 minetest.create_detached_inventory(name, callbacks) -> InvRef
1345 ^ callbacks: See "Detached inventory callbacks"
1346 ^ Creates a detached inventory. If it already exists, it is cleared.
1347 minetest.show_formspec(playername, formname, formspec)
1348 ^ playername: name of player to show formspec
1349 ^ formname: name passed to on_player_receive_fields callbacks
1350 ^ should follow "modname:<whatever>" naming convention
1351 ^ formspec: formspec to display
1354 minetest.inventorycube(img1, img2, img3)
1355 ^ Returns a string for making an image of a cube (useful as an item image)
1356 minetest.get_pointed_thing_position(pointed_thing, above)
1357 ^ Get position of a pointed_thing (that you can get from somewhere)
1358 minetest.dir_to_facedir(dir, is6d)
1359 ^ Convert a vector to a facedir value, used in param2 for paramtype2="facedir"; passing something non-nil/false for the optional second parameter causes it to take the y component into account
1360 minetest.facedir_to_dir(facedir)
1361 ^ Convert a facedir back into a vector aimed directly out the "back" of a node
1362 minetest.dir_to_wallmounted(dir)
1363 ^ Convert a vector to a wallmounted value, used for paramtype2="wallmounted"
1364 minetest.get_node_drops(nodename, toolname)
1365 ^ Returns list of item names.
1366 ^ Note: This will be removed or modified in a future version.
1367 minetest.get_craft_result(input) -> output, decremented_input
1368 ^ input.method = 'normal' or 'cooking' or 'fuel'
1369 ^ input.width = for example 3
1370 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
1371 stack 5, stack 6, stack 7, stack 8, stack 9 }
1372 ^ output.item = ItemStack, if unsuccessful: empty ItemStack
1373 ^ output.time = number, if unsuccessful: 0
1374 ^ decremented_input = like input
1375 minetest.get_craft_recipe(output) -> input
1376 ^ returns last registered recipe for output item (node)
1377 ^ output is a node or item type such as 'default:torch'
1378 ^ input.method = 'normal' or 'cooking' or 'fuel'
1379 ^ input.width = for example 3
1380 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
1381 stack 5, stack 6, stack 7, stack 8, stack 9 }
1382 ^ input.items = nil if no recipe found
1383 minetest.get_all_craft_recipes(query item) -> table or nil
1384 ^ returns indexed table with all registered recipes for query item (node)
1385 or nil if no recipe was found
1388 method = 'normal' or 'cooking' or 'fuel'
1389 width = 0-3, 0 means shapeless recipe
1390 items = indexed [1-9] table with recipe items
1391 output = string with item name and quantity
1393 Example query for default:gold_ingot will return table:
1395 1={type = "cooking", width = 3, output = "default:gold_ingot",
1396 items = {1 = "default:gold_lump"}},
1397 2={type = "normal", width = 1, output = "default:gold_ingot 9",
1398 items = {1 = "default:goldblock"}}
1400 minetest.handle_node_drops(pos, drops, digger)
1401 ^ drops: list of itemstrings
1402 ^ Handles drops from nodes after digging: Default action is to put them into
1404 ^ Can be overridden to get different functionality (eg. dropping items on
1408 minetest.rollback_get_node_actions(pos, range, seconds, limit) -> {{actor, pos, time, oldnode, newnode}, ...}
1409 ^ Find who has done something to a node, or near a node
1410 ^ actor: "player:<name>", also "liquid".
1411 minetest.rollback_revert_actions_by(actor, seconds) -> bool, log messages
1412 ^ Revert latest actions of someone
1413 ^ actor: "player:<name>", also "liquid".
1415 Defaults for the on_* item definition functions:
1416 (These return the leftover itemstack)
1417 minetest.item_place_node(itemstack, placer, pointed_thing, param2)
1418 ^ Place item as a node
1419 ^ param2 overrides facedir and wallmounted param2
1420 ^ returns itemstack, success
1421 minetest.item_place_object(itemstack, placer, pointed_thing)
1423 minetest.item_place(itemstack, placer, pointed_thing, param2)
1424 ^ Use one of the above based on what the item is.
1425 ^ Calls on_rightclick of pointed_thing.under if defined instead
1426 ^ Note: is not called when wielded item overrides on_place
1427 ^ param2 overrides facedir and wallmounted param2
1428 ^ returns itemstack, success
1429 minetest.item_drop(itemstack, dropper, pos)
1431 minetest.item_eat(hp_change, replace_with_item)
1432 ^ Eat the item. replace_with_item can be nil.
1434 Defaults for the on_punch and on_dig node definition callbacks:
1435 minetest.node_punch(pos, node, puncher)
1436 ^ Calls functions registered by minetest.register_on_punchnode()
1437 minetest.node_dig(pos, node, digger)
1438 ^ Checks if node can be dug, puts item into inventory, removes node
1439 ^ Calls functions registered by minetest.registered_on_dignodes()
1442 minetest.sound_play(spec, parameters) -> handle
1443 ^ spec = SimpleSoundSpec
1444 ^ parameters = sound parameter table
1445 minetest.sound_stop(handle)
1448 minetest.after(time, func, ...)
1449 ^ Call function after time seconds
1450 ^ Optional: Variable number of arguments that are passed to func
1453 minetest.request_shutdown() -> request for server shutdown
1454 minetest.get_server_status() -> server status string
1457 minetest.get_ban_list() -> ban list (same as minetest.get_ban_description(""))
1458 minetest.get_ban_description(ip_or_name) -> ban description (string)
1459 minetest.ban_player(name) -> ban a player
1460 minetest.unban_player_or_ip(name) -> unban player or IP address
1463 minetest.add_particle(pos, velocity, acceleration, expirationtime,
1464 size, collisiondetection, texture, playername)
1465 ^ Spawn particle at pos with velocity and acceleration
1466 ^ Disappears after expirationtime seconds
1467 ^ collisiondetection: if true collides with physical objects
1468 ^ Uses texture (string)
1469 ^ Playername is optional, if specified spawns particle only on the player's client
1471 minetest.add_particlespawner(amount, time,
1475 minexptime, maxexptime,
1477 collisiondetection, texture, playername)
1478 ^ Add a particlespawner, an object that spawns an amount of particles over time seconds
1479 ^ The particle's properties are random values in between the boundings:
1480 ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
1481 ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
1482 ^ collisiondetection: if true uses collisiondetection
1483 ^ Uses texture (string)
1484 ^ Playername is optional, if specified spawns particle only on the player's client
1485 ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
1488 minetest.delete_particlespawner(id, player)
1489 ^ Delete ParticleSpawner with id (return value from add_particlespawner)
1490 ^ If playername is specified, only deletes on the player's client,
1491 ^ otherwise on all clients
1494 minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)
1495 ^ Create a schematic from the volume of map specified by the box formed by p1 and p2.
1496 ^ Apply the specified probability values to the specified nodes in probability_list.
1497 ^ probability_list is an array of tables containing two fields, pos and prob.
1498 ^ pos is the 3d vector specifying the absolute coordinates of the node being modified,
1499 ^ and prob is the integer value from 0 to 255 of the probability (see: Schematic specifier).
1500 ^ If there are two or more entries with the same pos value, the last occuring in the array is used.
1501 ^ If pos is not inside the box formed by p1 and p2, it is ignored.
1502 ^ If probability_list is nil, no probabilities are applied.
1503 ^ Slice probability works in the same manner, except takes a field called ypos instead which indicates
1504 ^ the y position of the slice with a probability applied.
1505 ^ If slice probability list is nil, no slice probabilities are applied.
1506 ^ Saves schematic in the Minetest Schematic format to filename.
1508 minetest.place_schematic(pos, schematic, rotation, replacements)
1509 ^ Place the schematic specified by schematic (see: Schematic specifier) at pos.
1510 ^ Rotation can be "0", "90", "180", "270", or "random".
1511 ^ If the rotation parameter is omitted, the schematic is not rotated.
1512 ^ replacements = {{"oldname", "convert_to"}, ...}
1515 minetest.get_connected_players() -> list of ObjectRefs
1516 minetest.hash_node_position({x=,y=,z=}) -> 48-bit integer
1517 ^ Gives a unique hash number for a node position (16+16+16=48bit)
1518 minetest.get_item_group(name, group) -> rating
1519 ^ Get rating of a group of an item. (0 = not in group)
1520 minetest.get_node_group(name, group) -> rating
1521 ^ Deprecated: An alias for the former.
1522 minetest.get_content_id(name) -> integer
1523 ^ Gets the internal content ID of name
1524 minetest.get_name_from_content_id(content_id) -> string
1525 ^ Gets the name of the content with that content ID
1526 minetest.parse_json(string[, nullvalue]) -> something
1527 ^ Convert a string containing JSON data into the Lua equivalent
1528 ^ nullvalue: returned in place of the JSON null; defaults to nil
1529 ^ On success returns a table, a string, a number, a boolean or nullvalue
1530 ^ On failure outputs an error message and returns nil
1531 ^ Example: parse_json("[10, {\"a\":false}]") -> {[1] = 10, [2] = {a = false}}
1532 minetest.serialize(table) -> string
1533 ^ Convert a table containing tables, strings, numbers, booleans and nils
1534 into string form readable by minetest.deserialize
1535 ^ Example: serialize({foo='bar'}) -> 'return { ["foo"] = "bar" }'
1536 minetest.deserialize(string) -> table
1537 ^ Convert a string returned by minetest.deserialize into a table
1538 ^ String is loaded in an empty sandbox environment.
1539 ^ Will load functions, but they cannot access the global environment.
1540 ^ Example: deserialize('return { ["foo"] = "bar" }') -> {foo='bar'}
1541 ^ Example: deserialize('print("foo")') -> nil (function call fails)
1542 ^ error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)
1543 minetest.is_protected(pos, name) -> bool
1544 ^ This function should be overriden by protection mods and should be used to
1545 check if a player can interact at a position.
1546 ^ This function should call the old version of itself if the position is not
1547 protected by the mod.
1549 local old_is_protected = minetest.is_protected
1550 function minetest.is_protected(pos, name)
1551 if mymod:position_protected_from(pos, name) then
1554 return old_is_protected(pos, name)
1556 minetest.record_protection_violation(pos, name)
1557 ^ This function calls functions registered with
1558 minetest.register_on_protection_violation.
1559 minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)
1560 ^ Attempt to predict the desired orientation of the facedir-capable node
1561 defined by itemstack, and place it accordingly (on-wall, on the floor, or
1562 hanging from the ceiling). Stacks are handled normally if the infinitestacks
1563 field is false or omitted (else, the itemstack is not changed). orient_flags
1564 is an optional table containing extra tweaks to the placement code:
1565 invert_wall: if true, place wall-orientation on the ground and ground-
1566 orientation on the wall.
1567 force_wall: if true, always place the node in wall orientation.
1568 force_ceiling: if true, always place on the ceiling.
1569 force_floor: if true, always place the node on the floor.
1571 The above four options are mutually-exclusive; the last in the list takes
1572 precedence over the first.
1574 force_facedir: if true, forcably reset the facedir to north when placing on
1575 the floor or ceiling
1577 minetest.rotate_node(itemstack, placer, pointed_thing)
1578 ^ calls rotate_and_place() with infinitestacks set according to the state of
1579 the creative mode setting, and checks for "sneak" to set the invert_wall
1583 minetest.env - EnvRef of the server environment and world.
1584 ^ Any function in the minetest namespace can be called using the syntax
1585 minetest.env:somefunction(somearguments)
1587 minetest.somefunction(somearguments)
1588 ^ Deprecated, but support is not to be dropped soon
1591 minetest.registered_items
1592 ^ List of registered items, indexed by name
1593 minetest.registered_nodes
1594 ^ List of registered node definitions, indexed by name
1595 minetest.registered_craftitems
1596 ^ List of registered craft item definitions, indexed by name
1597 minetest.registered_tools
1598 ^ List of registered tool definitions, indexed by name
1599 minetest.registered_entities
1600 ^ List of registered entity prototypes, indexed by name
1601 minetest.object_refs
1602 ^ List of object references, indexed by active object id
1603 minetest.luaentities
1604 ^ List of lua entities, indexed by active object id
1608 NodeMetaRef: Node metadata - reference extra data and functionality stored
1610 - Can be gotten via minetest.get_nodemeta(pos)
1612 - set_string(name, value)
1614 - set_int(name, value)
1616 - set_float(name, value)
1618 - get_inventory() -> InvRef
1619 - to_table() -> nil or {fields = {...}, inventory = {list1 = {}, ...}}
1620 - from_table(nil or {})
1621 ^ See "Node Metadata"
1623 NodeTimerRef: Node Timers - a high resolution persistent per-node timer
1624 - Can be gotten via minetest.get_node_timer(pos)
1626 - set(timeout,elapsed)
1627 ^ set a timer's state
1628 ^ timeout is in seconds, and supports fractional values (0.1 etc)
1629 ^ elapsed is in seconds, and supports fractional values (0.1 etc)
1630 ^ will trigger the node's on_timer function after timeout-elapsed seconds
1633 ^ equivelent to set(timeout,0)
1636 - get_timeout() -> current timeout in seconds
1637 ^ if timeout is 0, timer is inactive
1638 - get_elapsed() -> current elapsed time in seconds
1639 ^ the node's on_timer function will be called after timeout-elapsed seconds
1640 - is_started() -> boolean state of timer
1641 ^ returns true if timer is started, otherwise false
1643 ObjectRef: Moving things in the game are generally these
1644 (basically reference to a C++ ServerActiveObject)
1646 - remove(): remove object (after returning from Lua)
1647 - getpos() -> {x=num, y=num, z=num}
1648 - setpos(pos); pos={x=num, y=num, z=num}
1649 - moveto(pos, continuous=false): interpolated move
1650 - punch(puncher, time_from_last_punch, tool_capabilities, direction)
1651 ^ puncher = an another ObjectRef,
1652 ^ time_from_last_punch = time since last punch action of the puncher
1653 ^ direction: can be nil
1654 - right_click(clicker); clicker = an another ObjectRef
1655 - get_hp(): returns number of hitpoints (2 * number of hearts)
1656 - set_hp(hp): set number of hitpoints (2 * number of hearts)
1657 - get_inventory() -> InvRef
1658 - get_wield_list(): returns the name of the inventory list the wielded item is in
1659 - get_wield_index(): returns the index of the wielded item
1660 - get_wielded_item() -> ItemStack
1661 - set_wielded_item(item): replaces the wielded item, returns true if successful
1662 - set_armor_groups({group1=rating, group2=rating, ...})
1663 - set_animation({x=1,y=1}, frame_speed=15, frame_blend=0)
1664 - set_attach(parent, bone, position, rotation)
1666 ^ position = {x=num, y=num, z=num} (relative)
1667 ^ rotation = {x=num, y=num, z=num}
1669 - set_bone_position(bone, position, rotation)
1671 ^ position = {x=num, y=num, z=num} (relative)
1672 ^ rotation = {x=num, y=num, z=num}
1673 - set_properties(object property table)
1674 LuaEntitySAO-only: (no-op for other objects)
1675 - setvelocity({x=num, y=num, z=num})
1676 - getvelocity() -> {x=num, y=num, z=num}
1677 - setacceleration({x=num, y=num, z=num})
1678 - getacceleration() -> {x=num, y=num, z=num}
1680 - getyaw() -> radians
1681 - settexturemod(mod)
1682 - setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
1683 - select_horiz_by_yawpitch=false)
1684 ^ Select sprite from spritesheet with optional animation and DM-style
1685 texture selection based on yaw relative to camera
1686 - get_entity_name() (DEPRECATED: Will be removed in a future version)
1688 Player-only: (no-op for other objects)
1689 - is_player(): true for players, false for others
1690 - get_player_name(): returns "" if is not a player
1691 - get_look_dir(): get camera direction as a unit vector
1692 - get_look_pitch(): pitch in radians
1693 - get_look_yaw(): yaw in radians (wraps around pretty randomly as of now)
1694 - set_look_pitch(radians): sets look pitch
1695 - set_look_yaw(radians): sets look yaw
1696 - get_breath() : returns players breath
1697 - set_breath(value) : sets players breath
1698 values: 0 player is drowning,
1699 1-10 number of bubbles remain,
1700 11 bubbles bar is not shown
1701 - set_inventory_formspec(formspec)
1702 ^ Redefine player's inventory form
1703 ^ Should usually be called in on_joinplayer
1704 - get_inventory_formspec() -> formspec string
1705 - get_player_control(): returns table with player pressed keys
1706 {jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}
1707 - get_player_control_bits(): returns integer with bit packed player pressed keys
1708 bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
1709 - set_physics_override({
1710 speed = 1.0, -- multiplier to default value
1711 jump = 1.0, -- multiplier to default value
1712 gravity = 1.0, -- multiplier to default value
1713 sneak = true, -- whether player can sneak
1714 sneak_glitch = true, -- whether player can use the sneak glitch
1716 - hud_add(hud definition): add a HUD element described by HUD def, returns ID number on success
1717 - hud_remove(id): remove the HUD element of the specified id
1718 - hud_change(id, stat, value): change a value of a previously added HUD element
1719 ^ element stat values: position, name, scale, text, number, item, dir
1720 - hud_get(id): gets the HUD element definition structure of the specified ID
1721 - hud_set_flags(flags): sets specified HUD flags to true/false
1722 ^ flags: (is visible) hotbar, healthbar, crosshair, wielditem
1723 ^ pass a table containing a true/false value of each flag to be set or unset
1724 ^ if a flag is nil, the flag is not modified
1725 - hud_set_hotbar_itemcount(count): sets number of items in builtin hotbar
1726 ^ count: number of items, must be between 1 and 23
1727 - hud_set_hotbar_image(texturename)
1728 ^ sets background image for hotbar
1729 - hud_set_hotbar_selected_image(texturename)
1730 ^ sets image for selected item of hotbar
1732 InvRef: Reference to an inventory
1734 - is_empty(listname): return true if list is empty
1735 - get_size(listname): get size of a list
1736 - set_size(listname, size): set size of a list
1737 ^ returns false on error (e.g. invalid listname or listsize)
1738 - get_width(listname): get width of a list
1739 - set_width(listname, width): set width of list; currently used for crafting
1740 - get_stack(listname, i): get a copy of stack index i in list
1741 - set_stack(listname, i, stack): copy stack to index i in list
1742 - get_list(listname): return full list
1743 - set_list(listname, list): set full list (size will not change)
1744 - add_item(listname, stack): add item somewhere in list, returns leftover ItemStack
1745 - room_for_item(listname, stack): returns true if the stack of items
1746 can be fully added to the list
1747 - contains_item(listname, stack): returns true if the stack of items
1748 can be fully taken from the list
1749 remove_item(listname, stack): take as many items as specified from the list,
1750 returns the items that were actually removed (as an ItemStack)
1751 - get_location() -> location compatible to minetest.get_inventory(location)
1752 -> {type="undefined"} in case location is not known
1754 ItemStack: A stack of items.
1755 - Can be created via ItemStack(itemstack or itemstring or table or nil)
1757 - is_empty(): return true if stack is empty
1758 - get_name(): returns item name (e.g. "default:stone")
1759 - set_name(itemname)
1760 - get_count(): returns number of items on the stack
1762 - get_wear(): returns tool wear (0-65535), 0 for non-tools
1764 - get_metadata(): returns metadata (a string attached to an item stack)
1765 - set_metadata(metadata)
1766 - clear(): removes all items from the stack, making it empty
1767 - replace(item): replace the contents of this stack (item can also
1768 be an itemstring or table)
1769 - to_string(): returns the stack in itemstring form
1770 - to_table(): returns the stack in Lua table form
1771 - get_stack_max(): returns the maximum size of the stack (depends on the item)
1772 - get_free_space(): returns get_stack_max() - get_count()
1773 - is_known(): returns true if the item name refers to a defined item type
1774 - get_definition(): returns the item definition table
1775 - get_tool_capabilities(): returns the digging properties of the item,
1776 ^ or those of the hand if none are defined for this item type
1777 - add_wear(amount): increases wear by amount if the item is a tool
1778 - add_item(item): put some item or stack onto this stack,
1779 ^ returns leftover ItemStack
1780 - item_fits(item): returns true if item or stack can be fully added to this one
1781 - take_item(n): take (and remove) up to n items from this stack
1782 ^ returns taken ItemStack
1783 ^ if n is omitted, n=1 is used
1784 - peek_item(n): copy (don't remove) up to n items from this stack
1785 ^ returns copied ItemStack
1786 ^ if n is omitted, n=1 is used
1788 PseudoRandom: A pseudorandom number generator
1789 - Can be created via PseudoRandom(seed)
1791 - next(): return next integer random number [0...32767]
1792 - next(min, max): return next integer random number [min...max]
1793 (max - min) must be 32767 or <= 6553 due to the simple
1794 implementation making bad distribution otherwise.
1796 PerlinNoise: A perlin noise generator
1797 - Can be created via PerlinNoise(seed, octaves, persistence, scale)
1798 - Also minetest.get_perlin(seeddiff, octaves, persistence, scale)
1800 - get2d(pos) -> 2d noise value at pos={x=,y=}
1801 - get3d(pos) -> 3d noise value at pos={x=,y=,z=}
1803 PerlinNoiseMap: A fast, bulk perlin noise generator
1804 - Can be created via PerlinNoiseMap(noiseparams, size)
1805 - Also minetest.get_perlin_map(noiseparams, size)
1807 - get2dMap(pos) -> <size.x>X<size.y> 2d array of 2d noise values starting at pos={x=,y=}
1808 - get3dMap(pos) -> <size.x>X<size.y>X<size.z> 3d array of 3d noise values starting at pos={x=,y=,z=}
1809 - get2dMap_flat(pos) -> Flat <size.x * size.y> element array of 2d noise values starting at pos={x=,y=}
1810 - get3dMap_flat(pos) -> Same as get2dMap_flat, but 3d noise
1812 VoxelManip: An interface to the MapVoxelManipulator for Lua
1813 - Can be created via VoxelManip()
1814 - Also minetest.get_voxel_manip()
1816 - read_from_map(p1, p2): Reads a chunk of map from the map containing the region formed by p1 and p2.
1817 ^ returns actual emerged pmin, actual emerged pmax
1818 - write_to_map(): Writes the data loaded from the VoxelManip back to the map.
1819 ^ important: data must be set using VoxelManip:set_data before calling this
1820 - get_data(): Gets the data read into the VoxelManip object
1821 ^ returns raw node data is in the form of an array of node content ids
1822 - set_data(data): Sets the data contents of the VoxelManip object
1823 - update_map(): Update map after writing chunk back to map.
1824 ^ To be used only by VoxelManip objects created by the mod itself; not a VoxelManip that was
1825 ^ retrieved from minetest.get_mapgen_object
1826 - set_lighting(light, p1, p2): Set the lighting within the VoxelManip to a uniform value
1827 ^ light is a table, {day=<0...15>, night=<0...15>}
1828 ^ To be used only by a VoxelManip object from minetest.get_mapgen_object
1829 ^ (p1, p2) is the area in which lighting is set; defaults to the whole area if left out
1830 - get_light_data(): Gets the light data read into the VoxelManip object
1831 ^ Returns an array (indicies 1 to volume) of integers ranging from 0 to 255
1832 ^ Each value is the bitwise combination of day and night light values (0..15 each)
1833 ^ light = day + (night * 16)
1834 - set_light_data(light_data): Sets the param1 (light) contents of each node in the VoxelManip
1835 ^ expects lighting data in the same format that get_light_data() returns
1836 - calc_lighting(p1, p2): Calculate lighting within the VoxelManip
1837 ^ To be used only by a VoxelManip object from minetest.get_mapgen_object
1838 ^ (p1, p2) is the area in which lighting is set; defaults to the whole area if left out
1839 - update_liquids(): Update liquid flow
1841 VoxelArea: A helper class for voxel areas
1842 - Can be created via VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}
1843 - Coordinates are *inclusive*, like most other things in Minetest
1845 - getExtent(): returns a 3d vector containing the size of the area formed by MinEdge and MaxEdge
1846 - getVolume(): returns the volume of the area formed by MinEdge and MaxEdge
1847 - index(x, y, z): returns the index of an absolute position in a flat array starting at 1
1848 ^ useful for things like VoxelManip, raw Schematic specifiers, PerlinNoiseMap:get2d/3dMap, and so on
1849 - indexp(p): same as above, except takes a vector
1850 - position(i): returns the absolute position vector corresponding to index i
1851 - contains(x, y, z): check if (x,y,z) is inside area formed by MinEdge and MaxEdge
1852 - containsp(p): same as above, except takes a vector
1853 - containsi(i): same as above, except takes an index
1854 - iter(minx, miny, minz, maxx, maxy, maxz): returns an iterator that returns indices
1855 ^ from (minx,miny,minz) to (maxx,maxy,maxz) in the order of [z [y [x]]]
1856 - iterp(minp, maxp): same as above, except takes a vector
1858 Settings: An interface to read config files in the format of minetest.conf
1859 - Can be created via Settings(filename)
1862 - get_bool(key) -> boolean
1864 - remove(key) -> success
1865 - get_names() -> {key1,...}
1866 - write() -> success
1867 ^ write changes to file
1868 - to_table() -> {[key1]=value1,...}
1872 A mapgen object is a construct used in map generation. Mapgen objects can be used by an on_generate
1873 callback to speed up operations by avoiding unnecessary recalculations; these can be retrieved using the
1874 minetest.get_mapgen_object() function. If the requested Mapgen object is unavailable, or
1875 get_mapgen_object() was called outside of an on_generate() callback, nil is returned.
1877 The following Mapgen objects are currently available:
1880 This returns three values; the VoxelManip object to be used, minimum and maximum emerged position, in that
1881 order. All mapgens support this object.
1884 Returns an array containing the y coordinates of the ground levels of nodes in the most recently
1885 generated chunk by the current mapgen.
1888 Returns an array containing the biome IDs of nodes in the most recently generated chunk by the
1892 Returns an array containing the temperature values of nodes in the most recently generated chunk by
1896 Returns an array containing the humidity values of nodes in the most recently generated chunk by the
1900 --------------------
1901 - Functions receive a "luaentity" as self:
1902 - It has the member .name, which is the registered name ("mod:thing")
1903 - It has the member .object, which is an ObjectRef pointing to the object
1904 - The original prototype stuff is visible directly via a metatable
1906 - on_activate(self, staticdata)
1907 ^ Called when the object is instantiated.
1908 - on_step(self, dtime)
1909 ^ Called on every server tick (dtime is usually 0.1 seconds)
1910 - on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
1911 ^ Called when somebody punches the object.
1912 ^ Note that you probably want to handle most punches using the
1913 automatic armor group system.
1914 ^ puncher: ObjectRef (can be nil)
1915 ^ time_from_last_punch: Meant for disallowing spamming of clicks (can be nil)
1916 ^ tool_capabilities: capability table of used tool (can be nil)
1917 ^ dir: unit vector of direction of punch. Always defined. Points from
1918 the puncher to the punched.
1919 - on_rightclick(self, clicker)
1920 - get_staticdata(self)
1921 ^ Should return a string that will be passed to on_activate when
1922 the object is instantiated the next time.
1927 axiom, - string initial tree axiom
1928 rules_a, - string rules set A
1929 rules_b, - string rules set B
1930 rules_c, - string rules set C
1931 rules_d, - string rules set D
1932 trunk, - string trunk node name
1933 leaves, - string leaves node name
1934 leaves2, - string secondary leaves node name
1935 leaves2_chance,- num chance (0-100) to replace leaves with leaves2
1936 angle, - num angle in deg
1937 iterations, - num max # of iterations, usually 2 -5
1938 random_level, - num factor to lower nr of iterations, usually 0 - 3
1939 trunk_type, - string single/double/crossed) type of trunk: 1 node, 2x2 nodes or 3x3 in cross shape
1940 thin_branches, - boolean true -> use thin (1 node) branches
1941 fruit, - string fruit node name
1942 fruit_chance, - num chance (0-100) to replace leaves with fruit node
1943 seed, - num random seed
1946 Key for Special L-System Symbols used in Axioms
1947 G - move forward one unit with the pen up
1948 F - move forward one unit with the pen down drawing trunks and branches
1949 f - move forward one unit with the pen down drawing leaves (100% chance)
1950 T - move forward one unit with the pen down drawing trunks only
1951 R - move forward one unit with the pen down placing fruit
1952 A - replace with rules set A
1953 B - replace with rules set B
1954 C - replace with rules set C
1955 D - replace with rules set D
1956 a - replace with rules set A, chance 90%
1957 b - replace with rules set B, chance 80%
1958 c - replace with rules set C, chance 70%
1959 d - replace with rules set D, chance 60%
1960 + - yaw the turtle right by angle parameter
1961 - - yaw the turtle left by angle parameter
1962 & - pitch the turtle down by angle parameter
1963 ^ - pitch the turtle up by angle parameter
1964 / - roll the turtle to the right by angle parameter
1965 * - roll the turtle to the left by angle parameter
1966 [ - save in stack current state info
1967 ] - recover from stack state info
1969 Example usage: spawn small apple tree
1972 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
1973 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
1974 trunk="default:tree",
1975 leaves="default:leaves",
1979 trunk_type="single",
1982 fruit="default:apple"
1984 minetest.spawn_tree(pos,apple_tree)
1993 collide_with_objects = true, -- collide with other objects if physical=true
1995 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
1996 visual = "cube"/"sprite"/"upright_sprite"/"mesh",
1997 visual_size = {x=1, y=1},
1999 textures = {}, -- number of required textures depends on visual
2000 colors = {}, -- number of required colors depends on visual
2001 spritediv = {x=1, y=1},
2002 initial_sprite_basepos = {x=0, y=0},
2004 makes_footstep_sound = false,
2005 automatic_rotate = false,
2007 automatic_face_movement_dir = 0.0,
2008 ^ automatically set yaw to movement direction; offset in degrees; false to disable
2011 Entity definition (register_entity)
2013 (Deprecated: Everything in object properties is read directly from here)
2015 initial_properties = <initial object properties>,
2017 on_activate = function(self, staticdata, dtime_s),
2018 on_step = function(self, dtime),
2019 on_punch = function(self, hitter),
2020 on_rightclick = function(self, clicker),
2021 get_staticdata = function(self),
2022 ^ Called sometimes; the string returned is passed to on_activate when
2023 the entity is re-activated from static state
2025 # Also you can define arbitrary member variables here
2026 myvariable = whatever,
2029 ABM (ActiveBlockModifier) definition (register_abm)
2031 -- In the following two fields, also group:groupname will work.
2032 nodenames = {"default:lava_source"},
2033 neighbors = {"default:water_source", "default:water_flowing"}, -- (any of these)
2034 ^ If left out or empty, any neighbor will do
2035 interval = 1.0, -- (operation interval)
2036 chance = 1, -- (chance of trigger is 1.0/this)
2037 action = func(pos, node, active_object_count, active_object_count_wider),
2040 Item definition (register_node, register_craftitem, register_tool)
2042 description = "Steel Axe",
2043 groups = {}, -- key=name, value=rating; rating=1..3.
2044 if rating not applicable, use 1.
2045 eg. {wool=1, fluffy=3}
2046 {soil=2, outerspace=1, crumbly=1}
2047 {bendy=2, snappy=1},
2048 {hard=1, metal=1, spikes=1}
2049 inventory_image = "default_tool_steelaxe.png",
2051 wield_scale = {x=1,y=1,z=1},
2054 liquids_pointable = false,
2055 tool_capabilities = {
2056 full_punch_interval = 1.0,
2060 snappy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
2061 choppy={times={[3]=0.90}, maxwear=0.05, maxlevel=0}
2063 damage_groups = {groupname=damage},
2065 node_placement_prediction = nil,
2066 ^ If nil and item is node, prediction is made automatically
2067 ^ If nil and item is not a node, no prediction is made
2068 ^ If "" and item is anything, no prediction is made
2069 ^ Otherwise should be name of node which the client immediately places
2070 on ground when the player places the item. Server will always update
2071 actual result to client in a short moment.
2073 place = <SimpleSoundSpec>,
2076 on_place = func(itemstack, placer, pointed_thing),
2077 ^ Shall place item and return the leftover itemstack
2078 ^ default: minetest.item_place
2079 on_drop = func(itemstack, dropper, pos),
2080 ^ Shall drop item and return the leftover itemstack
2081 ^ default: minetest.item_drop
2082 on_use = func(itemstack, user, pointed_thing),
2084 ^ Function must return either nil if no item shall be removed from
2085 inventory, or an itemstack to replace the original itemstack.
2086 eg. itemstack:take_item(); return itemstack
2087 ^ Otherwise, the function is free to do what it wants.
2088 ^ The default functions handle regular use cases.
2089 after_use = func(itemstack, user, node, digparams),
2091 ^ If defined, should return an itemstack and will be called instead of
2092 wearing out the tool. If returns nil, does nothing.
2093 If after_use doesn't exist, it is the same as:
2094 function(itemstack, user, node, digparams)
2095 itemstack:add_wear(digparams.wear)
2102 - {name="image.png", animation={Tile Animation definition}}
2103 - {name="image.png", backface_culling=bool}
2104 ^ backface culling only supported in special tiles
2105 - deprecated still supported field names:
2108 Tile animation definition:
2109 - {type="vertical_frames", aspect_w=16, aspect_h=16, length=3.0}
2111 Node definition (register_node)
2113 <all fields allowed in item definitions>,
2115 drawtype = "normal", -- See "Node drawtypes"
2117 ^ Supported for drawtypes "plantlike", "signlike", "torchlike".
2118 ^ For plantlike, the image will start at the bottom of the node; for the
2119 ^ other drawtypes, the image will be centered on the node.
2120 ^ Note that positioning for "torchlike" may still change.
2121 tiles = {tile definition 1, def2, def3, def4, def5, def6},
2122 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
2123 ^ List can be shortened to needed length
2124 special_tiles = {tile definition 1, Tile definition 2},
2125 ^ Special textures of node; used rarely (old field name: special_materials)
2126 ^ List can be shortened to needed length
2128 use_texture_alpha = false, -- Use texture's alpha channel
2129 post_effect_color = {a=0, r=0, g=0, b=0}, -- If player is inside node
2130 paramtype = "none", -- See "Nodes"
2131 paramtype2 = "none", -- See "Nodes"
2132 is_ground_content = false, -- Currently not used for anything
2133 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
2134 walkable = true, -- If true, objects collide with node
2135 pointable = true, -- If true, can be pointed at
2136 diggable = true, -- If false, can never be dug
2137 climbable = false, -- If true, can be climbed on (ladder)
2138 buildable_to = false, -- If true, placed nodes can replace this node
2139 drop = "", -- alternatively drop = { max_items = ..., items = { ... } }
2140 liquidtype = "none", -- "none"/"source"/"flowing"
2141 liquid_alternative_flowing = "", -- Flowing version of source liquid
2142 liquid_alternative_source = "", -- Source version of flowing liquid
2143 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
2144 liquid_renewable = true, -- Can new liquid source be created by placing two or more sources nearby?
2145 freezemelt = "", -- water for snow/ice, ice/snow for water
2146 leveled = 0, -- Block contain level in param2. value - default level, used for snow. Dont forget use "leveled" type nodebox
2147 liquid_range = 8, -- number of flowing nodes arround source (max. 8)
2148 drowning = 0, -- Player will take this amount of damage if no bubbles are left
2149 light_source = 0, -- Amount of light emitted by node
2150 damage_per_second = 0, -- If player is inside node, this damage is caused
2151 node_box = {type="regular"}, -- See "Node boxes"
2152 selection_box = {type="regular"}, -- See "Node boxes"
2153 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used
2154 legacy_facedir_simple = false, -- Support maps made in and before January 2012
2155 legacy_wallmounted = false, -- Support maps made in and before January 2012
2157 footstep = <SimpleSoundSpec>,
2158 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
2159 dug = <SimpleSoundSpec>,
2160 place = <SimpleSoundSpec>,
2163 on_construct = func(pos),
2164 ^ Node constructor; always called after adding node
2165 ^ Can set up metadata and stuff like that
2167 on_destruct = func(pos),
2168 ^ Node destructor; always called before removing node
2170 after_destruct = func(pos, oldnode),
2171 ^ Node destructor; always called after removing node
2174 after_place_node = func(pos, placer, itemstack),
2175 ^ Called after constructing node when node was placed using
2176 minetest.item_place_node / minetest.place_node
2177 ^ If return true no item is taken from itemstack
2179 after_dig_node = func(pos, oldnode, oldmetadata, digger),
2180 ^ oldmetadata is in table format
2181 ^ Called after destructing node when node was dug using
2182 minetest.node_dig / minetest.dig_node
2184 can_dig = function(pos,player)
2185 ^ returns true if node can be dug, or false if not
2188 on_punch = func(pos, node, puncher),
2189 ^ default: minetest.node_punch
2190 ^ By default: does nothing
2191 on_rightclick = func(pos, node, clicker, itemstack),
2193 ^ if defined, itemstack will hold clicker's wielded item
2194 Shall return the leftover itemstack
2195 on_dig = func(pos, node, digger),
2196 ^ default: minetest.node_dig
2197 ^ By default: checks privileges, wears out tool and removes node
2199 on_timer = function(pos,elapsed),
2201 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
2202 ^ elapsed is the total time passed since the timer was started
2203 ^ return true to run the timer for another cycle with the same timeout value
2205 on_receive_fields = func(pos, formname, fields, sender),
2206 ^ fields = {name1 = value1, name2 = value2, ...}
2207 ^ Called when an UI form (eg. sign text input) returns data
2210 allow_metadata_inventory_move = func(pos, from_list, from_index,
2211 to_list, to_index, count, player),
2212 ^ Called when a player wants to move items inside the inventory
2213 ^ Return value: number of items allowed to move
2215 allow_metadata_inventory_put = func(pos, listname, index, stack, player),
2216 ^ Called when a player wants to put something into the inventory
2217 ^ Return value: number of items allowed to put
2218 ^ Return value: -1: Allow and don't modify item count in inventory
2220 allow_metadata_inventory_take = func(pos, listname, index, stack, player),
2221 ^ Called when a player wants to take something out of the inventory
2222 ^ Return value: number of items allowed to take
2223 ^ Return value: -1: Allow and don't modify item count in inventory
2225 on_metadata_inventory_move = func(pos, from_list, from_index,
2226 to_list, to_index, count, player),
2227 on_metadata_inventory_put = func(pos, listname, index, stack, player),
2228 on_metadata_inventory_take = func(pos, listname, index, stack, player),
2229 ^ Called after the actual action has happened, according to what was allowed.
2232 on_blast = func(pos, intensity),
2233 ^ intensity: 1.0 = mid range of regular TNT
2234 ^ If defined, called when an explosion touches the node, instead of
2238 Recipe for register_craft: (shaped)
2240 output = 'default:pick_stone',
2242 {'default:cobble', 'default:cobble', 'default:cobble'},
2243 {'', 'default:stick', ''},
2244 {'', 'default:stick', ''}, -- Also groups; eg. 'group:crumbly'
2246 replacements = <optional list of item pairs,
2247 replace one input item with another item on crafting>
2250 Recipe for register_craft (shapeless)
2253 output = 'mushrooms:mushroom_stew',
2256 "mushrooms:mushroom_brown",
2257 "mushrooms:mushroom_red",
2259 replacements = <optional list of item pairs,
2260 replace one input item with another item on crafting>
2263 Recipe for register_craft (tool repair)
2265 type = "toolrepair",
2266 additional_wear = -0.02,
2269 Recipe for register_craft (cooking)
2272 output = "default:glass",
2273 recipe = "default:sand",
2277 Recipe for register_craft (furnace fuel)
2280 recipe = "default:leaves",
2284 Ore definition (register_ore)
2286 ore_type = "scatter", -- See "Ore types"
2287 ore = "default:stone_with_coal",
2288 wherein = "default:stone",
2289 ^ a list of nodenames is supported too
2290 clust_scarcity = 8*8*8,
2291 ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
2292 ^ This value should be *MUCH* higher than your intuition might tell you!
2294 ^ Number of ores in a cluster
2296 ^ Size of the bounding box of the cluster
2297 ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
2298 height_min = -31000,
2301 ^ Attributes for this ore generation
2302 noise_threshhold = 0.5,
2303 ^ If noise is above this threshhold, ore is placed. Not needed for a uniform distribution
2304 noise_params = {offset=0, scale=1, spread={x=100, y=100, z=100}, seed=23, octaves=3, persist=0.70}
2305 ^ NoiseParams structure describing the perlin noise used for ore distribution.
2306 ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
2309 Decoration definition (register_decoration)
2311 deco_type = "simple", -- See "Decoration types"
2312 place_on = "default:dirt_with_grass",
2313 ^ Node that decoration can be placed on
2315 ^ Size of divisions made in the chunk being generated.
2316 ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
2318 ^ Ratio of the area to be uniformly filled by the decoration.
2319 ^ Used only if noise_params is not specified.
2320 noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
2321 ^ NoiseParams structure describing the perlin noise used for decoration distribution.
2322 ^ The result of this is multiplied by the 2d area of the division being decorated.
2323 biomes = {"Oceanside", "Hills", "Plains"},
2324 ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
2325 ^ and ignored if the Mapgen being used does not support biomes.
2327 ----- Simple-type parameters
2328 decoration = "default:grass",
2329 ^ The node name used as the decoration.
2330 ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
2332 ^ Number of nodes high the decoration is made.
2333 ^ If height_max is not 0, this is the lower bound of the randomly selected height.
2335 ^ Number of nodes the decoration can be at maximum.
2336 ^ If absent, the parameter 'height' is used as a constant.
2337 spawn_by = "default:water",
2338 ^ Node that the decoration only spawns next to, in a 1-node square radius.
2340 ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
2341 ^ If absent or -1, decorations occur next to any nodes.
2343 ----- Schematic-type parameters
2344 schematic = "foobar.mts",
2345 ^ If schematic is a string, it is the filepath relative to the current working directory of the
2346 ^ specified Minetest schematic file.
2347 ^ - OR -, could instead be a table containing two fields, size and data:
2349 size = {x=4, y=6, z=4},
2351 {name="cobble", param1=255, param2=0},
2352 {name="dirt_with_grass", param1=255, param2=0},
2356 ^ See 'Schematic specifier' for details.
2357 replacements = {{"oldname", "convert_to"}, ...},
2358 flags = "place_center_x, place_center_z",
2359 ^ Flags for schematic decorations. See 'Schematic attributes'.
2360 rotation = "90" --rotate schematic 90 degrees on placement
2361 ^ Rotation can be "0", "90", "180", "270", or "random".
2364 Chatcommand definition (register_chatcommand)
2366 params = "<name> <privilege>", -- short parameter description
2367 description = "Remove privilege from player", -- full description
2368 privs = {privs=true}, -- require the "privs" privilege to run
2369 func = function(name, param), -- called when command is run
2372 Detached inventory callbacks
2374 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
2375 ^ Called when a player wants to move items inside the inventory
2376 ^ Return value: number of items allowed to move
2378 allow_put = func(inv, listname, index, stack, player),
2379 ^ Called when a player wants to put something into the inventory
2380 ^ Return value: number of items allowed to put
2381 ^ Return value: -1: Allow and don't modify item count in inventory
2383 allow_take = func(inv, listname, index, stack, player),
2384 ^ Called when a player wants to take something out of the inventory
2385 ^ Return value: number of items allowed to take
2386 ^ Return value: -1: Allow and don't modify item count in inventory
2388 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
2389 on_put = func(inv, listname, index, stack, player),
2390 on_take = func(inv, listname, index, stack, player),
2391 ^ Called after the actual action has happened, according to what was allowed.
2395 HUD Definition (hud_add, hud_get)
2397 hud_elem_type = "image", -- see HUD element types
2398 ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
2399 position = {x=0.5, y=0.5},
2400 ^ Left corner position of element
2406 ^ Selected item in inventory. 0 for no item selected.
2408 ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
2409 alignment = {x=0, y=0},
2410 ^ See "HUD Element Types"
2411 offset = {x=0, y=0},
2412 ^ See "HUD Element Types"