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
325 paramtype2 == "leveled"
326 ^ The drawn node level is read from param2, like flowingliquid
328 Nodes can also contain extra data. See "Node Metadata".
332 There are a bunch of different looking node types. These are mostly just
333 copied from Minetest 0.3; more may be made in the future.
335 Look for examples in games/minimal or games/minetest_game.
350 - nodebox -- See below. EXPERIMENTAL
354 Node selection boxes are defined using "node boxes"
356 The "nodebox" node drawtype allows defining visual of nodes consisting of
357 arbitrary number of boxes. It allows defining stuff like stairs. Only the
358 "fixed" and "leveled" box type is supported for these.
359 ^ Please note that this is still experimental, and may be incompatibly
360 changed in the future.
362 A nodebox is defined as any of:
364 -- A normal cube; the default in most things
368 -- A fixed box (facedir param2 is used, if applicable)
370 fixed = box OR {box1, box2, ...}
373 -- A box like the selection box for torches
374 -- (wallmounted param2 is used, if applicable)
375 type = "wallmounted",
382 {x1, y1, z1, x2, y2, z2}
383 A box of a regular node would look like:
384 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
386 type = "leveled" is same as "fixed", but y2 will be automaticaly setted to level from param2
390 These tell in what manner the ore is generated.
391 All default ores are of the uniformly-distributed scatter type.
394 Randomly chooses a location and generates a cluster of ore.
395 If noise_params is specified, the ore will be placed if the 3d perlin noise at
396 that point is greater than the noise_threshhold, giving the ability to create a non-equal
399 Creates a sheet of ore in a blob shape according to the 2d perlin noise described by noise_params.
400 The relative height of the sheet can be controlled by the same perlin noise as well, by specifying
401 a non-zero 'scale' parameter in noise_params. IMPORTANT: The noise is not transformed by offset or
402 scale when comparing against the noise threshhold, but scale is used to determine relative height.
403 The height of the blob is randomly scattered, with a maximum height of clust_size.
404 clust_scarcity and clust_num_ores are ignored.
405 This is essentially an improved version of the so-called "stratus" ore seen in some unofficial mods.
406 - claylike - NOT YET IMPLEMENTED
407 Places ore if there are no more than clust_scarcity number of specified nodes within a Von Neumann
408 neighborhood of clust_size radius.
412 Currently supported flags: absheight
414 Also produce this same ore between the height range of -height_max and -height_min.
415 Useful for having ore in sky realms without having to duplicate ore entries.
419 The varying types of decorations that can be placed.
420 The default value is simple, and is currently the only type supported.
423 Creates a 1xHx1 column of a specified node (or a random node from a list, if a decoration
424 list is specified). Can specify a certain node it must spawn next to, such as water or lava,
425 for example. Can also generate a decoration of random height between a specified lower and
426 upper bound. This type of decoration is intended for placement of grass, flowers, cacti,
429 Copies a box of MapNodes from a specified schematic file (or raw description). Can specify a
430 probability of a node randomly appearing when placed. This decoration type is intended to be used
431 for multi-node sized discrete structures, such as trees, cave spikes, rocks, and so on.
435 A schematic specifier identifies a schematic by either a filename to a Minetest Schematic file (.mts)
436 or through raw data supplied through Lua, in the form of a table. This table must specify two fields:
437 - The 'size' field is a 3d vector containing the dimensions of the provided schematic.
438 - The 'data' field is a flat table of MapNodes making up the schematic, in the order of [z [y [x]]].
440 In the bulk MapNode data, param1, instead of the typical light values, instead represents the
441 probability of that node appearing in the structure.
442 When passed to minetest.create_schematic, probability is an integer value ranging from -1 to 255:
443 - A probability value of 0 means that node will always appear.
444 - A probability value of -1 means the node will never appear.
445 - If the probability value p is greater than 0, then there is a (p / 256 * 100)% chance that node
446 will appear when the schematic is placed on the map.
448 If registering a structure in the raw format, however, -1 is not a valid probability value; in order to
449 have a node that is not placed, it must be CONTENT_IGNORE (the name for which is "ignore").
451 Important note: Node aliases cannot be used for a raw schematic provided when registering as a decoration.
454 ---------------------
455 Currently supported flags: place_center_x, place_center_y, place_center_z
457 Placement of this decoration is centered along the X axis.
459 Placement of this decoration is centered along the Y axis.
461 Placement of this decoration is centered along the Z axis.
465 The position field is used for all element types.
466 To account for differing resolutions, the position coordinates are the percentage of the screen,
467 ranging in value from 0 to 1.
468 The name field is not yet used, but should contain a description of what the HUD element represents.
469 The direction field is the direction in which something is drawn.
470 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.
471 The alignment field specifies how the item will be aligned. It ranges from -1 to 1,
472 with 0 being the center, -1 is moved to the left/up, and 1 is to the right/down. Fractional
474 The offset field specifies a pixel offset from the position. Contrary to position,
475 the offset is not scaled to screen size. This allows for some precisely-positioned
477 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
479 Note: Future revisions to the HUD API may be incompatible; the HUD API is still in the experimental stages.
482 Displays an image on the HUD.
483 - scale: The scale of the image, with 1 being the original texture size.
484 Only the X coordinate scale is used.
485 - text: The name of the texture that is displayed.
486 - alignment: The alignment of the image.
487 - offset: offset in pixels from position.
489 Displays text on the HUD.
490 - scale: Defines the bounding rectangle of the text.
491 A value such as {x=100, y=100} should work.
492 - text: The text to be displayed in the HUD element.
493 - number: An integer containing the RGB value of the color used to draw the text.
494 Specify 0xFFFFFF for white text, 0xFF0000 for red, and so on.
495 - alignment: The alignment of the text.
496 - offset: offset in pixels from position.
498 Displays a horizontal bar made up of half-images.
499 - text: The name of the texture that is used.
500 - number: The number of half-textures that are displayed.
501 If odd, will end with a vertically center-split texture.
503 - offset: offset in pixels from position.
505 - text: The name of the inventory list to be displayed.
506 - number: Number of items in the inventory to be displayed.
507 - item: Position of item that is selected.
510 Representations of simple things
511 --------------------------------
513 {x=num, y=num, z=num}
514 For helper functions see "Vector helpers".
518 {type="node", under=pos, above=pos}
519 {type="object", ref=ObjectRef}
523 Node (register_node):
524 A node from the world
525 Tool (register_tool):
526 A tool/weapon that can dig and damage things according to tool_capabilities
527 Craftitem (register_craftitem):
530 Items and item stacks can exist in three formats:
532 Serialized; This is called stackstring or itemstring:
534 eg. 'default:pick_wood 21323'
538 eg. {name="default:dirt", count=5, wear=0, metadata=""}
540 eg. {name="default:pick_wood", count=1, wear=21323, metadata=""}
541 ^ a wooden pick about 1/3 weared out
542 eg. {name="default:apple", count=1, wear=0, metadata=""}
546 C++ native format with many helper methods. Useful for converting between
547 formats. See the Class reference section for details.
549 When an item must be passed to a function, it can usually be in any of
554 In a number of places, there is a group table. Groups define the
555 properties of a thing (item, node, armor of entity, capabilities of
556 tool) in such a way that the engine and other mods can can interact with
557 the thing without actually knowing what the thing is.
560 - Groups are stored in a table, having the group names with keys and the
561 group ratings as values. For example:
562 groups = {crumbly=3, soil=1}
564 groups = {crumbly=2, soil=1, level=2, outerspace=1}
565 ^ A more special dirt-kind of thing
566 - Groups always have a rating associated with them. If there is no
567 useful meaning for a rating for an enabled group, it shall be 1.
568 - When not defined, the rating of a group defaults to 0. Thus when you
569 read groups, you must interpret nil and 0 as the same value, 0.
571 You can read the rating of a group for an item or a node by using
572 minetest.get_item_group(itemname, groupname)
576 Groups of items can define what kind of an item it is (eg. wool).
580 In addition to the general item things, groups are used to define whether
581 a node is destroyable and how long it takes to destroy by a tool.
585 For entities, groups are, as of now, used only for calculating damage.
586 The rating is the percentage of damage caused by tools with this damage group.
587 See "Entity damage mechanism".
589 object.get_armor_groups() -> a group-rating table (eg. {fleshy=100})
590 object.set_armor_groups({fleshy=30, cracky=80})
594 Groups in tools define which groups of nodes and entities they are
597 Groups in crafting recipes
598 ---------------------------
599 An example: Make meat soup from any meat, any water and any bowl
601 output = 'food:meat_soup_raw',
607 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
609 An another example: Make red wool from white wool and red dye
613 recipe = {'wool:white', 'group:dye,basecolor_red'},
618 - immortal: Disables the group damage system for an entity
619 - level: Can be used to give an additional sense of progression in the game.
620 - A larger level will cause eg. a weapon of a lower level make much less
621 damage, and get weared out much faster, or not be able to get drops
622 from destroyed nodes.
623 - 0 is something that is directly accessible at the start of gameplay
624 - There is no upper limit
625 - dig_immediate: (player can always pick up node without tool wear)
626 - 2: node is removed without tool wear after 0.5 seconds or so
628 - 3: node is removed without tool wear immediately (torch)
629 - disable_jump: Player (and possibly other things) cannot jump from node
630 - fall_damage_add_percent: damage speed = speed * (1 + value/100)
631 - bouncy: value is bounce speed in percent
632 - falling_node: if there is no walkable block under the node it will fall
633 - attached_node: if the node under it is not a walkable block the node will be
634 dropped as an item. If the node is wallmounted the
635 wallmounted direction is checked.
636 - soil: saplings will grow on nodes in this group
637 - connect_to_raillike: makes nodes of raillike drawtype connect to
638 other group members with same drawtype
640 Known damage and digging time defining groups
641 ----------------------------------------------
642 - crumbly: dirt, sand
643 - cracky: tough but crackable stuff like stone.
644 - snappy: something that can be cut using fine tools; eg. leaves, small
645 plants, wire, sheets of metal
646 - choppy: something that can be cut using force; eg. trees, wooden planks
647 - fleshy: Living things like animals and the player. This could imply
648 some blood effects when hitting.
649 - explody: Especially prone to explosions
650 - oddly_breakable_by_hand:
651 Can be added to nodes that shouldn't logically be breakable by the
652 hand but are. Somewhat similar to dig_immediate, but times are more
653 like {[1]=3.50,[2]=2.00,[3]=0.70} and this does not override the
654 speed of a tool if the tool can dig at a faster speed than this
655 suggests for the hand.
657 Examples of custom groups
658 --------------------------
659 Item groups are often used for defining, well, //groups of items//.
660 - meat: any meat-kind of a thing (rating might define the size or healing
661 ability or be irrelevant - it is not defined as of yet)
662 - eatable: anything that can be eaten. Rating might define HP gain in half
664 - flammable: can be set on fire. Rating might define the intensity of the
665 fire, affecting eg. the speed of the spreading of an open fire.
666 - wool: any wool (any origin, any color)
669 - heavy: anything considerably heavy
671 Digging time calculation specifics
672 -----------------------------------
673 Groups such as **crumbly**, **cracky** and **snappy** are used for this
674 purpose. Rating is 1, 2 or 3. A higher rating for such a group implies
677 The **level** group is used to limit the toughness of nodes a tool can dig
678 and to scale the digging times / damage to a greater extent.
680 ^ PLEASE DO UNDERSTAND THIS, otherwise you cannot use the system to it's
683 Tools define their properties by a list of parameters for groups. They
684 cannot dig other groups; thus it is important to use a standard bunch of
685 groups to enable interaction with tools.
688 * Full punch interval
690 * For an arbitrary list of groups:
691 * Uses (until the tool breaks)
692 * Maximum level (usually 0, 1, 2 or 3)
696 **Full punch interval**:
697 When used as a weapon, the tool will do full damage if this time is spent
698 between punches. If eg. half the time is spent, the tool will do half
701 **Maximum drop level**
702 Suggests the maximum level of node, when dug with the tool, that will drop
703 it's useful item. (eg. iron ore to drop a lump of iron).
704 - This is not automated; it is the responsibility of the node definition
708 Determines how many uses the tool has when it is used for digging a node,
709 of this group, of the maximum level. For lower leveled nodes, the use count
710 is multiplied by 3^leveldiff.
711 - uses=10, leveldiff=0 -> actual uses: 10
712 - uses=10, leveldiff=1 -> actual uses: 30
713 - uses=10, leveldiff=2 -> actual uses: 90
716 Tells what is the maximum level of a node of this group that the tool will
720 List of digging times for different ratings of the group, for nodes of the
722 * For example, as a lua table, ''times={2=2.00, 3=0.70}''. This would
723 result in the tool to be able to dig nodes that have a rating of 2 or 3
724 for this group, and unable to dig the rating 1, which is the toughest.
725 Unless there is a matching group that enables digging otherwise.
728 List of damage for groups of entities. See "Entity damage mechanism".
730 Example definition of the capabilities of a tool
731 -------------------------------------------------
732 tool_capabilities = {
733 full_punch_interval=1.5,
736 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
738 damage_groups = {fleshy=2},
741 This makes the tool be able to dig nodes that fullfill both of these:
742 - Have the **crumbly** group
743 - Have a **level** group less or equal to 2
745 Table of resulting digging times:
746 crumbly 0 1 2 3 4 <- level
752 level diff: 2 1 0 -1 -2
754 Table of resulting tool uses:
761 - At crumbly=0, the node is not diggable.
762 - At crumbly=3, the level difference digging time divider kicks in and makes
763 easy nodes to be quickly breakable.
764 - At level > 2, the node is not diggable, because it's level > maxlevel
766 Entity damage mechanism
767 ------------------------
770 foreach group in cap.damage_groups:
771 damage += cap.damage_groups[group] * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
772 * (object.armor_groups[group] / 100.0)
773 -- Where object.armor_groups[group] is 0 for inexisting values
776 Client predicts damage based on damage groups. Because of this, it is able to
777 give an immediate response when an entity is damaged or dies; the response is
778 pre-defined somehow (eg. by defining a sprite animation) (not implemented;
780 - Currently a smoke puff will appear when an entity dies.
782 The group **immortal** completely disables normal damage.
784 Entities can define a special armor group, which is **punch_operable**. This
785 group disables the regular damage mechanism for players punching it by hand or
786 a non-tool item, so that it can do something else than take damage.
788 On the Lua side, every punch calls ''entity:on_punch(puncher,
789 time_from_last_punch, tool_capabilities, direction)''. This should never be
790 called directly, because damage is usually not handled by the entity itself.
791 * ''puncher'' is the object performing the punch. Can be nil. Should never be
792 accessed unless absolutely required, to encourage interoperability.
793 * ''time_from_last_punch'' is time from last punch (by puncher) or nil.
794 * ''tool_capabilities'' can be nil.
795 * ''direction'' is a unit vector, pointing from the source of the punch to
798 To punch an entity/object in Lua, call ''object:punch(puncher,
799 time_from_last_punch, tool_capabilities, direction)''.
800 * Return value is tool wear.
801 * Parameters are equal to the above callback.
802 * If ''direction'' is nil and ''puncher'' is not nil, ''direction'' will be
803 automatically filled in based on the location of ''puncher''.
807 The instance of a node in the world normally only contains the three values
808 mentioned in "Nodes". However, it is possible to insert extra data into a
809 node. It is called "node metadata"; See "NodeMetaRef".
811 Metadata contains two things:
815 Some of the values in the key-value store are handled specially:
816 - formspec: Defines a right-click inventory menu. See "Formspec".
817 - infotext: Text shown on the screen when the node is pointed at
821 local meta = minetest.get_meta(pos)
822 meta:set_string("formspec",
824 "list[context;main;0,0;8,4;]"..
825 "list[current_player;main;0,5;8,4;]")
826 meta:set_string("infotext", "Chest");
827 local inv = meta:get_inventory()
828 inv:set_size("main", 8*4)
829 print(dump(meta:to_table()))
832 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] = ""}
835 formspec = "invsize[8,9;]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
842 Formspec defines a menu. Currently not much else than inventories are
843 supported. It is a string, with a somewhat strange format.
845 Spaces and newlines can be inserted between the blocks, as is used in the
851 list[context;main;0,0;8,4;]
852 list[current_player;main;0,5;8,4;]
855 list[context;fuel;2,3;1,1;]
856 list[context;src;2,1;1,1;]
857 list[context;dst;5,1;2,2;]
858 list[current_player;main;0,5;8,4;]
859 - Minecraft-like player inventory
861 image[1,0.6;1,2;player.png]
862 list[current_player;main;0,3.5;8,4;]
863 list[current_player;craft;3,0;3,3;]
864 list[current_player;craftpreview;7,1;1,1;]
869 ^ Define the size of the menu in inventory slots
870 ^ deprecated: invsize[<W>,<H>;]
872 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]
873 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]
874 ^ Show an inventory list
876 image[<X>,<Y>;<W>,<H>;<texture name>]
878 ^ Position and size units are inventory slots
880 item_image[<X>,<Y>;<W>,<H>;<item name>]
881 ^ Show an inventory image of registered item/node
882 ^ Position and size units are inventory slots
884 background[<X>,<Y>;<W>,<H>;<texture name>]
885 ^ Use a background. Inventory rectangles are not drawn then.
886 ^ Position and size units are inventory slots
887 ^ Example for formspec 8x4 in 16x resolution: image shall be sized 8*16px x 4*16px
889 pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]
890 ^ Textual password style field; will be sent to server when a button is clicked
891 ^ x and y position the field relative to the top left of the menu
892 ^ w and h are the size of the field
893 ^ fields are a set height, but will be vertically centred on h
894 ^ Position and size units are inventory slots
895 ^ name is the name of the field as returned in fields to on_receive_fields
896 ^ label, if not blank, will be text printed on the top left above the field
898 field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
899 ^ Textual field; will be sent to server when a button is clicked
900 ^ x and y position the field relative to the top left of the menu
901 ^ w and h are the size of the field
902 ^ fields are a set height, but will be vertically centred on h
903 ^ Position and size units are inventory slots
904 ^ name is the name of the field as returned in fields to on_receive_fields
905 ^ label, if not blank, will be text printed on the top left above the field
906 ^ default is the default value of the field
907 ^ default may contain variable references such as '${text}' which
908 will fill the value from the metadata value 'text'
909 ^ Note: no extra text or more than a single variable is supported ATM.
911 field[<name>;<label>;<default>]
912 ^ as above but without position/size units
913 ^ special field for creating simple forms, such as sign text input
914 ^ must be used without a size[] element
915 ^ a 'Proceed' button will be added automatically
917 textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
918 ^ same as fields above, but with multi-line input
920 label[<X>,<Y>;<label>]
921 ^ x and y work as per field
922 ^ label is the text on the label
923 ^ Position and size units are inventory slots
925 vertlabel[<X>,<Y>;<label>]
926 ^ Textual label drawn verticaly
927 ^ x and y work as per field
928 ^ label is the text on the label
929 ^ Position and size units are inventory slots
931 button[<X>,<Y>;<W>,<H>;<name>;<label>]
932 ^ Clickable button. When clicked, fields will be sent.
933 ^ x, y and name work as per field
934 ^ w and h are the size of the button
935 ^ label is the text on the button
936 ^ Position and size units are inventory slots
938 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
939 ^ x, y, w, h, and name work as per button
940 ^ texture name is the filename of an image
941 ^ Position and size units are inventory slots
943 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>]
944 ^ x, y, w, h, and name work as per button
945 ^ texture name is the filename of an image
946 ^ Position and size units are inventory slots
947 ^ noclip true meand imagebutton doesn't need to be within specified formsize
948 ^ drawborder draw button bodrer or not
950 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]
951 ^ x, y, w, h, and name work as per button
952 ^ texture name is the filename of an image
953 ^ Position and size units are inventory slots
954 ^ noclip true meand imagebutton doesn't need to be within specified formsize
955 ^ drawborder draw button bodrer or not
956 ^ pressed texture name is the filename of an image on pressed state
958 item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]
959 ^ x, y, w, h, name and label work as per button
960 ^ item name is the registered name of an item/node,
961 tooltip will be made out of its descritption
962 ^ Position and size units are inventory slots
964 button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]
965 ^ When clicked, fields will be sent and the form will quit.
967 image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
968 ^ When clicked, fields will be sent and the form will quit.
970 textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]
971 ^Scrollabel itemlist showing arbitrary text elements
972 ^ x and y position the itemlist relative to the top left of the menu
973 ^ w and h are the size of the itemlist
974 ^ name fieldname sent to server on doubleclick value is current selected element
975 ^ listelements can be prepended by #colorkey (see colorkeys),
976 ^ if you want a listelement to start with # write ##
978 textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]
979 ^Scrollabel itemlist showing arbitrary text elements
980 ^ x and y position the itemlist relative to the top left of the menu
981 ^ w and h are the size of the itemlist
982 ^ name fieldname sent to server on doubleclick value is current selected element
983 ^ listelements can be prepended by #RRGGBB in hexadecimal format
984 ^ if you want a listelement to start with # write ##
985 ^ index to be selected within textlist
986 ^ true/false draw transparent background
988 tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]
989 ^ show a tabHEADER at specific position (ignores formsize)
990 ^ x and y position the itemlist relative to the top left of the menu
991 ^ name fieldname data is transfered to lua
992 ^ caption 1... name shown on top of tab
993 ^ current_tab index of selected tab 1...
994 ^ transparent (optional) show transparent
995 ^ draw_border (optional) draw border
997 box[<X>,<Y>;<W>,<H>;<color>]
998 ^ simple colored semitransparent box
999 ^ x and y position the box relative to the top left of the menu
1000 ^ w and h are the size of box
1001 ^ colorkey (see colorkeys)
1003 dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]
1004 ^ show a dropdown field
1005 ^ x and y position of dropdown
1007 ^ fieldname data is transfered to lua
1008 ^ items to be shown in dropdown
1009 ^ index of currently selected dropdown item
1010 ^ color in hexadecimal format RRGGBB
1012 checkbox[<X>,<Y>;<name>;<label>;<selected>]
1014 ^ x and y position of checkbox
1015 ^ name fieldname data is transfered to lua
1016 ^ label to be shown left of checkbox
1017 ^ selected (optional) true/false
1019 Note: do NOT use a element name starting with "key_" those names are reserved to
1020 pass key press events to formspec!
1024 - "context": Selected node metadata (deprecated: "current_name")
1025 - "current_player": Player to whom the menu is shown
1026 - "player:<name>": Any player
1027 - "nodemeta:<X>,<Y>,<Z>": Any node metadata
1028 - "detached:<name>": A detached inventory
1032 vector.new([x[, y, z]]) -> vector
1033 ^ x is a table or the x position.
1034 vector.direction(p1, p2) -> vector
1035 vector.distance(p1, p2) -> number
1036 vector.length(v) -> number
1037 vector.normalize(v) -> vector
1038 vector.round(v) -> vector
1039 vector.equal(v1, v2) -> bool
1040 vector.add(v, x) -> vector
1041 ^ x can be annother vector or a number
1042 vector.subtract(v, x) -> vector
1043 vector.multiply(v, x) -> vector
1044 vector.divide(v, x) -> vector
1046 You can also use Lua operators on vectors.
1058 dump2(obj, name="_", dumped={})
1059 ^ Return object serialized as a string, handles reference loops
1060 dump(obj, dumped={})
1061 ^ Return object serialized as a string
1063 ^ Get the hypotenuse of a triangle with legs x and y.
1064 Usefull for distance calculation.
1065 string:split(separator)
1066 ^ eg. string:split("a,b", ",") == {"a","b"}
1068 ^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
1069 minetest.pos_to_string({x=X,y=Y,z=Z}) -> "(X,Y,Z)"
1070 ^ Convert position to a printable string
1071 minetest.string_to_pos(string) -> position
1072 ^ Same but in reverse
1073 minetest.formspec_escape(string) -> string
1074 ^ escapes characters like [, ], and \ that can not be used in formspecs
1076 minetest namespace reference
1077 -----------------------------
1079 minetest.get_current_modname() -> string
1080 minetest.get_modpath(modname) -> eg. "/home/user/.minetest/usermods/modname"
1081 ^ Useful for loading additional .lua modules or static data from mod
1082 minetest.get_modnames() -> list of installed mods
1083 ^ Return a list of installed mods, sorted alphabetically
1084 minetest.get_worldpath() -> eg. "/home/user/.minetest/world"
1085 ^ Useful for storing custom data
1086 minetest.is_singleplayer()
1088 ^ table containing API feature flags: {foo=true, bar=true}
1089 minetest.has_feature(arg) -> bool, missing_features
1090 ^ arg: string or table in format {foo=true, bar=true}
1091 ^ missing_features: {foo=true, bar=true}
1094 minetest.debug(line)
1095 ^ Always printed to stderr and logfile (print() is redirected here)
1097 minetest.log(loglevel, line)
1098 ^ loglevel one of "error", "action", "info", "verbose"
1100 Registration functions: (Call these only at load time)
1101 minetest.register_entity(name, prototype table)
1102 minetest.register_abm(abm definition)
1103 minetest.register_node(name, node definition)
1104 minetest.register_tool(name, item definition)
1105 minetest.register_craftitem(name, item definition)
1106 minetest.register_alias(name, convert_to)
1107 minetest.register_craft(recipe)
1108 minetest.register_ore(ore definition)
1109 minetest.register_decoration(decoration definition)
1111 Global callback registration functions: (Call these only at load time)
1112 minetest.register_globalstep(func(dtime))
1113 ^ Called every server step, usually interval of 0.05s
1114 minetest.register_on_shutdown(func())
1115 ^ Called before server shutdown
1116 ^ WARNING: If the server terminates abnormally (i.e. crashes), the registered
1117 callbacks WILL LIKELY NOT BE RUN. Data should be saved at
1118 semi-frequent intervals as well as on server shutdown.
1119 minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack))
1120 ^ Called when a node has been placed
1121 ^ If return true no item is taken from itemstack
1122 ^ Not recommended; use on_construct or after_place_node in node definition
1124 minetest.register_on_dignode(func(pos, oldnode, digger))
1125 ^ Called when a node has been dug.
1126 ^ Not recommended: Use on_destruct or after_dig_node in node definition
1128 minetest.register_on_punchnode(func(pos, node, puncher))
1129 ^ Called when a node is punched
1130 minetest.register_on_generated(func(minp, maxp, blockseed))
1131 ^ Called after generating a piece of world. Modifying nodes inside the area
1132 is a bit faster than usually.
1133 minetest.register_on_newplayer(func(ObjectRef))
1134 ^ Called after a new player has been created
1135 minetest.register_on_dieplayer(func(ObjectRef))
1136 ^ Called when a player dies
1137 minetest.register_on_respawnplayer(func(ObjectRef))
1138 ^ Called when player is to be respawned
1139 ^ Called _before_ repositioning of player occurs
1140 ^ return true in func to disable regular player placement
1141 minetest.register_on_joinplayer(func(ObjectRef))
1142 ^ Called when a player joins the game
1143 minetest.register_on_leaveplayer(func(ObjectRef))
1144 ^ Called when a player leaves the game
1145 minetest.register_on_cheat(func(ObjectRef, cheat))
1146 ^ Called when a player cheats
1147 ^ cheat: {type="moved_too_fast"/"interacted_too_far"/"finished_unknown_dig"/"dug_unbreakable"/"dug_too_fast"}
1148 minetest.register_on_chat_message(func(name, message))
1149 ^ Called always when a player says something
1150 minetest.register_on_player_receive_fields(func(player, formname, fields))
1151 ^ Called when a button is pressed in player's inventory form
1152 ^ Newest functions are called first
1153 ^ If function returns true, remaining functions are not called
1154 minetest.register_on_mapgen_init(func(MapgenParams))
1155 ^ Called just before the map generator is initialized but before the environment is initialized
1156 ^ MapgenParams consists of a table with the fields mgname, seed, water_level, and flags
1158 Other registration functions:
1159 minetest.register_chatcommand(cmd, chatcommand definition)
1160 minetest.register_privilege(name, definition)
1161 ^ definition: "description text"
1163 description = "description text",
1164 give_to_singleplayer = boolean, -- default: true
1166 minetest.register_authentication_handler(handler)
1167 ^ See minetest.builtin_auth_handler in builtin.lua for reference
1170 minetest.setting_set(name, value)
1171 minetest.setting_get(name) -> string or nil
1172 minetest.setting_getbool(name) -> boolean value or nil
1173 minetest.setting_get_pos(name) -> position or nil
1174 minetest.setting_save() -> nil, save all settings to config file
1177 minetest.notify_authentication_modified(name)
1178 ^ Should be called by the authentication handler if privileges change.
1179 ^ To report everybody, set name=nil.
1180 minetest.get_password_hash(name, raw_password)
1181 ^ Convert a name-password pair to a password hash that minetest can use
1182 minetest.string_to_privs(str) -> {priv1=true,...}
1183 minetest.privs_to_string(privs) -> "priv1,priv2,..."
1184 ^ Convert between two privilege representations
1185 minetest.set_player_password(name, password_hash)
1186 minetest.set_player_privs(name, {priv1=true,...})
1187 minetest.get_player_privs(name) -> {priv1=true,...}
1188 minetest.auth_reload()
1189 ^ These call the authentication handler
1190 minetest.check_player_privs(name, {priv1=true,...}) -> bool, missing_privs
1191 ^ A quickhand for checking privileges
1192 minetest.get_player_ip(name) -> IP address string
1195 minetest.chat_send_all(text)
1196 minetest.chat_send_player(name, text, prepend)
1197 ^ prepend: optional, if it is set to false "Server -!- " will not be prepended to the message
1201 minetest.set_node(pos, node)
1202 minetest.add_node(pos, node): alias set_node(pos, node)
1203 ^ Set node at position (node = {name="foo", param1=0, param2=0})
1204 minetest.remove_node(pos)
1205 ^ Equivalent to set_node(pos, "air")
1206 minetest.get_node(pos)
1207 ^ Returns {name="ignore", ...} for unloaded area
1208 minetest.get_node_or_nil(pos)
1209 ^ Returns nil for unloaded area
1210 minetest.get_node_light(pos, timeofday) -> 0...15 or nil
1211 ^ timeofday: nil = current time, 0 = night, 0.5 = day
1213 minetest.place_node(pos, node)
1214 ^ Place node with the same effects that a player would cause
1215 minetest.dig_node(pos)
1216 ^ Dig node with the same effects that a player would cause
1217 minetest.punch_node(pos)
1218 ^ Punch node with the same effects that a player would cause
1220 minetest.get_meta(pos) -- Get a NodeMetaRef at that position
1221 minetest.get_node_timer(pos) -- Get NodeTimerRef
1223 minetest.add_entity(pos, name): Spawn Lua-defined entity at position
1224 ^ Returns ObjectRef, or nil if failed
1225 minetest.add_item(pos, item): Spawn item
1226 ^ Returns ObjectRef, or nil if failed
1227 minetest.get_player_by_name(name) -- Get an ObjectRef to a player
1228 minetest.get_objects_inside_radius(pos, radius)
1229 minetest.set_timeofday(val): val: 0...1; 0 = midnight, 0.5 = midday
1230 minetest.get_timeofday()
1231 minetest.find_node_near(pos, radius, nodenames) -> pos or nil
1232 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1233 minetest.find_nodes_in_area(minp, maxp, nodenames) -> list of positions
1234 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1235 minetest.get_perlin(seeddiff, octaves, persistence, scale)
1236 ^ Return world-specific perlin noise (int(worldseed)+seeddiff)
1237 minetest.get_voxel_manip()
1238 ^ Return voxel manipulator object
1239 minetest.get_mapgen_object(objectname)
1240 ^ Return requested mapgen object if available (see Mapgen objects)
1241 minetest.set_mapgen_params(MapgenParams)
1242 ^ Set map generation parameters
1243 ^ Function cannot be called after the registration period; only initialization and on_mapgen_init
1244 ^ Takes a table as an argument with the fields mgname, seed, water_level, flags, and flagmask.
1245 ^ Leave field unset to leave that parameter unchanged
1246 ^ flagmask field must be set to all mapgen flags that are being modified
1247 ^ flags contains only the flags that are being set
1248 ^ flags and flagmask are in the same format and have the same options as 'mgflags' in minetest.conf
1249 minetest.clear_objects()
1250 ^ clear all objects in the environments
1251 minetest.line_of_sight(pos1,pos2,stepsize) ->true/false
1252 ^ checkif there is a direct line of sight between pos1 and pos2
1253 ^ pos1 First position
1254 ^ pos2 Second position
1255 ^ stepsize smaller gives more accurate results but requires more computing
1257 minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)
1258 ^ -> table containing path
1259 ^ returns a table of 3d points representing a path from pos1 to pos2 or nil
1260 ^ pos1: start position
1261 ^ pos2: end position
1262 ^ searchdistance: number of blocks to search in each direction
1263 ^ max_jump: maximum height difference to consider walkable
1264 ^ max_drop: maximum height difference to consider droppable
1265 ^ algorithm: A*_noprefetch(default), A*, Dijkstra
1266 minetest.spawn_tree (pos, {treedef})
1267 ^ spawns L-System tree at given pos with definition in treedef table
1268 minetest.transforming_liquid_add(pos)
1269 ^ add node to liquid update queue
1270 minetest.get_node_max_level(pos)
1271 ^ get max available level for leveled node
1272 minetest.get_node_level(pos)
1273 ^ get level of leveled node (water, snow)
1274 minetest.set_node_level(pos, level)
1275 ^ set level of leveled node, default level = 1, if totallevel > maxlevel returns rest (total-max).
1276 minetest.add_node_level(pos, level)
1277 ^ increase level of leveled node by level, default level = 1, if totallevel > maxlevel returns rest (total-max). can be negative for decreasing
1278 minetest.get_heat(pos)
1280 minetest.get_humidity(pos)
1284 minetest.get_inventory(location) -> InvRef
1285 ^ location = eg. {type="player", name="celeron55"}
1286 {type="node", pos={x=, y=, z=}}
1287 {type="detached", name="creative"}
1288 minetest.create_detached_inventory(name, callbacks) -> InvRef
1289 ^ callbacks: See "Detached inventory callbacks"
1290 ^ Creates a detached inventory. If it already exists, it is cleared.
1291 minetest.show_formspec(playername, formname, formspec)
1292 ^ playername: name of player to show formspec
1293 ^ formname: name passed to on_player_receive_fields callbacks
1294 ^ should follow "modname:<whatever>" naming convention
1295 ^ formspec: formspec to display
1298 minetest.inventorycube(img1, img2, img3)
1299 ^ Returns a string for making an image of a cube (useful as an item image)
1300 minetest.get_pointed_thing_position(pointed_thing, above)
1301 ^ Get position of a pointed_thing (that you can get from somewhere)
1302 minetest.dir_to_facedir(dir, is6d)
1303 ^ Convert a vector to a facedir value, used in param2 for paramtype2="facedir"; passing something non-nil/false for the optional second parameter causes it to take the y component into account
1304 minetest.facedir_to_dir(facedir)
1305 ^ Convert a facedir back into a vector aimed directly out the "back" of a node
1306 minetest.dir_to_wallmounted(dir)
1307 ^ Convert a vector to a wallmounted value, used for paramtype2="wallmounted"
1308 minetest.get_node_drops(nodename, toolname)
1309 ^ Returns list of item names.
1310 ^ Note: This will be removed or modified in a future version.
1311 minetest.get_craft_result(input) -> output, decremented_input
1312 ^ input.method = 'normal' or 'cooking' or 'fuel'
1313 ^ input.width = for example 3
1314 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
1315 stack 5, stack 6, stack 7, stack 8, stack 9 }
1316 ^ output.item = ItemStack, if unsuccessful: empty ItemStack
1317 ^ output.time = number, if unsuccessful: 0
1318 ^ decremented_input = like input
1319 minetest.get_craft_recipe(output) -> input
1320 ^ returns last registered recipe for output item (node)
1321 ^ output is a node or item type such as 'default:torch'
1322 ^ input.method = 'normal' or 'cooking' or 'fuel'
1323 ^ input.width = for example 3
1324 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
1325 stack 5, stack 6, stack 7, stack 8, stack 9 }
1326 ^ input.items = nil if no recipe found
1327 minetest.get_all_craft_recipes(query item) -> table or nil
1328 ^ returns indexed table with all registered recipes for query item (node)
1329 or nil if no recipe was found
1332 method = 'normal' or 'cooking' or 'fuel'
1333 width = 0-3, 0 means shapeless recipe
1334 items = indexed [1-9] table with recipe items
1335 output = string with item name and quantity
1337 Example query for default:gold_ingot will return table:
1339 1={type = "cooking", width = 3, output = "default:gold_ingot",
1340 items = {1 = "default:gold_lump"}},
1341 2={type = "normal", width = 1, output = "default:gold_ingot 9",
1342 items = {1 = "default:goldblock"}}
1344 minetest.handle_node_drops(pos, drops, digger)
1345 ^ drops: list of itemstrings
1346 ^ Handles drops from nodes after digging: Default action is to put them into
1348 ^ Can be overridden to get different functionality (eg. dropping items on
1352 minetest.rollback_get_last_node_actor(p, range, seconds) -> actor, p, seconds
1353 ^ Find who has done something to a node, or near a node
1354 ^ actor: "player:<name>", also "liquid".
1355 minetest.rollback_revert_actions_by(actor, seconds) -> bool, log messages
1356 ^ Revert latest actions of someone
1357 ^ actor: "player:<name>", also "liquid".
1359 Defaults for the on_* item definition functions:
1360 (These return the leftover itemstack)
1361 minetest.item_place_node(itemstack, placer, pointed_thing)
1362 ^ Place item as a node
1363 minetest.item_place_object(itemstack, placer, pointed_thing)
1365 minetest.item_place(itemstack, placer, pointed_thing)
1366 ^ Use one of the above based on what the item is.
1367 ^ Calls on_rightclick of pointed_thing.under if defined instead
1368 ^ Note: is not called when wielded item overrides on_place
1369 minetest.item_drop(itemstack, dropper, pos)
1371 minetest.item_eat(hp_change, replace_with_item)
1372 ^ Eat the item. replace_with_item can be nil.
1374 Defaults for the on_punch and on_dig node definition callbacks:
1375 minetest.node_punch(pos, node, puncher)
1376 ^ Calls functions registered by minetest.register_on_punchnode()
1377 minetest.node_dig(pos, node, digger)
1378 ^ Checks if node can be dug, puts item into inventory, removes node
1379 ^ Calls functions registered by minetest.registered_on_dignodes()
1382 minetest.sound_play(spec, parameters) -> handle
1383 ^ spec = SimpleSoundSpec
1384 ^ parameters = sound parameter table
1385 minetest.sound_stop(handle)
1388 minetest.after(time, func, ...)
1389 ^ Call function after time seconds
1390 ^ Optional: Variable number of arguments that are passed to func
1393 minetest.request_shutdown() -> request for server shutdown
1394 minetest.get_server_status() -> server status string
1397 minetest.get_ban_list() -> ban list (same as minetest.get_ban_description(""))
1398 minetest.get_ban_description(ip_or_name) -> ban description (string)
1399 minetest.ban_player(name) -> ban a player
1400 minetest.unban_player_or_ip(name) -> unban player or IP address
1403 minetest.add_particle(pos, velocity, acceleration, expirationtime,
1404 size, collisiondetection, texture, playername)
1405 ^ Spawn particle at pos with velocity and acceleration
1406 ^ Disappears after expirationtime seconds
1407 ^ collisiondetection: if true collides with physical objects
1408 ^ Uses texture (string)
1409 ^ Playername is optional, if specified spawns particle only on the player's client
1411 minetest.add_particlespawner(amount, time,
1415 minexptime, maxexptime,
1417 collisiondetection, texture, playername)
1418 ^ Add a particlespawner, an object that spawns an amount of particles over time seconds
1419 ^ The particle's properties are random values in between the boundings:
1420 ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
1421 ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
1422 ^ collisiondetection: if true uses collisiondetection
1423 ^ Uses texture (string)
1424 ^ Playername is optional, if specified spawns particle only on the player's client
1425 ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
1428 minetest.delete_particlespawner(id, player)
1429 ^ Delete ParticleSpawner with id (return value from add_particlespawner)
1430 ^ If playername is specified, only deletes on the player's client,
1431 ^ otherwise on all clients
1434 minetest.create_schematic(p1, p2, probability_list, filename)
1435 ^ Create a schematic from the volume of map specified by the box formed by p1 and p2.
1436 ^ Apply the specified probability values to the specified nodes in probability_list.
1437 ^ probability_list is an array of tables containing two fields, pos and prob.
1438 ^ pos is the 3d vector specifying the absolute coordinates of the node being modified,
1439 ^ and prob is the integer value from -1 to 255 of the probability (see: Schematic specifier).
1440 ^ If there are two or more entries with the same pos value, the last occuring in the array is used.
1441 ^ If pos is not inside the box formed by p1 and p2, it is ignored.
1442 ^ If probability_list is nil, no probabilities are applied.
1443 ^ Saves schematic in the Minetest Schematic format to filename.
1445 minetest.place_schematic(pos, schematic, rotation, replacements)
1446 ^ Place the schematic specified by schematic (see: Schematic specifier) at pos.
1447 ^ Rotation can be "0", "90", "180", "270", or "random".
1448 ^ If the rotation parameter is omitted, the schematic is not rotated.
1449 ^ replacements = {{"oldname", "convert_to"}, ...}
1452 minetest.get_connected_players() -> list of ObjectRefs
1453 minetest.hash_node_position({x=,y=,z=}) -> 48-bit integer
1454 ^ Gives a unique hash number for a node position (16+16+16=48bit)
1455 minetest.get_item_group(name, group) -> rating
1456 ^ Get rating of a group of an item. (0 = not in group)
1457 minetest.get_node_group(name, group) -> rating
1458 ^ Deprecated: An alias for the former.
1459 minetest.get_content_id(name) -> integer
1460 ^ Gets the internal content ID of name
1461 minetest.get_name_from_content_id(content_id) -> string
1462 ^ Gets the name of the content with that content ID
1463 minetest.serialize(table) -> string
1464 ^ Convert a table containing tables, strings, numbers, booleans and nils
1465 into string form readable by minetest.deserialize
1466 ^ Example: serialize({foo='bar'}) -> 'return { ["foo"] = "bar" }'
1467 minetest.deserialize(string) -> table
1468 ^ Convert a string returned by minetest.deserialize into a table
1469 ^ String is loaded in an empty sandbox environment.
1470 ^ Will load functions, but they cannot access the global environment.
1471 ^ Example: deserialize('return { ["foo"] = "bar" }') -> {foo='bar'}
1472 ^ Example: deserialize('print("foo")') -> nil (function call fails)
1473 ^ error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)
1476 minetest.env - EnvRef of the server environment and world.
1477 ^ Any function in the minetest namespace can be called using the syntax
1478 minetest.env:somefunction(somearguments)
1480 minetest.somefunction(somearguments)
1481 ^ Deprecated, but support is not to be dropped soon
1484 minetest.registered_items
1485 ^ List of registered items, indexed by name
1486 minetest.registered_nodes
1487 ^ List of registered node definitions, indexed by name
1488 minetest.registered_craftitems
1489 ^ List of registered craft item definitions, indexed by name
1490 minetest.registered_tools
1491 ^ List of registered tool definitions, indexed by name
1492 minetest.registered_entities
1493 ^ List of registered entity prototypes, indexed by name
1494 minetest.object_refs
1495 ^ List of object references, indexed by active object id
1496 minetest.luaentities
1497 ^ List of lua entities, indexed by active object id
1501 NodeMetaRef: Node metadata - reference extra data and functionality stored
1503 - Can be gotten via minetest.get_nodemeta(pos)
1505 - set_string(name, value)
1507 - set_int(name, value)
1509 - set_float(name, value)
1511 - get_inventory() -> InvRef
1512 - to_table() -> nil or {fields = {...}, inventory = {list1 = {}, ...}}
1513 - from_table(nil or {})
1514 ^ See "Node Metadata"
1516 NodeTimerRef: Node Timers - a high resolution persistent per-node timer
1517 - Can be gotten via minetest.get_node_timer(pos)
1519 - set(timeout,elapsed)
1520 ^ set a timer's state
1521 ^ timeout is in seconds, and supports fractional values (0.1 etc)
1522 ^ elapsed is in seconds, and supports fractional values (0.1 etc)
1523 ^ will trigger the node's on_timer function after timeout-elapsed seconds
1526 ^ equivelent to set(timeout,0)
1529 - get_timeout() -> current timeout in seconds
1530 ^ if timeout is 0, timer is inactive
1531 - get_elapsed() -> current elapsed time in seconds
1532 ^ the node's on_timer function will be called after timeout-elapsed seconds
1533 - is_started() -> boolean state of timer
1534 ^ returns true if timer is started, otherwise false
1536 ObjectRef: Moving things in the game are generally these
1537 (basically reference to a C++ ServerActiveObject)
1539 - remove(): remove object (after returning from Lua)
1540 - getpos() -> {x=num, y=num, z=num}
1541 - setpos(pos); pos={x=num, y=num, z=num}
1542 - moveto(pos, continuous=false): interpolated move
1543 - punch(puncher, time_from_last_punch, tool_capabilities, direction)
1544 ^ puncher = an another ObjectRef,
1545 ^ time_from_last_punch = time since last punch action of the puncher
1546 ^ direction: can be nil
1547 - right_click(clicker); clicker = an another ObjectRef
1548 - get_hp(): returns number of hitpoints (2 * number of hearts)
1549 - set_hp(hp): set number of hitpoints (2 * number of hearts)
1550 - get_inventory() -> InvRef
1551 - get_wield_list(): returns the name of the inventory list the wielded item is in
1552 - get_wield_index(): returns the index of the wielded item
1553 - get_wielded_item() -> ItemStack
1554 - set_wielded_item(item): replaces the wielded item, returns true if successful
1555 - set_armor_groups({group1=rating, group2=rating, ...})
1556 - set_animation({x=1,y=1}, frame_speed=15, frame_blend=0)
1557 - set_attach(parent, bone, position, rotation)
1559 ^ position = {x=num, y=num, z=num} (relative)
1560 ^ rotation = {x=num, y=num, z=num}
1562 - set_bone_position(bone, position, rotation)
1564 ^ position = {x=num, y=num, z=num} (relative)
1565 ^ rotation = {x=num, y=num, z=num}
1566 - set_properties(object property table)
1567 LuaEntitySAO-only: (no-op for other objects)
1568 - setvelocity({x=num, y=num, z=num})
1569 - getvelocity() -> {x=num, y=num, z=num}
1570 - setacceleration({x=num, y=num, z=num})
1571 - getacceleration() -> {x=num, y=num, z=num}
1573 - getyaw() -> radians
1574 - settexturemod(mod)
1575 - setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
1576 - select_horiz_by_yawpitch=false)
1577 ^ Select sprite from spritesheet with optional animation and DM-style
1578 texture selection based on yaw relative to camera
1579 - get_entity_name() (DEPRECATED: Will be removed in a future version)
1581 Player-only: (no-op for other objects)
1582 - is_player(): true for players, false for others
1583 - get_player_name(): returns "" if is not a player
1584 - get_look_dir(): get camera direction as a unit vector
1585 - get_look_pitch(): pitch in radians
1586 - get_look_yaw(): yaw in radians (wraps around pretty randomly as of now)
1587 - set_look_pitch(radians): sets look pitch
1588 - set_look_yaw(radians): sets look yaw
1589 - get_breath() : returns players breath
1590 - set_breath(value) : sets players breath
1591 values: 0 player is drowning,
1592 1-10 number of bubbles remain,
1593 11 bubbles bar is not shown
1594 - set_inventory_formspec(formspec)
1595 ^ Redefine player's inventory form
1596 ^ Should usually be called in on_joinplayer
1597 - get_inventory_formspec() -> formspec string
1598 - get_player_control(): returns table with player pressed keys
1599 {jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}
1600 - get_player_control_bits(): returns integer with bit packed player pressed keys
1601 bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
1602 - set_physics_override(speed, jump, gravity)
1603 modifies per-player walking speed, jump height, and gravity.
1604 Values default to 1 and act as offsets to the physics settings
1605 in minetest.conf. nil will keep the current setting.
1606 - hud_add(hud definition): add a HUD element described by HUD def, returns ID number on success
1607 - hud_remove(id): remove the HUD element of the specified id
1608 - hud_change(id, stat, value): change a value of a previously added HUD element
1609 ^ element stat values: position, name, scale, text, number, item, dir
1610 - hud_get(id): gets the HUD element definition structure of the specified ID
1611 - hud_set_flags(flags): sets specified HUD flags to true/false
1612 ^ flags: (is visible) hotbar, healthbar, crosshair, wielditem
1613 ^ pass a table containing a true/false value of each flag to be set or unset
1614 ^ if a flag is nil, the flag is not modified
1615 - hud_set_hotbar_itemcount(count): sets number of items in builtin hotbar
1616 ^ count: number of items, must be between 1 and 23
1618 InvRef: Reference to an inventory
1620 - is_empty(listname): return true if list is empty
1621 - get_size(listname): get size of a list
1622 - set_size(listname, size): set size of a list
1623 - get_width(listname): get width of a list
1624 - set_width(listname, width): set width of list; currently used for crafting
1625 - get_stack(listname, i): get a copy of stack index i in list
1626 - set_stack(listname, i, stack): copy stack to index i in list
1627 - get_list(listname): return full list
1628 - set_list(listname, list): set full list (size will not change)
1629 - add_item(listname, stack): add item somewhere in list, returns leftover ItemStack
1630 - room_for_item(listname, stack): returns true if the stack of items
1631 can be fully added to the list
1632 - contains_item(listname, stack): returns true if the stack of items
1633 can be fully taken from the list
1634 remove_item(listname, stack): take as many items as specified from the list,
1635 returns the items that were actually removed (as an ItemStack)
1636 - get_location() -> location compatible to minetest.get_inventory(location)
1637 -> {type="undefined"} in case location is not known
1639 ItemStack: A stack of items.
1640 - Can be created via ItemStack(itemstack or itemstring or table or nil)
1642 - is_empty(): return true if stack is empty
1643 - get_name(): returns item name (e.g. "default:stone")
1644 - get_count(): returns number of items on the stack
1645 - get_wear(): returns tool wear (0-65535), 0 for non-tools
1646 - get_metadata(): returns metadata (a string attached to an item stack)
1647 - clear(): removes all items from the stack, making it empty
1648 - replace(item): replace the contents of this stack (item can also
1649 be an itemstring or table)
1650 - to_string(): returns the stack in itemstring form
1651 - to_table(): returns the stack in Lua table form
1652 - get_stack_max(): returns the maximum size of the stack (depends on the item)
1653 - get_free_space(): returns get_stack_max() - get_count()
1654 - is_known(): returns true if the item name refers to a defined item type
1655 - get_definition(): returns the item definition table
1656 - get_tool_capabilities(): returns the digging properties of the item,
1657 ^ or those of the hand if none are defined for this item type
1658 - add_wear(amount): increases wear by amount if the item is a tool
1659 - add_item(item): put some item or stack onto this stack,
1660 ^ returns leftover ItemStack
1661 - item_fits(item): returns true if item or stack can be fully added to this one
1662 - take_item(n): take (and remove) up to n items from this stack
1663 ^ returns taken ItemStack
1664 ^ if n is omitted, n=1 is used
1665 - peek_item(n): copy (don't remove) up to n items from this stack
1666 ^ returns copied ItemStack
1667 ^ if n is omitted, n=1 is used
1669 PseudoRandom: A pseudorandom number generator
1670 - Can be created via PseudoRandom(seed)
1672 - next(): return next integer random number [0...32767]
1673 - next(min, max): return next integer random number [min...max]
1674 (max - min) must be 32767 or <= 6553 due to the simple
1675 implementation making bad distribution otherwise.
1677 PerlinNoise: A perlin noise generator
1678 - Can be created via PerlinNoise(seed, octaves, persistence, scale)
1679 - Also minetest.get_perlin(seeddiff, octaves, persistence, scale)
1681 - get2d(pos) -> 2d noise value at pos={x=,y=}
1682 - get3d(pos) -> 3d noise value at pos={x=,y=,z=}
1684 PerlinNoiseMap: A fast, bulk perlin noise generator
1685 - Can be created via PerlinNoiseMap(noiseparams, size)
1686 - Also minetest.get_perlin_map(noiseparams, size)
1688 - get2dMap(pos) -> <size.x>X<size.y> 2d array of 2d noise values starting at pos={x=,y=}
1689 - get3dMap(pos) -> <size.x>X<size.y>X<size.z> 3d array of 3d noise values starting at pos={x=,y=,z=}
1690 - get2dMap_flat(pos) -> Flat <size.x * size.y> element array of 2d noise values starting at pos={x=,y=}
1691 - get3dMap_flat(pos) -> Same as get2dMap_flat, but 3d noise
1693 VoxelManip: An interface to the MapVoxelManipulator for Lua
1694 - Can be created via VoxelManip()
1695 - Also minetest.get_voxel_manip()
1697 - read_from_map(p1, p2): Reads a chunk of map from the map containing the region formed by p1 and p2.
1698 ^ returns actual emerged pmin, actual emerged pmax
1699 - write_to_map(): Writes the data loaded from the VoxelManip back to the map.
1700 ^ important: data must be set using VoxelManip:set_data before calling this
1701 - get_data(): Gets the data read into the VoxelManip object
1702 ^ returns raw node data is in the form of an array of node content ids
1703 - set_data(data): Sets the data contents of the VoxelManip object
1704 - update_map(): Update map after writing chunk back to map.
1705 ^ To be used only by VoxelManip objects created by the mod itself; not a VoxelManip that was
1706 ^ retrieved from minetest.get_mapgen_object
1707 - set_lighting(light): Set the lighting within the VoxelManip
1708 ^ light is a table, {day=<0...15>, night=<0...15>}
1709 ^ To be used only by a VoxelManip object from minetest.get_mapgen_object
1710 - calc_lighting(): Calculate lighting within the VoxelManip
1711 ^ To be used only by a VoxelManip object from minetest.get_mapgen_object
1712 - update_liquids(): Update liquid flow
1714 VoxelArea: A helper class for voxel areas
1715 - Can be created via VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}
1716 - Coordinates are *inclusive*, like most other things in Minetest
1718 - getExtent(): returns a 3d vector containing the size of the area formed by MinEdge and MaxEdge
1719 - getVolume(): returns the volume of the area formed by MinEdge and MaxEdge
1720 - index(x, y, z): returns the index of an absolute position in a flat array starting at 1
1721 ^ useful for things like VoxelManip, raw Schematic specifiers, PerlinNoiseMap:get2d/3dMap, and so on
1722 - indexp(p): same as above, except takes a vector
1723 - position(i): returns the absolute position vector corresponding to index i
1724 - contains(x, y, z): check if (x,y,z) is inside area formed by MinEdge and MaxEdge
1725 - containsp(p): same as above, except takes a vector
1726 - containsi(i): same as above, except takes an index
1727 - iter(minx, miny, minz, maxx, maxy, maxz): returns an iterator that returns indices
1728 ^ from (minx,miny,minz) to (maxx,maxy,maxz) in the order of [z [y [x]]]
1729 - iterp(minp, maxp): same as above, except takes a vector
1733 A mapgen object is a construct used in map generation. Mapgen objects can be used by an on_generate
1734 callback to speed up operations by avoiding unnecessary recalculations; these can be retrieved using the
1735 minetest.get_mapgen_object() function. If the requested Mapgen object is unavailable, or
1736 get_mapgen_object() was called outside of an on_generate() callback, nil is returned.
1738 The following Mapgen objects are currently available:
1741 This returns three values; the VoxelManip object to be used, minimum and maximum emerged position, in that
1742 order. All mapgens support this object.
1745 Returns an array containing the y coordinates of the ground levels of nodes in the most recently
1746 generated chunk by the current mapgen.
1749 Returns an array containing the biome IDs of nodes in the most recently generated chunk by the
1753 Returns an array containing the temperature values of nodes in the most recently generated chunk by
1757 Returns an array containing the humidity values of nodes in the most recently generated chunk by the
1761 --------------------
1762 - Functions receive a "luaentity" as self:
1763 - It has the member .name, which is the registered name ("mod:thing")
1764 - It has the member .object, which is an ObjectRef pointing to the object
1765 - The original prototype stuff is visible directly via a metatable
1767 - on_activate(self, staticdata)
1768 ^ Called when the object is instantiated.
1769 - on_step(self, dtime)
1770 ^ Called on every server tick (dtime is usually 0.05 seconds)
1771 - on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
1772 ^ Called when somebody punches the object.
1773 ^ Note that you probably want to handle most punches using the
1774 automatic armor group system.
1775 ^ puncher: ObjectRef (can be nil)
1776 ^ time_from_last_punch: Meant for disallowing spamming of clicks (can be nil)
1777 ^ tool_capabilities: capability table of used tool (can be nil)
1778 ^ dir: unit vector of direction of punch. Always defined. Points from
1779 the puncher to the punched.
1780 - on_rightclick(self, clicker)
1781 - get_staticdata(self)
1782 ^ Should return a string that will be passed to on_activate when
1783 the object is instantiated the next time.
1788 axiom, - string initial tree axiom
1789 rules_a, - string rules set A
1790 rules_b, - string rules set B
1791 rules_c, - string rules set C
1792 rules_d, - string rules set D
1793 trunk, - string trunk node name
1794 leaves, - string leaves node name
1795 leaves2, - string secondary leaves node name
1796 leaves2_chance,- num chance (0-100) to replace leaves with leaves2
1797 angle, - num angle in deg
1798 iterations, - num max # of iterations, usually 2 -5
1799 random_level, - num factor to lower nr of iterations, usually 0 - 3
1800 trunk_type, - string single/double/crossed) type of trunk: 1 node, 2x2 nodes or 3x3 in cross shape
1801 thin_branches, - boolean true -> use thin (1 node) branches
1802 fruit, - string fruit node name
1803 fruit_chance, - num chance (0-100) to replace leaves with fruit node
1804 seed, - num random seed
1807 Key for Special L-System Symbols used in Axioms
1808 G - move forward one unit with the pen up
1809 F - move forward one unit with the pen down drawing trunks and branches
1810 f - move forward one unit with the pen down drawing leaves (100% chance)
1811 T - move forward one unit with the pen down drawing trunks only
1812 R - move forward one unit with the pen down placing fruit
1813 A - replace with rules set A
1814 B - replace with rules set B
1815 C - replace with rules set C
1816 D - replace with rules set D
1817 a - replace with rules set A, chance 90%
1818 b - replace with rules set B, chance 80%
1819 c - replace with rules set C, chance 70%
1820 d - replace with rules set D, chance 60%
1821 + - yaw the turtle right by angle parameter
1822 - - yaw the turtle left by angle parameter
1823 & - pitch the turtle down by angle parameter
1824 ^ - pitch the turtle up by angle parameter
1825 / - roll the turtle to the right by angle parameter
1826 * - roll the turtle to the left by angle parameter
1827 [ - save in stack current state info
1828 ] - recover from stack state info
1830 Example usage: spawn small apple tree
1833 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
1834 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
1835 trunk="default:tree",
1836 leaves="default:leaves",
1840 trunk_type="single",
1843 fruit="default:apple"
1845 minetest.spawn_tree(pos,apple_tree)
1854 collide_with_objects = true, -- collide with other objects if physical=true
1856 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
1857 visual = "cube"/"sprite"/"upright_sprite"/"mesh",
1858 visual_size = {x=1, y=1},
1860 textures = {}, -- number of required textures depends on visual
1861 colors = {}, -- number of required colors depends on visual
1862 spritediv = {x=1, y=1},
1863 initial_sprite_basepos = {x=0, y=0},
1865 makes_footstep_sound = false,
1866 automatic_rotate = false,
1870 Entity definition (register_entity)
1872 (Deprecated: Everything in object properties is read directly from here)
1874 initial_properties = <initial object properties>,
1876 on_activate = function(self, staticdata, dtime_s),
1877 on_step = function(self, dtime),
1878 on_punch = function(self, hitter),
1879 on_rightclick = function(self, clicker),
1880 get_staticdata = function(self),
1881 ^ Called sometimes; the string returned is passed to on_activate when
1882 the entity is re-activated from static state
1884 # Also you can define arbitrary member variables here
1885 myvariable = whatever,
1888 ABM (ActiveBlockModifier) definition (register_abm)
1890 -- In the following two fields, also group:groupname will work.
1891 nodenames = {"default:lava_source"},
1892 neighbors = {"default:water_source", "default:water_flowing"}, -- (any of these)
1893 ^ If left out or empty, any neighbor will do
1894 interval = 1.0, -- (operation interval)
1895 chance = 1, -- (chance of trigger is 1.0/this)
1896 action = func(pos, node, active_object_count, active_object_count_wider),
1899 Item definition (register_node, register_craftitem, register_tool)
1901 description = "Steel Axe",
1902 groups = {}, -- key=name, value=rating; rating=1..3.
1903 if rating not applicable, use 1.
1904 eg. {wool=1, fluffy=3}
1905 {soil=2, outerspace=1, crumbly=1}
1906 {bendy=2, snappy=1},
1907 {hard=1, metal=1, spikes=1}
1908 inventory_image = "default_tool_steelaxe.png",
1910 wield_scale = {x=1,y=1,z=1},
1913 liquids_pointable = false,
1914 tool_capabilities = {
1915 full_punch_interval = 1.0,
1919 snappy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
1920 choppy={times={[3]=0.90}, maxwear=0.05, maxlevel=0}
1922 damage_groups = {groupname=damage},
1924 node_placement_prediction = nil,
1925 ^ If nil and item is node, prediction is made automatically
1926 ^ If nil and item is not a node, no prediction is made
1927 ^ If "" and item is anything, no prediction is made
1928 ^ Otherwise should be name of node which the client immediately places
1929 on ground when the player places the item. Server will always update
1930 actual result to client in a short moment.
1932 place = <SimpleSoundSpec>,
1935 on_place = func(itemstack, placer, pointed_thing),
1936 ^ Shall place item and return the leftover itemstack
1937 ^ default: minetest.item_place
1938 on_drop = func(itemstack, dropper, pos),
1939 ^ Shall drop item and return the leftover itemstack
1940 ^ default: minetest.item_drop
1941 on_use = func(itemstack, user, pointed_thing),
1943 ^ Function must return either nil if no item shall be removed from
1944 inventory, or an itemstack to replace the original itemstack.
1945 eg. itemstack:take_item(); return itemstack
1946 ^ Otherwise, the function is free to do what it wants.
1947 ^ The default functions handle regular use cases.
1952 - {name="image.png", animation={Tile Animation definition}}
1953 - {name="image.png", backface_culling=bool}
1954 ^ backface culling only supported in special tiles
1955 - deprecated still supported field names:
1958 Tile animation definition:
1959 - {type="vertical_frames", aspect_w=16, aspect_h=16, length=3.0}
1961 Node definition (register_node)
1963 <all fields allowed in item definitions>,
1965 drawtype = "normal", -- See "Node drawtypes"
1967 tiles = {tile definition 1, def2, def3, def4, def5, def6},
1968 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
1969 ^ List can be shortened to needed length
1970 special_tiles = {tile definition 1, Tile definition 2},
1971 ^ Special textures of node; used rarely (old field name: special_materials)
1972 ^ List can be shortened to needed length
1974 use_texture_alpha = false, -- Use texture's alpha channel
1975 post_effect_color = {a=0, r=0, g=0, b=0}, -- If player is inside node
1976 paramtype = "none", -- See "Nodes"
1977 paramtype2 = "none", -- See "Nodes"
1978 is_ground_content = false, -- Currently not used for anything
1979 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
1980 walkable = true, -- If true, objects collide with node
1981 pointable = true, -- If true, can be pointed at
1982 diggable = true, -- If false, can never be dug
1983 climbable = false, -- If true, can be climbed on (ladder)
1984 buildable_to = false, -- If true, placed nodes can replace this node
1985 drop = "", -- alternatively drop = { max_items = ..., items = { ... } }
1986 liquidtype = "none", -- "none"/"source"/"flowing"
1987 liquid_alternative_flowing = "", -- Flowing version of source liquid
1988 liquid_alternative_source = "", -- Source version of flowing liquid
1989 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
1990 liquid_renewable = true, -- Can new liquid source be created by placing
1991 freezemelt = "", -- water for snow/ice, ice/snow for water
1992 leveled = 0, -- Block contain level in param2. value - default level, used for snow. Dont forget use "leveled" type nodebox
1993 liquid_range = 8, -- number of flowing nodes arround source (max. 8)
1994 drowning = 0, -- Player will take this amount of damage if no bubbles are left
1995 two or more sources nearly?
1996 light_source = 0, -- Amount of light emitted by node
1997 damage_per_second = 0, -- If player is inside node, this damage is caused
1998 node_box = {type="regular"}, -- See "Node boxes"
1999 selection_box = {type="regular"}, -- See "Node boxes"
2000 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used
2001 legacy_facedir_simple = false, -- Support maps made in and before January 2012
2002 legacy_wallmounted = false, -- Support maps made in and before January 2012
2004 footstep = <SimpleSoundSpec>,
2005 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
2006 dug = <SimpleSoundSpec>,
2007 place = <SimpleSoundSpec>,
2010 on_construct = func(pos),
2011 ^ Node constructor; always called after adding node
2012 ^ Can set up metadata and stuff like that
2014 on_destruct = func(pos),
2015 ^ Node destructor; always called before removing node
2017 after_destruct = func(pos, oldnode),
2018 ^ Node destructor; always called after removing node
2021 after_place_node = func(pos, placer, itemstack),
2022 ^ Called after constructing node when node was placed using
2023 minetest.item_place_node / minetest.place_node
2024 ^ If return true no item is taken from itemstack
2026 after_dig_node = func(pos, oldnode, oldmetadata, digger),
2027 ^ oldmetadata is in table format
2028 ^ Called after destructing node when node was dug using
2029 minetest.node_dig / minetest.dig_node
2031 can_dig = function(pos,player)
2032 ^ returns true if node can be dug, or false if not
2035 on_punch = func(pos, node, puncher),
2036 ^ default: minetest.node_punch
2037 ^ By default: does nothing
2038 on_rightclick = func(pos, node, clicker, itemstack),
2040 ^ if defined, itemstack will hold clicker's wielded item
2041 Shall return the leftover itemstack
2042 on_dig = func(pos, node, digger),
2043 ^ default: minetest.node_dig
2044 ^ By default: checks privileges, wears out tool and removes node
2046 on_timer = function(pos,elapsed),
2048 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
2049 ^ elapsed is the total time passed since the timer was started
2050 ^ return true to run the timer for another cycle with the same timeout value
2052 on_receive_fields = func(pos, formname, fields, sender),
2053 ^ fields = {name1 = value1, name2 = value2, ...}
2054 ^ Called when an UI form (eg. sign text input) returns data
2057 allow_metadata_inventory_move = func(pos, from_list, from_index,
2058 to_list, to_index, count, player),
2059 ^ Called when a player wants to move items inside the inventory
2060 ^ Return value: number of items allowed to move
2062 allow_metadata_inventory_put = func(pos, listname, index, stack, player),
2063 ^ Called when a player wants to put something into the inventory
2064 ^ Return value: number of items allowed to put
2065 ^ Return value: -1: Allow and don't modify item count in inventory
2067 allow_metadata_inventory_take = func(pos, listname, index, stack, player),
2068 ^ Called when a player wants to take something out of the inventory
2069 ^ Return value: number of items allowed to take
2070 ^ Return value: -1: Allow and don't modify item count in inventory
2072 on_metadata_inventory_move = func(pos, from_list, from_index,
2073 to_list, to_index, count, player),
2074 on_metadata_inventory_put = func(pos, listname, index, stack, player),
2075 on_metadata_inventory_take = func(pos, listname, index, stack, player),
2076 ^ Called after the actual action has happened, according to what was allowed.
2079 on_blast = func(pos, intensity),
2080 ^ intensity: 1.0 = mid range of regular TNT
2081 ^ If defined, called when an explosion touches the node, instead of
2085 Recipe for register_craft: (shaped)
2087 output = 'default:pick_stone',
2089 {'default:cobble', 'default:cobble', 'default:cobble'},
2090 {'', 'default:stick', ''},
2091 {'', 'default:stick', ''}, -- Also groups; eg. 'group:crumbly'
2093 replacements = <optional list of item pairs,
2094 replace one input item with another item on crafting>
2097 Recipe for register_craft (shapeless)
2100 output = 'mushrooms:mushroom_stew',
2103 "mushrooms:mushroom_brown",
2104 "mushrooms:mushroom_red",
2106 replacements = <optional list of item pairs,
2107 replace one input item with another item on crafting>
2110 Recipe for register_craft (tool repair)
2112 type = "toolrepair",
2113 additional_wear = -0.02,
2116 Recipe for register_craft (cooking)
2119 output = "default:glass",
2120 recipe = "default:sand",
2124 Recipe for register_craft (furnace fuel)
2127 recipe = "default:leaves",
2131 Ore definition (register_ore)
2133 ore_type = "scatter", -- See "Ore types"
2134 ore = "default:stone_with_coal",
2135 wherein = "default:stone",
2136 ^ a list of nodenames is supported too
2137 clust_scarcity = 8*8*8,
2138 ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
2139 ^ This value should be *MUCH* higher than your intuition might tell you!
2141 ^ Number of ores in a cluster
2143 ^ Size of the bounding box of the cluster
2144 ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
2145 height_min = -31000,
2148 ^ Attributes for this ore generation
2149 noise_threshhold = 0.5,
2150 ^ If noise is above this threshhold, ore is placed. Not needed for a uniform distribution
2151 noise_params = {offset=0, scale=1, spread={x=100, y=100, z=100}, seed=23, octaves=3, persist=0.70}
2152 ^ NoiseParams structure describing the perlin noise used for ore distribution.
2153 ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
2156 Decoration definition (register_decoration)
2158 deco_type = "simple", -- See "Decoration types"
2159 place_on = "default:dirt_with_grass",
2160 ^ Node that decoration can be placed on
2162 ^ Size of divisions made in the chunk being generated.
2163 ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
2165 ^ Ratio of the area to be uniformly filled by the decoration.
2166 ^ Used only if noise_params is not specified.
2167 noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
2168 ^ NoiseParams structure describing the perlin noise used for decoration distribution.
2169 ^ The result of this is multiplied by the 2d area of the division being decorated.
2170 biomes = {"Oceanside", "Hills", "Plains"},
2171 ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
2172 ^ and ignored if the Mapgen being used does not support biomes.
2174 ----- Simple-type parameters
2175 decoration = "default:grass",
2176 ^ The node name used as the decoration.
2177 ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
2179 ^ Number of nodes high the decoration is made.
2180 ^ If height_max is not 0, this is the lower bound of the randomly selected height.
2182 ^ Number of nodes the decoration can be at maximum.
2183 ^ If absent, the parameter 'height' is used as a constant.
2184 spawn_by = "default:water",
2185 ^ Node that the decoration only spawns next to, in a 1-node square radius.
2187 ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
2188 ^ If absent or -1, decorations occur next to any nodes.
2190 ----- Schematic-type parameters
2191 schematic = "foobar.mts",
2192 ^ If schematic is a string, it is the filepath relative to the current working directory of the
2193 ^ specified Minetest schematic file.
2194 ^ - OR -, could instead be a table containing two fields, size and data:
2196 size = {x=4, y=6, z=4},
2198 {name="cobble", param1=0, param2=0},
2199 {name="dirt_with_grass", param1=0, param2=0},
2203 ^ See 'Schematic specifier' for details.
2204 replacements = {{"oldname", "convert_to"}, ...},
2205 flags = "place_center_x, place_center_z",
2206 ^ Flags for schematic decorations. See 'Schematic attributes'.
2207 rotation = "90" --rotate schematic 90 degrees on placement
2208 ^ Rotation can be "0", "90", "180", "270", or "random".
2211 Chatcommand definition (register_chatcommand)
2213 params = "<name> <privilege>", -- short parameter description
2214 description = "Remove privilege from player", -- full description
2215 privs = {privs=true}, -- require the "privs" privilege to run
2216 func = function(name, param), -- called when command is run
2219 Detached inventory callbacks
2221 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
2222 ^ Called when a player wants to move items inside the inventory
2223 ^ Return value: number of items allowed to move
2225 allow_put = func(inv, listname, index, stack, player),
2226 ^ Called when a player wants to put something into the inventory
2227 ^ Return value: number of items allowed to put
2228 ^ Return value: -1: Allow and don't modify item count in inventory
2230 allow_take = func(inv, listname, index, stack, player),
2231 ^ Called when a player wants to take something out of the inventory
2232 ^ Return value: number of items allowed to take
2233 ^ Return value: -1: Allow and don't modify item count in inventory
2235 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
2236 on_put = func(inv, listname, index, stack, player),
2237 on_take = func(inv, listname, index, stack, player),
2238 ^ Called after the actual action has happened, according to what was allowed.
2242 HUD Definition (hud_add, hud_get)
2244 hud_elem_type = "image", -- see HUD element types
2245 ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
2246 position = {x=0.5, y=0.5},
2247 ^ Left corner position of element
2253 ^ Selected item in inventory. 0 for no item selected.
2255 ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
2256 alignment = {x=0, y=0},
2257 ^ See "HUD Element Types"
2258 offset = {x=0, y=0},
2259 ^ See "HUD Element Types"
projects / oweals / minetest.git / blob