1 Minetest Lua Modding API Reference 0.4.7
2 ========================================
3 More information at http://www.minetest.net/
4 Developer Wiki: http://dev.minetest.net/
8 Content and functionality can be added to Minetest 0.4 by using Lua
9 scripting in run-time loaded mods.
11 A mod is a self-contained bunch of scripts, textures and other related
12 things that is loaded by and interfaces with Minetest.
14 Mods are contained and ran solely on the server side. Definitions and media
15 files are automatically transferred to the client.
17 If you see a deficiency in the API, feel free to attempt to add the
18 functionality in the engine and API. You can send such improvements as
19 source code patches to <celeron55@gmail.com>.
23 If you have any difficulty in understanding this, please read:
24 http://www.lua.org/pil/
28 Mods are loaded during server startup from the mod load paths by running
29 the init.lua scripts in a shared environment.
33 RUN_IN_PLACE=1: (Windows release, local build)
34 $path_user: Linux: <build directory>
35 Windows: <build directory>
36 $path_share: Linux: <build directory>
37 Windows: <build directory>
39 RUN_IN_PLACE=0: (Linux release)
40 $path_share: Linux: /usr/share/minetest
41 Windows: <install directory>/minetest-0.4.x
42 $path_user: Linux: ~/.minetest
43 Windows: C:/users/<user>/AppData/minetest (maybe)
47 Games are looked up from:
48 $path_share/games/gameid/
49 $path_user/games/gameid/
50 where gameid is unique to each game.
52 The game directory contains the file game.conf, which contains these fields:
53 name = <Human-readable full name of the game>
57 The game directory can contain the file minetest.conf, which will be used
58 to set default settings when running the particular game.
63 $path_share/games/gameid/mods/
65 $path_user/games/gameid/mods/
66 $path_user/mods/ <-- User-installed mods
69 In a run-in-place version (eg. the distributed windows version):
70 minetest-0.4.x/games/gameid/mods/
71 minetest-0.4.x/mods/gameid/ <-- User-installed mods
72 minetest-0.4.x/worlds/worldname/worldmods/
74 On an installed version on linux:
75 /usr/share/minetest/games/gameid/mods/
76 ~/.minetest/mods/gameid/ <-- User-installed mods
77 ~/.minetest/worlds/worldname/worldmods
79 Mod load path for world-specific games
80 --------------------------------------
81 It is possible to include a game in a world; in this case, no mods or
82 games are loaded or checked from anywhere else.
84 This is useful for eg. adventure worlds.
86 This happens if the following directory exists:
89 Mods should be then be placed in:
94 Mods can be put in a subdirectory, if the parent directory, which otherwise
95 should be a mod, contains a file named modpack.txt. This file shall be
96 empty, except for lines starting with #, which are comments.
98 Mod directory structure
99 ------------------------
105 | | |-- modname_stuff.png
106 | | `-- modname_something_else.png
113 The location of this directory can be fetched by using
114 minetest.get_modpath(modname)
117 List of mods that have to be loaded before loading this mod.
118 A single line contains a single modname.
120 Optional dependencies can be defined by appending a question mark
121 to a single modname. Their meaning is that if the specified mod
122 is missing, that does not prevent this mod from being loaded.
125 An alternative way of specifying optional dependencies.
126 Like depends.txt, a single line contains a single modname.
128 NOTE: This file exists for compatibility purposes only and
129 support for it will be removed from the engine by the end of 2013.
132 The main Lua script. Running this script should register everything it
133 wants to register. Subsequent execution depends on minetest calling the
134 registered callbacks.
136 minetest.setting_get(name) and minetest.setting_getbool(name) can be used
137 to read custom or existing settings at load time, if necessary.
139 textures, sounds, media:
140 Media files (textures, sounds, whatever) that will be transferred to the
141 client and will be available for use by the mod.
143 Naming convention for registered textual names
144 ----------------------------------------------
145 Registered names should generally be in this format:
146 "modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
148 This is to prevent conflicting names from corrupting maps and is
149 enforced by the mod loader.
151 Example: mod "experimental", ideal item/node/entity name "tnt":
152 -> the name should be "experimental:tnt".
154 Enforcement can be overridden by prefixing the name with ":". This can
155 be used for overriding the registrations of some other mod.
157 Example: Any mod can redefine experimental:tnt by using the name
158 ":experimental:tnt" when registering it.
159 (also that mod is required to have "experimental" as a dependency)
161 The ":" prefix can also be used for maintaining backwards compatibility.
165 Aliases can be added by using minetest.register_alias(name, convert_to)
167 This will make Minetest to convert things called name to things called
170 This can be used for maintaining backwards compatibility.
172 This can be also used for setting quick access names for things, eg. if
173 you have an item called epiclylongmodname:stuff, you could do
174 minetest.register_alias("stuff", "epiclylongmodname:stuff")
175 and be able to use "/giveme stuff".
179 Mods should generally prefix their textures with modname_, eg. given
180 the mod name "foomod", a texture could be called
181 "foomod_foothing.png"
183 Textures are referred to by their complete name, or alternatively by
184 stripping out the file extension:
185 eg. foomod_foothing.png
190 Only OGG files are supported.
192 For positional playing of sounds, only single-channel (mono) files are
193 supported. Otherwise OpenAL will play them non-positionally.
195 Mods should generally prefix their sounds with modname_, eg. given
196 the mod name "foomod", a sound could be called
197 "foomod_foosound.ogg"
199 Sounds are referred to by their name with a dot, a single digit and the
200 file extension stripped out. When a sound is played, the actual sound file
201 is chosen randomly from the matching sounds.
203 When playing the sound "foomod_foosound", the sound is chosen randomly
204 from the available ones of the following files:
206 foomod_foosound.0.ogg
207 foomod_foosound.1.ogg
209 foomod_foosound.9.ogg
211 Examples of sound parameter tables:
212 -- Play locationless on all clients
214 gain = 1.0, -- default
216 -- Play locationless to a player
219 gain = 1.0, -- default
221 -- Play in a location
224 gain = 1.0, -- default
225 max_hear_distance = 32, -- default
227 -- Play connected to an object, looped
229 object = <an ObjectRef>,
230 gain = 1.0, -- default
231 max_hear_distance = 32, -- default
232 loop = true, -- only sounds connected to objects can be looped
237 eg. "default_place_node"
239 eg. {name="default_place_node"}
240 eg. {name="default_place_node", gain=1.0}
242 Registered definitions of stuff
243 --------------------------------
244 Anything added using certain minetest.register_* functions get added to
245 the global minetest.registered_* tables.
247 minetest.register_entity(name, prototype table)
248 -> minetest.registered_entities[name]
250 minetest.register_node(name, node definition)
251 -> minetest.registered_items[name]
252 -> minetest.registered_nodes[name]
254 minetest.register_tool(name, item definition)
255 -> minetest.registered_items[name]
257 minetest.register_craftitem(name, item definition)
258 -> minetest.registered_items[name]
260 Note that in some cases you will stumble upon things that are not contained
261 in these tables (eg. when a mod has been removed). Always check for
262 existence before trying to access the fields.
264 Example: If you want to check the drawtype of a node, you could do:
266 local function get_nodedef_field(nodename, fieldname)
267 if not minetest.registered_nodes[nodename] then
270 return minetest.registered_nodes[nodename][fieldname]
272 local drawtype = get_nodedef_field(nodename, "drawtype")
274 Example: minetest.get_item_group(name, group) has been implemented as:
276 function minetest.get_item_group(name, group)
277 if not minetest.registered_items[name] or not
278 minetest.registered_items[name].groups[group] then
281 return minetest.registered_items[name].groups[group]
286 Nodes are the bulk data of the world: cubes and other things that take the
287 space of a cube. Huge amounts of them are handled efficiently, but they
290 The definition of a node is stored and can be accessed by name in
291 minetest.registered_nodes[node.name]
292 See "Registered definitions of stuff".
294 Nodes are passed by value between Lua and the engine.
295 They are represented by a table:
296 {name="name", param1=num, param2=num}
298 param1 and param2 are 8 bit integers. The engine uses them for certain
299 automated functions. If you don't use these functions, you can use them to
300 store arbitrary values.
302 The functions of param1 and param2 are determined by certain fields in the
304 param1 is reserved for the engine when paramtype != "none":
306 ^ The value stores light with and without sun in it's
307 upper and lower 4 bits.
308 param2 is reserved for the engine when any of these are used:
309 liquidtype == "flowing"
310 ^ The level and some flags of the liquid is stored in param2
311 drawtype == "flowingliquid"
312 ^ The drawn liquid level is read from param2
313 drawtype == "torchlike"
314 drawtype == "signlike"
315 paramtype2 == "wallmounted"
316 ^ The rotation of the node is stored in param2. You can make this value
317 by using minetest.dir_to_wallmounted().
318 paramtype2 == "facedir"
319 ^ The rotation of the node is stored in param2. Furnaces and chests are
320 rotated this way. Can be made by using minetest.dir_to_facedir().
322 facedir modulo 4 = axisdir
323 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
324 facedir's two less significant bits are rotation around the axis
326 Nodes can also contain extra data. See "Node Metadata".
330 There are a bunch of different looking node types. These are mostly just
331 copied from Minetest 0.3; more may be made in the future.
333 Look for examples in games/minimal or games/minetest_game.
348 - nodebox -- See below. EXPERIMENTAL
352 Node selection boxes are defined using "node boxes"
354 The "nodebox" node drawtype allows defining visual of nodes consisting of
355 arbitrary number of boxes. It allows defining stuff like stairs. Only the
356 "fixed" box type is supported for these.
357 ^ Please note that this is still experimental, and may be incompatibly
358 changed in the future.
360 A nodebox is defined as any of:
362 -- A normal cube; the default in most things
366 -- A fixed box (facedir param2 is used, if applicable)
368 fixed = box OR {box1, box2, ...}
371 -- A box like the selection box for torches
372 -- (wallmounted param2 is used, if applicable)
373 type = "wallmounted",
380 {x1, y1, z1, x2, y2, z2}
381 A box of a regular node would look like:
382 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
386 These tell in what manner the ore is generated.
387 All default ores are of the uniformly-distributed scatter type.
390 Randomly chooses a location and generates a cluster of ore.
391 If noise_params is specified, the ore will be placed if the 3d perlin noise at
392 that point is greater than the noise_threshhold, giving the ability to create a non-equal
395 Creates a sheet of ore in a blob shape according to the 2d perlin noise described by noise_params.
396 The relative height of the sheet can be controlled by the same perlin noise as well, by specifying
397 a non-zero 'scale' parameter in noise_params. IMPORTANT: The noise is not transformed by offset or
398 scale when comparing against the noise threshhold, but scale is used to determine relative height.
399 The height of the blob is randomly scattered, with a maximum height of clust_size.
400 clust_scarcity and clust_num_ores are ignored.
401 This is essentially an improved version of the so-called "stratus" ore seen in some unofficial mods.
402 - claylike - NOT YET IMPLEMENTED
403 Places ore if there are no more than clust_scarcity number of specified nodes within a Von Neumann
404 neighborhood of clust_size radius.
408 Currently supported flags: absheight
410 Also produce this same ore between the height range of -height_max and -height_min.
411 Useful for having ore in sky realms without having to duplicate ore entries.
415 The varying types of decorations that can be placed.
416 The default value is simple, and is currently the only type supported.
419 Creates a 1xHx1 column of a specified node (or a random node from a list, if a decoration
420 list is specified). Can specify a certain node it must spawn next to, such as water or lava,
421 for example. Can also generate a decoration of random height between a specified lower and
422 upper bound. This type of decoration is intended for placement of grass, flowers, cacti,
425 Copies a box of MapNodes from a specified schematic file (or raw description). Can specify a
426 probability of a node randomly appearing when placed. This decoration type is intended to be used
427 for multi-node sized discrete structures, such as trees, cave spikes, rocks, and so on.
431 A schematic specifier identifies a schematic by either a filename to a Minetest Schematic file (.mts)
432 or through raw data supplied through Lua, in the form of a table. This table must specify two fields:
433 - The 'size' field is a 3d vector containing the dimensions of the provided schematic.
434 - The 'data' field is a flat table of MapNodes making up the schematic, in the order of [z [y [x]]].
436 In the bulk MapNode data, param1, instead of the typical light values, instead represents the
437 probability of that node appearing in the structure.
438 When passed to minetest.create_schematic, probability is an integer value ranging from -1 to 255:
439 - A probability value of 0 means that node will always appear.
440 - A probability value of -1 means the node will never appear.
441 - If the probability value p is greater than 0, then there is a (p / 256 * 100)% chance that node
442 will appear when the schematic is placed on the map.
444 If registering a structure in the raw format, however, -1 is not a valid probability value; in order to
445 have a node that is not placed, it must be CONTENT_IGNORE (the name for which is "ignore").
447 Important note: Node aliases cannot be used for a raw schematic provided when registering as a decoration.
450 ---------------------
451 Currently supported flags: place_center_x, place_center_y, place_center_z
453 Placement of this decoration is centered along the X axis.
455 Placement of this decoration is centered along the Y axis.
457 Placement of this decoration is centered along the Z axis.
461 The position field is used for all element types.
462 To account for differing resolutions, the position coordinates are the percentage of the screen,
463 ranging in value from 0 to 1.
464 The name field is not yet used, but should contain a description of what the HUD element represents.
465 The direction field is the direction in which something is drawn.
466 0 draws from left to right, 1 draws from right to left, 2 draws from top to bottom, and 3 draws from bottom to top.
467 The alignment field specifies how the item will be aligned. It ranges from -1 to 1,
468 with 0 being the center, -1 is moved to the left/up, and 1 is to the right/down. Fractional
470 The offset field specifies a pixel offset from the position. Contrary to position,
471 the offset is not scaled to screen size. This allows for some precisely-positioned
473 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
475 Note: Future revisions to the HUD API may be incompatible; the HUD API is still in the experimental stages.
478 Displays an image on the HUD.
479 - scale: The scale of the image, with 1 being the original texture size.
480 Only the X coordinate scale is used.
481 - text: The name of the texture that is displayed.
482 - alignment: The alignment of the image.
483 - offset: offset in pixels from position.
485 Displays text on the HUD.
486 - scale: Defines the bounding rectangle of the text.
487 A value such as {x=100, y=100} should work.
488 - text: The text to be displayed in the HUD element.
489 - number: An integer containing the RGB value of the color used to draw the text.
490 Specify 0xFFFFFF for white text, 0xFF0000 for red, and so on.
491 - alignment: The alignment of the text.
492 - offset: offset in pixels from position.
494 Displays a horizontal bar made up of half-images.
495 - text: The name of the texture that is used.
496 - number: The number of half-textures that are displayed.
497 If odd, will end with a vertically center-split texture.
499 - offset: offset in pixels from position.
501 - text: The name of the inventory list to be displayed.
502 - number: Number of items in the inventory to be displayed.
503 - item: Position of item that is selected.
506 Representations of simple things
507 --------------------------------
509 {x=num, y=num, z=num}
510 Currently the API does not provide any helper functions for addition,
511 subtraction and whatever; you can define those that you need yourself.
515 {type="node", under=pos, above=pos}
516 {type="object", ref=ObjectRef}
520 Node (register_node):
521 A node from the world
522 Tool (register_tool):
523 A tool/weapon that can dig and damage things according to tool_capabilities
524 Craftitem (register_craftitem):
527 Items and item stacks can exist in three formats:
529 Serialized; This is called stackstring or itemstring:
531 eg. 'default:pick_wood 21323'
535 eg. {name="default:dirt", count=5, wear=0, metadata=""}
537 eg. {name="default:pick_wood", count=1, wear=21323, metadata=""}
538 ^ a wooden pick about 1/3 weared out
539 eg. {name="default:apple", count=1, wear=0, metadata=""}
543 C++ native format with many helper methods. Useful for converting between
544 formats. See the Class reference section for details.
546 When an item must be passed to a function, it can usually be in any of
551 In a number of places, there is a group table. Groups define the
552 properties of a thing (item, node, armor of entity, capabilities of
553 tool) in such a way that the engine and other mods can can interact with
554 the thing without actually knowing what the thing is.
557 - Groups are stored in a table, having the group names with keys and the
558 group ratings as values. For example:
559 groups = {crumbly=3, soil=1}
561 groups = {crumbly=2, soil=1, level=2, outerspace=1}
562 ^ A more special dirt-kind of thing
563 - Groups always have a rating associated with them. If there is no
564 useful meaning for a rating for an enabled group, it shall be 1.
565 - When not defined, the rating of a group defaults to 0. Thus when you
566 read groups, you must interpret nil and 0 as the same value, 0.
568 You can read the rating of a group for an item or a node by using
569 minetest.get_item_group(itemname, groupname)
573 Groups of items can define what kind of an item it is (eg. wool).
577 In addition to the general item things, groups are used to define whether
578 a node is destroyable and how long it takes to destroy by a tool.
582 For entities, groups are, as of now, used only for calculating damage.
583 The rating is the percentage of damage caused by tools with this damage group.
584 See "Entity damage mechanism".
586 object.get_armor_groups() -> a group-rating table (eg. {fleshy=100})
587 object.set_armor_groups({fleshy=30, cracky=80})
591 Groups in tools define which groups of nodes and entities they are
594 Groups in crafting recipes
595 ---------------------------
596 An example: Make meat soup from any meat, any water and any bowl
598 output = 'food:meat_soup_raw',
604 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
606 An another example: Make red wool from white wool and red dye
610 recipe = {'wool:white', 'group:dye,basecolor_red'},
615 - immortal: Disables the group damage system for an entity
616 - level: Can be used to give an additional sense of progression in the game.
617 - A larger level will cause eg. a weapon of a lower level make much less
618 damage, and get weared out much faster, or not be able to get drops
619 from destroyed nodes.
620 - 0 is something that is directly accessible at the start of gameplay
621 - There is no upper limit
622 - dig_immediate: (player can always pick up node without tool wear)
623 - 2: node is removed without tool wear after 0.5 seconds or so
625 - 3: node is removed without tool wear immediately (torch)
626 - disable_jump: Player (and possibly other things) cannot jump from node
627 - fall_damage_add_percent: damage speed = speed * (1 + value/100)
628 - bouncy: value is bounce speed in percent
629 - falling_node: if there is no walkable block under the node it will fall
630 - attached_node: if the node under it is not a walkable block the node will be
631 dropped as an item. If the node is wallmounted the
632 wallmounted direction is checked.
633 - soil: saplings will grow on nodes in this group
634 - connect_to_raillike: makes nodes of raillike drawtype connect to
635 other group members with same drawtype
637 Known damage and digging time defining groups
638 ----------------------------------------------
639 - crumbly: dirt, sand
640 - cracky: tough but crackable stuff like stone.
641 - snappy: something that can be cut using fine tools; eg. leaves, small
642 plants, wire, sheets of metal
643 - choppy: something that can be cut using force; eg. trees, wooden planks
644 - fleshy: Living things like animals and the player. This could imply
645 some blood effects when hitting.
646 - explody: Especially prone to explosions
647 - oddly_breakable_by_hand:
648 Can be added to nodes that shouldn't logically be breakable by the
649 hand but are. Somewhat similar to dig_immediate, but times are more
650 like {[1]=3.50,[2]=2.00,[3]=0.70} and this does not override the
651 speed of a tool if the tool can dig at a faster speed than this
652 suggests for the hand.
654 Examples of custom groups
655 --------------------------
656 Item groups are often used for defining, well, //groups of items//.
657 - meat: any meat-kind of a thing (rating might define the size or healing
658 ability or be irrelevant - it is not defined as of yet)
659 - eatable: anything that can be eaten. Rating might define HP gain in half
661 - flammable: can be set on fire. Rating might define the intensity of the
662 fire, affecting eg. the speed of the spreading of an open fire.
663 - wool: any wool (any origin, any color)
666 - heavy: anything considerably heavy
668 Digging time calculation specifics
669 -----------------------------------
670 Groups such as **crumbly**, **cracky** and **snappy** are used for this
671 purpose. Rating is 1, 2 or 3. A higher rating for such a group implies
674 The **level** group is used to limit the toughness of nodes a tool can dig
675 and to scale the digging times / damage to a greater extent.
677 ^ PLEASE DO UNDERSTAND THIS, otherwise you cannot use the system to it's
680 Tools define their properties by a list of parameters for groups. They
681 cannot dig other groups; thus it is important to use a standard bunch of
682 groups to enable interaction with tools.
685 * Full punch interval
687 * For an arbitrary list of groups:
688 * Uses (until the tool breaks)
689 * Maximum level (usually 0, 1, 2 or 3)
693 **Full punch interval**:
694 When used as a weapon, the tool will do full damage if this time is spent
695 between punches. If eg. half the time is spent, the tool will do half
698 **Maximum drop level**
699 Suggests the maximum level of node, when dug with the tool, that will drop
700 it's useful item. (eg. iron ore to drop a lump of iron).
701 - This is not automated; it is the responsibility of the node definition
705 Determines how many uses the tool has when it is used for digging a node,
706 of this group, of the maximum level. For lower leveled nodes, the use count
707 is multiplied by 3^leveldiff.
708 - uses=10, leveldiff=0 -> actual uses: 10
709 - uses=10, leveldiff=1 -> actual uses: 30
710 - uses=10, leveldiff=2 -> actual uses: 90
713 Tells what is the maximum level of a node of this group that the tool will
717 List of digging times for different ratings of the group, for nodes of the
719 * For example, as a lua table, ''times={2=2.00, 3=0.70}''. This would
720 result in the tool to be able to dig nodes that have a rating of 2 or 3
721 for this group, and unable to dig the rating 1, which is the toughest.
722 Unless there is a matching group that enables digging otherwise.
725 List of damage for groups of entities. See "Entity damage mechanism".
727 Example definition of the capabilities of a tool
728 -------------------------------------------------
729 tool_capabilities = {
730 full_punch_interval=1.5,
733 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
735 damage_groups = {fleshy=2},
738 This makes the tool be able to dig nodes that fullfill both of these:
739 - Have the **crumbly** group
740 - Have a **level** group less or equal to 2
742 Table of resulting digging times:
743 crumbly 0 1 2 3 4 <- level
749 level diff: 2 1 0 -1 -2
751 Table of resulting tool uses:
758 - At crumbly=0, the node is not diggable.
759 - At crumbly=3, the level difference digging time divider kicks in and makes
760 easy nodes to be quickly breakable.
761 - At level > 2, the node is not diggable, because it's level > maxlevel
763 Entity damage mechanism
764 ------------------------
767 foreach group in cap.damage_groups:
768 damage += cap.damage_groups[group] * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
769 * (object.armor_groups[group] / 100.0)
770 -- Where object.armor_groups[group] is 0 for inexisting values
773 Client predicts damage based on damage groups. Because of this, it is able to
774 give an immediate response when an entity is damaged or dies; the response is
775 pre-defined somehow (eg. by defining a sprite animation) (not implemented;
777 - Currently a smoke puff will appear when an entity dies.
779 The group **immortal** completely disables normal damage.
781 Entities can define a special armor group, which is **punch_operable**. This
782 group disables the regular damage mechanism for players punching it by hand or
783 a non-tool item, so that it can do something else than take damage.
785 On the Lua side, every punch calls ''entity:on_punch(puncher,
786 time_from_last_punch, tool_capabilities, direction)''. This should never be
787 called directly, because damage is usually not handled by the entity itself.
788 * ''puncher'' is the object performing the punch. Can be nil. Should never be
789 accessed unless absolutely required, to encourage interoperability.
790 * ''time_from_last_punch'' is time from last punch (by puncher) or nil.
791 * ''tool_capabilities'' can be nil.
792 * ''direction'' is a unit vector, pointing from the source of the punch to
795 To punch an entity/object in Lua, call ''object:punch(puncher,
796 time_from_last_punch, tool_capabilities, direction)''.
797 * Return value is tool wear.
798 * Parameters are equal to the above callback.
799 * If ''direction'' is nil and ''puncher'' is not nil, ''direction'' will be
800 automatically filled in based on the location of ''puncher''.
804 The instance of a node in the world normally only contains the three values
805 mentioned in "Nodes". However, it is possible to insert extra data into a
806 node. It is called "node metadata"; See "NodeMetaRef".
808 Metadata contains two things:
812 Some of the values in the key-value store are handled specially:
813 - formspec: Defines a right-click inventory menu. See "Formspec".
814 - infotext: Text shown on the screen when the node is pointed at
818 local meta = minetest.get_meta(pos)
819 meta:set_string("formspec",
821 "list[context;main;0,0;8,4;]"..
822 "list[current_player;main;0,5;8,4;]")
823 meta:set_string("infotext", "Chest");
824 local inv = meta:get_inventory()
825 inv:set_size("main", 8*4)
826 print(dump(meta:to_table()))
829 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] = ""}
832 formspec = "invsize[8,9;]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
839 Formspec defines a menu. Currently not much else than inventories are
840 supported. It is a string, with a somewhat strange format.
842 Spaces and newlines can be inserted between the blocks, as is used in the
848 list[context;main;0,0;8,4;]
849 list[current_player;main;0,5;8,4;]
852 list[context;fuel;2,3;1,1;]
853 list[context;src;2,1;1,1;]
854 list[context;dst;5,1;2,2;]
855 list[current_player;main;0,5;8,4;]
856 - Minecraft-like player inventory
858 image[1,0.6;1,2;player.png]
859 list[current_player;main;0,3.5;8,4;]
860 list[current_player;craft;3,0;3,3;]
861 list[current_player;craftpreview;7,1;1,1;]
866 ^ Define the size of the menu in inventory slots
867 ^ deprecated: invsize[<W>,<H>;]
869 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]
870 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]
871 ^ Show an inventory list
873 image[<X>,<Y>;<W>,<H>;<texture name>]
875 ^ Position and size units are inventory slots
877 item_image[<X>,<Y>;<W>,<H>;<item name>]
878 ^ Show an inventory image of registered item/node
879 ^ Position and size units are inventory slots
881 background[<X>,<Y>;<W>,<H>;<texture name>]
882 ^ Use a background. Inventory rectangles are not drawn then.
883 ^ Position and size units are inventory slots
884 ^ Example for formspec 8x4 in 16x resolution: image shall be sized 8*16px x 4*16px
886 field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
887 ^ Textual field; will be sent to server when a button is clicked
888 ^ x and y position the field relative to the top left of the menu
889 ^ w and h are the size of the field
890 ^ fields are a set height, but will be vertically centred on h
891 ^ Position and size units are inventory slots
892 ^ name is the name of the field as returned in fields to on_receive_fields
893 ^ label, if not blank, will be text printed on the top left above the field
894 ^ default is the default value of the field
895 ^ default may contain variable references such as '${text}' which
896 will fill the value from the metadata value 'text'
897 ^ Note: no extra text or more than a single variable is supported ATM.
899 field[<name>;<label>;<default>]
900 ^ as above but without position/size units
901 ^ special field for creating simple forms, such as sign text input
902 ^ must be used without a size[] element
903 ^ a 'Proceed' button will be added automatically
905 textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
906 ^ same as fields above, but with multi-line input
908 label[<X>,<Y>;<label>]
909 ^ x and y work as per field
910 ^ label is the text on the label
911 ^ Position and size units are inventory slots
913 button[<X>,<Y>;<W>,<H>;<name>;<label>]
914 ^ Clickable button. When clicked, fields will be sent.
915 ^ x, y and name work as per field
916 ^ w and h are the size of the button
917 ^ label is the text on the button
918 ^ Position and size units are inventory slots
920 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
921 ^ x, y, w, h, and name work as per button
922 ^ image is the filename of an image
923 ^ Position and size units are inventory slots
925 item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]
926 ^ x, y, w, h, name and label work as per button
927 ^ item name is the registered name of an item/node,
928 tooltip will be made out of its descritption
929 ^ Position and size units are inventory slots
931 button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]
932 ^ When clicked, fields will be sent and the form will quit.
934 image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
935 ^ When clicked, fields will be sent and the form will quit.
939 - "context": Selected node metadata (deprecated: "current_name")
940 - "current_player": Player to whom the menu is shown
941 - "player:<name>": Any player
942 - "nodemeta:<X>,<Y>,<Z>": Any node metadata
943 - "detached:<name>": A detached inventory
947 dump2(obj, name="_", dumped={})
948 ^ Return object serialized as a string, handles reference loops
950 ^ Return object serialized as a string
951 string:split(separator)
952 ^ eg. string:split("a,b", ",") == {"a","b"}
954 ^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
955 minetest.pos_to_string({x=X,y=Y,z=Z}) -> "(X,Y,Z)"
956 ^ Convert position to a printable string
957 minetest.string_to_pos(string) -> position
958 ^ Same but in reverse
959 minetest.formspec_escape(string) -> string
960 ^ escapes characters like [, ], and \ that can not be used in formspecs
962 minetest namespace reference
963 -----------------------------
965 minetest.get_current_modname() -> string
966 minetest.get_modpath(modname) -> eg. "/home/user/.minetest/usermods/modname"
967 ^ Useful for loading additional .lua modules or static data from mod
968 minetest.get_modnames() -> list of installed mods
969 ^ Return a list of installed mods, sorted alphabetically
970 minetest.get_worldpath() -> eg. "/home/user/.minetest/world"
971 ^ Useful for storing custom data
972 minetest.is_singleplayer()
974 ^ table containing API feature flags: {foo=true, bar=true}
975 minetest.has_feature(arg) -> bool, missing_features
976 ^ arg: string or table in format {foo=true, bar=true}
977 ^ missing_features: {foo=true, bar=true}
981 ^ Always printed to stderr and logfile (print() is redirected here)
983 minetest.log(loglevel, line)
984 ^ loglevel one of "error", "action", "info", "verbose"
986 Registration functions: (Call these only at load time)
987 minetest.register_entity(name, prototype table)
988 minetest.register_abm(abm definition)
989 minetest.register_node(name, node definition)
990 minetest.register_tool(name, item definition)
991 minetest.register_craftitem(name, item definition)
992 minetest.register_alias(name, convert_to)
993 minetest.register_craft(recipe)
994 minetest.register_ore(ore definition)
995 minetest.register_decoration(decoration definition)
997 Global callback registration functions: (Call these only at load time)
998 minetest.register_globalstep(func(dtime))
999 ^ Called every server step, usually interval of 0.05s
1000 minetest.register_on_shutdown(func())
1001 ^ Called before server shutdown
1002 ^ WARNING: If the server terminates abnormally (i.e. crashes), the registered
1003 callbacks WILL LIKELY NOT BE RUN. Data should be saved at
1004 semi-frequent intervals as well as on server shutdown.
1005 minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack))
1006 ^ Called when a node has been placed
1007 ^ If return true no item is taken from itemstack
1008 ^ Not recommended; use on_construct or after_place_node in node definition
1010 minetest.register_on_dignode(func(pos, oldnode, digger))
1011 ^ Called when a node has been dug.
1012 ^ Not recommended: Use on_destruct or after_dig_node in node definition
1014 minetest.register_on_punchnode(func(pos, node, puncher))
1015 ^ Called when a node is punched
1016 minetest.register_on_generated(func(minp, maxp, blockseed))
1017 ^ Called after generating a piece of world. Modifying nodes inside the area
1018 is a bit faster than usually.
1019 minetest.register_on_newplayer(func(ObjectRef))
1020 ^ Called after a new player has been created
1021 minetest.register_on_dieplayer(func(ObjectRef))
1022 ^ Called when a player dies
1023 minetest.register_on_respawnplayer(func(ObjectRef))
1024 ^ Called when player is to be respawned
1025 ^ Called _before_ repositioning of player occurs
1026 ^ return true in func to disable regular player placement
1027 minetest.register_on_joinplayer(func(ObjectRef))
1028 ^ Called when a player joins the game
1029 minetest.register_on_leaveplayer(func(ObjectRef))
1030 ^ Called when a player leaves the game
1031 minetest.register_on_chat_message(func(name, message))
1032 ^ Called always when a player says something
1033 minetest.register_on_player_receive_fields(func(player, formname, fields))
1034 ^ Called when a button is pressed in player's inventory form
1035 ^ Newest functions are called first
1036 ^ If function returns true, remaining functions are not called
1037 minetest.register_on_mapgen_init(func(MapgenParams))
1038 ^ Called just before the map generator is initialized but before the environment is initialized
1039 ^ MapgenParams consists of a table with the fields mgname, seed, water_level, and flags
1041 Other registration functions:
1042 minetest.register_chatcommand(cmd, chatcommand definition)
1043 minetest.register_privilege(name, definition)
1044 ^ definition: "description text"
1046 description = "description text",
1047 give_to_singleplayer = boolean, -- default: true
1049 minetest.register_authentication_handler(handler)
1050 ^ See minetest.builtin_auth_handler in builtin.lua for reference
1053 minetest.setting_set(name, value)
1054 minetest.setting_get(name) -> string or nil
1055 minetest.setting_getbool(name) -> boolean value or nil
1056 minetest.setting_get_pos(name) -> position or nil
1057 minetest.setting_save() -> nil, save all settings to config file
1060 minetest.notify_authentication_modified(name)
1061 ^ Should be called by the authentication handler if privileges change.
1062 ^ To report everybody, set name=nil.
1063 minetest.get_password_hash(name, raw_password)
1064 ^ Convert a name-password pair to a password hash that minetest can use
1065 minetest.string_to_privs(str) -> {priv1=true,...}
1066 minetest.privs_to_string(privs) -> "priv1,priv2,..."
1067 ^ Convert between two privilege representations
1068 minetest.set_player_password(name, password_hash)
1069 minetest.set_player_privs(name, {priv1=true,...})
1070 minetest.get_player_privs(name) -> {priv1=true,...}
1071 minetest.auth_reload()
1072 ^ These call the authentication handler
1073 minetest.check_player_privs(name, {priv1=true,...}) -> bool, missing_privs
1074 ^ A quickhand for checking privileges
1075 minetest.get_player_ip(name) -> IP address string
1078 minetest.chat_send_all(text)
1079 minetest.chat_send_player(name, text, prepend)
1080 ^ prepend: optional, if it is set to false "Server -!- " will not be prepended to the message
1084 minetest.set_node(pos, node)
1085 minetest.add_node(pos, node): alias set_node(pos, node)
1086 ^ Set node at position (node = {name="foo", param1=0, param2=0})
1087 minetest.remove_node(pos)
1088 ^ Equivalent to set_node(pos, "air")
1089 minetest.get_node(pos)
1090 ^ Returns {name="ignore", ...} for unloaded area
1091 minetest.get_node_or_nil(pos)
1092 ^ Returns nil for unloaded area
1093 minetest.get_node_light(pos, timeofday) -> 0...15 or nil
1094 ^ timeofday: nil = current time, 0 = night, 0.5 = day
1096 minetest.place_node(pos, node)
1097 ^ Place node with the same effects that a player would cause
1098 minetest.dig_node(pos)
1099 ^ Dig node with the same effects that a player would cause
1100 minetest.punch_node(pos)
1101 ^ Punch node with the same effects that a player would cause
1103 minetest.get_meta(pos) -- Get a NodeMetaRef at that position
1104 minetest.get_node_timer(pos) -- Get NodeTimerRef
1106 minetest.add_entity(pos, name): Spawn Lua-defined entity at position
1107 ^ Returns ObjectRef, or nil if failed
1108 minetest.add_item(pos, item): Spawn item
1109 ^ Returns ObjectRef, or nil if failed
1110 minetest.get_player_by_name(name) -- Get an ObjectRef to a player
1111 minetest.get_objects_inside_radius(pos, radius)
1112 minetest.set_timeofday(val): val: 0...1; 0 = midnight, 0.5 = midday
1113 minetest.get_timeofday()
1114 minetest.find_node_near(pos, radius, nodenames) -> pos or nil
1115 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1116 minetest.find_nodes_in_area(minp, maxp, nodenames) -> list of positions
1117 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1118 minetest.get_perlin(seeddiff, octaves, persistence, scale)
1119 ^ Return world-specific perlin noise (int(worldseed)+seeddiff)
1120 minetest.get_voxel_manip()
1121 ^ Return voxel manipulator object
1122 minetest.get_mapgen_object(objectname)
1123 ^ Return requested mapgen object if available (see Mapgen objects)
1124 minetest.set_mapgen_params(MapgenParams)
1125 ^ Set map generation parameters
1126 ^ Function cannot be called after the registration period; only initialization and on_mapgen_init
1127 ^ Takes a table as an argument with the fields mgname, seed, water_level, flags, and flagmask.
1128 ^ Leave field unset to leave that parameter unchanged
1129 ^ flagmask field must be set to all mapgen flags that are being modified
1130 ^ flags contains only the flags that are being set
1131 ^ flags and flagmask are in the same format and have the same options as 'mgflags' in minetest.conf
1132 minetest.clear_objects()
1133 ^ clear all objects in the environments
1134 minetest.line_of_sight(pos1,pos2,stepsize) ->true/false
1135 ^ checkif there is a direct line of sight between pos1 and pos2
1136 ^ pos1 First position
1137 ^ pos2 Second position
1138 ^ stepsize smaller gives more accurate results but requires more computing
1140 minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)
1141 ^ -> table containing path
1142 ^ returns a table of 3d points representing a path from pos1 to pos2 or nil
1143 ^ pos1: start position
1144 ^ pos2: end position
1145 ^ searchdistance: number of blocks to search in each direction
1146 ^ max_jump: maximum height difference to consider walkable
1147 ^ max_drop: maximum height difference to consider droppable
1148 ^ algorithm: A*_noprefetch(default), A*, Dijkstra
1149 minetest.spawn_tree (pos, {treedef})
1150 ^ spawns L-System tree at given pos with definition in treedef table
1153 minetest.get_inventory(location) -> InvRef
1154 ^ location = eg. {type="player", name="celeron55"}
1155 {type="node", pos={x=, y=, z=}}
1156 {type="detached", name="creative"}
1157 minetest.create_detached_inventory(name, callbacks) -> InvRef
1158 ^ callbacks: See "Detached inventory callbacks"
1159 ^ Creates a detached inventory. If it already exists, it is cleared.
1160 minetest.show_formspec(playername, formname, formspec)
1161 ^ playername: name of player to show formspec
1162 ^ formname: name passed to on_player_receive_fields callbacks
1163 ^ should follow "modname:<whatever>" naming convention
1164 ^ formspec: formspec to display
1167 minetest.inventorycube(img1, img2, img3)
1168 ^ Returns a string for making an image of a cube (useful as an item image)
1169 minetest.get_pointed_thing_position(pointed_thing, above)
1170 ^ Get position of a pointed_thing (that you can get from somewhere)
1171 minetest.dir_to_facedir(dir)
1172 ^ Convert a vector to a facedir value, used in param2 for paramtype2="facedir"
1173 minetest.dir_to_wallmounted(dir)
1174 ^ Convert a vector to a wallmounted value, used for paramtype2="wallmounted"
1175 minetest.get_node_drops(nodename, toolname)
1176 ^ Returns list of item names.
1177 ^ Note: This will be removed or modified in a future version.
1178 minetest.get_craft_result(input) -> output, decremented_input
1179 ^ input.method = 'normal' or 'cooking' or 'fuel'
1180 ^ input.width = for example 3
1181 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
1182 stack 5, stack 6, stack 7, stack 8, stack 9 }
1183 ^ output.item = ItemStack, if unsuccessful: empty ItemStack
1184 ^ output.time = number, if unsuccessful: 0
1185 ^ decremented_input = like input
1186 minetest.get_craft_recipe(output) -> input
1187 ^ returns last registered recipe for output item (node)
1188 ^ output is a node or item type such as 'default:torch'
1189 ^ input.method = 'normal' or 'cooking' or 'fuel'
1190 ^ input.width = for example 3
1191 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
1192 stack 5, stack 6, stack 7, stack 8, stack 9 }
1193 ^ input.items = nil if no recipe found
1194 minetest.get_all_craft_recipes(query item) -> table or nil
1195 ^ returns indexed table with all registered recipes for query item (node)
1196 or nil if no recipe was found
1199 method = 'normal' or 'cooking' or 'fuel'
1200 width = 0-3, 0 means shapeless recipe
1201 items = indexed [1-9] table with recipe items
1202 output = string with item name and quantity
1204 Example query for default:gold_ingot will return table:
1206 1={type = "cooking", width = 3, output = "default:gold_ingot",
1207 items = {1 = "default:gold_lump"}},
1208 2={type = "normal", width = 1, output = "default:gold_ingot 9",
1209 items = {1 = "default:goldblock"}}
1211 minetest.handle_node_drops(pos, drops, digger)
1212 ^ drops: list of itemstrings
1213 ^ Handles drops from nodes after digging: Default action is to put them into
1215 ^ Can be overridden to get different functionality (eg. dropping items on
1219 minetest.rollback_get_last_node_actor(p, range, seconds) -> actor, p, seconds
1220 ^ Find who has done something to a node, or near a node
1221 ^ actor: "player:<name>", also "liquid".
1222 minetest.rollback_revert_actions_by(actor, seconds) -> bool, log messages
1223 ^ Revert latest actions of someone
1224 ^ actor: "player:<name>", also "liquid".
1226 Defaults for the on_* item definition functions:
1227 (These return the leftover itemstack)
1228 minetest.item_place_node(itemstack, placer, pointed_thing)
1229 ^ Place item as a node
1230 minetest.item_place_object(itemstack, placer, pointed_thing)
1232 minetest.item_place(itemstack, placer, pointed_thing)
1233 ^ Use one of the above based on what the item is.
1234 ^ Calls on_rightclick of pointed_thing.under if defined instead
1235 ^ Note: is not called when wielded item overrides on_place
1236 minetest.item_drop(itemstack, dropper, pos)
1238 minetest.item_eat(hp_change, replace_with_item)
1239 ^ Eat the item. replace_with_item can be nil.
1241 Defaults for the on_punch and on_dig node definition callbacks:
1242 minetest.node_punch(pos, node, puncher)
1243 ^ Calls functions registered by minetest.register_on_punchnode()
1244 minetest.node_dig(pos, node, digger)
1245 ^ Checks if node can be dug, puts item into inventory, removes node
1246 ^ Calls functions registered by minetest.registered_on_dignodes()
1249 minetest.sound_play(spec, parameters) -> handle
1250 ^ spec = SimpleSoundSpec
1251 ^ parameters = sound parameter table
1252 minetest.sound_stop(handle)
1255 minetest.after(time, func, ...)
1256 ^ Call function after time seconds
1257 ^ Optional: Variable number of arguments that are passed to func
1260 minetest.request_shutdown() -> request for server shutdown
1261 minetest.get_server_status() -> server status string
1264 minetest.get_ban_list() -> ban list (same as minetest.get_ban_description(""))
1265 minetest.get_ban_description(ip_or_name) -> ban description (string)
1266 minetest.ban_player(name) -> ban a player
1267 minetest.unban_player_or_ip(name) -> unban player or IP address
1270 minetest.add_particle(pos, velocity, acceleration, expirationtime,
1271 size, collisiondetection, texture, playername)
1272 ^ Spawn particle at pos with velocity and acceleration
1273 ^ Disappears after expirationtime seconds
1274 ^ collisiondetection: if true collides with physical objects
1275 ^ Uses texture (string)
1276 ^ Playername is optional, if specified spawns particle only on the player's client
1278 minetest.add_particlespawner(amount, time,
1282 minexptime, maxexptime,
1284 collisiondetection, texture, playername)
1285 ^ Add a particlespawner, an object that spawns an amount of particles over time seconds
1286 ^ The particle's properties are random values in between the boundings:
1287 ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
1288 ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
1289 ^ collisiondetection: if true uses collisiondetection
1290 ^ Uses texture (string)
1291 ^ Playername is optional, if specified spawns particle only on the player's client
1292 ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
1295 minetest.delete_particlespawner(id, player)
1296 ^ Delete ParticleSpawner with id (return value from add_particlespawner)
1297 ^ If playername is specified, only deletes on the player's client,
1298 ^ otherwise on all clients
1301 minetest.create_schematic(p1, p2, probability_list, filename)
1302 ^ Create a schematic from the volume of map specified by the box formed by p1 and p2.
1303 ^ Apply the specified probability values to the specified nodes in probability_list.
1304 ^ probability_list is an array of tables containing two fields, pos and prob.
1305 ^ pos is the 3d vector specifying the absolute coordinates of the node being modified,
1306 ^ and prob is the integer value from -1 to 255 of the probability (see: Schematic specifier).
1307 ^ If there are two or more entries with the same pos value, the last occuring in the array is used.
1308 ^ If pos is not inside the box formed by p1 and p2, it is ignored.
1309 ^ If probability_list is nil, no probabilities are applied.
1310 ^ Saves schematic in the Minetest Schematic format to filename.
1312 minetest.place_schematic(pos, schematic, rotation)
1313 ^ Place the schematic specified by schematic (see: Schematic specifier) at pos.
1314 ^ Rotation can be "0", "90", "180", "270", or "random".
1315 ^ If the rotation parameter is omitted, the schematic is not rotated.
1318 minetest.get_connected_players() -> list of ObjectRefs
1319 minetest.hash_node_position({x=,y=,z=}) -> 48-bit integer
1320 ^ Gives a unique hash number for a node position (16+16+16=48bit)
1321 minetest.get_item_group(name, group) -> rating
1322 ^ Get rating of a group of an item. (0 = not in group)
1323 minetest.get_node_group(name, group) -> rating
1324 ^ Deprecated: An alias for the former.
1325 minetest.get_content_id(name) -> integer
1326 ^ Gets the internal content ID of name
1327 minetest.get_name_from_content_id(content_id) -> string
1328 ^ Gets the name of the content with that content ID
1329 minetest.serialize(table) -> string
1330 ^ Convert a table containing tables, strings, numbers, booleans and nils
1331 into string form readable by minetest.deserialize
1332 ^ Example: serialize({foo='bar'}) -> 'return { ["foo"] = "bar" }'
1333 minetest.deserialize(string) -> table
1334 ^ Convert a string returned by minetest.deserialize into a table
1335 ^ String is loaded in an empty sandbox environment.
1336 ^ Will load functions, but they cannot access the global environment.
1337 ^ Example: deserialize('return { ["foo"] = "bar" }') -> {foo='bar'}
1338 ^ Example: deserialize('print("foo")') -> nil (function call fails)
1339 ^ error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)
1342 minetest.env - EnvRef of the server environment and world.
1343 ^ Any function in the minetest namespace can be called using the syntax
1344 minetest.env:somefunction(somearguments)
1346 minetest.somefunction(somearguments)
1347 ^ Deprecated, but support is not to be dropped soon
1350 minetest.registered_items
1351 ^ List of registered items, indexed by name
1352 minetest.registered_nodes
1353 ^ List of registered node definitions, indexed by name
1354 minetest.registered_craftitems
1355 ^ List of registered craft item definitions, indexed by name
1356 minetest.registered_tools
1357 ^ List of registered tool definitions, indexed by name
1358 minetest.registered_entities
1359 ^ List of registered entity prototypes, indexed by name
1360 minetest.object_refs
1361 ^ List of object references, indexed by active object id
1362 minetest.luaentities
1363 ^ List of lua entities, indexed by active object id
1367 NodeMetaRef: Node metadata - reference extra data and functionality stored
1369 - Can be gotten via minetest.get_nodemeta(pos)
1371 - set_string(name, value)
1373 - set_int(name, value)
1375 - set_float(name, value)
1377 - get_inventory() -> InvRef
1378 - to_table() -> nil or {fields = {...}, inventory = {list1 = {}, ...}}
1379 - from_table(nil or {})
1380 ^ See "Node Metadata"
1382 NodeTimerRef: Node Timers - a high resolution persistent per-node timer
1383 - Can be gotten via minetest.get_node_timer(pos)
1385 - set(timeout,elapsed)
1386 ^ set a timer's state
1387 ^ timeout is in seconds, and supports fractional values (0.1 etc)
1388 ^ elapsed is in seconds, and supports fractional values (0.1 etc)
1389 ^ will trigger the node's on_timer function after timeout-elapsed seconds
1392 ^ equivelent to set(timeout,0)
1395 - get_timeout() -> current timeout in seconds
1396 ^ if timeout is 0, timer is inactive
1397 - get_elapsed() -> current elapsed time in seconds
1398 ^ the node's on_timer function will be called after timeout-elapsed seconds
1399 - is_started() -> boolean state of timer
1400 ^ returns true if timer is started, otherwise false
1402 ObjectRef: Moving things in the game are generally these
1403 (basically reference to a C++ ServerActiveObject)
1405 - remove(): remove object (after returning from Lua)
1406 - getpos() -> {x=num, y=num, z=num}
1407 - setpos(pos); pos={x=num, y=num, z=num}
1408 - moveto(pos, continuous=false): interpolated move
1409 - punch(puncher, time_from_last_punch, tool_capabilities, direction)
1410 ^ puncher = an another ObjectRef,
1411 ^ time_from_last_punch = time since last punch action of the puncher
1412 ^ direction: can be nil
1413 - right_click(clicker); clicker = an another ObjectRef
1414 - get_hp(): returns number of hitpoints (2 * number of hearts)
1415 - set_hp(hp): set number of hitpoints (2 * number of hearts)
1416 - get_inventory() -> InvRef
1417 - get_wield_list(): returns the name of the inventory list the wielded item is in
1418 - get_wield_index(): returns the index of the wielded item
1419 - get_wielded_item() -> ItemStack
1420 - set_wielded_item(item): replaces the wielded item, returns true if successful
1421 - set_armor_groups({group1=rating, group2=rating, ...})
1422 - set_animation({x=1,y=1}, frame_speed=15, frame_blend=0)
1423 - set_attach(parent, bone, position, rotation)
1425 ^ position = {x=num, y=num, z=num} (relative)
1426 ^ rotation = {x=num, y=num, z=num}
1428 - set_bone_position(bone, position, rotation)
1430 ^ position = {x=num, y=num, z=num} (relative)
1431 ^ rotation = {x=num, y=num, z=num}
1432 - set_properties(object property table)
1433 LuaEntitySAO-only: (no-op for other objects)
1434 - setvelocity({x=num, y=num, z=num})
1435 - getvelocity() -> {x=num, y=num, z=num}
1436 - setacceleration({x=num, y=num, z=num})
1437 - getacceleration() -> {x=num, y=num, z=num}
1439 - getyaw() -> radians
1440 - settexturemod(mod)
1441 - setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
1442 - select_horiz_by_yawpitch=false)
1443 ^ Select sprite from spritesheet with optional animation and DM-style
1444 texture selection based on yaw relative to camera
1445 - get_entity_name() (DEPRECATED: Will be removed in a future version)
1447 Player-only: (no-op for other objects)
1448 - is_player(): true for players, false for others
1449 - get_player_name(): returns "" if is not a player
1450 - get_look_dir(): get camera direction as a unit vector
1451 - get_look_pitch(): pitch in radians
1452 - get_look_yaw(): yaw in radians (wraps around pretty randomly as of now)
1453 - set_look_pitch(radians): sets look pitch
1454 - set_look_yaw(radians): sets look yaw
1455 - set_inventory_formspec(formspec)
1456 ^ Redefine player's inventory form
1457 ^ Should usually be called in on_joinplayer
1458 - get_inventory_formspec() -> formspec string
1459 - get_player_control(): returns table with player pressed keys
1460 {jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}
1461 - get_player_control_bits(): returns integer with bit packed player pressed keys
1462 bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
1463 - set_physics_override(speed, jump, gravity)
1464 modifies per-player walking speed, jump height, and gravity.
1465 Values default to 1 and act as offsets to the physics settings
1466 in minetest.conf. nil will keep the current setting.
1467 - hud_add(hud definition): add a HUD element described by HUD def, returns ID number on success
1468 - hud_remove(id): remove the HUD element of the specified id
1469 - hud_change(id, stat, value): change a value of a previously added HUD element
1470 ^ element stat values: position, name, scale, text, number, item, dir
1471 - hud_get(id): gets the HUD element definition structure of the specified ID
1472 - hud_set_flags(flags): sets specified HUD flags to true/false
1473 ^ flags: (is visible) hotbar, healthbar, crosshair, wielditem
1474 ^ pass a table containing a true/false value of each flag to be set or unset
1475 ^ if a flag is nil, the flag is not modified
1476 - hud_set_hotbar_itemcount(count): sets number of items in builtin hotbar
1477 ^ count: number of items, must be between 1 and 23
1479 InvRef: Reference to an inventory
1481 - is_empty(listname): return true if list is empty
1482 - get_size(listname): get size of a list
1483 - set_size(listname, size): set size of a list
1484 - get_width(listname): get width of a list
1485 - set_width(listname, width): set width of list; currently used for crafting
1486 - get_stack(listname, i): get a copy of stack index i in list
1487 - set_stack(listname, i, stack): copy stack to index i in list
1488 - get_list(listname): return full list
1489 - set_list(listname, list): set full list (size will not change)
1490 - add_item(listname, stack): add item somewhere in list, returns leftover ItemStack
1491 - room_for_item(listname, stack): returns true if the stack of items
1492 can be fully added to the list
1493 - contains_item(listname, stack): returns true if the stack of items
1494 can be fully taken from the list
1495 remove_item(listname, stack): take as many items as specified from the list,
1496 returns the items that were actually removed (as an ItemStack)
1497 - get_location() -> location compatible to minetest.get_inventory(location)
1498 -> {type="undefined"} in case location is not known
1500 ItemStack: A stack of items.
1501 - Can be created via ItemStack(itemstack or itemstring or table or nil)
1503 - is_empty(): return true if stack is empty
1504 - get_name(): returns item name (e.g. "default:stone")
1505 - get_count(): returns number of items on the stack
1506 - get_wear(): returns tool wear (0-65535), 0 for non-tools
1507 - get_metadata(): returns metadata (a string attached to an item stack)
1508 - clear(): removes all items from the stack, making it empty
1509 - replace(item): replace the contents of this stack (item can also
1510 be an itemstring or table)
1511 - to_string(): returns the stack in itemstring form
1512 - to_table(): returns the stack in Lua table form
1513 - get_stack_max(): returns the maximum size of the stack (depends on the item)
1514 - get_free_space(): returns get_stack_max() - get_count()
1515 - is_known(): returns true if the item name refers to a defined item type
1516 - get_definition(): returns the item definition table
1517 - get_tool_capabilities(): returns the digging properties of the item,
1518 ^ or those of the hand if none are defined for this item type
1519 - add_wear(amount): increases wear by amount if the item is a tool
1520 - add_item(item): put some item or stack onto this stack,
1521 ^ returns leftover ItemStack
1522 - item_fits(item): returns true if item or stack can be fully added to this one
1523 - take_item(n): take (and remove) up to n items from this stack
1524 ^ returns taken ItemStack
1525 ^ if n is omitted, n=1 is used
1526 - peek_item(n): copy (don't remove) up to n items from this stack
1527 ^ returns copied ItemStack
1528 ^ if n is omitted, n=1 is used
1530 PseudoRandom: A pseudorandom number generator
1531 - Can be created via PseudoRandom(seed)
1533 - next(): return next integer random number [0...32767]
1534 - next(min, max): return next integer random number [min...max]
1535 (max - min) must be 32767 or <= 6553 due to the simple
1536 implementation making bad distribution otherwise.
1538 PerlinNoise: A perlin noise generator
1539 - Can be created via PerlinNoise(seed, octaves, persistence, scale)
1540 - Also minetest.get_perlin(seeddiff, octaves, persistence, scale)
1542 - get2d(pos) -> 2d noise value at pos={x=,y=}
1543 - get3d(pos) -> 3d noise value at pos={x=,y=,z=}
1545 PerlinNoiseMap: A fast, bulk perlin noise generator
1546 - Can be created via PerlinNoiseMap(noiseparams, size)
1547 - Also minetest.get_perlin_map(noiseparams, size)
1549 - get2dMap(pos) -> <size.x>X<size.y> 2d array of 2d noise values starting at pos={x=,y=}
1550 - get3dMap(pos) -> <size.x>X<size.y>X<size.z> 3d array of 3d noise values starting at pos={x=,y=,z=}
1551 - get2dMap_flat(pos) -> Flat <size.x * size.y> element array of 2d noise values starting at pos={x=,y=}
1552 - get3dMap_flat(pos) -> Same as get2dMap_flat, but 3d noise
1554 VoxelManip: An interface to the MapVoxelManipulator for Lua
1555 - Can be created via VoxelManip()
1556 - Also minetest.get_voxel_manip()
1558 - read_from_map(p1, p2): Reads a chunk of map from the map containing the region formed by p1 and p2.
1559 ^ returns actual emerged pmin, actual emerged pmax
1560 - write_to_map(): Writes the data loaded from the VoxelManip back to the map.
1561 ^ important: data must be set using VoxelManip:set_data before calling this
1562 - get_data(): Gets the data read into the VoxelManip object
1563 ^ returns raw node data is in the form of an array of node content ids
1564 - set_data(data): Sets the data contents of the VoxelManip object
1565 - update_map(): Update map after writing chunk back to map.
1566 ^ To be used only by VoxelManip objects created by the mod itself; not a VoxelManip that was
1567 ^ retrieved from minetest.get_mapgen_object
1568 - set_lighting(light): Set the lighting within the VoxelManip
1569 ^ light is a table, {day=<0...15>, night=<0...15>}
1570 ^ To be used only by a VoxelManip object from minetest.get_mapgen_object
1571 - calc_lighting(): Calculate lighting within the VoxelManip
1572 ^ To be used only by a VoxelManip object from minetest.get_mapgen_object
1573 - update_liquids(): Update liquid flow
1575 VoxelArea: A helper class for voxel areas
1576 - Can be created via VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}
1577 - Coordinates are *inclusive*, like most other things in Minetest
1579 - getExtent(): returns a 3d vector containing the size of the area formed by MinEdge and MaxEdge
1580 - getVolume(): returns the volume of the area formed by MinEdge and MaxEdge
1581 - index(x, y, z): returns the index of an absolute position in a flat array starting at 1
1582 ^ useful for things like VoxelManip, raw Schematic specifiers, PerlinNoiseMap:get2d/3dMap, and so on
1583 - indexp(p): same as above, except takes a vector
1587 A mapgen object is a construct used in map generation. Mapgen objects can be used by an on_generate
1588 callback to speed up operations by avoiding unnecessary recalculations; these can be retrieved using the
1589 minetest.get_mapgen_object() function. If the requested Mapgen object is unavailable, or
1590 get_mapgen_object() was called outside of an on_generate() callback, nil is returned.
1592 The following Mapgen objects are currently available:
1595 This returns three values; the VoxelManip object to be used, minimum and maximum emerged position, in that
1596 order. All mapgens support this object.
1599 Returns an array containing the y coordinates of the ground levels of nodes in the most recently
1600 generated chunk by the current mapgen.
1603 Returns an array containing the biome IDs of nodes in the most recently generated chunk by the
1607 Returns an array containing the temperature values of nodes in the most recently generated chunk by
1611 Returns an array containing the humidity values of nodes in the most recently generated chunk by the
1615 --------------------
1616 - Functions receive a "luaentity" as self:
1617 - It has the member .name, which is the registered name ("mod:thing")
1618 - It has the member .object, which is an ObjectRef pointing to the object
1619 - The original prototype stuff is visible directly via a metatable
1621 - on_activate(self, staticdata)
1622 ^ Called when the object is instantiated.
1623 - on_step(self, dtime)
1624 ^ Called on every server tick (dtime is usually 0.05 seconds)
1625 - on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
1626 ^ Called when somebody punches the object.
1627 ^ Note that you probably want to handle most punches using the
1628 automatic armor group system.
1629 ^ puncher: ObjectRef (can be nil)
1630 ^ time_from_last_punch: Meant for disallowing spamming of clicks (can be nil)
1631 ^ tool_capabilities: capability table of used tool (can be nil)
1632 ^ dir: unit vector of direction of punch. Always defined. Points from
1633 the puncher to the punched.
1634 - on_rightclick(self, clicker)
1635 - get_staticdata(self)
1636 ^ Should return a string that will be passed to on_activate when
1637 the object is instantiated the next time.
1642 axiom, - string initial tree axiom
1643 rules_a, - string rules set A
1644 rules_b, - string rules set B
1645 rules_c, - string rules set C
1646 rules_d, - string rules set D
1647 trunk, - string trunk node name
1648 leaves, - string leaves node name
1649 leaves2, - string secondary leaves node name
1650 leaves2_chance,- num chance (0-100) to replace leaves with leaves2
1651 angle, - num angle in deg
1652 iterations, - num max # of iterations, usually 2 -5
1653 random_level, - num factor to lower nr of iterations, usually 0 - 3
1654 trunk_type, - string single/double/crossed) type of trunk: 1 node, 2x2 nodes or 3x3 in cross shape
1655 thin_branches, - boolean true -> use thin (1 node) branches
1656 fruit, - string fruit node name
1657 fruit_chance, - num chance (0-100) to replace leaves with fruit node
1658 seed, - num random seed
1661 Key for Special L-System Symbols used in Axioms
1662 G - move forward one unit with the pen up
1663 F - move forward one unit with the pen down drawing trunks and branches
1664 f - move forward one unit with the pen down drawing leaves (100% chance)
1665 T - move forward one unit with the pen down drawing trunks only
1666 R - move forward one unit with the pen down placing fruit
1667 A - replace with rules set A
1668 B - replace with rules set B
1669 C - replace with rules set C
1670 D - replace with rules set D
1671 a - replace with rules set A, chance 90%
1672 b - replace with rules set B, chance 80%
1673 c - replace with rules set C, chance 70%
1674 d - replace with rules set D, chance 60%
1675 + - yaw the turtle right by angle parameter
1676 - - yaw the turtle left by angle parameter
1677 & - pitch the turtle down by angle parameter
1678 ^ - pitch the turtle up by angle parameter
1679 / - roll the turtle to the right by angle parameter
1680 * - roll the turtle to the left by angle parameter
1681 [ - save in stack current state info
1682 ] - recover from stack state info
1684 Example usage: spawn small apple tree
1687 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
1688 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
1689 trunk="default:tree",
1690 leaves="default:leaves",
1694 trunk_type="single",
1697 fruit="default:apple"
1699 minetest.spawn_tree(pos,apple_tree)
1709 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
1710 visual = "cube"/"sprite"/"upright_sprite"/"mesh",
1711 visual_size = {x=1, y=1},
1713 textures = {}, -- number of required textures depends on visual
1714 colors = {}, -- number of required colors depends on visual
1715 spritediv = {x=1, y=1},
1716 initial_sprite_basepos = {x=0, y=0},
1718 makes_footstep_sound = false,
1719 automatic_rotate = false,
1722 Entity definition (register_entity)
1724 (Deprecated: Everything in object properties is read directly from here)
1726 initial_properties = <initial object properties>,
1728 on_activate = function(self, staticdata, dtime_s),
1729 on_step = function(self, dtime),
1730 on_punch = function(self, hitter),
1731 on_rightclick = function(self, clicker),
1732 get_staticdata = function(self),
1733 ^ Called sometimes; the string returned is passed to on_activate when
1734 the entity is re-activated from static state
1736 # Also you can define arbitrary member variables here
1737 myvariable = whatever,
1740 ABM (ActiveBlockModifier) definition (register_abm)
1742 -- In the following two fields, also group:groupname will work.
1743 nodenames = {"default:lava_source"},
1744 neighbors = {"default:water_source", "default:water_flowing"}, -- (any of these)
1745 ^ If left out or empty, any neighbor will do
1746 interval = 1.0, -- (operation interval)
1747 chance = 1, -- (chance of trigger is 1.0/this)
1748 action = func(pos, node, active_object_count, active_object_count_wider),
1751 Item definition (register_node, register_craftitem, register_tool)
1753 description = "Steel Axe",
1754 groups = {}, -- key=name, value=rating; rating=1..3.
1755 if rating not applicable, use 1.
1756 eg. {wool=1, fluffy=3}
1757 {soil=2, outerspace=1, crumbly=1}
1758 {bendy=2, snappy=1},
1759 {hard=1, metal=1, spikes=1}
1760 inventory_image = "default_tool_steelaxe.png",
1762 wield_scale = {x=1,y=1,z=1},
1764 liquids_pointable = false,
1765 tool_capabilities = {
1766 full_punch_interval = 1.0,
1770 snappy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
1771 choppy={times={[3]=0.90}, maxwear=0.05, maxlevel=0}
1773 damage_groups = {groupname=damage},
1775 node_placement_prediction = nil,
1776 ^ If nil and item is node, prediction is made automatically
1777 ^ If nil and item is not a node, no prediction is made
1778 ^ If "" and item is anything, no prediction is made
1779 ^ Otherwise should be name of node which the client immediately places
1780 on ground when the player places the item. Server will always update
1781 actual result to client in a short moment.
1783 place = <SimpleSoundSpec>,
1786 on_place = func(itemstack, placer, pointed_thing),
1787 ^ Shall place item and return the leftover itemstack
1788 ^ default: minetest.item_place
1789 on_drop = func(itemstack, dropper, pos),
1790 ^ Shall drop item and return the leftover itemstack
1791 ^ default: minetest.item_drop
1792 on_use = func(itemstack, user, pointed_thing),
1794 ^ Function must return either nil if no item shall be removed from
1795 inventory, or an itemstack to replace the original itemstack.
1796 eg. itemstack:take_item(); return itemstack
1797 ^ Otherwise, the function is free to do what it wants.
1798 ^ The default functions handle regular use cases.
1803 - {name="image.png", animation={Tile Animation definition}}
1804 - {name="image.png", backface_culling=bool}
1805 ^ backface culling only supported in special tiles
1806 - deprecated still supported field names:
1809 Tile animation definition:
1810 - {type="vertical_frames", aspect_w=16, aspect_h=16, length=3.0}
1812 Node definition (register_node)
1814 <all fields allowed in item definitions>,
1816 drawtype = "normal", -- See "Node drawtypes"
1818 tiles = {tile definition 1, def2, def3, def4, def5, def6},
1819 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
1820 ^ List can be shortened to needed length
1821 special_tiles = {tile definition 1, Tile definition 2},
1822 ^ Special textures of node; used rarely (old field name: special_materials)
1823 ^ List can be shortened to needed length
1825 use_texture_alpha = false, -- Use texture's alpha channel
1826 post_effect_color = {a=0, r=0, g=0, b=0}, -- If player is inside node
1827 paramtype = "none", -- See "Nodes"
1828 paramtype2 = "none", -- See "Nodes"
1829 is_ground_content = false, -- Currently not used for anything
1830 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
1831 walkable = true, -- If true, objects collide with node
1832 pointable = true, -- If true, can be pointed at
1833 diggable = true, -- If false, can never be dug
1834 climbable = false, -- If true, can be climbed on (ladder)
1835 buildable_to = false, -- If true, placed nodes can replace this node
1836 drop = "", -- alternatively drop = { max_items = ..., items = { ... } }
1837 liquidtype = "none", -- "none"/"source"/"flowing"
1838 liquid_alternative_flowing = "", -- Flowing version of source liquid
1839 liquid_alternative_source = "", -- Source version of flowing liquid
1840 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
1841 liquid_renewable = true, -- Can new liquid source be created by placing
1842 drowning = true, -- Player will drown in these
1843 two or more sources nearly?
1844 light_source = 0, -- Amount of light emitted by node
1845 damage_per_second = 0, -- If player is inside node, this damage is caused
1846 node_box = {type="regular"}, -- See "Node boxes"
1847 selection_box = {type="regular"}, -- See "Node boxes"
1848 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used
1849 legacy_facedir_simple = false, -- Support maps made in and before January 2012
1850 legacy_wallmounted = false, -- Support maps made in and before January 2012
1852 footstep = <SimpleSoundSpec>,
1853 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
1854 dug = <SimpleSoundSpec>,
1855 place = <SimpleSoundSpec>,
1858 on_construct = func(pos),
1859 ^ Node constructor; always called after adding node
1860 ^ Can set up metadata and stuff like that
1862 on_destruct = func(pos),
1863 ^ Node destructor; always called before removing node
1865 after_destruct = func(pos, oldnode),
1866 ^ Node destructor; always called after removing node
1869 after_place_node = func(pos, placer, itemstack),
1870 ^ Called after constructing node when node was placed using
1871 minetest.item_place_node / minetest.place_node
1872 ^ If return true no item is taken from itemstack
1874 after_dig_node = func(pos, oldnode, oldmetadata, digger),
1875 ^ oldmetadata is in table format
1876 ^ Called after destructing node when node was dug using
1877 minetest.node_dig / minetest.dig_node
1879 can_dig = function(pos,player)
1880 ^ returns true if node can be dug, or false if not
1883 on_punch = func(pos, node, puncher),
1884 ^ default: minetest.node_punch
1885 ^ By default: does nothing
1886 on_rightclick = func(pos, node, clicker, itemstack),
1888 ^ if defined, itemstack will hold clicker's wielded item
1889 Shall return the leftover itemstack
1890 on_dig = func(pos, node, digger),
1891 ^ default: minetest.node_dig
1892 ^ By default: checks privileges, wears out tool and removes node
1894 on_timer = function(pos,elapsed),
1896 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
1897 ^ elapsed is the total time passed since the timer was started
1898 ^ return true to run the timer for another cycle with the same timeout value
1900 on_receive_fields = func(pos, formname, fields, sender),
1901 ^ fields = {name1 = value1, name2 = value2, ...}
1902 ^ Called when an UI form (eg. sign text input) returns data
1905 allow_metadata_inventory_move = func(pos, from_list, from_index,
1906 to_list, to_index, count, player),
1907 ^ Called when a player wants to move items inside the inventory
1908 ^ Return value: number of items allowed to move
1910 allow_metadata_inventory_put = func(pos, listname, index, stack, player),
1911 ^ Called when a player wants to put something into the inventory
1912 ^ Return value: number of items allowed to put
1913 ^ Return value: -1: Allow and don't modify item count in inventory
1915 allow_metadata_inventory_take = func(pos, listname, index, stack, player),
1916 ^ Called when a player wants to take something out of the inventory
1917 ^ Return value: number of items allowed to take
1918 ^ Return value: -1: Allow and don't modify item count in inventory
1920 on_metadata_inventory_move = func(pos, from_list, from_index,
1921 to_list, to_index, count, player),
1922 on_metadata_inventory_put = func(pos, listname, index, stack, player),
1923 on_metadata_inventory_take = func(pos, listname, index, stack, player),
1924 ^ Called after the actual action has happened, according to what was allowed.
1927 on_blast = func(pos, intensity),
1928 ^ intensity: 1.0 = mid range of regular TNT
1929 ^ If defined, called when an explosion touches the node, instead of
1933 Recipe for register_craft: (shaped)
1935 output = 'default:pick_stone',
1937 {'default:cobble', 'default:cobble', 'default:cobble'},
1938 {'', 'default:stick', ''},
1939 {'', 'default:stick', ''}, -- Also groups; eg. 'group:crumbly'
1941 replacements = <optional list of item pairs,
1942 replace one input item with another item on crafting>
1945 Recipe for register_craft (shapeless)
1948 output = 'mushrooms:mushroom_stew',
1951 "mushrooms:mushroom_brown",
1952 "mushrooms:mushroom_red",
1954 replacements = <optional list of item pairs,
1955 replace one input item with another item on crafting>
1958 Recipe for register_craft (tool repair)
1960 type = "toolrepair",
1961 additional_wear = -0.02,
1964 Recipe for register_craft (cooking)
1967 output = "default:glass",
1968 recipe = "default:sand",
1972 Recipe for register_craft (furnace fuel)
1975 recipe = "default:leaves",
1979 Ore definition (register_ore)
1981 ore_type = "scatter", -- See "Ore types"
1982 ore = "default:stone_with_coal",
1983 wherein = "default:stone",
1984 clust_scarcity = 8*8*8,
1985 ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
1986 ^ This value should be *MUCH* higher than your intuition might tell you!
1988 ^ Number of ores in a cluster
1990 ^ Size of the bounding box of the cluster
1991 ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
1992 height_min = -31000,
1995 ^ Attributes for this ore generation
1996 noise_threshhold = 0.5,
1997 ^ If noise is above this threshhold, ore is placed. Not needed for a uniform distribution
1998 noise_params = {offset=0, scale=1, spread={x=100, y=100, z=100}, seed=23, octaves=3, persist=0.70}
1999 ^ NoiseParams structure describing the perlin noise used for ore distribution.
2000 ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
2003 Decoration definition (register_decoration)
2005 deco_type = "simple", -- See "Decoration types"
2006 place_on = "default:dirt_with_grass",
2007 ^ Node that decoration can be placed on
2009 ^ Size of divisions made in the chunk being generated.
2010 ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
2012 ^ Ratio of the area to be uniformly filled by the decoration.
2013 ^ Used only if noise_params is not specified.
2014 noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
2015 ^ NoiseParams structure describing the perlin noise used for decoration distribution.
2016 ^ The result of this is multiplied by the 2d area of the division being decorated.
2017 biomes = {"Oceanside", "Hills", "Plains"},
2018 ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
2019 ^ and ignored if the Mapgen being used does not support biomes.
2021 ----- Simple-type parameters
2022 decoration = "default:grass",
2023 ^ The node name used as the decoration.
2024 ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
2026 ^ Number of nodes high the decoration is made.
2027 ^ If height_max is not 0, this is the lower bound of the randomly selected height.
2029 ^ Number of nodes the decoration can be at maximum.
2030 ^ If absent, the parameter 'height' is used as a constant.
2031 spawn_by = "default:water",
2032 ^ Node that the decoration only spawns next to, in a 1-node square radius.
2034 ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
2035 ^ If absent or -1, decorations occur next to any nodes.
2037 ----- Schematic-type parameters
2038 schematic = "foobar.mts",
2039 ^ If schematic is a string, it is the filepath relative to the current working directory of the
2040 ^ specified Minetest schematic file.
2041 ^ - OR -, could instead be a table containing two fields, size and data:
2043 size = {x=4, y=6, z=4},
2045 {name="cobble", param1=0, param2=0},
2046 {name="dirt_with_grass", param1=0, param2=0},
2050 ^ See 'Schematic specifier' for details.
2051 flags = "place_center_x, place_center_z",
2052 ^ Flags for schematic decorations. See 'Schematic attributes'.
2053 rotation = "90" --rotate schematic 90 degrees on placement
2054 ^ Rotation can be "0", "90", "180", "270", or "random".
2057 Chatcommand definition (register_chatcommand)
2059 params = "<name> <privilege>", -- short parameter description
2060 description = "Remove privilege from player", -- full description
2061 privs = {privs=true}, -- require the "privs" privilege to run
2062 func = function(name, param), -- called when command is run
2065 Detached inventory callbacks
2067 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
2068 ^ Called when a player wants to move items inside the inventory
2069 ^ Return value: number of items allowed to move
2071 allow_put = func(inv, listname, index, stack, player),
2072 ^ Called when a player wants to put something into the inventory
2073 ^ Return value: number of items allowed to put
2074 ^ Return value: -1: Allow and don't modify item count in inventory
2076 allow_take = func(inv, listname, index, stack, player),
2077 ^ Called when a player wants to take something out of the inventory
2078 ^ Return value: number of items allowed to take
2079 ^ Return value: -1: Allow and don't modify item count in inventory
2081 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
2082 on_put = func(inv, listname, index, stack, player),
2083 on_take = func(inv, listname, index, stack, player),
2084 ^ Called after the actual action has happened, according to what was allowed.
2088 HUD Definition (hud_add, hud_get)
2090 hud_elem_type = "image", -- see HUD element types
2091 ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
2092 position = {x=0.5, y=0.5},
2093 ^ Left corner position of element
2099 ^ Selected item in inventory. 0 for no item selected.
2101 ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
2102 alignment = {x=0, y=0},
2103 ^ See "HUD Element Types"
2104 offset = {x=0, y=0},
2105 ^ See "HUD Element Types"
projects / oweals / minetest.git / blob