1 Minetest Lua Modding API Reference 0.4.9
2 ========================================
3 More information at http://www.minetest.net/
4 Developer Wiki: http://dev.minetest.net/
8 Content and functionality can be added to Minetest 0.4 by using Lua
9 scripting in run-time loaded mods.
11 A mod is a self-contained bunch of scripts, textures and other related
12 things that is loaded by and interfaces with Minetest.
14 Mods are contained and ran solely on the server side. Definitions and media
15 files are automatically transferred to the client.
17 If you see a deficiency in the API, feel free to attempt to add the
18 functionality in the engine and API. You can send such improvements as
19 source code patches to <celeron55@gmail.com>.
23 If you have any difficulty in understanding this, please read:
24 http://www.lua.org/pil/
28 Mods are loaded during server startup from the mod load paths by running
29 the init.lua scripts in a shared environment.
33 RUN_IN_PLACE=1: (Windows release, local build)
34 $path_user: Linux: <build directory>
35 Windows: <build directory>
36 $path_share: Linux: <build directory>
37 Windows: <build directory>
39 RUN_IN_PLACE=0: (Linux release)
40 $path_share: Linux: /usr/share/minetest
41 Windows: <install directory>/minetest-0.4.x
42 $path_user: Linux: ~/.minetest
43 Windows: C:/users/<user>/AppData/minetest (maybe)
47 Games are looked up from:
48 $path_share/games/gameid/
49 $path_user/games/gameid/
50 where gameid is unique to each game.
52 The game directory contains the file game.conf, which contains these fields:
53 name = <Human-readable full name of the game>
57 The game directory can contain the file minetest.conf, which will be used
58 to set default settings when running the particular game.
63 $path_share/games/gameid/mods/
65 $path_user/games/gameid/mods/
66 $path_user/mods/ <-- User-installed mods
69 In a run-in-place version (eg. the distributed windows version):
70 minetest-0.4.x/games/gameid/mods/
71 minetest-0.4.x/mods/gameid/ <-- User-installed mods
72 minetest-0.4.x/worlds/worldname/worldmods/
74 On an installed version on linux:
75 /usr/share/minetest/games/gameid/mods/
76 ~/.minetest/mods/gameid/ <-- User-installed mods
77 ~/.minetest/worlds/worldname/worldmods
79 Mod load path for world-specific games
80 --------------------------------------
81 It is possible to include a game in a world; in this case, no mods or
82 games are loaded or checked from anywhere else.
84 This is useful for eg. adventure worlds.
86 This happens if the following directory exists:
89 Mods should be then be placed in:
94 Mods can be put in a subdirectory, if the parent directory, which otherwise
95 should be a mod, contains a file named modpack.txt. This file shall be
96 empty, except for lines starting with #, which are comments.
98 Mod directory structure
99 ------------------------
104 | |-- description.txt
107 | | |-- modname_stuff.png
108 | | `-- modname_something_else.png
115 The location of this directory can be fetched by using
116 minetest.get_modpath(modname)
119 List of mods that have to be loaded before loading this mod.
120 A single line contains a single modname.
122 Optional dependencies can be defined by appending a question mark
123 to a single modname. Their meaning is that if the specified mod
124 is missing, that does not prevent this mod from being loaded.
127 A screenshot shown in modmanager within mainmenu.
130 File containing desctiption to be shown within mainmenu.
133 The main Lua script. Running this script should register everything it
134 wants to register. Subsequent execution depends on minetest calling the
135 registered callbacks.
137 minetest.setting_get(name) and minetest.setting_getbool(name) can be used
138 to read custom or existing settings at load time, if necessary.
140 textures, sounds, media:
141 Media files (textures, sounds, whatever) that will be transferred to the
142 client and will be available for use by the mod.
144 Naming convention for registered textual names
145 ----------------------------------------------
146 Registered names should generally be in this format:
147 "modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
149 This is to prevent conflicting names from corrupting maps and is
150 enforced by the mod loader.
152 Example: mod "experimental", ideal item/node/entity name "tnt":
153 -> the name should be "experimental:tnt".
155 Enforcement can be overridden by prefixing the name with ":". This can
156 be used for overriding the registrations of some other mod.
158 Example: Any mod can redefine experimental:tnt by using the name
159 ":experimental:tnt" when registering it.
160 (also that mod is required to have "experimental" as a dependency)
162 The ":" prefix can also be used for maintaining backwards compatibility.
166 Aliases can be added by using minetest.register_alias(name, convert_to)
168 This will make Minetest to convert things called name to things called
171 This can be used for maintaining backwards compatibility.
173 This can be also used for setting quick access names for things, eg. if
174 you have an item called epiclylongmodname:stuff, you could do
175 minetest.register_alias("stuff", "epiclylongmodname:stuff")
176 and be able to use "/giveme stuff".
180 Mods should generally prefix their textures with modname_, eg. given
181 the mod name "foomod", a texture could be called
182 "foomod_foothing.png"
184 Textures are referred to by their complete name, or alternatively by
185 stripping out the file extension:
186 eg. foomod_foothing.png
191 Only OGG files are supported.
193 For positional playing of sounds, only single-channel (mono) files are
194 supported. Otherwise OpenAL will play them non-positionally.
196 Mods should generally prefix their sounds with modname_, eg. given
197 the mod name "foomod", a sound could be called
198 "foomod_foosound.ogg"
200 Sounds are referred to by their name with a dot, a single digit and the
201 file extension stripped out. When a sound is played, the actual sound file
202 is chosen randomly from the matching sounds.
204 When playing the sound "foomod_foosound", the sound is chosen randomly
205 from the available ones of the following files:
207 foomod_foosound.0.ogg
208 foomod_foosound.1.ogg
210 foomod_foosound.9.ogg
212 Examples of sound parameter tables:
213 -- Play locationless on all clients
215 gain = 1.0, -- default
217 -- Play locationless to a player
220 gain = 1.0, -- default
222 -- Play in a location
225 gain = 1.0, -- default
226 max_hear_distance = 32, -- default
228 -- Play connected to an object, looped
230 object = <an ObjectRef>,
231 gain = 1.0, -- default
232 max_hear_distance = 32, -- default
233 loop = true, -- only sounds connected to objects can be looped
238 eg. "default_place_node"
240 eg. {name="default_place_node"}
241 eg. {name="default_place_node", gain=1.0}
243 Registered definitions of stuff
244 --------------------------------
245 Anything added using certain minetest.register_* functions get added to
246 the global minetest.registered_* tables.
248 minetest.register_entity(name, prototype table)
249 -> minetest.registered_entities[name]
251 minetest.register_node(name, node definition)
252 -> minetest.registered_items[name]
253 -> minetest.registered_nodes[name]
255 minetest.register_tool(name, item definition)
256 -> minetest.registered_items[name]
258 minetest.register_craftitem(name, item definition)
259 -> minetest.registered_items[name]
261 Note that in some cases you will stumble upon things that are not contained
262 in these tables (eg. when a mod has been removed). Always check for
263 existence before trying to access the fields.
265 Example: If you want to check the drawtype of a node, you could do:
267 local function get_nodedef_field(nodename, fieldname)
268 if not minetest.registered_nodes[nodename] then
271 return minetest.registered_nodes[nodename][fieldname]
273 local drawtype = get_nodedef_field(nodename, "drawtype")
275 Example: minetest.get_item_group(name, group) has been implemented as:
277 function minetest.get_item_group(name, group)
278 if not minetest.registered_items[name] or not
279 minetest.registered_items[name].groups[group] then
282 return minetest.registered_items[name].groups[group]
287 Nodes are the bulk data of the world: cubes and other things that take the
288 space of a cube. Huge amounts of them are handled efficiently, but they
291 The definition of a node is stored and can be accessed by name in
292 minetest.registered_nodes[node.name]
293 See "Registered definitions of stuff".
295 Nodes are passed by value between Lua and the engine.
296 They are represented by a table:
297 {name="name", param1=num, param2=num}
299 param1 and param2 are 8 bit integers. The engine uses them for certain
300 automated functions. If you don't use these functions, you can use them to
301 store arbitrary values.
303 The functions of param1 and param2 are determined by certain fields in the
305 param1 is reserved for the engine when paramtype != "none":
307 ^ The value stores light with and without sun in it's
308 upper and lower 4 bits.
309 param2 is reserved for the engine when any of these are used:
310 liquidtype == "flowing"
311 ^ The level and some flags of the liquid is stored in param2
312 drawtype == "flowingliquid"
313 ^ The drawn liquid level is read from param2
314 drawtype == "torchlike"
315 drawtype == "signlike"
316 paramtype2 == "wallmounted"
317 ^ The rotation of the node is stored in param2. You can make this value
318 by using minetest.dir_to_wallmounted().
319 paramtype2 == "facedir"
320 ^ The rotation of the node is stored in param2. Furnaces and chests are
321 rotated this way. Can be made by using minetest.dir_to_facedir().
323 facedir modulo 4 = axisdir
324 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
325 facedir's two less significant bits are rotation around the axis
326 paramtype2 == "leveled"
327 ^ The drawn node level is read from param2, like flowingliquid
329 Nodes can also contain extra data. See "Node Metadata".
333 There are a bunch of different looking node types. These are mostly just
334 copied from Minetest 0.3; more may be made in the future.
336 Look for examples in games/minimal or games/minetest_game.
351 - nodebox -- See below. EXPERIMENTAL
355 Node selection boxes are defined using "node boxes"
357 The "nodebox" node drawtype allows defining visual of nodes consisting of
358 arbitrary number of boxes. It allows defining stuff like stairs. Only the
359 "fixed" and "leveled" box type is supported for these.
360 ^ Please note that this is still experimental, and may be incompatibly
361 changed in the future.
363 A nodebox is defined as any of:
365 -- A normal cube; the default in most things
369 -- A fixed box (facedir param2 is used, if applicable)
371 fixed = box OR {box1, box2, ...}
374 -- A box like the selection box for torches
375 -- (wallmounted param2 is used, if applicable)
376 type = "wallmounted",
383 {x1, y1, z1, x2, y2, z2}
384 A box of a regular node would look like:
385 {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
387 type = "leveled" is same as "fixed", but y2 will be automaticaly setted to level from param2
391 These tell in what manner the ore is generated.
392 All default ores are of the uniformly-distributed scatter type.
395 Randomly chooses a location and generates a cluster of ore.
396 If noise_params is specified, the ore will be placed if the 3d perlin noise at
397 that point is greater than the noise_threshhold, giving the ability to create a non-equal
400 Creates a sheet of ore in a blob shape according to the 2d perlin noise described by noise_params.
401 The relative height of the sheet can be controlled by the same perlin noise as well, by specifying
402 a non-zero 'scale' parameter in noise_params. IMPORTANT: The noise is not transformed by offset or
403 scale when comparing against the noise threshhold, but scale is used to determine relative height.
404 The height of the blob is randomly scattered, with a maximum height of clust_size.
405 clust_scarcity and clust_num_ores are ignored.
406 This is essentially an improved version of the so-called "stratus" ore seen in some unofficial mods.
407 - claylike - NOT YET IMPLEMENTED
408 Places ore if there are no more than clust_scarcity number of specified nodes within a Von Neumann
409 neighborhood of clust_size radius.
413 See section Flag Specifier Format.
414 Currently supported flags: absheight
416 Also produce this same ore between the height range of -height_max and -height_min.
417 Useful for having ore in sky realms without having to duplicate ore entries.
421 The varying types of decorations that can be placed.
422 The default value is simple, and is currently the only type supported.
425 Creates a 1xHx1 column of a specified node (or a random node from a list, if a decoration
426 list is specified). Can specify a certain node it must spawn next to, such as water or lava,
427 for example. Can also generate a decoration of random height between a specified lower and
428 upper bound. This type of decoration is intended for placement of grass, flowers, cacti,
431 Copies a box of MapNodes from a specified schematic file (or raw description). Can specify a
432 probability of a node randomly appearing when placed. This decoration type is intended to be used
433 for multi-node sized discrete structures, such as trees, cave spikes, rocks, and so on.
437 A schematic specifier identifies a schematic by either a filename to a Minetest Schematic file (.mts)
438 or through raw data supplied through Lua, in the form of a table. This table must specify two fields:
439 - The 'size' field is a 3d vector containing the dimensions of the provided schematic.
440 - The 'data' field is a flat table of MapNodes making up the schematic, in the order of [z [y [x]]].
441 Important: The default value for param1 in MapNodes here is 255, which represents "always place".
443 In the bulk MapNode data, param1, instead of the typical light values, instead represents the
444 probability of that node appearing in the structure.
445 When passed to minetest.create_schematic, probability is an integer value ranging from 0 to 255:
446 - A probability value of 0 means that node will never appear (0% chance).
447 - A probability value of 255 means the node will always appear (100% chance).
448 - If the probability value p is greater than 0, then there is a (p / 256 * 100)% chance that node
449 will appear when the schematic is placed on the map.
451 Important note: Node aliases cannot be used for a raw schematic provided when registering as a decoration.
454 ---------------------
455 See section Flag Specifier Format.
456 Currently supported flags: place_center_x, place_center_y, place_center_z
458 Placement of this decoration is centered along the X axis.
460 Placement of this decoration is centered along the Y axis.
462 Placement of this decoration is centered along the Z axis.
466 The position field is used for all element types.
467 To account for differing resolutions, the position coordinates are the percentage of the screen,
468 ranging in value from 0 to 1.
469 The name field is not yet used, but should contain a description of what the HUD element represents.
470 The direction field is the direction in which something is drawn.
471 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.
472 The alignment field specifies how the item will be aligned. It ranges from -1 to 1,
473 with 0 being the center, -1 is moved to the left/up, and 1 is to the right/down. Fractional
475 The offset field specifies a pixel offset from the position. Contrary to position,
476 the offset is not scaled to screen size. This allows for some precisely-positioned
478 Note offset WILL adapt to screen dpi as well as user defined scaling factor!
479 Below are the specific uses for fields in each type; fields not listed for that type are ignored.
481 Note: Future revisions to the HUD API may be incompatible; the HUD API is still in the experimental stages.
484 Displays an image on the HUD.
485 - scale: The scale of the image, with 1 being the original texture size.
486 Only the X coordinate scale is used (positive values)
487 Negative values represent that percentage of the screen it
488 should take; e.g. x=-100 means 100% (width)
489 - text: The name of the texture that is displayed.
490 - alignment: The alignment of the image.
491 - offset: offset in pixels from position.
493 Displays text on the HUD.
494 - scale: Defines the bounding rectangle of the text.
495 A value such as {x=100, y=100} should work.
496 - text: The text to be displayed in the HUD element.
497 - number: An integer containing the RGB value of the color used to draw the text.
498 Specify 0xFFFFFF for white text, 0xFF0000 for red, and so on.
499 - alignment: The alignment of the text.
500 - offset: offset in pixels from position.
502 Displays a horizontal bar made up of half-images.
503 - text: The name of the texture that is used.
504 - number: The number of half-textures that are displayed.
505 If odd, will end with a vertically center-split texture.
507 - offset: offset in pixels from position.
508 - size: If used will force full-image size to this value (override texture pack image size)
510 - text: The name of the inventory list to be displayed.
511 - number: Number of items in the inventory to be displayed.
512 - item: Position of item that is selected.
515 Displays distance to selected world position.
516 - name: The name of the waypoint.
517 - text: Distance suffix. Can be blank.
518 - number: An integer containing the RGB value of the color used to draw the text.
519 - world_pos: World position of the waypoint.
521 Representations of simple things
522 --------------------------------
524 {x=num, y=num, z=num}
525 For helper functions see "Vector helpers".
529 {type="node", under=pos, above=pos}
530 {type="object", ref=ObjectRef}
532 Flag Specifier Format
533 -----------------------
534 Flags using the standardized flag specifier format can be specified in either of two ways, by string or table.
535 The string format is a comma-delimited set of flag names; whitespace and unrecognized flag fields are ignored.
536 Specifying a flag in the string sets the flag, and specifying a flag prefixed by the string "no" explicitly
537 clears the flag from whatever the default may be.
538 In addition to the standard string flag format, the schematic flags field can also be a table of flag names
539 to boolean values representing whether or not the flag is set. Additionally, if a field with the flag name
540 prefixed with "no" is present, mapped to a boolean of any value, the specified flag is unset.
542 e.g. A flag field of value
543 {place_center_x = true, place_center_y=false, place_center_z=true}
545 {place_center_x = true, noplace_center_y=true, place_center_z=true}
546 which is equivalent to
547 "place_center_x, noplace_center_y, place_center_z"
549 "place_center_x, place_center_z"
550 since, by default, no schematic attributes are set.
554 Node (register_node):
555 A node from the world
556 Tool (register_tool):
557 A tool/weapon that can dig and damage things according to tool_capabilities
558 Craftitem (register_craftitem):
561 Items and item stacks can exist in three formats:
563 Serialized; This is called stackstring or itemstring:
565 eg. 'default:pick_wood 21323'
569 eg. {name="default:dirt", count=5, wear=0, metadata=""}
571 eg. {name="default:pick_wood", count=1, wear=21323, metadata=""}
572 ^ a wooden pick about 1/3 weared out
573 eg. {name="default:apple", count=1, wear=0, metadata=""}
577 C++ native format with many helper methods. Useful for converting between
578 formats. See the Class reference section for details.
580 When an item must be passed to a function, it can usually be in any of
585 In a number of places, there is a group table. Groups define the
586 properties of a thing (item, node, armor of entity, capabilities of
587 tool) in such a way that the engine and other mods can can interact with
588 the thing without actually knowing what the thing is.
591 - Groups are stored in a table, having the group names with keys and the
592 group ratings as values. For example:
593 groups = {crumbly=3, soil=1}
595 groups = {crumbly=2, soil=1, level=2, outerspace=1}
596 ^ A more special dirt-kind of thing
597 - Groups always have a rating associated with them. If there is no
598 useful meaning for a rating for an enabled group, it shall be 1.
599 - When not defined, the rating of a group defaults to 0. Thus when you
600 read groups, you must interpret nil and 0 as the same value, 0.
602 You can read the rating of a group for an item or a node by using
603 minetest.get_item_group(itemname, groupname)
607 Groups of items can define what kind of an item it is (eg. wool).
611 In addition to the general item things, groups are used to define whether
612 a node is destroyable and how long it takes to destroy by a tool.
616 For entities, groups are, as of now, used only for calculating damage.
617 The rating is the percentage of damage caused by tools with this damage group.
618 See "Entity damage mechanism".
620 object.get_armor_groups() -> a group-rating table (eg. {fleshy=100})
621 object.set_armor_groups({fleshy=30, cracky=80})
625 Groups in tools define which groups of nodes and entities they are
628 Groups in crafting recipes
629 ---------------------------
630 An example: Make meat soup from any meat, any water and any bowl
632 output = 'food:meat_soup_raw',
638 -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
640 An another example: Make red wool from white wool and red dye
644 recipe = {'wool:white', 'group:dye,basecolor_red'},
649 - immortal: Disables the group damage system for an entity
650 - level: Can be used to give an additional sense of progression in the game.
651 - A larger level will cause eg. a weapon of a lower level make much less
652 damage, and get weared out much faster, or not be able to get drops
653 from destroyed nodes.
654 - 0 is something that is directly accessible at the start of gameplay
655 - There is no upper limit
656 - dig_immediate: (player can always pick up node without tool wear)
657 - 2: node is removed without tool wear after 0.5 seconds or so
659 - 3: node is removed without tool wear immediately (torch)
660 - disable_jump: Player (and possibly other things) cannot jump from node
661 - fall_damage_add_percent: damage speed = speed * (1 + value/100)
662 - bouncy: value is bounce speed in percent
663 - falling_node: if there is no walkable block under the node it will fall
664 - attached_node: if the node under it is not a walkable block the node will be
665 dropped as an item. If the node is wallmounted the
666 wallmounted direction is checked.
667 - soil: saplings will grow on nodes in this group
668 - connect_to_raillike: makes nodes of raillike drawtype connect to
669 other group members with same drawtype
671 Known damage and digging time defining groups
672 ----------------------------------------------
673 - crumbly: dirt, sand
674 - cracky: tough but crackable stuff like stone.
675 - snappy: something that can be cut using fine tools; eg. leaves, small
676 plants, wire, sheets of metal
677 - choppy: something that can be cut using force; eg. trees, wooden planks
678 - fleshy: Living things like animals and the player. This could imply
679 some blood effects when hitting.
680 - explody: Especially prone to explosions
681 - oddly_breakable_by_hand:
682 Can be added to nodes that shouldn't logically be breakable by the
683 hand but are. Somewhat similar to dig_immediate, but times are more
684 like {[1]=3.50,[2]=2.00,[3]=0.70} and this does not override the
685 speed of a tool if the tool can dig at a faster speed than this
686 suggests for the hand.
688 Examples of custom groups
689 --------------------------
690 Item groups are often used for defining, well, //groups of items//.
691 - meat: any meat-kind of a thing (rating might define the size or healing
692 ability or be irrelevant - it is not defined as of yet)
693 - eatable: anything that can be eaten. Rating might define HP gain in half
695 - flammable: can be set on fire. Rating might define the intensity of the
696 fire, affecting eg. the speed of the spreading of an open fire.
697 - wool: any wool (any origin, any color)
700 - heavy: anything considerably heavy
702 Digging time calculation specifics
703 -----------------------------------
704 Groups such as **crumbly**, **cracky** and **snappy** are used for this
705 purpose. Rating is 1, 2 or 3. A higher rating for such a group implies
708 The **level** group is used to limit the toughness of nodes a tool can dig
709 and to scale the digging times / damage to a greater extent.
711 ^ PLEASE DO UNDERSTAND THIS, otherwise you cannot use the system to it's
714 Tools define their properties by a list of parameters for groups. They
715 cannot dig other groups; thus it is important to use a standard bunch of
716 groups to enable interaction with tools.
719 * Full punch interval
721 * For an arbitrary list of groups:
722 * Uses (until the tool breaks)
723 * Maximum level (usually 0, 1, 2 or 3)
727 **Full punch interval**:
728 When used as a weapon, the tool will do full damage if this time is spent
729 between punches. If eg. half the time is spent, the tool will do half
732 **Maximum drop level**
733 Suggests the maximum level of node, when dug with the tool, that will drop
734 it's useful item. (eg. iron ore to drop a lump of iron).
735 - This is not automated; it is the responsibility of the node definition
739 Determines how many uses the tool has when it is used for digging a node,
740 of this group, of the maximum level. For lower leveled nodes, the use count
741 is multiplied by 3^leveldiff.
742 - uses=10, leveldiff=0 -> actual uses: 10
743 - uses=10, leveldiff=1 -> actual uses: 30
744 - uses=10, leveldiff=2 -> actual uses: 90
747 Tells what is the maximum level of a node of this group that the tool will
751 List of digging times for different ratings of the group, for nodes of the
753 * For example, as a lua table, ''times={2=2.00, 3=0.70}''. This would
754 result in the tool to be able to dig nodes that have a rating of 2 or 3
755 for this group, and unable to dig the rating 1, which is the toughest.
756 Unless there is a matching group that enables digging otherwise.
759 List of damage for groups of entities. See "Entity damage mechanism".
761 Example definition of the capabilities of a tool
762 -------------------------------------------------
763 tool_capabilities = {
764 full_punch_interval=1.5,
767 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
769 damage_groups = {fleshy=2},
772 This makes the tool be able to dig nodes that fullfill both of these:
773 - Have the **crumbly** group
774 - Have a **level** group less or equal to 2
776 Table of resulting digging times:
777 crumbly 0 1 2 3 4 <- level
783 level diff: 2 1 0 -1 -2
785 Table of resulting tool uses:
792 - At crumbly=0, the node is not diggable.
793 - At crumbly=3, the level difference digging time divider kicks in and makes
794 easy nodes to be quickly breakable.
795 - At level > 2, the node is not diggable, because it's level > maxlevel
797 Entity damage mechanism
798 ------------------------
801 foreach group in cap.damage_groups:
802 damage += cap.damage_groups[group] * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
803 * (object.armor_groups[group] / 100.0)
804 -- Where object.armor_groups[group] is 0 for inexisting values
807 Client predicts damage based on damage groups. Because of this, it is able to
808 give an immediate response when an entity is damaged or dies; the response is
809 pre-defined somehow (eg. by defining a sprite animation) (not implemented;
811 - Currently a smoke puff will appear when an entity dies.
813 The group **immortal** completely disables normal damage.
815 Entities can define a special armor group, which is **punch_operable**. This
816 group disables the regular damage mechanism for players punching it by hand or
817 a non-tool item, so that it can do something else than take damage.
819 On the Lua side, every punch calls ''entity:on_punch(puncher,
820 time_from_last_punch, tool_capabilities, direction)''. This should never be
821 called directly, because damage is usually not handled by the entity itself.
822 * ''puncher'' is the object performing the punch. Can be nil. Should never be
823 accessed unless absolutely required, to encourage interoperability.
824 * ''time_from_last_punch'' is time from last punch (by puncher) or nil.
825 * ''tool_capabilities'' can be nil.
826 * ''direction'' is a unit vector, pointing from the source of the punch to
829 To punch an entity/object in Lua, call ''object:punch(puncher,
830 time_from_last_punch, tool_capabilities, direction)''.
831 * Return value is tool wear.
832 * Parameters are equal to the above callback.
833 * If ''direction'' is nil and ''puncher'' is not nil, ''direction'' will be
834 automatically filled in based on the location of ''puncher''.
838 The instance of a node in the world normally only contains the three values
839 mentioned in "Nodes". However, it is possible to insert extra data into a
840 node. It is called "node metadata"; See "NodeMetaRef".
842 Metadata contains two things:
846 Some of the values in the key-value store are handled specially:
847 - formspec: Defines a right-click inventory menu. See "Formspec".
848 - infotext: Text shown on the screen when the node is pointed at
852 local meta = minetest.get_meta(pos)
853 meta:set_string("formspec",
855 "list[context;main;0,0;8,4;]"..
856 "list[current_player;main;0,5;8,4;]")
857 meta:set_string("infotext", "Chest");
858 local inv = meta:get_inventory()
859 inv:set_size("main", 8*4)
860 print(dump(meta:to_table()))
863 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] = ""}
866 formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
873 Formspec defines a menu. Currently not much else than inventories are
874 supported. It is a string, with a somewhat strange format.
876 Spaces and newlines can be inserted between the blocks, as is used in the
882 list[context;main;0,0;8,4;]
883 list[current_player;main;0,5;8,4;]
886 list[context;fuel;2,3;1,1;]
887 list[context;src;2,1;1,1;]
888 list[context;dst;5,1;2,2;]
889 list[current_player;main;0,5;8,4;]
890 - Minecraft-like player inventory
892 image[1,0.6;1,2;player.png]
893 list[current_player;main;0,3.5;8,4;]
894 list[current_player;craft;3,0;3,3;]
895 list[current_player;craftpreview;7,1;1,1;]
899 size[<W>,<H>,<fixed_size>]
900 ^ Define the size of the menu in inventory slots
901 ^ fixed_size true/false (optional)
902 ^ deprecated: invsize[<W>,<H>;]
904 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]
905 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]
906 ^ Show an inventory list
908 listcolors[<slot_bg_normal>;<slot_bg_hover>]
909 ^ Sets background color of slots in HEX-Color format
910 ^ Sets background color of slots on mouse hovering
912 listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]
913 ^ Sets background color of slots in HEX-Color format
914 ^ Sets background color of slots on mouse hovering
915 ^ Sets color of slots border
917 listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]
918 ^ Sets background color of slots in HEX-Color format
919 ^ Sets background color of slots on mouse hovering
920 ^ Sets color of slots border
921 ^ Sets background color of tooltips
922 ^ Sets font color of tooltips
924 image[<X>,<Y>;<W>,<H>;<texture name>]
926 ^ Position and size units are inventory slots
928 item_image[<X>,<Y>;<W>,<H>;<item name>]
929 ^ Show an inventory image of registered item/node
930 ^ Position and size units are inventory slots
932 bgcolor[<color>;<fullscreen>]
933 ^ Sets background color of formspec in HEX-Color format
934 ^ If true the background color is drawn fullscreen (does not effect the size of the formspec)
936 background[<X>,<Y>;<W>,<H>;<texture name>]
937 ^ Use a background. Inventory rectangles are not drawn then.
938 ^ Position and size units are inventory slots
939 ^ Example for formspec 8x4 in 16x resolution: image shall be sized 8*16px x 4*16px
941 background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]
942 ^ Use a background. Inventory rectangles are not drawn then.
943 ^ Position and size units are inventory slots
944 ^ Example for formspec 8x4 in 16x resolution: image shall be sized 8*16px x 4*16px
945 ^ If true the background is clipped to formspec size (x and y are used as offset values, w and h are ignored)
947 pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]
948 ^ Textual password style field; will be sent to server when a button is clicked
949 ^ x and y position the field relative to the top left of the menu
950 ^ w and h are the size of the field
951 ^ fields are a set height, but will be vertically centred on h
952 ^ Position and size units are inventory slots
953 ^ name is the name of the field as returned in fields to on_receive_fields
954 ^ label, if not blank, will be text printed on the top left above the field
956 field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
957 ^ Textual field; will be sent to server when a button is clicked
958 ^ x and y position the field relative to the top left of the menu
959 ^ w and h are the size of the field
960 ^ fields are a set height, but will be vertically centred on h
961 ^ Position and size units are inventory slots
962 ^ name is the name of the field as returned in fields to on_receive_fields
963 ^ label, if not blank, will be text printed on the top left above the field
964 ^ default is the default value of the field
965 ^ default may contain variable references such as '${text}' which
966 will fill the value from the metadata value 'text'
967 ^ Note: no extra text or more than a single variable is supported ATM.
969 field[<name>;<label>;<default>]
970 ^ as above but without position/size units
971 ^ special field for creating simple forms, such as sign text input
972 ^ must be used without a size[] element
973 ^ a 'Proceed' button will be added automatically
975 textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
976 ^ same as fields above, but with multi-line input
978 label[<X>,<Y>;<label>]
979 ^ x and y work as per field
980 ^ label is the text on the label
981 ^ Position and size units are inventory slots
983 vertlabel[<X>,<Y>;<label>]
984 ^ Textual label drawn verticaly
985 ^ x and y work as per field
986 ^ label is the text on the label
987 ^ Position and size units are inventory slots
989 button[<X>,<Y>;<W>,<H>;<name>;<label>]
990 ^ Clickable button. When clicked, fields will be sent.
991 ^ x, y and name work as per field
992 ^ w and h are the size of the button
993 ^ label is the text on the button
994 ^ Position and size units are inventory slots
996 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
997 ^ x, y, w, h, and name work as per button
998 ^ texture name is the filename of an image
999 ^ Position and size units are inventory slots
1001 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>]
1002 ^ x, y, w, h, and name work as per button
1003 ^ texture name is the filename of an image
1004 ^ Position and size units are inventory slots
1005 ^ noclip true meand imagebutton doesn't need to be within specified formsize
1006 ^ drawborder draw button bodrer or not
1008 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]
1009 ^ x, y, w, h, and name work as per button
1010 ^ texture name is the filename of an image
1011 ^ Position and size units are inventory slots
1012 ^ noclip true meand imagebutton doesn't need to be within specified formsize
1013 ^ drawborder draw button bodrer or not
1014 ^ pressed texture name is the filename of an image on pressed state
1016 item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]
1017 ^ x, y, w, h, name and label work as per button
1018 ^ item name is the registered name of an item/node,
1019 tooltip will be made out of its descritption
1020 ^ Position and size units are inventory slots
1022 button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]
1023 ^ When clicked, fields will be sent and the form will quit.
1025 image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
1026 ^ When clicked, fields will be sent and the form will quit.
1028 textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]
1029 ^Scrollabel itemlist showing arbitrary text elements
1030 ^ x and y position the itemlist relative to the top left of the menu
1031 ^ w and h are the size of the itemlist
1032 ^ name fieldname sent to server on doubleclick value is current selected element
1033 ^ listelements can be prepended by #color in hexadecimal format RRGGBB (only),
1034 ^ if you want a listelement to start with # write ##
1036 textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]
1037 ^Scrollabel itemlist showing arbitrary text elements
1038 ^ x and y position the itemlist relative to the top left of the menu
1039 ^ w and h are the size of the itemlist
1040 ^ name fieldname sent to server on doubleclick value is current selected element
1041 ^ listelements can be prepended by #RRGGBB (only) in hexadecimal format
1042 ^ if you want a listelement to start with # write ##
1043 ^ index to be selected within textlist
1044 ^ true/false draw transparent background
1045 ^ see also minetest.explode_textlist_event (main menu: engine.explode_textlist_event)
1047 tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]
1048 ^ show a tabHEADER at specific position (ignores formsize)
1049 ^ x and y position the itemlist relative to the top left of the menu
1050 ^ name fieldname data is transfered to lua
1051 ^ caption 1... name shown on top of tab
1052 ^ current_tab index of selected tab 1...
1053 ^ transparent (optional) show transparent
1054 ^ draw_border (optional) draw border
1056 box[<X>,<Y>;<W>,<H>;<color>]
1057 ^ simple colored semitransparent box
1058 ^ x and y position the box relative to the top left of the menu
1059 ^ w and h are the size of box
1060 ^ color in HEX-Color format
1062 dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]
1063 ^ show a dropdown field
1064 ^ x and y position of dropdown
1066 ^ fieldname data is transfered to lua
1067 ^ items to be shown in dropdown
1068 ^ index of currently selected dropdown item
1069 ^ color in hexadecimal format RRGGBB (only)
1071 checkbox[<X>,<Y>;<name>;<label>;<selected>]
1073 ^ x and y position of checkbox
1074 ^ name fieldname data is transfered to lua
1075 ^ label to be shown left of checkbox
1076 ^ selected (optional) true/false
1078 table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]
1079 ^ show scrollable table using options defined by the previous tableoptions[]
1080 ^ displays cells as defined by the previous tablecolumns[]
1081 ^ x and y position the itemlist relative to the top left of the menu
1082 ^ w and h are the size of the itemlist
1083 ^ name fieldname sent to server on row select or doubleclick
1084 ^ cell 1...n cell contents given in row-major order
1085 ^ selected idx: index of row to be selected within table (first row = 1)
1086 ^ see also minetest.explode_table_event (main menu: engine.explode_table_event)
1088 tableoptions[<opt 1>;<opt 2>;...]
1089 ^ sets options for table[]:
1091 ^^ default text color (HEX-Color), defaults to #FFFFFF
1092 ^ background=#RRGGBB
1093 ^^ table background color (HEX-Color), defaults to #000000
1094 ^ border=<true/false>
1095 ^^ should the table be drawn with a border? (default true)
1097 ^^ highlight background color (HEX-Color), defaults to #466432
1098 ^ highlight_text=#RRGGBB
1099 ^^ highlight text color (HEX-Color), defaults to #FFFFFF
1101 ^^ all subtrees up to depth < value are open (default value = 0)
1102 ^^ only useful when there is a column of type "tree"
1104 tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]
1105 ^ sets columns for table[]:
1106 ^ types: text, image, color, indent, tree
1107 ^^ text: show cell contents as text
1108 ^^ image: cell contents are an image index, use column options to define images
1109 ^^ color: cell contents are a HEX-Color and define color of following cell
1110 ^^ indent: cell contents are a number and define indentation of following cell
1111 ^^ tree: same as indent, but user can open and close subtrees (treeview-like)
1113 ^^ align=<value> for "text" and "image": content alignment within cells
1114 ^^ available values: left (default), center, right, inline
1115 ^^ width=<value> for "text" and "image": minimum width in em (default 0)
1116 ^^ for "indent" and "tree": indent width in em (default 1.5)
1117 ^^ padding=<value> padding left of the column, in em (default 0.5)
1118 ^^ exception: defaults to 0 for indent columns
1119 ^^ tooltip=<value> tooltip text (default empty)
1120 ^ "image" column options:
1121 ^^ 0=<value> sets image for image index 0
1122 ^^ 1=<value> sets image for image index 1
1123 ^^ 2=<value> sets image for image index 2
1124 ^^ and so on; defined indices need not be contiguous
1125 ^^ empty or non-numeric cells are treated as 0
1126 ^ "color" column options:
1127 ^^ span=<value> number of following columns to affect (default infinite)
1129 Note: do NOT use a element name starting with "key_" those names are reserved to
1130 pass key press events to formspec!
1134 - "context": Selected node metadata (deprecated: "current_name")
1135 - "current_player": Player to whom the menu is shown
1136 - "player:<name>": Any player
1137 - "nodemeta:<X>,<Y>,<Z>": Any node metadata
1138 - "detached:<name>": A detached inventory
1143 ^ defines a color in hexadecimal format
1145 ^ defines a color in hexadecimal format and alpha channel
1147 ^ defines a color in hexadecimal format
1149 ^ defines a color in hexadecimal format and alpha channel
1153 vector.new([x[, y, z]]) -> vector
1154 ^ x is a table or the x position.
1155 vector.direction(p1, p2) -> vector
1156 vector.distance(p1, p2) -> number
1157 vector.length(v) -> number
1158 vector.normalize(v) -> vector
1159 vector.round(v) -> vector
1160 vector.equals(v1, v2) -> bool
1161 For the folowing x can be either a vector or a number.
1162 vector.add(v, x) -> vector
1163 vector.subtract(v, x) -> vector
1164 vector.multiply(v, x) -> vector
1165 vector.divide(v, x) -> vector
1169 dump2(obj, name="_", dumped={})
1170 ^ Return object serialized as a string, handles reference loops
1171 dump(obj, dumped={})
1172 ^ Return object serialized as a string
1174 ^ Get the hypotenuse of a triangle with legs x and y.
1175 Usefull for distance calculation.
1176 string:split(separator)
1177 ^ eg. string:split("a,b", ",") == {"a","b"}
1179 ^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
1180 minetest.pos_to_string({x=X,y=Y,z=Z}) -> "(X,Y,Z)"
1181 ^ Convert position to a printable string
1182 minetest.string_to_pos(string) -> position
1183 ^ Same but in reverse
1184 minetest.formspec_escape(string) -> string
1185 ^ escapes characters [ ] \ , ; that can not be used in formspecs
1186 minetest.is_yes(arg)
1187 ^ returns whether arg can be interpreted as yes
1189 minetest namespace reference
1190 -----------------------------
1192 minetest.get_current_modname() -> string
1193 minetest.get_modpath(modname) -> eg. "/home/user/.minetest/usermods/modname"
1194 ^ Useful for loading additional .lua modules or static data from mod
1195 minetest.get_modnames() -> list of installed mods
1196 ^ Return a list of installed mods, sorted alphabetically
1197 minetest.get_worldpath() -> eg. "/home/user/.minetest/world"
1198 ^ Useful for storing custom data
1199 minetest.is_singleplayer()
1201 ^ table containing API feature flags: {foo=true, bar=true}
1202 minetest.has_feature(arg) -> bool, missing_features
1203 ^ arg: string or table in format {foo=true, bar=true}
1204 ^ missing_features: {foo=true, bar=true}
1205 minetest.get_player_information(playername)
1206 ^ table containing information about player peer:
1208 address = "127.0.0.1", -- ip address of client
1209 ip_version = 4, -- IPv4 / IPv6
1210 min_rtt = 0.01, -- minimum round trip time
1211 max_rtt = 0.2, -- maximum round trip time
1212 avg_rtt = 0.02, -- average round trip time
1213 min_jitter = 0.01, -- minimum packet time jitter
1214 max_jitter = 0.5, -- maximum packet time jitter
1215 avg_jitter = 0.03, -- average packet time jitter
1216 connection_uptime = 200, -- seconds since client connected
1218 -- following information is available on debug build only!!!
1219 -- DO NOT USE IN MODS
1220 --ser_vers = 26, -- serialization version used by client
1221 --prot_vers = 23, -- protocol version used by client
1222 --major = 0, -- major version number
1223 --minor = 4, -- minor version number
1224 --patch = 10, -- patch version number
1225 --vers_string = "0.4.9-git", -- full version string
1226 --state = "Active" -- current client state
1230 minetest.debug(line)
1231 ^ Always printed to stderr and logfile (print() is redirected here)
1233 minetest.log(loglevel, line)
1234 ^ loglevel one of "error", "action", "info", "verbose"
1236 Registration functions: (Call these only at load time)
1237 minetest.register_entity(name, prototype table)
1238 minetest.register_abm(abm definition)
1239 minetest.register_node(name, node definition)
1240 minetest.register_tool(name, item definition)
1241 minetest.register_craftitem(name, item definition)
1242 minetest.register_alias(name, convert_to)
1243 minetest.register_craft(recipe)
1244 minetest.register_ore(ore definition)
1245 minetest.register_decoration(decoration definition)
1246 minetest.override_item(name, redefinition)
1247 ^ Overrides fields of an item registered with register_node/tool/craftitem.
1248 ^ Note: Item must already be defined, (opt)depend on the mod defining it.
1249 ^ Example: minetest.override_item("default:mese", {light_source=LIGHT_MAX})
1251 Global callback registration functions: (Call these only at load time)
1252 minetest.register_globalstep(func(dtime))
1253 ^ Called every server step, usually interval of 0.1s
1254 minetest.register_on_shutdown(func())
1255 ^ Called before server shutdown
1256 ^ WARNING: If the server terminates abnormally (i.e. crashes), the registered
1257 callbacks WILL LIKELY NOT BE RUN. Data should be saved at
1258 semi-frequent intervals as well as on server shutdown.
1259 minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack, pointed_thing))
1260 ^ Called when a node has been placed
1261 ^ If return true no item is taken from itemstack
1262 ^ Not recommended; use on_construct or after_place_node in node definition
1264 minetest.register_on_dignode(func(pos, oldnode, digger))
1265 ^ Called when a node has been dug.
1266 ^ Not recommended: Use on_destruct or after_dig_node in node definition
1268 minetest.register_on_punchnode(func(pos, node, puncher, pointed_thing))
1269 ^ Called when a node is punched
1270 minetest.register_on_generated(func(minp, maxp, blockseed))
1271 ^ Called after generating a piece of world. Modifying nodes inside the area
1272 is a bit faster than usually.
1273 minetest.register_on_newplayer(func(ObjectRef))
1274 ^ Called after a new player has been created
1275 minetest.register_on_dieplayer(func(ObjectRef))
1276 ^ Called when a player dies
1277 minetest.register_on_respawnplayer(func(ObjectRef))
1278 ^ Called when player is to be respawned
1279 ^ Called _before_ repositioning of player occurs
1280 ^ return true in func to disable regular player placement
1281 minetest.register_on_prejoinplayer(func(name, ip))
1282 ^ Called before a player joins the game
1283 ^ If it returns a string, the player is disconnected with that string as reason
1284 minetest.register_on_joinplayer(func(ObjectRef))
1285 ^ Called when a player joins the game
1286 minetest.register_on_leaveplayer(func(ObjectRef))
1287 ^ Called when a player leaves the game
1288 minetest.register_on_cheat(func(ObjectRef, cheat))
1289 ^ Called when a player cheats
1290 ^ cheat: {type="moved_too_fast"/"interacted_too_far"/"finished_unknown_dig"/"dug_unbreakable"/"dug_too_fast"}
1291 minetest.register_on_chat_message(func(name, message))
1292 ^ Called always when a player says something
1293 minetest.register_on_player_receive_fields(func(player, formname, fields))
1294 ^ Called when a button is pressed in player's inventory form
1295 ^ Newest functions are called first
1296 ^ If function returns true, remaining functions are not called
1297 minetest.register_on_mapgen_init(func(MapgenParams))
1298 ^ Called just before the map generator is initialized but before the environment is initialized
1299 ^ MapgenParams consists of a table with the fields mgname, seed, water_level, and flags
1300 minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))
1301 ^ Called when player crafts something
1302 ^ itemstack is the output
1303 ^ old_craft_grid contains the recipe (Note: the one in the inventory is cleared)
1304 ^ craft_inv is the inventory with the crafting grid
1305 ^ Return either an ItemStack, to replace the output, or nil, to not modify it
1306 minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))
1307 ^ The same as before, except that it is called before the player crafts, to make
1308 ^ craft prediction, and it should not change anything.
1309 minetest.register_on_protection_violation(func(pos, name))
1310 ^ Called by builtin and mods when a player violates protection at a position
1311 (eg, digs a node or punches a protected entity).
1312 ^ The registered functions can be called using minetest.record_protection_violation
1313 ^ The provided function should check that the position is protected by the mod
1314 calling this function before it prints a message, if it does, to allow for
1315 multiple protection mods.
1316 minetest.register_on_item_eat(func(hp_change, replace_with_item, itemstack, user, pointed_thing))
1317 ^ Called when an item is eaten, by minetest.item_eat
1318 ^ Return true or itemstack to cancel the default item eat response (ie: hp increase)
1320 Other registration functions:
1321 minetest.register_chatcommand(cmd, chatcommand definition)
1322 minetest.register_privilege(name, definition)
1323 ^ definition: "description text"
1325 description = "description text",
1326 give_to_singleplayer = boolean, -- default: true
1328 minetest.register_authentication_handler(handler)
1329 ^ See minetest.builtin_auth_handler in builtin.lua for reference
1332 minetest.setting_set(name, value)
1333 minetest.setting_get(name) -> string or nil
1334 minetest.setting_setbool(name, value)
1335 minetest.setting_getbool(name) -> boolean value or nil
1336 minetest.setting_get_pos(name) -> position or nil
1337 minetest.setting_save() -> nil, save all settings to config file
1340 minetest.notify_authentication_modified(name)
1341 ^ Should be called by the authentication handler if privileges change.
1342 ^ To report everybody, set name=nil.
1343 minetest.get_password_hash(name, raw_password)
1344 ^ Convert a name-password pair to a password hash that minetest can use
1345 minetest.string_to_privs(str) -> {priv1=true,...}
1346 minetest.privs_to_string(privs) -> "priv1,priv2,..."
1347 ^ Convert between two privilege representations
1348 minetest.set_player_password(name, password_hash)
1349 minetest.set_player_privs(name, {priv1=true,...})
1350 minetest.get_player_privs(name) -> {priv1=true,...}
1351 minetest.auth_reload()
1352 ^ These call the authentication handler
1353 minetest.check_player_privs(name, {priv1=true,...}) -> bool, missing_privs
1354 ^ A quickhand for checking privileges
1355 minetest.get_player_ip(name) -> IP address string
1358 minetest.chat_send_all(text)
1359 minetest.chat_send_player(name, text)
1363 minetest.set_node(pos, node)
1364 minetest.add_node(pos, node): alias set_node(pos, node)
1365 ^ Set node at position (node = {name="foo", param1=0, param2=0})
1366 minetest.swap_node(pos, node)
1367 ^ Set node at position, but don't remove metadata
1368 minetest.remove_node(pos)
1369 ^ Equivalent to set_node(pos, "air")
1370 minetest.get_node(pos)
1371 ^ Returns {name="ignore", ...} for unloaded area
1372 minetest.get_node_or_nil(pos)
1373 ^ Returns nil for unloaded area
1374 minetest.get_node_light(pos, timeofday) -> 0...15 or nil
1375 ^ timeofday: nil = current time, 0 = night, 0.5 = day
1377 minetest.place_node(pos, node)
1378 ^ Place node with the same effects that a player would cause
1379 minetest.dig_node(pos)
1380 ^ Dig node with the same effects that a player would cause
1381 minetest.punch_node(pos)
1382 ^ Punch node with the same effects that a player would cause
1384 minetest.get_meta(pos) -- Get a NodeMetaRef at that position
1385 minetest.get_node_timer(pos) -- Get NodeTimerRef
1387 minetest.add_entity(pos, name): Spawn Lua-defined entity at position
1388 ^ Returns ObjectRef, or nil if failed
1389 minetest.add_item(pos, item): Spawn item
1390 ^ Returns ObjectRef, or nil if failed
1391 minetest.get_player_by_name(name) -- Get an ObjectRef to a player
1392 minetest.get_objects_inside_radius(pos, radius)
1393 minetest.set_timeofday(val): val: 0...1; 0 = midnight, 0.5 = midday
1394 minetest.get_timeofday()
1395 minetest.get_gametime(): returns the time, in seconds, since the world was created
1396 minetest.find_node_near(pos, radius, nodenames) -> pos or nil
1397 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1398 minetest.find_nodes_in_area(minp, maxp, nodenames) -> list of positions
1399 ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1400 minetest.get_perlin(seeddiff, octaves, persistence, scale)
1401 ^ Return world-specific perlin noise (int(worldseed)+seeddiff)
1402 minetest.get_voxel_manip()
1403 ^ Return voxel manipulator object
1404 minetest.set_gen_notify(flags)
1405 ^ Set the types of on-generate notifications that should be collected
1406 ^ flags is a comma-delimited combination of:
1407 ^ dungeon, temple, cave_begin, cave_end, large_cave_begin, large_cave_end
1408 minetest.get_mapgen_object(objectname)
1409 ^ Return requested mapgen object if available (see Mapgen objects)
1410 minetest.set_mapgen_params(MapgenParams)
1411 ^ Set map generation parameters
1412 ^ Function cannot be called after the registration period; only initialization and on_mapgen_init
1413 ^ Takes a table as an argument with the fields mgname, seed, water_level, and flags.
1414 ^ Leave field unset to leave that parameter unchanged
1415 ^ flags contains a comma-delimited string of flags to set, or if the prefix "no" is attached, clears instead.
1416 ^ flags is in the same format and has the same options as 'mg_flags' in minetest.conf
1417 minetest.set_noiseparam_defaults({np1=NoiseParams, np2= NoiseParams, ...})
1418 ^ Sets the default value of a noiseparam setting
1419 ^ Takes a table as an argument that maps one or more setting names to NoiseParams structures
1420 ^ Possible setting names consist of any NoiseParams setting exposed through the global settings
1421 minetest.clear_objects()
1422 ^ clear all objects in the environments
1423 minetest.line_of_sight(pos1, pos2, stepsize) -> true/false, pos
1424 ^ Check if there is a direct line of sight between pos1 and pos2
1425 ^ Returns the position of the blocking node when false
1426 ^ pos1 First position
1427 ^ pos2 Second position
1428 ^ stepsize smaller gives more accurate results but requires more computing
1430 minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)
1431 ^ -> table containing path
1432 ^ returns a table of 3d points representing a path from pos1 to pos2 or nil
1433 ^ pos1: start position
1434 ^ pos2: end position
1435 ^ searchdistance: number of blocks to search in each direction
1436 ^ max_jump: maximum height difference to consider walkable
1437 ^ max_drop: maximum height difference to consider droppable
1438 ^ algorithm: A*_noprefetch(default), A*, Dijkstra
1439 minetest.spawn_tree (pos, {treedef})
1440 ^ spawns L-System tree at given pos with definition in treedef table
1441 minetest.transforming_liquid_add(pos)
1442 ^ add node to liquid update queue
1443 minetest.get_node_max_level(pos)
1444 ^ get max available level for leveled node
1445 minetest.get_node_level(pos)
1446 ^ get level of leveled node (water, snow)
1447 minetest.set_node_level(pos, level)
1448 ^ set level of leveled node, default level = 1, if totallevel > maxlevel returns rest (total-max).
1449 minetest.add_node_level(pos, level)
1450 ^ increase level of leveled node by level, default level = 1, if totallevel > maxlevel returns rest (total-max). can be negative for decreasing
1453 minetest.get_inventory(location) -> InvRef
1454 ^ location = eg. {type="player", name="celeron55"}
1455 {type="node", pos={x=, y=, z=}}
1456 {type="detached", name="creative"}
1457 minetest.create_detached_inventory(name, callbacks) -> InvRef
1458 ^ callbacks: See "Detached inventory callbacks"
1459 ^ Creates a detached inventory. If it already exists, it is cleared.
1462 minetest.show_formspec(playername, formname, formspec)
1463 ^ playername: name of player to show formspec
1464 ^ formname: name passed to on_player_receive_fields callbacks
1465 ^ should follow "modname:<whatever>" naming convention
1466 ^ formspec: formspec to display
1467 minetest.formspec_escape(string) -> string
1468 ^ escapes characters [ ] \ , ; that can not be used in formspecs
1469 minetest.explode_table_event(string) -> table
1470 ^ returns e.g. {type="CHG", row=1, column=2}
1471 ^ type: "INV" (no row selected), "CHG" (selected) or "DCL" (double-click)
1472 minetest.explode_textlist_event(string) -> table
1473 ^ returns e.g. {type="CHG", index=1}
1474 ^ type: "INV" (no row selected), "CHG" (selected) or "DCL" (double-click)
1477 minetest.inventorycube(img1, img2, img3)
1478 ^ Returns a string for making an image of a cube (useful as an item image)
1479 minetest.get_pointed_thing_position(pointed_thing, above)
1480 ^ Get position of a pointed_thing (that you can get from somewhere)
1481 minetest.dir_to_facedir(dir, is6d)
1482 ^ 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
1483 minetest.facedir_to_dir(facedir)
1484 ^ Convert a facedir back into a vector aimed directly out the "back" of a node
1485 minetest.dir_to_wallmounted(dir)
1486 ^ Convert a vector to a wallmounted value, used for paramtype2="wallmounted"
1487 minetest.get_node_drops(nodename, toolname)
1488 ^ Returns list of item names.
1489 ^ Note: This will be removed or modified in a future version.
1490 minetest.get_craft_result(input) -> output, decremented_input
1491 ^ input.method = 'normal' or 'cooking' or 'fuel'
1492 ^ input.width = for example 3
1493 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
1494 stack 5, stack 6, stack 7, stack 8, stack 9 }
1495 ^ output.item = ItemStack, if unsuccessful: empty ItemStack
1496 ^ output.time = number, if unsuccessful: 0
1497 ^ decremented_input = like input
1498 minetest.get_craft_recipe(output) -> input
1499 ^ returns last registered recipe for output item (node)
1500 ^ output is a node or item type such as 'default:torch'
1501 ^ input.method = 'normal' or 'cooking' or 'fuel'
1502 ^ input.width = for example 3
1503 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
1504 stack 5, stack 6, stack 7, stack 8, stack 9 }
1505 ^ input.items = nil if no recipe found
1506 minetest.get_all_craft_recipes(query item) -> table or nil
1507 ^ returns indexed table with all registered recipes for query item (node)
1508 or nil if no recipe was found
1511 method = 'normal' or 'cooking' or 'fuel'
1512 width = 0-3, 0 means shapeless recipe
1513 items = indexed [1-9] table with recipe items
1514 output = string with item name and quantity
1516 Example query for default:gold_ingot will return table:
1518 1={type = "cooking", width = 3, output = "default:gold_ingot",
1519 items = {1 = "default:gold_lump"}},
1520 2={type = "normal", width = 1, output = "default:gold_ingot 9",
1521 items = {1 = "default:goldblock"}}
1523 minetest.handle_node_drops(pos, drops, digger)
1524 ^ drops: list of itemstrings
1525 ^ Handles drops from nodes after digging: Default action is to put them into
1527 ^ Can be overridden to get different functionality (eg. dropping items on
1531 minetest.rollback_get_node_actions(pos, range, seconds, limit) -> {{actor, pos, time, oldnode, newnode}, ...}
1532 ^ Find who has done something to a node, or near a node
1533 ^ actor: "player:<name>", also "liquid".
1534 minetest.rollback_revert_actions_by(actor, seconds) -> bool, log messages
1535 ^ Revert latest actions of someone
1536 ^ actor: "player:<name>", also "liquid".
1538 Defaults for the on_* item definition functions:
1539 (These return the leftover itemstack)
1540 minetest.item_place_node(itemstack, placer, pointed_thing, param2)
1541 ^ Place item as a node
1542 ^ param2 overrides facedir and wallmounted param2
1543 ^ returns itemstack, success
1544 minetest.item_place_object(itemstack, placer, pointed_thing)
1546 minetest.item_place(itemstack, placer, pointed_thing, param2)
1547 ^ Use one of the above based on what the item is.
1548 ^ Calls on_rightclick of pointed_thing.under if defined instead
1549 ^ Note: is not called when wielded item overrides on_place
1550 ^ param2 overrides facedir and wallmounted param2
1551 ^ returns itemstack, success
1552 minetest.item_drop(itemstack, dropper, pos)
1554 minetest.item_eat(hp_change, replace_with_item)
1555 ^ Eat the item. replace_with_item can be nil.
1557 Defaults for the on_punch and on_dig node definition callbacks:
1558 minetest.node_punch(pos, node, puncher, pointed_thing)
1559 ^ Calls functions registered by minetest.register_on_punchnode()
1560 minetest.node_dig(pos, node, digger)
1561 ^ Checks if node can be dug, puts item into inventory, removes node
1562 ^ Calls functions registered by minetest.registered_on_dignodes()
1565 minetest.sound_play(spec, parameters) -> handle
1566 ^ spec = SimpleSoundSpec
1567 ^ parameters = sound parameter table
1568 minetest.sound_stop(handle)
1571 minetest.after(time, func, ...)
1572 ^ Call function after time seconds
1573 ^ Optional: Variable number of arguments that are passed to func
1576 minetest.request_shutdown() -> request for server shutdown
1577 minetest.get_server_status() -> server status string
1580 minetest.get_ban_list() -> ban list (same as minetest.get_ban_description(""))
1581 minetest.get_ban_description(ip_or_name) -> ban description (string)
1582 minetest.ban_player(name) -> ban a player
1583 minetest.unban_player_or_ip(name) -> unban player or IP address
1584 minetest.kick_player(name, [reason]) -> disconnect a player with a optional reason
1587 minetest.add_particle(particle definition)
1588 ^ Deprecated: minetest.add_particle(pos, velocity, acceleration, expirationtime,
1589 size, collisiondetection, texture, playername)
1591 minetest.add_particlespawner(particlespawner definition)
1592 ^ Add a particlespawner, an object that spawns an amount of particles over time seconds
1594 ^ Deprecated: minetest.add_particlespawner(amount, time,
1598 minexptime, maxexptime,
1600 collisiondetection, texture, playername)
1602 minetest.delete_particlespawner(id, player)
1603 ^ Delete ParticleSpawner with id (return value from add_particlespawner)
1604 ^ If playername is specified, only deletes on the player's client,
1605 ^ otherwise on all clients
1608 minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)
1609 ^ Create a schematic from the volume of map specified by the box formed by p1 and p2.
1610 ^ Apply the specified probability values to the specified nodes in probability_list.
1611 ^ probability_list is an array of tables containing two fields, pos and prob.
1612 ^ pos is the 3d vector specifying the absolute coordinates of the node being modified,
1613 ^ and prob is the integer value from 0 to 255 of the probability (see: Schematic specifier).
1614 ^ If there are two or more entries with the same pos value, the last occuring in the array is used.
1615 ^ If pos is not inside the box formed by p1 and p2, it is ignored.
1616 ^ If probability_list is nil, no probabilities are applied.
1617 ^ Slice probability works in the same manner, except takes a field called ypos instead which indicates
1618 ^ the y position of the slice with a probability applied.
1619 ^ If slice probability list is nil, no slice probabilities are applied.
1620 ^ Saves schematic in the Minetest Schematic format to filename.
1622 minetest.place_schematic(pos, schematic, rotation, replacements, force_placement)
1623 ^ Place the schematic specified by schematic (see: Schematic specifier) at pos.
1624 ^ Rotation can be "0", "90", "180", "270", or "random".
1625 ^ If the rotation parameter is omitted, the schematic is not rotated.
1626 ^ replacements = {{"oldname", "convert_to"}, ...}
1627 ^ force_placement is a boolean indicating whether nodes other than air and
1628 ^ ignore are replaced by the schematic
1631 minetest.get_connected_players() -> list of ObjectRefs
1632 minetest.hash_node_position({x=,y=,z=}) -> 48-bit integer
1633 ^ Gives a unique hash number for a node position (16+16+16=48bit)
1634 minetest.get_position_from_hash(hash) -> postion
1635 ^ Inverse transform of minetest.hash_node_postion
1636 minetest.get_item_group(name, group) -> rating
1637 ^ Get rating of a group of an item. (0 = not in group)
1638 minetest.get_node_group(name, group) -> rating
1639 ^ Deprecated: An alias for the former.
1640 minetest.get_content_id(name) -> integer
1641 ^ Gets the internal content ID of name
1642 minetest.get_name_from_content_id(content_id) -> string
1643 ^ Gets the name of the content with that content ID
1644 minetest.parse_json(string[, nullvalue]) -> something
1645 ^ Convert a string containing JSON data into the Lua equivalent
1646 ^ nullvalue: returned in place of the JSON null; defaults to nil
1647 ^ On success returns a table, a string, a number, a boolean or nullvalue
1648 ^ On failure outputs an error message and returns nil
1649 ^ Example: parse_json("[10, {\"a\":false}]") -> {10, {a = false}}
1650 minetest.write_json(data[, styled]) -> string or nil and error message
1651 ^ Convert a Lua table into a JSON string
1652 ^ styled: Outputs in a human-readable format if this is set, defaults to false
1653 ^ Un-serializable things like functions and userdata are saved as null.
1654 ^ Warning: JSON is more strict than the Lua table format.
1655 1. You can only use strings and positive integers of at least one as keys.
1656 2. You can not mix string and integer keys.
1657 This is due to the fact that Javascript has two distinct array and object values.
1658 ^ Example: write_json({10, {a = false}}) -> "[10, {\"a\": false}]"
1659 minetest.serialize(table) -> string
1660 ^ Convert a table containing tables, strings, numbers, booleans and nils
1661 into string form readable by minetest.deserialize
1662 ^ Example: serialize({foo='bar'}) -> 'return { ["foo"] = "bar" }'
1663 minetest.deserialize(string) -> table
1664 ^ Convert a string returned by minetest.deserialize into a table
1665 ^ String is loaded in an empty sandbox environment.
1666 ^ Will load functions, but they cannot access the global environment.
1667 ^ Example: deserialize('return { ["foo"] = "bar" }') -> {foo='bar'}
1668 ^ Example: deserialize('print("foo")') -> nil (function call fails)
1669 ^ error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)
1670 minetest.is_protected(pos, name) -> bool
1671 ^ This function should be overriden by protection mods and should be used to
1672 check if a player can interact at a position.
1673 ^ This function should call the old version of itself if the position is not
1674 protected by the mod.
1676 local old_is_protected = minetest.is_protected
1677 function minetest.is_protected(pos, name)
1678 if mymod:position_protected_from(pos, name) then
1681 return old_is_protected(pos, name)
1683 minetest.record_protection_violation(pos, name)
1684 ^ This function calls functions registered with
1685 minetest.register_on_protection_violation.
1686 minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)
1687 ^ Attempt to predict the desired orientation of the facedir-capable node
1688 defined by itemstack, and place it accordingly (on-wall, on the floor, or
1689 hanging from the ceiling). Stacks are handled normally if the infinitestacks
1690 field is false or omitted (else, the itemstack is not changed). orient_flags
1691 is an optional table containing extra tweaks to the placement code:
1692 invert_wall: if true, place wall-orientation on the ground and ground-
1693 orientation on the wall.
1694 force_wall: if true, always place the node in wall orientation.
1695 force_ceiling: if true, always place on the ceiling.
1696 force_floor: if true, always place the node on the floor.
1698 The above four options are mutually-exclusive; the last in the list takes
1699 precedence over the first.
1701 force_facedir: if true, forcably reset the facedir to north when placing on
1702 the floor or ceiling
1704 minetest.rotate_node(itemstack, placer, pointed_thing)
1705 ^ calls rotate_and_place() with infinitestacks set according to the state of
1706 the creative mode setting, and checks for "sneak" to set the invert_wall
1709 minetest.forceload_block(pos)
1710 ^ forceloads the position pos.
1711 ^ returns true if area could be forceloaded
1713 minetest.forceload_free_block(pos)
1714 ^ stops forceloading the position pos.
1716 Please note that forceloaded areas are saved when the server restarts.
1719 minetest.env - EnvRef of the server environment and world.
1720 ^ Any function in the minetest namespace can be called using the syntax
1721 minetest.env:somefunction(somearguments)
1723 minetest.somefunction(somearguments)
1724 ^ Deprecated, but support is not to be dropped soon
1727 minetest.registered_items
1728 ^ List of registered items, indexed by name
1729 minetest.registered_nodes
1730 ^ List of registered node definitions, indexed by name
1731 minetest.registered_craftitems
1732 ^ List of registered craft item definitions, indexed by name
1733 minetest.registered_tools
1734 ^ List of registered tool definitions, indexed by name
1735 minetest.registered_entities
1736 ^ List of registered entity prototypes, indexed by name
1737 minetest.object_refs
1738 ^ List of object references, indexed by active object id
1739 minetest.luaentities
1740 ^ List of lua entities, indexed by active object id
1744 NodeMetaRef: Node metadata - reference extra data and functionality stored
1746 - Can be gotten via minetest.get_nodemeta(pos)
1748 - set_string(name, value)
1750 - set_int(name, value)
1752 - set_float(name, value)
1754 - get_inventory() -> InvRef
1755 - to_table() -> nil or {fields = {...}, inventory = {list1 = {}, ...}}
1756 - from_table(nil or {})
1757 ^ See "Node Metadata"
1759 NodeTimerRef: Node Timers - a high resolution persistent per-node timer
1760 - Can be gotten via minetest.get_node_timer(pos)
1762 - set(timeout,elapsed)
1763 ^ set a timer's state
1764 ^ timeout is in seconds, and supports fractional values (0.1 etc)
1765 ^ elapsed is in seconds, and supports fractional values (0.1 etc)
1766 ^ will trigger the node's on_timer function after timeout-elapsed seconds
1769 ^ equivelent to set(timeout,0)
1772 - get_timeout() -> current timeout in seconds
1773 ^ if timeout is 0, timer is inactive
1774 - get_elapsed() -> current elapsed time in seconds
1775 ^ the node's on_timer function will be called after timeout-elapsed seconds
1776 - is_started() -> boolean state of timer
1777 ^ returns true if timer is started, otherwise false
1779 ObjectRef: Moving things in the game are generally these
1780 (basically reference to a C++ ServerActiveObject)
1782 - remove(): remove object (after returning from Lua)
1783 - getpos() -> {x=num, y=num, z=num}
1784 - setpos(pos); pos={x=num, y=num, z=num}
1785 - moveto(pos, continuous=false): interpolated move
1786 - punch(puncher, time_from_last_punch, tool_capabilities, direction)
1787 ^ puncher = an another ObjectRef,
1788 ^ time_from_last_punch = time since last punch action of the puncher
1789 ^ direction: can be nil
1790 - right_click(clicker); clicker = an another ObjectRef
1791 - get_hp(): returns number of hitpoints (2 * number of hearts)
1792 - set_hp(hp): set number of hitpoints (2 * number of hearts)
1793 - get_inventory() -> InvRef
1794 - get_wield_list(): returns the name of the inventory list the wielded item is in
1795 - get_wield_index(): returns the index of the wielded item
1796 - get_wielded_item() -> ItemStack
1797 - set_wielded_item(item): replaces the wielded item, returns true if successful
1798 - set_armor_groups({group1=rating, group2=rating, ...})
1799 - set_animation({x=1,y=1}, frame_speed=15, frame_blend=0)
1800 - set_attach(parent, bone, position, rotation)
1802 ^ position = {x=num, y=num, z=num} (relative)
1803 ^ rotation = {x=num, y=num, z=num}
1805 - set_bone_position(bone, position, rotation)
1807 ^ position = {x=num, y=num, z=num} (relative)
1808 ^ rotation = {x=num, y=num, z=num}
1809 - set_properties(object property table)
1810 LuaEntitySAO-only: (no-op for other objects)
1811 - setvelocity({x=num, y=num, z=num})
1812 - getvelocity() -> {x=num, y=num, z=num}
1813 - setacceleration({x=num, y=num, z=num})
1814 - getacceleration() -> {x=num, y=num, z=num}
1816 - getyaw() -> radians
1817 - settexturemod(mod)
1818 - setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
1819 - select_horiz_by_yawpitch=false)
1820 ^ Select sprite from spritesheet with optional animation and DM-style
1821 texture selection based on yaw relative to camera
1822 - get_entity_name() (DEPRECATED: Will be removed in a future version)
1824 Player-only: (no-op for other objects)
1825 - is_player(): true for players, false for others
1826 - get_player_name(): returns "" if is not a player
1827 - get_look_dir(): get camera direction as a unit vector
1828 - get_look_pitch(): pitch in radians
1829 - get_look_yaw(): yaw in radians (wraps around pretty randomly as of now)
1830 - set_look_pitch(radians): sets look pitch
1831 - set_look_yaw(radians): sets look yaw
1832 - get_breath() : returns players breath
1833 - set_breath(value) : sets players breath
1834 values: 0 player is drowning,
1835 1-10 number of bubbles remain,
1836 11 bubbles bar is not shown
1837 - set_inventory_formspec(formspec)
1838 ^ Redefine player's inventory form
1839 ^ Should usually be called in on_joinplayer
1840 - get_inventory_formspec() -> formspec string
1841 - get_player_control(): returns table with player pressed keys
1842 {jump=bool,right=bool,left=bool,LMB=bool,RMB=bool,sneak=bool,aux1=bool,down=bool,up=bool}
1843 - get_player_control_bits(): returns integer with bit packed player pressed keys
1844 bit nr/meaning: 0/up ,1/down ,2/left ,3/right ,4/jump ,5/aux1 ,6/sneak ,7/LMB ,8/RMB
1845 - set_physics_override({
1846 speed = 1.0, -- multiplier to default value
1847 jump = 1.0, -- multiplier to default value
1848 gravity = 1.0, -- multiplier to default value
1849 sneak = true, -- whether player can sneak
1850 sneak_glitch = true, -- whether player can use the sneak glitch
1852 - hud_add(hud definition): add a HUD element described by HUD def, returns ID number on success
1853 - hud_remove(id): remove the HUD element of the specified id
1854 - hud_change(id, stat, value): change a value of a previously added HUD element
1855 ^ element stat values: position, name, scale, text, number, item, dir
1856 - hud_get(id): gets the HUD element definition structure of the specified ID
1857 - hud_set_flags(flags): sets specified HUD flags to true/false
1858 ^ flags: (is visible) hotbar, healthbar, crosshair, wielditem
1859 ^ pass a table containing a true/false value of each flag to be set or unset
1860 ^ if a flag is nil, the flag is not modified
1861 - hud_get_flags(): returns a table containing status of hud flags
1862 ^ returns { hotbar=true, healthbar=true, crosshair=true, wielditem=true, breathbar=true }
1863 - hud_set_hotbar_itemcount(count): sets number of items in builtin hotbar
1864 ^ count: number of items, must be between 1 and 23
1865 - hud_set_hotbar_image(texturename)
1866 ^ sets background image for hotbar
1867 - hud_set_hotbar_selected_image(texturename)
1868 ^ sets image for selected item of hotbar
1869 - hud_replace_builtin(name, hud definition)
1870 ^ replace definition of a builtin hud element
1871 ^ name: "breath" or "health"
1872 ^ hud definition: definition to replace builtin definition
1873 - set_sky(bgcolor, type, {texture names})
1874 ^ bgcolor: {r=0...255, g=0...255, b=0...255} or nil, defaults to white
1876 - "regular": Uses 0 textures, bgcolor ignored
1877 - "skybox": Uses 6 textures, bgcolor used
1878 - "plain": Uses 0 textures, bgcolor used
1879 ^ Note: currently does not work directly in on_joinplayer; use
1880 minetest.after(0) in there.
1881 - override_day_night_ratio(ratio or nil)
1882 ^ 0...1: Overrides day-night ratio, controlling sunlight to a specific amount
1883 ^ nil: Disables override, defaulting to sunlight based on day-night cycle
1884 - set_local_animation({x=0, y=79}, {x=168, y=187}, {x=189, y=198}, {x=200, y=219}, frame_speed=30): set animation for player model in third person view
1885 ^ stand/idle animation key frames
1886 ^ walk animation key frames
1887 ^ dig animation key frames
1888 ^ walk+dig animation key frames
1889 ^ animation frame speed
1890 - set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0}): defines offset value for camera per player
1891 ^ in first person view
1892 ^ in third person view (max. values {x=-10/10,y=-10,15,z=-5/5})
1894 InvRef: Reference to an inventory
1896 - is_empty(listname): return true if list is empty
1897 - get_size(listname): get size of a list
1898 - set_size(listname, size): set size of a list
1899 ^ returns false on error (e.g. invalid listname or listsize)
1900 - get_width(listname): get width of a list
1901 - set_width(listname, width): set width of list; currently used for crafting
1902 - get_stack(listname, i): get a copy of stack index i in list
1903 - set_stack(listname, i, stack): copy stack to index i in list
1904 - get_list(listname): return full list
1905 - set_list(listname, list): set full list (size will not change)
1906 - get_lists(): returns list of inventory lists
1907 - set_lists(lists): sets inventory lists (size will not change)
1908 - add_item(listname, stack): add item somewhere in list, returns leftover ItemStack
1909 - room_for_item(listname, stack): returns true if the stack of items
1910 can be fully added to the list
1911 - contains_item(listname, stack): returns true if the stack of items
1912 can be fully taken from the list
1913 remove_item(listname, stack): take as many items as specified from the list,
1914 returns the items that were actually removed (as an ItemStack)
1915 - get_location() -> location compatible to minetest.get_inventory(location)
1916 -> {type="undefined"} in case location is not known
1918 ItemStack: A stack of items.
1919 - Can be created via ItemStack(itemstack or itemstring or table or nil)
1921 - is_empty(): return true if stack is empty
1922 - get_name(): returns item name (e.g. "default:stone")
1923 - set_name(itemname)
1924 - get_count(): returns number of items on the stack
1926 - get_wear(): returns tool wear (0-65535), 0 for non-tools
1928 - get_metadata(): returns metadata (a string attached to an item stack)
1929 - set_metadata(metadata)
1930 - clear(): removes all items from the stack, making it empty
1931 - replace(item): replace the contents of this stack (item can also
1932 be an itemstring or table)
1933 - to_string(): returns the stack in itemstring form
1934 - to_table(): returns the stack in Lua table form
1935 - get_stack_max(): returns the maximum size of the stack (depends on the item)
1936 - get_free_space(): returns get_stack_max() - get_count()
1937 - is_known(): returns true if the item name refers to a defined item type
1938 - get_definition(): returns the item definition table
1939 - get_tool_capabilities(): returns the digging properties of the item,
1940 ^ or those of the hand if none are defined for this item type
1941 - add_wear(amount): increases wear by amount if the item is a tool
1942 - add_item(item): put some item or stack onto this stack,
1943 ^ returns leftover ItemStack
1944 - item_fits(item): returns true if item or stack can be fully added to this one
1945 - take_item(n): take (and remove) up to n items from this stack
1946 ^ returns taken ItemStack
1947 ^ if n is omitted, n=1 is used
1948 - peek_item(n): copy (don't remove) up to n items from this stack
1949 ^ returns copied ItemStack
1950 ^ if n is omitted, n=1 is used
1952 PseudoRandom: A pseudorandom number generator
1953 - Can be created via PseudoRandom(seed)
1955 - next(): return next integer random number [0...32767]
1956 - next(min, max): return next integer random number [min...max]
1957 (max - min) must be 32767 or <= 6553 due to the simple
1958 implementation making bad distribution otherwise.
1960 PerlinNoise: A perlin noise generator
1961 - Can be created via PerlinNoise(seed, octaves, persistence, scale)
1962 - Also minetest.get_perlin(seeddiff, octaves, persistence, scale)
1964 - get2d(pos) -> 2d noise value at pos={x=,y=}
1965 - get3d(pos) -> 3d noise value at pos={x=,y=,z=}
1967 PerlinNoiseMap: A fast, bulk perlin noise generator
1968 - Can be created via PerlinNoiseMap(noiseparams, size)
1969 - Also minetest.get_perlin_map(noiseparams, size)
1971 - get2dMap(pos) -> <size.x>X<size.y> 2d array of 2d noise values starting at pos={x=,y=}
1972 - get3dMap(pos) -> <size.x>X<size.y>X<size.z> 3d array of 3d noise values starting at pos={x=,y=,z=}
1973 - get2dMap_flat(pos) -> Flat <size.x * size.y> element array of 2d noise values starting at pos={x=,y=}
1974 - get3dMap_flat(pos) -> Same as get2dMap_flat, but 3d noise
1976 VoxelManip: An interface to the MapVoxelManipulator for Lua
1977 - Can be created via VoxelManip()
1978 - Also minetest.get_voxel_manip()
1980 - read_from_map(p1, p2): Reads a chunk of map from the map containing the region formed by p1 and p2.
1981 ^ returns actual emerged pmin, actual emerged pmax
1982 - write_to_map(): Writes the data loaded from the VoxelManip back to the map.
1983 ^ important: data must be set using VoxelManip:set_data before calling this
1984 - get_data(): Gets the data read into the VoxelManip object
1985 ^ returns raw node data is in the form of an array of node content ids
1986 - set_data(data): Sets the data contents of the VoxelManip object
1987 - update_map(): Update map after writing chunk back to map.
1988 ^ To be used only by VoxelManip objects created by the mod itself; not a VoxelManip that was
1989 ^ retrieved from minetest.get_mapgen_object
1990 - set_lighting(light, p1, p2): Set the lighting within the VoxelManip to a uniform value
1991 ^ light is a table, {day=<0...15>, night=<0...15>}
1992 ^ To be used only by a VoxelManip object from minetest.get_mapgen_object
1993 ^ (p1, p2) is the area in which lighting is set; defaults to the whole area if left out
1994 - get_light_data(): Gets the light data read into the VoxelManip object
1995 ^ Returns an array (indicies 1 to volume) of integers ranging from 0 to 255
1996 ^ Each value is the bitwise combination of day and night light values (0..15 each)
1997 ^ light = day + (night * 16)
1998 - set_light_data(light_data): Sets the param1 (light) contents of each node in the VoxelManip
1999 ^ expects lighting data in the same format that get_light_data() returns
2000 - get_param2_data(): Gets the raw param2 data read into the VoxelManip object
2001 - set_param2_data(param2_data): Sets the param2 contents of each node in the VoxelManip
2002 - calc_lighting(p1, p2): Calculate lighting within the VoxelManip
2003 ^ To be used only by a VoxelManip object from minetest.get_mapgen_object
2004 ^ (p1, p2) is the area in which lighting is set; defaults to the whole area if left out
2005 - update_liquids(): Update liquid flow
2007 VoxelArea: A helper class for voxel areas
2008 - Can be created via VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}
2009 - Coordinates are *inclusive*, like most other things in Minetest
2011 - getExtent(): returns a 3d vector containing the size of the area formed by MinEdge and MaxEdge
2012 - getVolume(): returns the volume of the area formed by MinEdge and MaxEdge
2013 - index(x, y, z): returns the index of an absolute position in a flat array starting at 1
2014 ^ useful for things like VoxelManip, raw Schematic specifiers, PerlinNoiseMap:get2d/3dMap, and so on
2015 - indexp(p): same as above, except takes a vector
2016 - position(i): returns the absolute position vector corresponding to index i
2017 - contains(x, y, z): check if (x,y,z) is inside area formed by MinEdge and MaxEdge
2018 - containsp(p): same as above, except takes a vector
2019 - containsi(i): same as above, except takes an index
2020 - iter(minx, miny, minz, maxx, maxy, maxz): returns an iterator that returns indices
2021 ^ from (minx,miny,minz) to (maxx,maxy,maxz) in the order of [z [y [x]]]
2022 - iterp(minp, maxp): same as above, except takes a vector
2024 Settings: An interface to read config files in the format of minetest.conf
2025 - Can be created via Settings(filename)
2028 - get_bool(key) -> boolean
2030 - remove(key) -> success
2031 - get_names() -> {key1,...}
2032 - write() -> success
2033 ^ write changes to file
2034 - to_table() -> {[key1]=value1,...}
2038 A mapgen object is a construct used in map generation. Mapgen objects can be used by an on_generate
2039 callback to speed up operations by avoiding unnecessary recalculations; these can be retrieved using the
2040 minetest.get_mapgen_object() function. If the requested Mapgen object is unavailable, or
2041 get_mapgen_object() was called outside of an on_generate() callback, nil is returned.
2043 The following Mapgen objects are currently available:
2046 This returns three values; the VoxelManip object to be used, minimum and maximum emerged position, in that
2047 order. All mapgens support this object.
2050 Returns an array containing the y coordinates of the ground levels of nodes in the most recently
2051 generated chunk by the current mapgen.
2054 Returns an array containing the biome IDs of nodes in the most recently generated chunk by the
2058 Returns an array containing the temperature values of nodes in the most recently generated chunk by
2062 Returns an array containing the humidity values of nodes in the most recently generated chunk by the
2066 Returns a table mapping requested generation notification types to arrays of positions at which the
2067 corresponding generated structures are located at within the current chunk. To set the capture of positions
2068 of interest to be recorded on generate, use minetest.set_gen_notify().
2069 Possible fields of the table returned are: dungeon, temple, cave_begin, cave_end, large_cave_begin, large_cave_end
2072 --------------------
2073 - Functions receive a "luaentity" as self:
2074 - It has the member .name, which is the registered name ("mod:thing")
2075 - It has the member .object, which is an ObjectRef pointing to the object
2076 - The original prototype stuff is visible directly via a metatable
2078 - on_activate(self, staticdata)
2079 ^ Called when the object is instantiated.
2080 - on_step(self, dtime)
2081 ^ Called on every server tick (dtime is usually 0.1 seconds)
2082 - on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
2083 ^ Called when somebody punches the object.
2084 ^ Note that you probably want to handle most punches using the
2085 automatic armor group system.
2086 ^ puncher: ObjectRef (can be nil)
2087 ^ time_from_last_punch: Meant for disallowing spamming of clicks (can be nil)
2088 ^ tool_capabilities: capability table of used tool (can be nil)
2089 ^ dir: unit vector of direction of punch. Always defined. Points from
2090 the puncher to the punched.
2091 - on_rightclick(self, clicker)
2092 - get_staticdata(self)
2093 ^ Should return a string that will be passed to on_activate when
2094 the object is instantiated the next time.
2099 axiom, - string initial tree axiom
2100 rules_a, - string rules set A
2101 rules_b, - string rules set B
2102 rules_c, - string rules set C
2103 rules_d, - string rules set D
2104 trunk, - string trunk node name
2105 leaves, - string leaves node name
2106 leaves2, - string secondary leaves node name
2107 leaves2_chance,- num chance (0-100) to replace leaves with leaves2
2108 angle, - num angle in deg
2109 iterations, - num max # of iterations, usually 2 -5
2110 random_level, - num factor to lower nr of iterations, usually 0 - 3
2111 trunk_type, - string single/double/crossed) type of trunk: 1 node, 2x2 nodes or 3x3 in cross shape
2112 thin_branches, - boolean true -> use thin (1 node) branches
2113 fruit, - string fruit node name
2114 fruit_chance, - num chance (0-100) to replace leaves with fruit node
2115 seed, - num random seed
2118 Key for Special L-System Symbols used in Axioms
2119 G - move forward one unit with the pen up
2120 F - move forward one unit with the pen down drawing trunks and branches
2121 f - move forward one unit with the pen down drawing leaves (100% chance)
2122 T - move forward one unit with the pen down drawing trunks only
2123 R - move forward one unit with the pen down placing fruit
2124 A - replace with rules set A
2125 B - replace with rules set B
2126 C - replace with rules set C
2127 D - replace with rules set D
2128 a - replace with rules set A, chance 90%
2129 b - replace with rules set B, chance 80%
2130 c - replace with rules set C, chance 70%
2131 d - replace with rules set D, chance 60%
2132 + - yaw the turtle right by angle parameter
2133 - - yaw the turtle left by angle parameter
2134 & - pitch the turtle down by angle parameter
2135 ^ - pitch the turtle up by angle parameter
2136 / - roll the turtle to the right by angle parameter
2137 * - roll the turtle to the left by angle parameter
2138 [ - save in stack current state info
2139 ] - recover from stack state info
2141 Example usage: spawn small apple tree
2144 rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
2145 rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
2146 trunk="default:tree",
2147 leaves="default:leaves",
2151 trunk_type="single",
2154 fruit="default:apple"
2156 minetest.spawn_tree(pos,apple_tree)
2165 collide_with_objects = true, -- collide with other objects if physical=true
2167 collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
2168 visual = "cube"/"sprite"/"upright_sprite"/"mesh"/"wielditem",
2169 visual_size = {x=1, y=1},
2171 textures = {}, -- number of required textures depends on visual
2172 colors = {}, -- number of required colors depends on visual
2173 spritediv = {x=1, y=1},
2174 initial_sprite_basepos = {x=0, y=0},
2176 makes_footstep_sound = false,
2177 automatic_rotate = false,
2179 automatic_face_movement_dir = 0.0,
2180 ^ automatically set yaw to movement direction; offset in degrees; false to disable
2183 Entity definition (register_entity)
2185 (Deprecated: Everything in object properties is read directly from here)
2187 initial_properties = <initial object properties>,
2189 on_activate = function(self, staticdata, dtime_s),
2190 on_step = function(self, dtime),
2191 on_punch = function(self, hitter),
2192 on_rightclick = function(self, clicker),
2193 get_staticdata = function(self),
2194 ^ Called sometimes; the string returned is passed to on_activate when
2195 the entity is re-activated from static state
2197 # Also you can define arbitrary member variables here
2198 myvariable = whatever,
2201 ABM (ActiveBlockModifier) definition (register_abm)
2203 -- In the following two fields, also group:groupname will work.
2204 nodenames = {"default:lava_source"},
2205 neighbors = {"default:water_source", "default:water_flowing"}, -- (any of these)
2206 ^ If left out or empty, any neighbor will do
2207 interval = 1.0, -- (operation interval)
2208 chance = 1, -- (chance of trigger is 1.0/this)
2209 action = func(pos, node, active_object_count, active_object_count_wider),
2212 Item definition (register_node, register_craftitem, register_tool)
2214 description = "Steel Axe",
2215 groups = {}, -- key=name, value=rating; rating=1..3.
2216 if rating not applicable, use 1.
2217 eg. {wool=1, fluffy=3}
2218 {soil=2, outerspace=1, crumbly=1}
2219 {bendy=2, snappy=1},
2220 {hard=1, metal=1, spikes=1}
2221 inventory_image = "default_tool_steelaxe.png",
2223 wield_scale = {x=1,y=1,z=1},
2226 liquids_pointable = false,
2227 tool_capabilities = {
2228 full_punch_interval = 1.0,
2232 snappy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
2233 choppy={times={[3]=0.90}, maxwear=0.05, maxlevel=0}
2235 damage_groups = {groupname=damage},
2237 node_placement_prediction = nil,
2238 ^ If nil and item is node, prediction is made automatically
2239 ^ If nil and item is not a node, no prediction is made
2240 ^ If "" and item is anything, no prediction is made
2241 ^ Otherwise should be name of node which the client immediately places
2242 on ground when the player places the item. Server will always update
2243 actual result to client in a short moment.
2245 place = <SimpleSoundSpec>,
2248 on_place = func(itemstack, placer, pointed_thing),
2249 ^ Shall place item and return the leftover itemstack
2250 ^ default: minetest.item_place
2251 on_drop = func(itemstack, dropper, pos),
2252 ^ Shall drop item and return the leftover itemstack
2253 ^ default: minetest.item_drop
2254 on_use = func(itemstack, user, pointed_thing),
2256 ^ Function must return either nil if no item shall be removed from
2257 inventory, or an itemstack to replace the original itemstack.
2258 eg. itemstack:take_item(); return itemstack
2259 ^ Otherwise, the function is free to do what it wants.
2260 ^ The default functions handle regular use cases.
2261 after_use = func(itemstack, user, node, digparams),
2263 ^ If defined, should return an itemstack and will be called instead of
2264 wearing out the tool. If returns nil, does nothing.
2265 If after_use doesn't exist, it is the same as:
2266 function(itemstack, user, node, digparams)
2267 itemstack:add_wear(digparams.wear)
2274 - {name="image.png", animation={Tile Animation definition}}
2275 - {name="image.png", backface_culling=bool}
2276 ^ backface culling only supported in special tiles
2277 - deprecated still supported field names:
2280 Tile animation definition:
2281 - {type="vertical_frames", aspect_w=16, aspect_h=16, length=3.0}
2283 Node definition (register_node)
2285 <all fields allowed in item definitions>,
2287 drawtype = "normal", -- See "Node drawtypes"
2289 ^ Supported for drawtypes "plantlike", "signlike", "torchlike".
2290 ^ For plantlike, the image will start at the bottom of the node; for the
2291 ^ other drawtypes, the image will be centered on the node.
2292 ^ Note that positioning for "torchlike" may still change.
2293 tiles = {tile definition 1, def2, def3, def4, def5, def6},
2294 ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
2295 ^ List can be shortened to needed length
2296 special_tiles = {tile definition 1, Tile definition 2},
2297 ^ Special textures of node; used rarely (old field name: special_materials)
2298 ^ List can be shortened to needed length
2300 use_texture_alpha = false, -- Use texture's alpha channel
2301 post_effect_color = {a=0, r=0, g=0, b=0}, -- If player is inside node
2302 paramtype = "none", -- See "Nodes"
2303 paramtype2 = "none", -- See "Nodes"
2304 is_ground_content = true, -- If false, cavegen will not carve through this
2305 sunlight_propagates = false, -- If true, sunlight will go infinitely through this
2306 walkable = true, -- If true, objects collide with node
2307 pointable = true, -- If true, can be pointed at
2308 diggable = true, -- If false, can never be dug
2309 climbable = false, -- If true, can be climbed on (ladder)
2310 buildable_to = false, -- If true, placed nodes can replace this node
2311 drop = "", -- alternatively drop = { max_items = ..., items = { ... } }
2312 liquidtype = "none", -- "none"/"source"/"flowing"
2313 liquid_alternative_flowing = "", -- Flowing version of source liquid
2314 liquid_alternative_source = "", -- Source version of flowing liquid
2315 liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
2316 liquid_renewable = true, -- Can new liquid source be created by placing two or more sources nearby?
2317 freezemelt = "", -- water for snow/ice, ice/snow for water
2318 leveled = 0, -- Block contain level in param2. value - default level, used for snow. Dont forget use "leveled" type nodebox
2319 liquid_range = 8, -- number of flowing nodes arround source (max. 8)
2320 drowning = 0, -- Player will take this amount of damage if no bubbles are left
2321 light_source = 0, -- Amount of light emitted by node
2322 damage_per_second = 0, -- If player is inside node, this damage is caused
2323 node_box = {type="regular"}, -- See "Node boxes"
2324 selection_box = {type="regular"}, -- See "Node boxes"
2325 ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used
2326 legacy_facedir_simple = false, -- Support maps made in and before January 2012
2327 legacy_wallmounted = false, -- Support maps made in and before January 2012
2329 footstep = <SimpleSoundSpec>,
2330 dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
2331 dug = <SimpleSoundSpec>,
2332 place = <SimpleSoundSpec>,
2335 on_construct = func(pos),
2336 ^ Node constructor; always called after adding node
2337 ^ Can set up metadata and stuff like that
2339 on_destruct = func(pos),
2340 ^ Node destructor; always called before removing node
2342 after_destruct = func(pos, oldnode),
2343 ^ Node destructor; always called after removing node
2346 after_place_node = func(pos, placer, itemstack, pointed_thing),
2347 ^ Called after constructing node when node was placed using
2348 minetest.item_place_node / minetest.place_node
2349 ^ If return true no item is taken from itemstack
2351 after_dig_node = func(pos, oldnode, oldmetadata, digger),
2352 ^ oldmetadata is in table format
2353 ^ Called after destructing node when node was dug using
2354 minetest.node_dig / minetest.dig_node
2356 can_dig = function(pos,player)
2357 ^ returns true if node can be dug, or false if not
2360 on_punch = func(pos, node, puncher, pointed_thing),
2361 ^ default: minetest.node_punch
2362 ^ By default: Calls minetest.register_on_punchnode callbacks
2363 on_rightclick = func(pos, node, clicker, itemstack, pointed_thing),
2365 ^ if defined, itemstack will hold clicker's wielded item
2366 ^ Shall return the leftover itemstack
2367 ^ Note: pointed_thing can be nil, if a mod calls this function
2369 on_dig = func(pos, node, digger),
2370 ^ default: minetest.node_dig
2371 ^ By default: checks privileges, wears out tool and removes node
2373 on_timer = function(pos,elapsed),
2375 ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
2376 ^ elapsed is the total time passed since the timer was started
2377 ^ return true to run the timer for another cycle with the same timeout value
2379 on_receive_fields = func(pos, formname, fields, sender),
2380 ^ fields = {name1 = value1, name2 = value2, ...}
2381 ^ Called when an UI form (eg. sign text input) returns data
2384 allow_metadata_inventory_move = func(pos, from_list, from_index,
2385 to_list, to_index, count, player),
2386 ^ Called when a player wants to move items inside the inventory
2387 ^ Return value: number of items allowed to move
2389 allow_metadata_inventory_put = func(pos, listname, index, stack, player),
2390 ^ Called when a player wants to put something into the inventory
2391 ^ Return value: number of items allowed to put
2392 ^ Return value: -1: Allow and don't modify item count in inventory
2394 allow_metadata_inventory_take = func(pos, listname, index, stack, player),
2395 ^ Called when a player wants to take something out of the inventory
2396 ^ Return value: number of items allowed to take
2397 ^ Return value: -1: Allow and don't modify item count in inventory
2399 on_metadata_inventory_move = func(pos, from_list, from_index,
2400 to_list, to_index, count, player),
2401 on_metadata_inventory_put = func(pos, listname, index, stack, player),
2402 on_metadata_inventory_take = func(pos, listname, index, stack, player),
2403 ^ Called after the actual action has happened, according to what was allowed.
2406 on_blast = func(pos, intensity),
2407 ^ intensity: 1.0 = mid range of regular TNT
2408 ^ If defined, called when an explosion touches the node, instead of
2412 Recipe for register_craft: (shaped)
2414 output = 'default:pick_stone',
2416 {'default:cobble', 'default:cobble', 'default:cobble'},
2417 {'', 'default:stick', ''},
2418 {'', 'default:stick', ''}, -- Also groups; eg. 'group:crumbly'
2420 replacements = <optional list of item pairs,
2421 replace one input item with another item on crafting>
2424 Recipe for register_craft (shapeless)
2427 output = 'mushrooms:mushroom_stew',
2430 "mushrooms:mushroom_brown",
2431 "mushrooms:mushroom_red",
2433 replacements = <optional list of item pairs,
2434 replace one input item with another item on crafting>
2437 Recipe for register_craft (tool repair)
2439 type = "toolrepair",
2440 additional_wear = -0.02,
2443 Recipe for register_craft (cooking)
2446 output = "default:glass",
2447 recipe = "default:sand",
2451 Recipe for register_craft (furnace fuel)
2454 recipe = "default:leaves",
2458 Ore definition (register_ore)
2460 ore_type = "scatter", -- See "Ore types"
2461 ore = "default:stone_with_coal",
2462 wherein = "default:stone",
2463 ^ a list of nodenames is supported too
2464 clust_scarcity = 8*8*8,
2465 ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
2466 ^ This value should be *MUCH* higher than your intuition might tell you!
2468 ^ Number of ores in a cluster
2470 ^ Size of the bounding box of the cluster
2471 ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
2472 height_min = -31000,
2475 ^ Attributes for this ore generation
2476 noise_threshhold = 0.5,
2477 ^ If noise is above this threshhold, ore is placed. Not needed for a uniform distribution
2478 noise_params = {offset=0, scale=1, spread={x=100, y=100, z=100}, seed=23, octaves=3, persist=0.70}
2479 ^ NoiseParams structure describing the perlin noise used for ore distribution.
2480 ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
2483 Decoration definition (register_decoration)
2485 deco_type = "simple", -- See "Decoration types"
2486 place_on = "default:dirt_with_grass",
2487 ^ Node that decoration can be placed on
2489 ^ Size of divisions made in the chunk being generated.
2490 ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
2492 ^ Ratio of the area to be uniformly filled by the decoration.
2493 ^ Used only if noise_params is not specified.
2494 noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
2495 ^ NoiseParams structure describing the perlin noise used for decoration distribution.
2496 ^ The result of this is multiplied by the 2d area of the division being decorated.
2497 biomes = {"Oceanside", "Hills", "Plains"},
2498 ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
2499 ^ and ignored if the Mapgen being used does not support biomes.
2501 ----- Simple-type parameters
2502 decoration = "default:grass",
2503 ^ The node name used as the decoration.
2504 ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
2506 ^ Number of nodes high the decoration is made.
2507 ^ If height_max is not 0, this is the lower bound of the randomly selected height.
2509 ^ Number of nodes the decoration can be at maximum.
2510 ^ If absent, the parameter 'height' is used as a constant.
2511 spawn_by = "default:water",
2512 ^ Node that the decoration only spawns next to, in a 1-node square radius.
2514 ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
2515 ^ If absent or -1, decorations occur next to any nodes.
2517 ----- Schematic-type parameters
2518 schematic = "foobar.mts",
2519 ^ If schematic is a string, it is the filepath relative to the current working directory of the
2520 ^ specified Minetest schematic file.
2521 ^ - OR -, could instead be a table containing two mandatory fields, size and data,
2522 ^ and an optional table yslice_prob:
2524 size = {x=4, y=6, z=4},
2526 {name="cobble", param1=255, param2=0},
2527 {name="dirt_with_grass", param1=255, param2=0},
2536 ^ See 'Schematic specifier' for details.
2537 replacements = {{"oldname", "convert_to"}, ...},
2538 flags = "place_center_x, place_center_z",
2539 ^ Flags for schematic decorations. See 'Schematic attributes'.
2540 rotation = "90" --rotate schematic 90 degrees on placement
2541 ^ Rotation can be "0", "90", "180", "270", or "random".
2544 Chatcommand definition (register_chatcommand)
2546 params = "<name> <privilege>", -- Short parameter description
2547 description = "Remove privilege from player", -- Full description
2548 privs = {privs=true}, -- Require the "privs" privilege to run
2549 func = function(name, param), -- Called when command is run.
2550 -- Returns boolean success and text output.
2553 Detached inventory callbacks
2555 allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
2556 ^ Called when a player wants to move items inside the inventory
2557 ^ Return value: number of items allowed to move
2559 allow_put = func(inv, listname, index, stack, player),
2560 ^ Called when a player wants to put something into the inventory
2561 ^ Return value: number of items allowed to put
2562 ^ Return value: -1: Allow and don't modify item count in inventory
2564 allow_take = func(inv, listname, index, stack, player),
2565 ^ Called when a player wants to take something out of the inventory
2566 ^ Return value: number of items allowed to take
2567 ^ Return value: -1: Allow and don't modify item count in inventory
2569 on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
2570 on_put = func(inv, listname, index, stack, player),
2571 on_take = func(inv, listname, index, stack, player),
2572 ^ Called after the actual action has happened, according to what was allowed.
2576 HUD Definition (hud_add, hud_get)
2578 hud_elem_type = "image", -- see HUD element types
2579 ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
2580 position = {x=0.5, y=0.5},
2581 ^ Left corner position of element
2587 ^ Selected item in inventory. 0 for no item selected.
2589 ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
2590 alignment = {x=0, y=0},
2591 ^ See "HUD Element Types"
2592 offset = {x=0, y=0},
2593 ^ See "HUD Element Types"
2594 size = { x=100, y=100 },
2595 ^ Size of element in pixels
2598 Particle definition (add_particle)
2600 pos = {x=0, y=0, z=0},
2601 velocity = {x=0, y=0, z=0},
2602 acceleration = {x=0, y=0, z=0},
2603 ^ Spawn particle at pos with velocity and acceleration
2605 ^ Disappears after expirationtime seconds
2607 collisiondetection = false,
2608 ^ collisiondetection: if true collides with physical objects
2610 ^ vertical: if true faces player using y axis only
2611 texture = "image.png",
2612 ^ Uses texture (string)
2613 playername = "singleplayer"
2614 ^ Playername is optional, if specified spawns particle only on the player's client
2617 Particlespawner definition (add_particlespawner)
2621 ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
2622 minpos = {x=0, y=0, z=0},
2623 maxpos = {x=0, y=0, z=0},
2624 minvel = {x=0, y=0, z=0},
2625 maxvel = {x=0, y=0, z=0},
2626 minacc = {x=0, y=0, z=0},
2627 maxacc = {x=0, y=0, z=0},
2632 ^ The particle's properties are random values in between the boundings:
2633 ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
2634 ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
2635 collisiondetection = false,
2636 ^ collisiondetection: if true uses collisiondetection
2638 ^ vertical: if true faces player using y axis only
2639 texture = "image.png",
2640 ^ Uses texture (string)
2641 playername = "singleplayer"
2642 ^ Playername is optional, if specified spawns particle only on the player's client