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 label[<X>,<Y>;<label>]
729 ^ x and y work as per field
730 ^ label is the text on the label
731 ^ Position and size units are inventory slots
733 button[<X>,<Y>;<W>,<H>;<name>;<label>]
734 ^ Clickable button. When clicked, fields will be sent.
735 ^ x, y and name work as per field
736 ^ w and h are the size of the button
737 ^ label is the text on the button
738 ^ Position and size units are inventory slots
740 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
741 ^ x, y, w, h, and name work as per button
742 ^ image is the filename of an image
743 ^ Position and size units are inventory slots
745 item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]
746 ^ x, y, w, h, name and label work as per button
747 ^ item name is the registered name of an item/node,
748 tooltip will be made out of its descritption
749 ^ Position and size units are inventory slots
751 button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]
752 ^ When clicked, fields will be sent and the form will quit.
754 image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
755 ^ When clicked, fields will be sent and the form will quit.
759 - "context": Selected node metadata (deprecated: "current_name")
760 - "current_player": Player to whom the menu is shown
761 - "player:<name>": Any player
762 - "nodemeta:<X>,<Y>,<Z>": Any node metadata
763 - "detached:<name>": A detached inventory
767 dump2(obj, name="_", dumped={})
768 ^ Return object serialized as a string, handles reference loops
770 ^ Return object serialized as a string
771 string:split(separator)
772 ^ eg. string:split("a,b", ",") == {"a","b"}
774 ^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
775 minetest.pos_to_string({x=X,y=Y,z=Z}) -> "(X,Y,Z)"
776 ^ Convert position to a printable string
777 minetest.string_to_pos(string) -> position
779 minetest namespace reference
780 -----------------------------
781 minetest.get_current_modname() -> string
782 minetest.get_modpath(modname) -> eg. "/home/user/.minetest/usermods/modname"
783 ^ Useful for loading additional .lua modules or static data from mod
784 minetest.get_modnames() -> list of installed mods
785 ^ Return a list of installed mods, sorted alphabetically
786 minetest.get_worldpath() -> eg. "/home/user/.minetest/world"
787 ^ Useful for storing custom data
788 minetest.is_singleplayer()
791 ^ Always printed to stderr and logfile (print() is redirected here)
793 minetest.log(loglevel, line)
794 ^ loglevel one of "error", "action", "info", "verbose"
796 Registration functions: (Call these only at load time)
797 minetest.register_entity(name, prototype table)
798 minetest.register_abm(abm definition)
799 minetest.register_node(name, node definition)
800 minetest.register_tool(name, item definition)
801 minetest.register_craftitem(name, item definition)
802 minetest.register_alias(name, convert_to)
803 minetest.register_craft(recipe)
805 Global callback registration functions: (Call these only at load time)
806 minetest.register_globalstep(func(dtime))
807 ^ Called every server step, usually interval of 0.05s
808 minetest.register_on_shutdown(func())
809 ^ Called before server shutdown
810 ^ WARNING: If the server terminates abnormally (i.e. crashes), the registered
811 callbacks WILL LIKELY NOT BE RUN. Data should be saved at
812 semi-frequent intervals as well as on server shutdown.
813 minetest.register_on_placenode(func(pos, newnode, placer, oldnode))
814 ^ Called when a node has been placed
815 ^ Deprecated: Use on_construct or after_place_node in node definition instead
816 minetest.register_on_dignode(func(pos, oldnode, digger))
817 ^ Called when a node has been dug.
818 ^ Deprecated: Use on_destruct or after_dig_node in node definition instead
819 minetest.register_on_punchnode(func(pos, node, puncher))
820 ^ Called when a node is punched
821 minetest.register_on_generated(func(minp, maxp, blockseed))
822 ^ Called after generating a piece of world. Modifying nodes inside the area
823 is a bit faster than usually.
824 minetest.register_on_newplayer(func(ObjectRef))
825 ^ Called after a new player has been created
826 minetest.register_on_dieplayer(func(ObjectRef))
827 ^ Called when a player dies
828 minetest.register_on_respawnplayer(func(ObjectRef))
829 ^ Called when player is to be respawned
830 ^ Called _before_ repositioning of player occurs
831 ^ return true in func to disable regular player placement
832 minetest.register_on_joinplayer(func(ObjectRef))
833 ^ Called when a player joins the game
834 minetest.register_on_leaveplayer(func(ObjectRef))
835 ^ Called when a player leaves the game
836 minetest.register_on_chat_message(func(name, message))
837 ^ Called always when a player says something
838 minetest.register_on_player_receive_fields(func(player, formname, fields))
839 ^ Called when a button is pressed in player's inventory form
840 ^ Newest functions are called first
841 ^ If function returns true, remaining functions are not called
843 Other registration functions:
844 minetest.register_chatcommand(cmd, chatcommand definition)
845 minetest.register_privilege(name, definition)
846 ^ definition: "description text"
848 description = "description text",
849 give_to_singleplayer = boolean, -- default: true
851 minetest.register_authentication_handler(handler)
852 ^ See minetest.builtin_auth_handler in builtin.lua for reference
855 minetest.setting_set(name, value)
856 minetest.setting_get(name) -> string or nil
857 minetest.setting_getbool(name) -> boolean value or nil
858 minetest.setting_get_pos(name) -> position or nil
859 minetest.add_to_creative_inventory(itemstring)
862 minetest.notify_authentication_modified(name)
863 ^ Should be called by the authentication handler if privileges change.
864 ^ To report everybody, set name=nil.
865 minetest.get_password_hash(name, raw_password)
866 ^ Convert a name-password pair to a password hash that minetest can use
867 minetest.string_to_privs(str) -> {priv1=true,...}
868 minetest.privs_to_string(privs) -> "priv1,priv2,..."
869 ^ Convert between two privilege representations
870 minetest.set_player_password(name, password_hash)
871 minetest.set_player_privs(name, {priv1=true,...})
872 minetest.get_player_privs(name) -> {priv1=true,...}
873 minetest.auth_reload()
874 ^ These call the authentication handler
875 minetest.check_player_privs(name, {priv1=true,...}) -> bool, missing_privs
876 ^ A quickhand for checking privileges
879 minetest.chat_send_all(text)
880 minetest.chat_send_player(name, text)
883 minetest.get_inventory(location) -> InvRef
884 ^ location = eg. {type="player", name="celeron55"}
885 {type="node", pos={x=, y=, z=}}
886 {type="detached", name="creative"}
887 minetest.create_detached_inventory(name, callbacks) -> InvRef
888 ^ callbacks: See "Detached inventory callbacks"
889 ^ Creates a detached inventory. If it already exists, it is cleared.
892 minetest.inventorycube(img1, img2, img3)
893 ^ Returns a string for making an image of a cube (useful as an item image)
894 minetest.get_pointed_thing_position(pointed_thing, above)
895 ^ Get position of a pointed_thing (that you can get from somewhere)
896 minetest.dir_to_facedir(dir)
897 ^ Convert a vector to a facedir value, used in param2 for paramtype2="facedir"
898 minetest.dir_to_wallmounted(dir)
899 ^ Convert a vector to a wallmounted value, used for paramtype2="wallmounted"
900 minetest.get_node_drops(nodename, toolname)
901 ^ Returns list of item names.
902 ^ Note: This will be removed or modified in a future version.
903 minetest.get_craft_result(input) -> output, decremented_input
904 ^ input.method = 'normal' or 'cooking' or 'fuel'
905 ^ input.width = for example 3
906 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
907 stack 5, stack 6, stack 7, stack 8, stack 9 }
908 ^ output.item = ItemStack, if unsuccessful: empty ItemStack
909 ^ output.time = number, if unsuccessful: 0
910 ^ decremented_input = like input
911 minetest.get_craft_recipe(output) -> input
912 ^ output is a node or item type such as 'default:torch'
913 ^ input.method = 'normal' or 'cooking' or 'fuel'
914 ^ input.width = for example 3
915 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
916 stack 5, stack 6, stack 7, stack 8, stack 9 }
917 ^ input.items = nil if no recipe found
918 minetest.handle_node_drops(pos, drops, digger)
919 ^ drops: list of itemstrings
920 ^ Handles drops from nodes after digging: Default action is to put them into
922 ^ Can be overridden to get different functionality (eg. dropping items on
926 minetest.rollback_get_last_node_actor(p, range, seconds) -> actor, p, seconds
927 ^ Find who has done something to a node, or near a node
928 ^ actor: "player:<name>", also "liquid".
929 minetest.rollback_revert_actions_by(actor, seconds) -> bool, log messages
930 ^ Revert latest actions of someone
931 ^ actor: "player:<name>", also "liquid".
933 Defaults for the on_* item definition functions:
934 (These return the leftover itemstack)
935 minetest.item_place_node(itemstack, placer, pointed_thing)
936 ^ Place item as a node
937 minetest.item_place_object(itemstack, placer, pointed_thing)
939 minetest.item_place(itemstack, placer, pointed_thing)
940 ^ Use one of the above based on what the item is.
941 minetest.item_drop(itemstack, dropper, pos)
943 minetest.item_eat(hp_change, replace_with_item)
944 ^ Eat the item. replace_with_item can be nil.
946 Defaults for the on_punch and on_dig node definition callbacks:
947 minetest.node_punch(pos, node, puncher)
948 ^ Calls functions registered by minetest.register_on_punchnode()
949 minetest.node_dig(pos, node, digger)
950 ^ Checks if node can be dug, puts item into inventory, removes node
951 ^ Calls functions registered by minetest.registered_on_dignodes()
954 minetest.sound_play(spec, parameters) -> handle
955 ^ spec = SimpleSoundSpec
956 ^ parameters = sound parameter table
957 minetest.sound_stop(handle)
960 minetest.after(time, func, param)
961 ^ Call function after time seconds
962 ^ param is optional; to pass multiple parameters, pass a table.
965 minetest.request_shutdown() -> request for server shutdown
966 minetest.get_server_status() -> server status string
969 minetest.get_ban_list() -> ban list (same as minetest.get_ban_description(""))
970 minetest.get_ban_description(ip_or_name) -> ban description (string)
971 minetest.ban_player(name) -> ban a player
972 minetest.unban_player_or_ip(name) -> unban player or IP address
975 minetest.get_connected_players() -> list of ObjectRefs
976 minetest.hash_node_position({x=,y=,z=}) -> 48-bit integer
977 ^ Gives a unique hash number for a node position (16+16+16=48bit)
978 minetest.get_item_group(name, group) -> rating
979 ^ Get rating of a group of an item. (0 = not in group)
980 minetest.get_node_group(name, group) -> rating
981 ^ Deprecated: An alias for the former.
982 minetest.serialize(table) -> string
983 ^ Convert a table containing tables, strings, numbers, booleans and nils
984 into string form readable by minetest.deserialize
985 ^ Example: serialize({foo='bar'}) -> 'return { ["foo"] = "bar" }'
986 minetest.deserialize(string) -> table
987 ^ Convert a string returned by minetest.deserialize into a table
988 ^ String is loaded in an empty sandbox environment.
989 ^ Will load functions, but they cannot access the global environment.
990 ^ Example: deserialize('return { ["foo"] = "bar" }') -> {foo='bar'}
991 ^ Example: deserialize('print("foo")') -> nil (function call fails)
992 ^ error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)
995 minetest.env - EnvRef of the server environment and world.
996 ^ Using this you can access nodes and entities
999 minetest.registered_items
1000 ^ List of registered items, indexed by name
1001 minetest.registered_nodes
1002 ^ List of registered node definitions, indexed by name
1003 minetest.registered_craftitems
1004 ^ List of registered craft item definitions, indexed by name
1005 minetest.registered_tools
1006 ^ List of registered tool definitions, indexed by name
1007 minetest.registered_entities
1008 ^ List of registered entity prototypes, indexed by name
1009 minetest.object_refs
1010 ^ List of object references, indexed by active object id
1011 minetest.luaentities
1012 ^ List of lua entities, indexed by active object id
1014 Deprecated but defined for backwards compatibility:
1015 minetest.digprop_constanttime(time)
1016 minetest.digprop_stonelike(toughness)
1017 minetest.digprop_dirtlike(toughness)
1018 minetest.digprop_gravellike(toughness)
1019 minetest.digprop_woodlike(toughness)
1020 minetest.digprop_leaveslike(toughness)
1021 minetest.digprop_glasslike(toughness)
1025 EnvRef: basically ServerEnvironment and ServerMap combined.
1027 - set_node(pos, node)
1028 - add_node(pos, node): alias set_node(pos, node)
1029 ^ Set node at position (node = {name="foo", param1=0, param2=0})
1031 ^ Equivalent to set_node(pos, "air")
1033 ^ Returns {name="ignore", ...} for unloaded area
1034 - get_node_or_nil(pos)
1035 ^ Returns nil for unloaded area
1036 - get_node_light(pos, timeofday) -> 0...15 or nil
1037 ^ timeofday: nil = current time, 0 = night, 0.5 = day
1039 - place_node(pos, node)
1040 ^ Place node with the same effects that a player would cause
1042 ^ Dig node with the same effects that a player would cause
1044 ^ Punch node with the same effects that a player would cause
1046 - get_meta(pos) -- Get a NodeMetaRef at that position
1047 - get_node_timer(pos) -- Get NodeTimerRef
1049 - add_entity(pos, name): Spawn Lua-defined entity at position
1050 ^ Returns ObjectRef, or nil if failed
1051 - add_item(pos, item): Spawn item
1052 ^ Returns ObjectRef, or nil if failed
1053 - get_player_by_name(name) -- Get an ObjectRef to a player
1054 - get_objects_inside_radius(pos, radius)
1055 - set_timeofday(val): val: 0...1; 0 = midnight, 0.5 = midday
1057 - find_node_near(pos, radius, nodenames) -> pos or nil
1058 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1059 - find_nodes_in_area(minp, maxp, nodenames) -> list of positions
1060 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1061 - get_perlin(seeddiff, octaves, persistence, scale)
1062 ^ Return world-specific perlin noise (int(worldseed)+seeddiff)
1064 ^ clear all objects in the environments
1066 - add_rat(pos): Add C++ rat object (no-op)
1067 - add_firefly(pos): Add C++ firefly object (no-op)
1069 NodeMetaRef: Node metadata - reference extra data and functionality stored
1071 - Can be gotten via minetest.env:get_nodemeta(pos)
1073 - set_string(name, value)
1075 - set_int(name, value)
1077 - set_float(name, value)
1079 - get_inventory() -> InvRef
1080 - to_table() -> nil or {fields = {...}, inventory = {list1 = {}, ...}}
1081 - from_table(nil or {})
1082 ^ See "Node Metadata"
1084 NodeTimerRef: Node Timers - a high resolution persistent per-node timer
1085 - Can be gotten via minetest.env:get_node_timer(pos)
1087 - set(timeout,elapsed)
1088 ^ set a timer's state
1089 ^ timeout is in seconds, and supports fractional values (0.1 etc)
1090 ^ elapsed is in seconds, and supports fractional values (0.1 etc)
1091 ^ will trigger the node's on_timer function after timeout-elapsed seconds
1094 ^ equivelent to set(timeout,0)
1097 - get_timeout() -> current timeout in seconds
1098 ^ if timeout is 0, timer is inactive
1099 - get_elapsed() -> current elapsed time in seconds
1100 ^ the node's on_timer function will be called after timeout-elapsed seconds
1101 - is_started() -> boolean state of timer
1102 ^ returns true if timer is started, otherwise false
1104 ObjectRef: Moving things in the game are generally these
1105 (basically reference to a C++ ServerActiveObject)
1107 - remove(): remove object (after returning from Lua)
1108 - getpos() -> {x=num, y=num, z=num}
1109 - setpos(pos); pos={x=num, y=num, z=num}
1110 - moveto(pos, continuous=false): interpolated move
1111 - punch(puncher, time_from_last_punch, tool_capabilities, direction)
1112 ^ puncher = an another ObjectRef,
1113 ^ time_from_last_punch = time since last punch action of the puncher
1114 ^ direction: can be nil
1115 - right_click(clicker); clicker = an another ObjectRef
1116 - get_hp(): returns number of hitpoints (2 * number of hearts)
1117 - set_hp(hp): set number of hitpoints (2 * number of hearts)
1118 - get_inventory() -> InvRef
1119 - get_wield_list(): returns the name of the inventory list the wielded item is in
1120 - get_wield_index(): returns the index of the wielded item
1121 - get_wielded_item() -> ItemStack
1122 - set_wielded_item(item): replaces the wielded item, returns true if successful
1123 - set_armor_groups({group1=rating, group2=rating, ...})
1124 - set_animation({x=1,y=1}, frame_speed=15, frame_blend=0)
1125 - set_attach(parent, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
1127 - set_bone_position("", {x=0,y=0,z=0}, {x=0,y=0,z=0})
1128 - set_properties(object property table)
1129 LuaEntitySAO-only: (no-op for other objects)
1130 - setvelocity({x=num, y=num, z=num})
1131 - getvelocity() -> {x=num, y=num, z=num}
1132 - setacceleration({x=num, y=num, z=num})
1133 - getacceleration() -> {x=num, y=num, z=num}
1135 - getyaw() -> radians
1136 - settexturemod(mod)
1137 - setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
1138 - select_horiz_by_yawpitch=false)
1139 ^ Select sprite from spritesheet with optional animation and DM-style
1140 texture selection based on yaw relative to camera
1141 - get_entity_name() (DEPRECATED: Will be removed in a future version)
1143 Player-only: (no-op for other objects)
1144 - is_player(): true for players, false for others
1145 - get_player_name(): returns "" if is not a player
1146 - get_look_dir(): get camera direction as a unit vector
1147 - get_look_pitch(): pitch in radians
1148 - get_look_yaw(): yaw in radians (wraps around pretty randomly as of now)
1149 - set_inventory_formspec(formspec)
1150 ^ Redefine player's inventory form
1151 ^ Should usually be called in on_joinplayer
1152 - get_inventory_formspec() -> formspec string
1153 - get_player_control(): returns table with player pressed keys
1154 {jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}
1155 - get_player_control_bits(): returns integer with bit packed player pressed keys
1156 bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
1158 InvRef: Reference to an inventory
1160 - is_empty(listname): return true if list is empty
1161 - get_size(listname): get size of a list
1162 - set_size(listname, size): set size of a list
1163 - get_width(listname): get width of a list
1164 - set_width(listname, width): set width of list; currently used for crafting
1165 - get_stack(listname, i): get a copy of stack index i in list
1166 - set_stack(listname, i, stack): copy stack to index i in list
1167 - get_list(listname): return full list
1168 - set_list(listname, list): set full list (size will not change)
1169 - add_item(listname, stack): add item somewhere in list, returns leftover ItemStack
1170 - room_for_item(listname, stack): returns true if the stack of items
1171 can be fully added to the list
1172 - contains_item(listname, stack): returns true if the stack of items
1173 can be fully taken from the list
1174 remove_item(listname, stack): take as many items as specified from the list,
1175 returns the items that were actually removed (as an ItemStack)
1177 ItemStack: A stack of items.
1178 - Can be created via ItemStack(itemstack or itemstring or table or nil)
1180 - is_empty(): return true if stack is empty
1181 - get_name(): returns item name (e.g. "default:stone")
1182 - get_count(): returns number of items on the stack
1183 - get_wear(): returns tool wear (0-65535), 0 for non-tools
1184 - get_metadata(): returns metadata (a string attached to an item stack)
1185 - clear(): removes all items from the stack, making it empty
1186 - replace(item): replace the contents of this stack (item can also
1187 be an itemstring or table)
1188 - to_string(): returns the stack in itemstring form
1189 - to_table(): returns the stack in Lua table form
1190 - get_stack_max(): returns the maximum size of the stack (depends on the item)
1191 - get_free_space(): returns get_stack_max() - get_count()
1192 - is_known(): returns true if the item name refers to a defined item type
1193 - get_definition(): returns the item definition table
1194 - get_tool_capabilities(): returns the digging properties of the item,
1195 ^ or those of the hand if none are defined for this item type
1196 - add_wear(amount): increases wear by amount if the item is a tool
1197 - add_item(item): put some item or stack onto this stack,
1198 ^ returns leftover ItemStack
1199 - item_fits(item): returns true if item or stack can be fully added to this one
1200 - take_item(n): take (and remove) up to n items from this stack
1201 ^ returns taken ItemStack
1202 ^ if n is omitted, n=1 is used
1203 - peek_item(n): copy (don't remove) up to n items from this stack
1204 ^ returns copied ItemStack
1205 ^ if n is omitted, n=1 is used
1207 PseudoRandom: A pseudorandom number generator
1208 - Can be created via PseudoRandom(seed)
1210 - next(): return next integer random number [0...32767]
1211 - next(min, max): return next integer random number [min...max]
1212 (max - min) must be 32767 or <= 6553 due to the simple
1213 implementation making bad distribution otherwise.
1215 PerlinNoise: A perlin noise generator
1216 - Can be created via PerlinNoise(seed, octaves, persistence, scale)
1217 - Also minetest.env:get_perlin(seeddiff, octaves, persistence, scale)
1219 - get2d(pos) -> 2d noise value at pos={x=,y=}
1220 - get3d(pos) -> 3d noise value at pos={x=,y=,z=}
1223 --------------------
1224 - Functions receive a "luaentity" as self:
1225 - It has the member .name, which is the registered name ("mod:thing")
1226 - It has the member .object, which is an ObjectRef pointing to the object
1227 - The original prototype stuff is visible directly via a metatable
1229 - on_activate(self, staticdata)
1230 ^ Called when the object is instantiated.
1231 - on_step(self, dtime)
1232 ^ Called on every server tick (dtime is usually 0.05 seconds)
1233 - on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
1234 ^ Called when somebody punches the object.
1235 ^ Note that you probably want to handle most punches using the
1236 automatic armor group system.
1237 ^ puncher: ObjectRef (can be nil)
1238 ^ time_from_last_punch: Meant for disallowing spamming of clicks (can be nil)
1239 ^ tool_capabilities: capability table of used tool (can be nil)
1240 ^ dir: unit vector of direction of punch. Always defined. Points from
1241 the puncher to the punched.
1242 - on_rightclick(self, clicker)
1243 - get_staticdata(self)
1244 ^ Should return a string that will be passed to on_activate when
1245 the object is instantiated the next time.
1255 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
1256 visual = "cube"/"sprite"/"upright_sprite"/"mesh",
1257 visual_size = {x=1, y=1},
1259 textures = {}, -- number of required textures depends on visual
1260 colors = {}, -- number of required colors depends on visual
1261 spritediv = {x=1, y=1},
1262 initial_sprite_basepos = {x=0, y=0},
1264 makes_footstep_sound = false,
1265 automatic_rotate = false,
1268 Entity definition (register_entity)
1270 (Deprecated: Everything in object properties is read directly from here)
1272 initial_properties = <initial object properties>,
1274 on_activate = function(self, staticdata, dtime_s),
1275 on_step = function(self, dtime),
1276 on_punch = function(self, hitter),
1277 on_rightclick = function(self, clicker),
1278 get_staticdata = function(self),
1279 ^ Called sometimes; the string returned is passed to on_activate when
1280 the entity is re-activated from static state
1282 # Also you can define arbitrary member variables here
1283 myvariable = whatever,
1286 ABM (ActiveBlockModifier) definition (register_abm)
1288 -- In the following two fields, also group:groupname will work.
1289 nodenames = {"default:lava_source"},
1290 neighbors = {"default:water_source", "default:water_flowing"}, -- (any of these)
1291 ^ If left out or empty, any neighbor will do
1292 interval = 1.0, -- (operation interval)
1293 chance = 1, -- (chance of trigger is 1.0/this)
1294 action = func(pos, node, active_object_count, active_object_count_wider),
1297 Item definition (register_node, register_craftitem, register_tool)
1299 description = "Steel Axe",
1300 groups = {}, -- key=name, value=rating; rating=1..3.
1301 if rating not applicable, use 1.
1302 eg. {wool=1, fluffy=3}
1303 {soil=2, outerspace=1, crumbly=1}
1304 {bendy=2, snappy=1},
1305 {hard=1, metal=1, spikes=1}
1306 inventory_image = "default_tool_steelaxe.png",
1308 wield_scale = {x=1,y=1,z=1},
1310 liquids_pointable = false,
1311 tool_capabilities = {
1312 full_punch_interval = 1.0,
1316 fleshy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
1317 snappy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
1318 choppy={times={[3]=0.90}, maxwear=0.05, maxlevel=0}
1321 node_placement_prediction = nil,
1322 ^ If nil and item is node, prediction is made automatically
1323 ^ If nil and item is not a node, no prediction is made
1324 ^ If "" and item is anything, no prediction is made
1325 ^ Otherwise should be name of node which the client immediately places
1326 on ground when the player places the item. Server will always update
1327 actual result to client in a short moment.
1329 on_place = func(itemstack, placer, pointed_thing),
1330 ^ Shall place item and return the leftover itemstack
1331 ^ default: minetest.item_place
1332 on_drop = func(itemstack, dropper, pos),
1333 ^ Shall drop item and return the leftover itemstack
1334 ^ default: minetest.item_drop
1335 on_use = func(itemstack, user, pointed_thing),
1337 ^ Function must return either nil if no item shall be removed from
1338 inventory, or an itemstack to replace the original itemstack.
1339 eg. itemstack:take_item(); return itemstack
1340 ^ Otherwise, the function is free to do what it wants.
1341 ^ The default functions handle regular use cases.
1346 - {name="image.png", animation={Tile Animation definition}}
1347 - {name="image.png", backface_culling=bool}
1348 ^ backface culling only supported in special tiles
1349 - deprecated still supported field names:
1352 Tile animation definition:
1353 - {type="vertical_frames", aspect_w=16, aspect_h=16, length=3.0}
1355 Node definition (register_node)
1357 <all fields allowed in item definitions>,
1359 drawtype = "normal", -- See "Node drawtypes"
1361 tiles = {tile definition 1, def2, def3, def4, def5, def6},
1362 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
1363 ^ List can be shortened to needed length
1364 special_tiles = {tile definition 1, Tile definition 2},
1365 ^ Special textures of node; used rarely (old field name: special_materials)
1366 ^ List can be shortened to needed length
1368 post_effect_color = {a=0, r=0, g=0, b=0}, -- If player is inside node
1369 paramtype = "none", -- See "Nodes"
1370 paramtype2 = "none", -- See "Nodes"
1371 is_ground_content = false, -- Currently not used for anything
1372 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
1373 walkable = true, -- If true, objects collide with node
1374 pointable = true, -- If true, can be pointed at
1375 diggable = true, -- If false, can never be dug
1376 climbable = false, -- If true, can be climbed on (ladder)
1377 buildable_to = false, -- If true, placed nodes can replace this node
1378 drop = "", -- alternatively drop = { max_items = ..., items = { ... } }
1379 liquidtype = "none", -- "none"/"source"/"flowing"
1380 liquid_alternative_flowing = "", -- Flowing version of source liquid
1381 liquid_alternative_source = "", -- Source version of flowing liquid
1382 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
1383 liquid_renewable = true, -- Can new liquid source be created by placing
1384 two or more sources nearly?
1385 light_source = 0, -- Amount of light emitted by node
1386 damage_per_second = 0, -- If player is inside node, this damage is caused
1387 node_box = {type="regular"}, -- See "Node boxes"
1388 selection_box = {type="regular"}, -- See "Node boxes"
1389 legacy_facedir_simple = false, -- Support maps made in and before January 2012
1390 legacy_wallmounted = false, -- Support maps made in and before January 2012
1392 footstep = <SimpleSoundSpec>,
1393 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
1394 dug = <SimpleSoundSpec>,
1397 on_construct = func(pos),
1398 ^ Node constructor; always called after adding node
1399 ^ Can set up metadata and stuff like that
1401 on_destruct = func(pos),
1402 ^ Node destructor; always called before removing node
1404 after_destruct = func(pos, oldnode),
1405 ^ Node destructor; always called after removing node
1408 after_place_node = func(pos, placer),
1409 ^ Called after constructing node when node was placed using
1410 minetest.item_place_node / minetest.env:place_node
1412 after_dig_node = func(pos, oldnode, oldmetadata, digger),
1413 ^ oldmetadata is in table format
1414 ^ Called after destructing node when node was dug using
1415 minetest.node_dig / minetest.env:dig_node
1417 can_dig = function(pos,player)
1418 ^ returns true if node can be dug, or false if not
1421 on_punch = func(pos, node, puncher),
1422 ^ default: minetest.node_punch
1423 ^ By default: does nothing
1424 on_dig = func(pos, node, digger),
1425 ^ default: minetest.node_dig
1426 ^ By default: checks privileges, wears out tool and removes node
1428 on_timer = function(pos,elapsed),
1430 ^ called by NodeTimers, see EnvRef and NodeTimerRef
1431 ^ elapsed is the total time passed since the timer was started
1432 ^ return true to run the timer for another cycle with the same timeout value
1434 on_receive_fields = func(pos, formname, fields, sender),
1435 ^ fields = {name1 = value1, name2 = value2, ...}
1436 ^ Called when an UI form (eg. sign text input) returns data
1439 allow_metadata_inventory_move = func(pos, from_list, from_index,
1440 to_list, to_index, count, player),
1441 ^ Called when a player wants to move items inside the inventory
1442 ^ Return value: number of items allowed to move
1444 allow_metadata_inventory_put = func(pos, listname, index, stack, player),
1445 ^ Called when a player wants to put something into the inventory
1446 ^ Return value: number of items allowed to put
1447 ^ Return value: -1: Allow and don't modify item count in inventory
1449 allow_metadata_inventory_take = func(pos, listname, index, stack, player),
1450 ^ Called when a player wants to take something out of the inventory
1451 ^ Return value: number of items allowed to take
1452 ^ Return value: -1: Allow and don't modify item count in inventory
1454 on_metadata_inventory_move = func(pos, from_list, from_index,
1455 to_list, to_index, count, player),
1456 on_metadata_inventory_put = func(pos, listname, index, stack, player),
1457 on_metadata_inventory_take = func(pos, listname, index, stack, player),
1458 ^ Called after the actual action has happened, according to what was allowed.
1461 on_blast = func(pos, intensity),
1462 ^ intensity: 1.0 = mid range of regular TNT
1463 ^ If defined, called when an explosion touches the node, instead of
1467 Recipe for register_craft: (shaped)
1469 output = 'default:pick_stone',
1471 {'default:cobble', 'default:cobble', 'default:cobble'},
1472 {'', 'default:stick', ''},
1473 {'', 'default:stick', ''}, -- Also groups; eg. 'group:crumbly'
1475 replacements = <optional list of item pairs,
1476 replace one input item with another item on crafting>
1479 Recipe for register_craft (shapeless)
1482 output = 'mushrooms:mushroom_stew',
1485 "mushrooms:mushroom_brown",
1486 "mushrooms:mushroom_red",
1488 replacements = <optional list of item pairs,
1489 replace one input item with another item on crafting>
1492 Recipe for register_craft (tool repair)
1494 type = "toolrepair",
1495 additional_wear = -0.02,
1498 Recipe for register_craft (cooking)
1501 output = "default:glass",
1502 recipe = "default:sand",
1506 Recipe for register_craft (furnace fuel)
1509 recipe = "default:leaves",
1513 Chatcommand definition (register_chatcommand)
1515 params = "<name> <privilege>", -- short parameter description
1516 description = "Remove privilege from player", -- full description
1517 privs = {privs=true}, -- require the "privs" privilege to run
1518 func = function(name, param), -- called when command is run
1521 Detached inventory callbacks
1523 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
1524 ^ Called when a player wants to move items inside the inventory
1525 ^ Return value: number of items allowed to move
1527 allow_put = func(inv, listname, index, stack, player),
1528 ^ Called when a player wants to put something into the inventory
1529 ^ Return value: number of items allowed to put
1530 ^ Return value: -1: Allow and don't modify item count in inventory
1532 allow_take = func(inv, listname, index, stack, player),
1533 ^ Called when a player wants to take something out of the inventory
1534 ^ Return value: number of items allowed to take
1535 ^ Return value: -1: Allow and don't modify item count in inventory
1537 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
1538 on_put = func(inv, listname, index, stack, player),
1539 on_take = func(inv, listname, index, stack, player),
1540 ^ Called after the actual action has happened, according to what was allowed.