1 Minetest Lua Modding API Reference 0.4.4
2 ==========================================
3 More information at http://c55.me/minetest/
7 Content and functionality can be added to Minetest 0.4 by using Lua
8 scripting in run-time loaded mods.
10 A mod is a self-contained bunch of scripts, textures and other related
11 things that is loaded by and interfaces with Minetest.
13 Mods are contained and ran solely on the server side. Definitions and media
14 files are automatically transferred to the client.
16 If you see a deficiency in the API, feel free to attempt to add the
17 functionality in the engine and API. You can send such improvements as
18 source code patches to <celeron55@gmail.com>.
22 If you have any difficulty in understanding this, please read:
23 http://www.lua.org/pil/
27 Mods are loaded during server startup from the mod load paths by running
28 the init.lua scripts in a shared environment.
33 $path_share/games/gameid/mods/
34 $path_share/mods/gameid/
35 $path_user/games/gameid/mods/
36 $path_user/mods/gameid/ <-- User-installed mods
39 In a run-in-place version (eg. the distributed windows version):
40 minetest-0.4.x/games/gameid/mods/
41 minetest-0.4.x/mods/gameid/ <-- User-installed mods
42 minetest-0.4.x/worlds/worldname/worldmods/
44 On an installed version on linux:
45 /usr/share/minetest/games/gameid/mods/
46 ~/.minetest/mods/gameid/ <-- User-installed mods
47 ~/.minetest/worlds/worldname/worldmods
49 Mod load path for world-specific games
50 --------------------------------------
51 It is possible to include a game in a world; in this case, no mods or
52 games are loaded or checked from anywhere else.
54 This is useful for eg. adventure worlds.
56 This happens if the following directory exists:
59 Mods should be then be placed in:
64 Mods can be put in a subdirectory, if the parent directory, which otherwise
65 should be a mod, contains a file named modpack.txt. This file shall be
66 empty, except for lines starting with #, which are comments.
68 Mod directory structure
69 ------------------------
75 | | |-- modname_stuff.png
76 | | `-- modname_something_else.png
83 The location of this directory can be fetched by using
84 minetest.get_modpath(modname)
87 List of mods that have to be loaded before loading this mod.
88 A single line contains a single modname.
91 The main Lua script. Running this script should register everything it
92 wants to register. Subsequent execution depends on minetest calling the
95 minetest.setting_get(name) and minetest.setting_getbool(name) can be used
96 to read custom or existing settings at load time, if necessary.
98 textures, sounds, media:
99 Media files (textures, sounds, whatever) that will be transferred to the
100 client and will be available for use by the mod.
102 Naming convention for registered textual names
103 ----------------------------------------------
104 Registered names should generally be in this format:
105 "modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
107 This is to prevent conflicting names from corrupting maps and is
108 enforced by the mod loader.
110 Example: mod "experimental", ideal item/node/entity name "tnt":
111 -> the name should be "experimental:tnt".
113 Enforcement can be overridden by prefixing the name with ":". This can
114 be used for overriding the registrations of some other mod.
116 Example: Any mod can redefine experimental:tnt by using the name
117 ":experimental:tnt" when registering it.
118 (also that mod is required to have "experimental" as a dependency)
120 The ":" prefix can also be used for maintaining backwards compatibility.
124 Aliases can be added by using minetest.register_alias(name, convert_to)
126 This will make Minetest to convert things called name to things called
129 This can be used for maintaining backwards compatibility.
131 This can be also used for setting quick access names for things, eg. if
132 you have an item called epiclylongmodname:stuff, you could do
133 minetest.register_alias("stuff", "epiclylongmodname:stuff")
134 and be able to use "/giveme stuff".
138 Mods should generally prefix their textures with modname_, eg. given
139 the mod name "foomod", a texture could be called
140 "foomod_foothing.png"
142 Textures are referred to by their complete name, or alternatively by
143 stripping out the file extension:
144 eg. foomod_foothing.png
149 Only OGG files are supported.
151 For positional playing of sounds, only single-channel (mono) files are
152 supported. Otherwise OpenAL will play them non-positionally.
154 Mods should generally prefix their sounds with modname_, eg. given
155 the mod name "foomod", a sound could be called
156 "foomod_foosound.ogg"
158 Sounds are referred to by their name with a dot, a single digit and the
159 file extension stripped out. When a sound is played, the actual sound file
160 is chosen randomly from the matching sounds.
162 When playing the sound "foomod_foosound", the sound is chosen randomly
163 from the available ones of the following files:
165 foomod_foosound.0.ogg
166 foomod_foosound.1.ogg
168 foomod_foosound.9.ogg
170 Examples of sound parameter tables:
171 -- Play locationless on all clients
173 gain = 1.0, -- default
175 -- Play locationless to a player
178 gain = 1.0, -- default
180 -- Play in a location
183 gain = 1.0, -- default
184 max_hear_distance = 32, -- default
186 -- Play connected to an object, looped
188 object = <an ObjectRef>,
189 gain = 1.0, -- default
190 max_hear_distance = 32, -- default
191 loop = true, -- only sounds connected to objects can be looped
196 eg. "default_place_node"
198 eg. {name="default_place_node"}
199 eg. {name="default_place_node", gain=1.0}
201 Registered definitions of stuff
202 --------------------------------
203 Anything added using certain minetest.register_* functions get added to
204 the global minetest.registered_* tables.
206 minetest.register_entity(name, prototype table)
207 -> minetest.registered_entities[name]
209 minetest.register_node(name, node definition)
210 -> minetest.registered_items[name]
211 -> minetest.registered_nodes[name]
213 minetest.register_tool(name, item definition)
214 -> minetest.registered_items[name]
216 minetest.register_craftitem(name, item definition)
217 -> minetest.registered_items[name]
219 Note that in some cases you will stumble upon things that are not contained
220 in these tables (eg. when a mod has been removed). Always check for
221 existence before trying to access the fields.
223 Example: If you want to check the drawtype of a node, you could do:
225 local function get_nodedef_field(nodename, fieldname)
226 if not minetest.registered_nodes[nodename] then
229 return minetest.registered_nodes[nodename][fieldname]
231 local drawtype = get_nodedef_field(nodename, "drawtype")
233 Example: minetest.get_item_group(name, group) has been implemented as:
235 function minetest.get_item_group(name, group)
236 if not minetest.registered_items[name] or not
237 minetest.registered_items[name].groups[group] then
240 return minetest.registered_items[name].groups[group]
245 Nodes are the bulk data of the world: cubes and other things that take the
246 space of a cube. Huge amounts of them are handled efficiently, but they
249 The definition of a node is stored and can be accessed by name in
250 minetest.registered_nodes[node.name]
251 See "Registered definitions of stuff".
253 Nodes are passed by value between Lua and the engine.
254 They are represented by a table:
255 {name="name", param1=num, param2=num}
257 param1 and param2 are 8 bit integers. The engine uses them for certain
258 automated functions. If you don't use these functions, you can use them to
259 store arbitrary values.
261 The functions of param1 and param2 are determined by certain fields in the
263 param1 is reserved for the engine when paramtype != "none":
265 ^ The value stores light with and without sun in it's
266 upper and lower 4 bits.
267 param2 is reserved for the engine when any of these are used:
268 liquidtype == "flowing"
269 ^ The level and some flags of the liquid is stored in param2
270 drawtype == "flowingliquid"
271 ^ The drawn liquid level is read from param2
272 drawtype == "torchlike"
273 drawtype == "signlike"
274 paramtype2 == "wallmounted"
275 ^ The rotation of the node is stored in param2. You can make this value
276 by using minetest.dir_to_wallmounted().
277 paramtype2 == "facedir"
278 ^ The rotation of the node is stored in param2. Furnaces and chests are
279 rotated this way. Can be made by using minetest.dir_to_facedir().
281 Nodes can also contain extra data. See "Node Metadata".
285 There are a bunch of different looking node types. These are mostly just
286 copied from Minetest 0.3; more may be made in the future.
288 Look for examples in games/minimal or games/minetest_game.
302 - nodebox -- See below. EXPERIMENTAL
306 Node selection boxes are defined using "node boxes"
308 The "nodebox" node drawtype allows defining visual of nodes consisting of
309 arbitrary number of boxes. It allows defining stuff like stairs. Only the
310 "fixed" box type is supported for these.
311 ^ Please note that this is still experimental, and may be incompatibly
312 changed in the future.
314 A nodebox is defined as any of:
316 -- A normal cube; the default in most things
320 -- A fixed box (facedir param2 is used, if applicable)
322 fixed = box OR {box1, box2, ...}
325 -- A box like the selection box for torches
326 -- (wallmounted param2 is used, if applicable)
327 type = "wallmounted",
334 {x1, y1, z1, x2, y2, z2}
335 A box of a regular node would look like:
336 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
338 Representations of simple things
339 --------------------------------
341 {x=num, y=num, z=num}
342 Currently the API does not provide any helper functions for addition,
343 subtraction and whatever; you can define those that you need yourself.
347 {type="node", under=pos, above=pos}
348 {type="object", ref=ObjectRef}
352 Node (register_node):
353 A node from the world
354 Tool (register_tool):
355 A tool/weapon that can dig and damage things according to tool_capabilities
356 Craftitem (register_craftitem):
359 Items and item stacks can exist in three formats:
361 Serialized; This is called stackstring or itemstring:
363 eg. 'default:pick_wood 21323'
367 eg. {name="default:dirt", count=5, wear=0, metadata=""}
369 eg. {name="default:pick_wood", count=1, wear=21323, metadata=""}
370 ^ a wooden pick about 1/3 weared out
371 eg. {name="default:apple", count=1, wear=0, metadata=""}
375 C++ native format with many helper methods. Useful for converting between
376 formats. See the Class reference section for details.
378 When an item must be passed to a function, it can usually be in any of
383 In a number of places, there is a group table. Groups define the
384 properties of a thing (item, node, armor of entity, capabilities of
385 tool) in such a way that the engine and other mods can can interact with
386 the thing without actually knowing what the thing is.
389 - Groups are stored in a table, having the group names with keys and the
390 group ratings as values. For example:
391 groups = {crumbly=3, soil=1}
392 ^ Default dirt (soil group actually currently not defined; TODO)
393 groups = {crumbly=2, soil=1, level=2, outerspace=1}
394 ^ A more special dirt-kind of thing
395 - Groups always have a rating associated with them. If there is no
396 useful meaning for a rating for an enabled group, it shall be 1.
397 - When not defined, the rating of a group defaults to 0. Thus when you
398 read groups, you must interpret nil and 0 as the same value, 0.
400 You can read the rating of a group for an item or a node by using
401 minetest.get_item_group(itemname, groupname)
405 Groups of items can define what kind of an item it is (eg. wool).
409 In addition to the general item things, groups are used to define whether
410 a node is destroyable and how long it takes to destroy by a tool.
414 For entities, groups are, as of now, used only for calculating damage.
416 object.get_armor_groups() -> a group-rating table (eg. {fleshy=3})
417 object.set_armor_groups({level=2, fleshy=2, cracky=2})
421 Groups in tools define which groups of nodes and entities they are
424 Groups in crafting recipes
425 ---------------------------
426 An example: Make meat soup from any meat, any water and any bowl
428 output = 'food:meat_soup_raw',
434 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
436 An another example: Make red wool from white wool and red dye
440 recipe = {'wool:white', 'group:dye,basecolor_red'},
445 - immortal: Disables the group damage system for an entity
446 - level: Can be used to give an additional sense of progression in the game.
447 - A larger level will cause eg. a weapon of a lower level make much less
448 damage, and get weared out much faster, or not be able to get drops
449 from destroyed nodes.
450 - 0 is something that is directly accessible at the start of gameplay
451 - There is no upper limit
452 - dig_immediate: (player can always pick up node without tool wear)
453 - 2: node is removed without tool wear after 0.5 seconds or so
455 - 3: node is removed without tool wear immediately (torch)
456 - disable_jump: Player (and possibly other things) cannot jump from node
457 - fall_damage_add_percent: damage speed = speed * (1 + value/100)
458 - bouncy: value is bounce speed in percent
459 - falling_node: if there is no walkable block under the node it will fall
460 - attached_node: if the node under it is not a walkable block the node will be
461 dropped as an item. If the node is wallmounted the
462 wallmounted direction is checked.
464 Known damage and digging time defining groups
465 ----------------------------------------------
466 Valid ratings for these are 0, 1, 2 and 3, unless otherwise stated.
467 - crumbly: dirt, sand
468 - cracky: tough but crackable stuff like stone.
469 - snappy: something that can be cut using fine tools; eg. leaves, small
470 plants, wire, sheets of metal
471 - choppy: something that can be cut using force; eg. trees, wooden planks
472 - fleshy: Living things like animals and the player. This could imply
473 some blood effects when hitting.
474 - explody: Especially prone to explosions
475 - oddly_breakable_by_hand:
476 Can be added to nodes that shouldn't logically be breakable by the
477 hand but are. Somewhat similar to dig_immediate, but times are more
478 like {[1]=3.50,[2]=2.00,[3]=0.70} and this does not override the
479 speed of a tool if the tool can dig at a faster speed than this
480 suggests for the hand.
482 Examples of custom groups
483 --------------------------
484 Item groups are often used for defining, well, //groups of items//.
485 - meat: any meat-kind of a thing (rating might define the size or healing
486 ability or be irrelevant - it is not defined as of yet)
487 - eatable: anything that can be eaten. Rating might define HP gain in half
489 - flammable: can be set on fire. Rating might define the intensity of the
490 fire, affecting eg. the speed of the spreading of an open fire.
491 - wool: any wool (any origin, any color)
494 - heavy: anything considerably heavy
496 Digging time calculation specifics
497 -----------------------------------
498 Groups such as **crumbly**, **cracky** and **snappy** are used for this
499 purpose. Rating is 1, 2 or 3. A higher rating for such a group implies
502 The **level** group is used to limit the toughness of nodes a tool can dig
503 and to scale the digging times / damage to a greater extent.
505 ^ PLEASE DO UNDERSTAND THIS, otherwise you cannot use the system to it's
508 Tools define their properties by a list of parameters for groups. They
509 cannot dig other groups; thus it is important to use a standard bunch of
510 groups to enable interaction with tools.
513 * Full punch interval
515 * For an arbitrary list of groups:
516 * Uses (until the tool breaks)
517 * Maximum level (usually 0, 1, 2 or 3)
520 **Full punch interval**:
521 When used as a weapon, the tool will do full damage if this time is spent
522 between punches. If eg. half the time is spent, the tool will do half
525 **Maximum drop level**
526 Suggests the maximum level of node, when dug with the tool, that will drop
527 it's useful item. (eg. iron ore to drop a lump of iron).
528 - This is not automated; it is the responsibility of the node definition
532 Determines how many uses the tool has when it is used for digging a node,
533 of this group, of the maximum level. For lower leveled nodes, the use count
534 is multiplied by 3^leveldiff.
535 - uses=10, leveldiff=0 -> actual uses: 10
536 - uses=10, leveldiff=1 -> actual uses: 30
537 - uses=10, leveldiff=2 -> actual uses: 90
540 Tells what is the maximum level of a node of this group that the tool will
544 List of digging times for different ratings of the group, for nodes of the
546 * For example, as a lua table, ''times={2=2.00, 3=0.70}''. This would
547 result in the tool to be able to dig nodes that have a rating of 2 or 3
548 for this group, and unable to dig the rating 1, which is the toughest.
549 Unless there is a matching group that enables digging otherwise.
550 * For entities, damage equals the amount of nodes dug in the time spent
551 between hits, with a maximum time of ''full_punch_interval''.
553 Example definition of the capabilities of a tool
554 -------------------------------------------------
555 tool_capabilities = {
556 full_punch_interval=1.5,
559 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
563 This makes the tool be able to dig nodes that fullfill both of these:
564 - Have the **crumbly** group
565 - Have a **level** group less or equal to 2
567 Table of resulting digging times:
568 crumbly 0 1 2 3 4 <- level
574 level diff: 2 1 0 -1 -2
576 Table of resulting tool uses:
583 - At crumbly=0, the node is not diggable.
584 - At crumbly=3, the level difference digging time divider kicks in and makes
585 easy nodes to be quickly breakable.
586 - At level > 2, the node is not diggable, because it's level > maxlevel
588 Entity damage mechanism
589 ------------------------
591 - Take the time spent after the last hit
592 - Limit time to full_punch_interval
593 - Take the damage groups and imagine a bunch of nodes that have them
594 - Damage in HP is the amount of nodes destroyed in this time.
596 Client predicts damage based on damage groups. Because of this, it is able to
597 give an immediate response when an entity is damaged or dies; the response is
598 pre-defined somehow (eg. by defining a sprite animation) (not implemented;
600 - Currently a smoke puff will appear when an entity dies.
602 The group **immortal** completely disables normal damage.
604 Entities can define a special armor group, which is **punch_operable**. This
605 group disables the regular damage mechanism for players punching it by hand or
606 a non-tool item, so that it can do something else than take damage.
608 On the Lua side, every punch calls ''entity:on_punch(puncher,
609 time_from_last_punch, tool_capabilities, direction)''. This should never be
610 called directly, because damage is usually not handled by the entity itself.
611 * ''puncher'' is the object performing the punch. Can be nil. Should never be
612 accessed unless absolutely required, to encourage interoperability.
613 * ''time_from_last_punch'' is time from last punch (by puncher) or nil.
614 * ''tool_capabilities'' can be nil.
615 * ''direction'' is a unit vector, pointing from the source of the punch to
618 To punch an entity/object in Lua, call ''object:punch(puncher,
619 time_from_last_punch, tool_capabilities, direction)''.
620 * Return value is tool wear.
621 * Parameters are equal to the above callback.
622 * If ''direction'' is nil and ''puncher'' is not nil, ''direction'' will be
623 automatically filled in based on the location of ''puncher''.
627 The instance of a node in the world normally only contains the three values
628 mentioned in "Nodes". However, it is possible to insert extra data into a
629 node. It is called "node metadata"; See "NodeMetaRef".
631 Metadata contains two things:
635 Some of the values in the key-value store are handled specially:
636 - formspec: Defines a right-click inventory menu. See "Formspec".
637 - infotext: Text shown on the screen when the node is pointed at
641 local meta = minetest.env:get_meta(pos)
642 meta:set_string("formspec",
644 "list[context;main;0,0;8,4;]"..
645 "list[current_player;main;0,5;8,4;]")
646 meta:set_string("infotext", "Chest");
647 local inv = meta:get_inventory()
648 inv:set_size("main", 8*4)
649 print(dump(meta:to_table()))
652 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] = ""}
655 formspec = "invsize[8,9;]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
662 Formspec defines a menu. Currently not much else than inventories are
663 supported. It is a string, with a somewhat strange format.
665 Spaces and newlines can be inserted between the blocks, as is used in the
671 list[context;main;0,0;8,4;]
672 list[current_player;main;0,5;8,4;]
675 list[context;fuel;2,3;1,1;]
676 list[context;src;2,1;1,1;]
677 list[context;dst;5,1;2,2;]
678 list[current_player;main;0,5;8,4;]
679 - Minecraft-like player inventory
681 image[1,0.6;1,2;player.png]
682 list[current_player;main;0,3.5;8,4;]
683 list[current_player;craft;3,0;3,3;]
684 list[current_player;craftpreview;7,1;1,1;]
689 ^ Define the size of the menu in inventory slots
690 ^ deprecated: invsize[<W>,<H>;]
692 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]
693 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]
694 ^ Show an inventory list
696 image[<X>,<Y>;<W>,<H>;<texture name>]
698 ^ Position and size units are inventory slots
700 item_image[<X>,<Y>;<W>,<H>;<item name>]
701 ^ Show an inventory image of registered item/node
702 ^ Position and size units are inventory slots
704 background[<X>,<Y>;<W>,<H>;<texture name>]
705 ^ Use a background. Inventory rectangles are not drawn then.
706 ^ Position and size units are inventory slots
707 ^ Example for formspec 8x4 in 16x resolution: image shall be sized 8*16px x 4*16px
709 field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
710 ^ Textual field; will be sent to server when a button is clicked
711 ^ x and y position the field relative to the top left of the menu
712 ^ w and h are the size of the field
713 ^ fields are a set height, but will be vertically centred on h
714 ^ Position and size units are inventory slots
715 ^ name is the name of the field as returned in fields to on_receive_fields
716 ^ label, if not blank, will be text printed on the top left above the field
717 ^ default is the default value of the field
718 ^ default may contain variable references such as '${text}' which
719 will fill the value from the metadata value 'text'
720 ^ Note: no extra text or more than a single variable is supported ATM.
722 field[<name>;<label>;<default>]
723 ^ as above but without position/size units
724 ^ special field for creating simple forms, such as sign text input
725 ^ must be used without a size[] element
726 ^ a 'Proceed' button will be added automatically
728 textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
729 ^ same as fields above, but with multi-line input
731 label[<X>,<Y>;<label>]
732 ^ x and y work as per field
733 ^ label is the text on the label
734 ^ Position and size units are inventory slots
736 button[<X>,<Y>;<W>,<H>;<name>;<label>]
737 ^ Clickable button. When clicked, fields will be sent.
738 ^ x, y and name work as per field
739 ^ w and h are the size of the button
740 ^ label is the text on the button
741 ^ Position and size units are inventory slots
743 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
744 ^ x, y, w, h, and name work as per button
745 ^ image is the filename of an image
746 ^ Position and size units are inventory slots
748 item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]
749 ^ x, y, w, h, name and label work as per button
750 ^ item name is the registered name of an item/node,
751 tooltip will be made out of its descritption
752 ^ Position and size units are inventory slots
754 button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]
755 ^ When clicked, fields will be sent and the form will quit.
757 image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
758 ^ When clicked, fields will be sent and the form will quit.
762 - "context": Selected node metadata (deprecated: "current_name")
763 - "current_player": Player to whom the menu is shown
764 - "player:<name>": Any player
765 - "nodemeta:<X>,<Y>,<Z>": Any node metadata
766 - "detached:<name>": A detached inventory
770 dump2(obj, name="_", dumped={})
771 ^ Return object serialized as a string, handles reference loops
773 ^ Return object serialized as a string
774 string:split(separator)
775 ^ eg. string:split("a,b", ",") == {"a","b"}
777 ^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
778 minetest.pos_to_string({x=X,y=Y,z=Z}) -> "(X,Y,Z)"
779 ^ Convert position to a printable string
780 minetest.string_to_pos(string) -> position
782 minetest namespace reference
783 -----------------------------
784 minetest.get_current_modname() -> string
785 minetest.get_modpath(modname) -> eg. "/home/user/.minetest/usermods/modname"
786 ^ Useful for loading additional .lua modules or static data from mod
787 minetest.get_modnames() -> list of installed mods
788 ^ Return a list of installed mods, sorted alphabetically
789 minetest.get_worldpath() -> eg. "/home/user/.minetest/world"
790 ^ Useful for storing custom data
791 minetest.is_singleplayer()
794 ^ Always printed to stderr and logfile (print() is redirected here)
796 minetest.log(loglevel, line)
797 ^ loglevel one of "error", "action", "info", "verbose"
799 Registration functions: (Call these only at load time)
800 minetest.register_entity(name, prototype table)
801 minetest.register_abm(abm definition)
802 minetest.register_node(name, node definition)
803 minetest.register_tool(name, item definition)
804 minetest.register_craftitem(name, item definition)
805 minetest.register_alias(name, convert_to)
806 minetest.register_craft(recipe)
808 Global callback registration functions: (Call these only at load time)
809 minetest.register_globalstep(func(dtime))
810 ^ Called every server step, usually interval of 0.05s
811 minetest.register_on_shutdown(func())
812 ^ Called before server shutdown
813 ^ WARNING: If the server terminates abnormally (i.e. crashes), the registered
814 callbacks WILL LIKELY NOT BE RUN. Data should be saved at
815 semi-frequent intervals as well as on server shutdown.
816 minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack))
817 ^ Called when a node has been placed
818 ^ If return true no item is taken from itemstack
819 ^ Deprecated: Use on_construct or after_place_node in node definition instead
820 minetest.register_on_dignode(func(pos, oldnode, digger))
821 ^ Called when a node has been dug.
822 ^ Deprecated: Use on_destruct or after_dig_node in node definition instead
823 minetest.register_on_punchnode(func(pos, node, puncher))
824 ^ Called when a node is punched
825 minetest.register_on_generated(func(minp, maxp, blockseed))
826 ^ Called after generating a piece of world. Modifying nodes inside the area
827 is a bit faster than usually.
828 minetest.register_on_newplayer(func(ObjectRef))
829 ^ Called after a new player has been created
830 minetest.register_on_dieplayer(func(ObjectRef))
831 ^ Called when a player dies
832 minetest.register_on_respawnplayer(func(ObjectRef))
833 ^ Called when player is to be respawned
834 ^ Called _before_ repositioning of player occurs
835 ^ return true in func to disable regular player placement
836 minetest.register_on_joinplayer(func(ObjectRef))
837 ^ Called when a player joins the game
838 minetest.register_on_leaveplayer(func(ObjectRef))
839 ^ Called when a player leaves the game
840 minetest.register_on_chat_message(func(name, message))
841 ^ Called always when a player says something
842 minetest.register_on_player_receive_fields(func(player, formname, fields))
843 ^ Called when a button is pressed in player's inventory form
844 ^ Newest functions are called first
845 ^ If function returns true, remaining functions are not called
847 Other registration functions:
848 minetest.register_chatcommand(cmd, chatcommand definition)
849 minetest.register_privilege(name, definition)
850 ^ definition: "description text"
852 description = "description text",
853 give_to_singleplayer = boolean, -- default: true
855 minetest.register_authentication_handler(handler)
856 ^ See minetest.builtin_auth_handler in builtin.lua for reference
859 minetest.setting_set(name, value)
860 minetest.setting_get(name) -> string or nil
861 minetest.setting_getbool(name) -> boolean value or nil
862 minetest.setting_get_pos(name) -> position or nil
863 minetest.setting_save() -> nil, save all settings to config file
864 minetest.add_to_creative_inventory(itemstring)
867 minetest.notify_authentication_modified(name)
868 ^ Should be called by the authentication handler if privileges change.
869 ^ To report everybody, set name=nil.
870 minetest.get_password_hash(name, raw_password)
871 ^ Convert a name-password pair to a password hash that minetest can use
872 minetest.string_to_privs(str) -> {priv1=true,...}
873 minetest.privs_to_string(privs) -> "priv1,priv2,..."
874 ^ Convert between two privilege representations
875 minetest.set_player_password(name, password_hash)
876 minetest.set_player_privs(name, {priv1=true,...})
877 minetest.get_player_privs(name) -> {priv1=true,...}
878 minetest.auth_reload()
879 ^ These call the authentication handler
880 minetest.check_player_privs(name, {priv1=true,...}) -> bool, missing_privs
881 ^ A quickhand for checking privileges
884 minetest.chat_send_all(text)
885 minetest.chat_send_player(name, text)
888 minetest.get_inventory(location) -> InvRef
889 ^ location = eg. {type="player", name="celeron55"}
890 {type="node", pos={x=, y=, z=}}
891 {type="detached", name="creative"}
892 minetest.create_detached_inventory(name, callbacks) -> InvRef
893 ^ callbacks: See "Detached inventory callbacks"
894 ^ Creates a detached inventory. If it already exists, it is cleared.
895 minetest.show_formspec(playername, formname, formspec)
896 ^ playername: name of player to show formspec
897 ^ formname: name passed to on_player_receive_fields callbacks
898 ^ should follow "modname:<whatever>" naming convention
899 ^ formspec: formspec to display
902 minetest.inventorycube(img1, img2, img3)
903 ^ Returns a string for making an image of a cube (useful as an item image)
904 minetest.get_pointed_thing_position(pointed_thing, above)
905 ^ Get position of a pointed_thing (that you can get from somewhere)
906 minetest.dir_to_facedir(dir)
907 ^ Convert a vector to a facedir value, used in param2 for paramtype2="facedir"
908 minetest.dir_to_wallmounted(dir)
909 ^ Convert a vector to a wallmounted value, used for paramtype2="wallmounted"
910 minetest.get_node_drops(nodename, toolname)
911 ^ Returns list of item names.
912 ^ Note: This will be removed or modified in a future version.
913 minetest.get_craft_result(input) -> output, decremented_input
914 ^ input.method = 'normal' or 'cooking' or 'fuel'
915 ^ input.width = for example 3
916 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
917 stack 5, stack 6, stack 7, stack 8, stack 9 }
918 ^ output.item = ItemStack, if unsuccessful: empty ItemStack
919 ^ output.time = number, if unsuccessful: 0
920 ^ decremented_input = like input
921 minetest.get_craft_recipe(output) -> input
922 ^ output is a node or item type such as 'default:torch'
923 ^ input.method = 'normal' or 'cooking' or 'fuel'
924 ^ input.width = for example 3
925 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
926 stack 5, stack 6, stack 7, stack 8, stack 9 }
927 ^ input.items = nil if no recipe found
928 minetest.handle_node_drops(pos, drops, digger)
929 ^ drops: list of itemstrings
930 ^ Handles drops from nodes after digging: Default action is to put them into
932 ^ Can be overridden to get different functionality (eg. dropping items on
936 minetest.rollback_get_last_node_actor(p, range, seconds) -> actor, p, seconds
937 ^ Find who has done something to a node, or near a node
938 ^ actor: "player:<name>", also "liquid".
939 minetest.rollback_revert_actions_by(actor, seconds) -> bool, log messages
940 ^ Revert latest actions of someone
941 ^ actor: "player:<name>", also "liquid".
943 Defaults for the on_* item definition functions:
944 (These return the leftover itemstack)
945 minetest.item_place_node(itemstack, placer, pointed_thing)
946 ^ Place item as a node
947 minetest.item_place_object(itemstack, placer, pointed_thing)
949 minetest.item_place(itemstack, placer, pointed_thing)
950 ^ Use one of the above based on what the item is.
951 ^ Calls on_rightclick of pointed_thing.under if defined instead
952 ^ Note: is not called when wielded item overrides on_place
953 minetest.item_drop(itemstack, dropper, pos)
955 minetest.item_eat(hp_change, replace_with_item)
956 ^ Eat the item. replace_with_item can be nil.
958 Defaults for the on_punch and on_dig node definition callbacks:
959 minetest.node_punch(pos, node, puncher)
960 ^ Calls functions registered by minetest.register_on_punchnode()
961 minetest.node_dig(pos, node, digger)
962 ^ Checks if node can be dug, puts item into inventory, removes node
963 ^ Calls functions registered by minetest.registered_on_dignodes()
966 minetest.sound_play(spec, parameters) -> handle
967 ^ spec = SimpleSoundSpec
968 ^ parameters = sound parameter table
969 minetest.sound_stop(handle)
972 minetest.after(time, func, param)
973 ^ Call function after time seconds
974 ^ param is optional; to pass multiple parameters, pass a table.
977 minetest.request_shutdown() -> request for server shutdown
978 minetest.get_server_status() -> server status string
981 minetest.get_ban_list() -> ban list (same as minetest.get_ban_description(""))
982 minetest.get_ban_description(ip_or_name) -> ban description (string)
983 minetest.ban_player(name) -> ban a player
984 minetest.unban_player_or_ip(name) -> unban player or IP address
987 minetest.get_connected_players() -> list of ObjectRefs
988 minetest.hash_node_position({x=,y=,z=}) -> 48-bit integer
989 ^ Gives a unique hash number for a node position (16+16+16=48bit)
990 minetest.get_item_group(name, group) -> rating
991 ^ Get rating of a group of an item. (0 = not in group)
992 minetest.get_node_group(name, group) -> rating
993 ^ Deprecated: An alias for the former.
994 minetest.serialize(table) -> string
995 ^ Convert a table containing tables, strings, numbers, booleans and nils
996 into string form readable by minetest.deserialize
997 ^ Example: serialize({foo='bar'}) -> 'return { ["foo"] = "bar" }'
998 minetest.deserialize(string) -> table
999 ^ Convert a string returned by minetest.deserialize into a table
1000 ^ String is loaded in an empty sandbox environment.
1001 ^ Will load functions, but they cannot access the global environment.
1002 ^ Example: deserialize('return { ["foo"] = "bar" }') -> {foo='bar'}
1003 ^ Example: deserialize('print("foo")') -> nil (function call fails)
1004 ^ error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)
1007 minetest.env - EnvRef of the server environment and world.
1008 ^ Using this you can access nodes and entities
1011 minetest.registered_items
1012 ^ List of registered items, indexed by name
1013 minetest.registered_nodes
1014 ^ List of registered node definitions, indexed by name
1015 minetest.registered_craftitems
1016 ^ List of registered craft item definitions, indexed by name
1017 minetest.registered_tools
1018 ^ List of registered tool definitions, indexed by name
1019 minetest.registered_entities
1020 ^ List of registered entity prototypes, indexed by name
1021 minetest.object_refs
1022 ^ List of object references, indexed by active object id
1023 minetest.luaentities
1024 ^ List of lua entities, indexed by active object id
1026 Deprecated but defined for backwards compatibility:
1027 minetest.digprop_constanttime(time)
1028 minetest.digprop_stonelike(toughness)
1029 minetest.digprop_dirtlike(toughness)
1030 minetest.digprop_gravellike(toughness)
1031 minetest.digprop_woodlike(toughness)
1032 minetest.digprop_leaveslike(toughness)
1033 minetest.digprop_glasslike(toughness)
1037 EnvRef: basically ServerEnvironment and ServerMap combined.
1039 - set_node(pos, node)
1040 - add_node(pos, node): alias set_node(pos, node)
1041 ^ Set node at position (node = {name="foo", param1=0, param2=0})
1043 ^ Equivalent to set_node(pos, "air")
1045 ^ Returns {name="ignore", ...} for unloaded area
1046 - get_node_or_nil(pos)
1047 ^ Returns nil for unloaded area
1048 - get_node_light(pos, timeofday) -> 0...15 or nil
1049 ^ timeofday: nil = current time, 0 = night, 0.5 = day
1051 - place_node(pos, node)
1052 ^ Place node with the same effects that a player would cause
1054 ^ Dig node with the same effects that a player would cause
1056 ^ Punch node with the same effects that a player would cause
1058 - get_meta(pos) -- Get a NodeMetaRef at that position
1059 - get_node_timer(pos) -- Get NodeTimerRef
1061 - add_entity(pos, name): Spawn Lua-defined entity at position
1062 ^ Returns ObjectRef, or nil if failed
1063 - add_item(pos, item): Spawn item
1064 ^ Returns ObjectRef, or nil if failed
1065 - get_player_by_name(name) -- Get an ObjectRef to a player
1066 - get_objects_inside_radius(pos, radius)
1067 - set_timeofday(val): val: 0...1; 0 = midnight, 0.5 = midday
1069 - find_node_near(pos, radius, nodenames) -> pos or nil
1070 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1071 - find_nodes_in_area(minp, maxp, nodenames) -> list of positions
1072 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1073 - get_perlin(seeddiff, octaves, persistence, scale)
1074 ^ Return world-specific perlin noise (int(worldseed)+seeddiff)
1076 ^ clear all objects in the environments
1077 - spawn_tree (pos, {treedef})
1078 ^ spawns L-System tree at given pos with definition in treedef table
1080 axiom, - string initial tree axiom
1081 rules_a, - string rules set A
1082 rules_b, - string rules set B
1083 rules_c, - string rules set C
1084 rules_d, - string rules set D
1085 trunk, - string trunk node name
1086 leaves, - string leaves node name
1087 leaves2, - string secondary leaves node name
1088 leaves2_chance,- num chance (0-100) to replace leaves with leaves2
1089 angle, - num angle in deg
1090 iterations, - num max # of iterations, usually 2 -5
1091 random_level, - num factor to lower nr of iterations, usually 0 - 3
1092 trunk_type, - string single/double/crossed) type of trunk: 1 node, 2x2 nodes or 3x3 in cross shape
1093 thin_branches, - boolean true -> use thin (1 node) branches
1094 fruit, - string fruit node name
1095 fruit_chance, - num chance (0-100) to replace leaves with fruit node
1098 Key for Special L-System Symbols used in Axioms
1099 G - move forward one unit with the pen up
1100 F - move forward one unit with the pen down drawing trunks and branches
1101 f - move forward one unit with the pen down drawing leaves (100% chance)
1102 T - move forward one unit with the pen down drawing trunks only
1103 R - move forward one unit with the pen down placing fruit
1104 A - replace with rules set A
1105 B - replace with rules set B
1106 C - replace with rules set C
1107 D - replace with rules set D
1108 a - replace with rules set A, chance 90%
1109 b - replace with rules set B, chance 80%
1110 c - replace with rules set C, chance 70%
1111 d - replace with rules set D, chance 60%
1112 + - yaw the turtle right by angle parameter
1113 - - yaw the turtle left by angle parameter
1114 & - pitch the turtle down by angle parameter
1115 ^ - pitch the turtle up by angle parameter
1116 / - roll the turtle to the right by angle parameter
1117 * - roll the turtle to the left by angle parameter
1118 [ - save in stack current state info
1119 ] - recover from stack state info
1121 Example usage: spawn small apple tree
1124 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
1125 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
1126 trunk="default:tree",
1127 leaves="default:leaves",
1131 trunk_type="single",
1134 fruit="default:apple"
1136 minetest.env:spawn_tree(pos,apple_tree)
1139 - add_rat(pos): Add C++ rat object (no-op)
1140 - add_firefly(pos): Add C++ firefly object (no-op)
1142 NodeMetaRef: Node metadata - reference extra data and functionality stored
1144 - Can be gotten via minetest.env:get_nodemeta(pos)
1146 - set_string(name, value)
1148 - set_int(name, value)
1150 - set_float(name, value)
1152 - get_inventory() -> InvRef
1153 - to_table() -> nil or {fields = {...}, inventory = {list1 = {}, ...}}
1154 - from_table(nil or {})
1155 ^ See "Node Metadata"
1157 NodeTimerRef: Node Timers - a high resolution persistent per-node timer
1158 - Can be gotten via minetest.env:get_node_timer(pos)
1160 - set(timeout,elapsed)
1161 ^ set a timer's state
1162 ^ timeout is in seconds, and supports fractional values (0.1 etc)
1163 ^ elapsed is in seconds, and supports fractional values (0.1 etc)
1164 ^ will trigger the node's on_timer function after timeout-elapsed seconds
1167 ^ equivelent to set(timeout,0)
1170 - get_timeout() -> current timeout in seconds
1171 ^ if timeout is 0, timer is inactive
1172 - get_elapsed() -> current elapsed time in seconds
1173 ^ the node's on_timer function will be called after timeout-elapsed seconds
1174 - is_started() -> boolean state of timer
1175 ^ returns true if timer is started, otherwise false
1177 ObjectRef: Moving things in the game are generally these
1178 (basically reference to a C++ ServerActiveObject)
1180 - remove(): remove object (after returning from Lua)
1181 - getpos() -> {x=num, y=num, z=num}
1182 - setpos(pos); pos={x=num, y=num, z=num}
1183 - moveto(pos, continuous=false): interpolated move
1184 - punch(puncher, time_from_last_punch, tool_capabilities, direction)
1185 ^ puncher = an another ObjectRef,
1186 ^ time_from_last_punch = time since last punch action of the puncher
1187 ^ direction: can be nil
1188 - right_click(clicker); clicker = an another ObjectRef
1189 - get_hp(): returns number of hitpoints (2 * number of hearts)
1190 - set_hp(hp): set number of hitpoints (2 * number of hearts)
1191 - get_inventory() -> InvRef
1192 - get_wield_list(): returns the name of the inventory list the wielded item is in
1193 - get_wield_index(): returns the index of the wielded item
1194 - get_wielded_item() -> ItemStack
1195 - set_wielded_item(item): replaces the wielded item, returns true if successful
1196 - set_armor_groups({group1=rating, group2=rating, ...})
1197 - set_animation({x=1,y=1}, frame_speed=15, frame_blend=0)
1198 - set_attach(parent, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
1200 - set_bone_position("", {x=0,y=0,z=0}, {x=0,y=0,z=0})
1201 - set_properties(object property table)
1202 LuaEntitySAO-only: (no-op for other objects)
1203 - setvelocity({x=num, y=num, z=num})
1204 - getvelocity() -> {x=num, y=num, z=num}
1205 - setacceleration({x=num, y=num, z=num})
1206 - getacceleration() -> {x=num, y=num, z=num}
1208 - getyaw() -> radians
1209 - settexturemod(mod)
1210 - setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
1211 - select_horiz_by_yawpitch=false)
1212 ^ Select sprite from spritesheet with optional animation and DM-style
1213 texture selection based on yaw relative to camera
1214 - get_entity_name() (DEPRECATED: Will be removed in a future version)
1216 Player-only: (no-op for other objects)
1217 - is_player(): true for players, false for others
1218 - get_player_name(): returns "" if is not a player
1219 - get_look_dir(): get camera direction as a unit vector
1220 - get_look_pitch(): pitch in radians
1221 - get_look_yaw(): yaw in radians (wraps around pretty randomly as of now)
1222 - set_inventory_formspec(formspec)
1223 ^ Redefine player's inventory form
1224 ^ Should usually be called in on_joinplayer
1225 - get_inventory_formspec() -> formspec string
1226 - get_player_control(): returns table with player pressed keys
1227 {jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}
1228 - get_player_control_bits(): returns integer with bit packed player pressed keys
1229 bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
1231 InvRef: Reference to an inventory
1233 - is_empty(listname): return true if list is empty
1234 - get_size(listname): get size of a list
1235 - set_size(listname, size): set size of a list
1236 - get_width(listname): get width of a list
1237 - set_width(listname, width): set width of list; currently used for crafting
1238 - get_stack(listname, i): get a copy of stack index i in list
1239 - set_stack(listname, i, stack): copy stack to index i in list
1240 - get_list(listname): return full list
1241 - set_list(listname, list): set full list (size will not change)
1242 - add_item(listname, stack): add item somewhere in list, returns leftover ItemStack
1243 - room_for_item(listname, stack): returns true if the stack of items
1244 can be fully added to the list
1245 - contains_item(listname, stack): returns true if the stack of items
1246 can be fully taken from the list
1247 remove_item(listname, stack): take as many items as specified from the list,
1248 returns the items that were actually removed (as an ItemStack)
1249 - get_location() -> location compatible to minetest.get_inventory(location)
1250 -> {type="undefined"} in case location is not known
1252 ItemStack: A stack of items.
1253 - Can be created via ItemStack(itemstack or itemstring or table or nil)
1255 - is_empty(): return true if stack is empty
1256 - get_name(): returns item name (e.g. "default:stone")
1257 - get_count(): returns number of items on the stack
1258 - get_wear(): returns tool wear (0-65535), 0 for non-tools
1259 - get_metadata(): returns metadata (a string attached to an item stack)
1260 - clear(): removes all items from the stack, making it empty
1261 - replace(item): replace the contents of this stack (item can also
1262 be an itemstring or table)
1263 - to_string(): returns the stack in itemstring form
1264 - to_table(): returns the stack in Lua table form
1265 - get_stack_max(): returns the maximum size of the stack (depends on the item)
1266 - get_free_space(): returns get_stack_max() - get_count()
1267 - is_known(): returns true if the item name refers to a defined item type
1268 - get_definition(): returns the item definition table
1269 - get_tool_capabilities(): returns the digging properties of the item,
1270 ^ or those of the hand if none are defined for this item type
1271 - add_wear(amount): increases wear by amount if the item is a tool
1272 - add_item(item): put some item or stack onto this stack,
1273 ^ returns leftover ItemStack
1274 - item_fits(item): returns true if item or stack can be fully added to this one
1275 - take_item(n): take (and remove) up to n items from this stack
1276 ^ returns taken ItemStack
1277 ^ if n is omitted, n=1 is used
1278 - peek_item(n): copy (don't remove) up to n items from this stack
1279 ^ returns copied ItemStack
1280 ^ if n is omitted, n=1 is used
1282 PseudoRandom: A pseudorandom number generator
1283 - Can be created via PseudoRandom(seed)
1285 - next(): return next integer random number [0...32767]
1286 - next(min, max): return next integer random number [min...max]
1287 (max - min) must be 32767 or <= 6553 due to the simple
1288 implementation making bad distribution otherwise.
1290 PerlinNoise: A perlin noise generator
1291 - Can be created via PerlinNoise(seed, octaves, persistence, scale)
1292 - Also minetest.env:get_perlin(seeddiff, octaves, persistence, scale)
1294 - get2d(pos) -> 2d noise value at pos={x=,y=}
1295 - get3d(pos) -> 3d noise value at pos={x=,y=,z=}
1298 --------------------
1299 - Functions receive a "luaentity" as self:
1300 - It has the member .name, which is the registered name ("mod:thing")
1301 - It has the member .object, which is an ObjectRef pointing to the object
1302 - The original prototype stuff is visible directly via a metatable
1304 - on_activate(self, staticdata)
1305 ^ Called when the object is instantiated.
1306 - on_step(self, dtime)
1307 ^ Called on every server tick (dtime is usually 0.05 seconds)
1308 - on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
1309 ^ Called when somebody punches the object.
1310 ^ Note that you probably want to handle most punches using the
1311 automatic armor group system.
1312 ^ puncher: ObjectRef (can be nil)
1313 ^ time_from_last_punch: Meant for disallowing spamming of clicks (can be nil)
1314 ^ tool_capabilities: capability table of used tool (can be nil)
1315 ^ dir: unit vector of direction of punch. Always defined. Points from
1316 the puncher to the punched.
1317 - on_rightclick(self, clicker)
1318 - get_staticdata(self)
1319 ^ Should return a string that will be passed to on_activate when
1320 the object is instantiated the next time.
1330 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
1331 visual = "cube"/"sprite"/"upright_sprite"/"mesh",
1332 visual_size = {x=1, y=1},
1334 textures = {}, -- number of required textures depends on visual
1335 colors = {}, -- number of required colors depends on visual
1336 spritediv = {x=1, y=1},
1337 initial_sprite_basepos = {x=0, y=0},
1339 makes_footstep_sound = false,
1340 automatic_rotate = false,
1343 Entity definition (register_entity)
1345 (Deprecated: Everything in object properties is read directly from here)
1347 initial_properties = <initial object properties>,
1349 on_activate = function(self, staticdata, dtime_s),
1350 on_step = function(self, dtime),
1351 on_punch = function(self, hitter),
1352 on_rightclick = function(self, clicker),
1353 get_staticdata = function(self),
1354 ^ Called sometimes; the string returned is passed to on_activate when
1355 the entity is re-activated from static state
1357 # Also you can define arbitrary member variables here
1358 myvariable = whatever,
1361 ABM (ActiveBlockModifier) definition (register_abm)
1363 -- In the following two fields, also group:groupname will work.
1364 nodenames = {"default:lava_source"},
1365 neighbors = {"default:water_source", "default:water_flowing"}, -- (any of these)
1366 ^ If left out or empty, any neighbor will do
1367 interval = 1.0, -- (operation interval)
1368 chance = 1, -- (chance of trigger is 1.0/this)
1369 action = func(pos, node, active_object_count, active_object_count_wider),
1372 Item definition (register_node, register_craftitem, register_tool)
1374 description = "Steel Axe",
1375 groups = {}, -- key=name, value=rating; rating=1..3.
1376 if rating not applicable, use 1.
1377 eg. {wool=1, fluffy=3}
1378 {soil=2, outerspace=1, crumbly=1}
1379 {bendy=2, snappy=1},
1380 {hard=1, metal=1, spikes=1}
1381 inventory_image = "default_tool_steelaxe.png",
1383 wield_scale = {x=1,y=1,z=1},
1385 liquids_pointable = false,
1386 tool_capabilities = {
1387 full_punch_interval = 1.0,
1391 fleshy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
1392 snappy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
1393 choppy={times={[3]=0.90}, maxwear=0.05, maxlevel=0}
1396 node_placement_prediction = nil,
1397 ^ If nil and item is node, prediction is made automatically
1398 ^ If nil and item is not a node, no prediction is made
1399 ^ If "" and item is anything, no prediction is made
1400 ^ Otherwise should be name of node which the client immediately places
1401 on ground when the player places the item. Server will always update
1402 actual result to client in a short moment.
1404 on_place = func(itemstack, placer, pointed_thing),
1405 ^ Shall place item and return the leftover itemstack
1406 ^ default: minetest.item_place
1407 on_drop = func(itemstack, dropper, pos),
1408 ^ Shall drop item and return the leftover itemstack
1409 ^ default: minetest.item_drop
1410 on_use = func(itemstack, user, pointed_thing),
1412 ^ Function must return either nil if no item shall be removed from
1413 inventory, or an itemstack to replace the original itemstack.
1414 eg. itemstack:take_item(); return itemstack
1415 ^ Otherwise, the function is free to do what it wants.
1416 ^ The default functions handle regular use cases.
1421 - {name="image.png", animation={Tile Animation definition}}
1422 - {name="image.png", backface_culling=bool}
1423 ^ backface culling only supported in special tiles
1424 - deprecated still supported field names:
1427 Tile animation definition:
1428 - {type="vertical_frames", aspect_w=16, aspect_h=16, length=3.0}
1430 Node definition (register_node)
1432 <all fields allowed in item definitions>,
1434 drawtype = "normal", -- See "Node drawtypes"
1436 tiles = {tile definition 1, def2, def3, def4, def5, def6},
1437 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
1438 ^ List can be shortened to needed length
1439 special_tiles = {tile definition 1, Tile definition 2},
1440 ^ Special textures of node; used rarely (old field name: special_materials)
1441 ^ List can be shortened to needed length
1443 post_effect_color = {a=0, r=0, g=0, b=0}, -- If player is inside node
1444 paramtype = "none", -- See "Nodes"
1445 paramtype2 = "none", -- See "Nodes"
1446 is_ground_content = false, -- Currently not used for anything
1447 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
1448 walkable = true, -- If true, objects collide with node
1449 pointable = true, -- If true, can be pointed at
1450 diggable = true, -- If false, can never be dug
1451 climbable = false, -- If true, can be climbed on (ladder)
1452 buildable_to = false, -- If true, placed nodes can replace this node
1453 drop = "", -- alternatively drop = { max_items = ..., items = { ... } }
1454 liquidtype = "none", -- "none"/"source"/"flowing"
1455 liquid_alternative_flowing = "", -- Flowing version of source liquid
1456 liquid_alternative_source = "", -- Source version of flowing liquid
1457 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
1458 liquid_renewable = true, -- Can new liquid source be created by placing
1459 two or more sources nearly?
1460 light_source = 0, -- Amount of light emitted by node
1461 damage_per_second = 0, -- If player is inside node, this damage is caused
1462 node_box = {type="regular"}, -- See "Node boxes"
1463 selection_box = {type="regular"}, -- See "Node boxes"
1464 legacy_facedir_simple = false, -- Support maps made in and before January 2012
1465 legacy_wallmounted = false, -- Support maps made in and before January 2012
1467 footstep = <SimpleSoundSpec>,
1468 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
1469 dug = <SimpleSoundSpec>,
1472 on_construct = func(pos),
1473 ^ Node constructor; always called after adding node
1474 ^ Can set up metadata and stuff like that
1476 on_destruct = func(pos),
1477 ^ Node destructor; always called before removing node
1479 after_destruct = func(pos, oldnode),
1480 ^ Node destructor; always called after removing node
1483 after_place_node = func(pos, placer, itemstack),
1484 ^ Called after constructing node when node was placed using
1485 minetest.item_place_node / minetest.env:place_node
1486 ^ If return true no item is taken from itemstack
1488 after_dig_node = func(pos, oldnode, oldmetadata, digger),
1489 ^ oldmetadata is in table format
1490 ^ Called after destructing node when node was dug using
1491 minetest.node_dig / minetest.env:dig_node
1493 can_dig = function(pos,player)
1494 ^ returns true if node can be dug, or false if not
1497 on_punch = func(pos, node, puncher),
1498 ^ default: minetest.node_punch
1499 ^ By default: does nothing
1500 on_rightclick = func(pos, node, clicker),
1502 on_dig = func(pos, node, digger),
1503 ^ default: minetest.node_dig
1504 ^ By default: checks privileges, wears out tool and removes node
1506 on_timer = function(pos,elapsed),
1508 ^ called by NodeTimers, see EnvRef and NodeTimerRef
1509 ^ elapsed is the total time passed since the timer was started
1510 ^ return true to run the timer for another cycle with the same timeout value
1512 on_receive_fields = func(pos, formname, fields, sender),
1513 ^ fields = {name1 = value1, name2 = value2, ...}
1514 ^ Called when an UI form (eg. sign text input) returns data
1517 allow_metadata_inventory_move = func(pos, from_list, from_index,
1518 to_list, to_index, count, player),
1519 ^ Called when a player wants to move items inside the inventory
1520 ^ Return value: number of items allowed to move
1522 allow_metadata_inventory_put = func(pos, listname, index, stack, player),
1523 ^ Called when a player wants to put something into the inventory
1524 ^ Return value: number of items allowed to put
1525 ^ Return value: -1: Allow and don't modify item count in inventory
1527 allow_metadata_inventory_take = func(pos, listname, index, stack, player),
1528 ^ Called when a player wants to take something out of the inventory
1529 ^ Return value: number of items allowed to take
1530 ^ Return value: -1: Allow and don't modify item count in inventory
1532 on_metadata_inventory_move = func(pos, from_list, from_index,
1533 to_list, to_index, count, player),
1534 on_metadata_inventory_put = func(pos, listname, index, stack, player),
1535 on_metadata_inventory_take = func(pos, listname, index, stack, player),
1536 ^ Called after the actual action has happened, according to what was allowed.
1539 on_blast = func(pos, intensity),
1540 ^ intensity: 1.0 = mid range of regular TNT
1541 ^ If defined, called when an explosion touches the node, instead of
1545 Recipe for register_craft: (shaped)
1547 output = 'default:pick_stone',
1549 {'default:cobble', 'default:cobble', 'default:cobble'},
1550 {'', 'default:stick', ''},
1551 {'', 'default:stick', ''}, -- Also groups; eg. 'group:crumbly'
1553 replacements = <optional list of item pairs,
1554 replace one input item with another item on crafting>
1557 Recipe for register_craft (shapeless)
1560 output = 'mushrooms:mushroom_stew',
1563 "mushrooms:mushroom_brown",
1564 "mushrooms:mushroom_red",
1566 replacements = <optional list of item pairs,
1567 replace one input item with another item on crafting>
1570 Recipe for register_craft (tool repair)
1572 type = "toolrepair",
1573 additional_wear = -0.02,
1576 Recipe for register_craft (cooking)
1579 output = "default:glass",
1580 recipe = "default:sand",
1584 Recipe for register_craft (furnace fuel)
1587 recipe = "default:leaves",
1591 Chatcommand definition (register_chatcommand)
1593 params = "<name> <privilege>", -- short parameter description
1594 description = "Remove privilege from player", -- full description
1595 privs = {privs=true}, -- require the "privs" privilege to run
1596 func = function(name, param), -- called when command is run
1599 Detached inventory callbacks
1601 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
1602 ^ Called when a player wants to move items inside the inventory
1603 ^ Return value: number of items allowed to move
1605 allow_put = func(inv, listname, index, stack, player),
1606 ^ Called when a player wants to put something into the inventory
1607 ^ Return value: number of items allowed to put
1608 ^ Return value: -1: Allow and don't modify item count in inventory
1610 allow_take = func(inv, listname, index, stack, player),
1611 ^ Called when a player wants to take something out of the inventory
1612 ^ Return value: number of items allowed to take
1613 ^ Return value: -1: Allow and don't modify item count in inventory
1615 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
1616 on_put = func(inv, listname, index, stack, player),
1617 on_take = func(inv, listname, index, stack, player),
1618 ^ Called after the actual action has happened, according to what was allowed.