]> git.lizzy.rs Git - dragonfireclient.git/blob - doc/lua_api.txt
Merge pull request #243 from xyzz/liquid_renewable
[dragonfireclient.git] / doc / lua_api.txt
1 Minetest Lua Modding API Reference 0.4.0
2 ==========================================
3 More information at http://c55.me/minetest/
4
5 Introduction
6 -------------
7 Content and functionality can be added to Minetest 0.4 by using Lua
8 scripting in run-time loaded mods.
9
10 A mod is a self-contained bunch of scripts, textures and other related
11 things that is loaded by and interfaces with Minetest.
12
13 Mods are contained and ran solely on the server side. Definitions and media
14 files are automatically transferred to the client.
15
16 If you see a deficiency in the API, feel free to attempt to add the
17 functionality in the engine and API. You can send such improvements as
18 source code patches to <celeron55@gmail.com>.
19
20 Programming in Lua
21 -------------------
22 If you have any difficulty in understanding this, please read:
23   http://www.lua.org/pil/
24
25 Startup
26 --------
27 Mods are loaded during server startup from the mod load paths by running
28 the init.lua scripts in a shared environment.
29
30 Mod load path
31 -------------
32 Generic:
33   $path_share/games/gameid/mods/
34   $path_share/mods/gameid/
35   $path_user/games/gameid/mods/
36   $path_user/mods/gameid/ <-- User-installed mods
37   $worldpath/worldmods/
38
39 In a run-in-place version (eg. the distributed windows version):
40   minetest-0.4.x/games/gameid/mods/
41   minetest-0.4.x/mods/gameid/ <-- User-installed mods
42   minetest-0.4.x/worlds/worldname/worldmods/
43
44 On an installed version on linux:
45   /usr/share/minetest/games/gameid/mods/
46   ~/.minetest/mods/gameid/ <-- User-installed mods
47   ~/.minetest/worlds/worldname/worldmods
48
49 Mod load path for world-specific games
50 --------------------------------------
51 It is possible to include a game in a world; in this case, no mods or
52 games are loaded or checked from anywhere else.
53
54 This is useful for eg. adventure worlds.
55
56 This happens if the following directory exists:
57   $world/game/
58
59 Mods should be then be placed in:
60   $world/game/mods/
61
62 Modpack support
63 ----------------
64 Mods can be put in a subdirectory, if the parent directory, which otherwise
65 should be a mod, contains a file named modpack.txt. This file shall be
66 empty, except for lines starting with #, which are comments.
67
68 Mod directory structure
69 ------------------------
70 mods
71 |-- modname
72 |   |-- depends.txt
73 |   |-- init.lua
74 |   |-- textures
75 |   |   |-- modname_stuff.png
76 |   |   `-- modname_something_else.png
77 |   |-- sounds
78 |   |-- media
79 |   `-- <custom data>
80 `-- another
81
82 modname:
83   The location of this directory can be fetched by using
84   minetest.get_modpath(modname)
85
86 depends.txt:
87   List of mods that have to be loaded before loading this mod.
88   A single line contains a single modname.
89
90 init.lua:
91   The main Lua script. Running this script should register everything it
92   wants to register. Subsequent execution depends on minetest calling the
93   registered callbacks.
94
95   minetest.setting_get(name) and minetest.setting_getbool(name) can be used
96   to read custom or existing settings at load time, if necessary.
97
98 textures, sounds, media:
99   Media files (textures, sounds, whatever) that will be transferred to the
100   client and will be available for use by the mod.
101
102 Naming convention for registered textual names
103 ----------------------------------------------
104 Registered names should generally be in this format:
105   "modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
106
107 This is to prevent conflicting names from corrupting maps and is
108 enforced by the mod loader.
109
110 Example: mod "experimental", ideal item/node/entity name "tnt":
111          -> the name should be "experimental:tnt".
112
113 Enforcement can be overridden by prefixing the name with ":". This can
114 be used for overriding the registrations of some other mod.
115
116 Example: Any mod can redefine experimental:tnt by using the name
117          ":experimental:tnt" when registering it.
118 (also that mod is required to have "experimental" as a dependency)
119
120 The ":" prefix can also be used for maintaining backwards compatibility.
121
122 Aliases
123 -------
124 Aliases can be added by using minetest.register_alias(name, convert_to)
125
126 This will make Minetest to convert things called name to things called
127 convert_to.
128
129 This can be used for maintaining backwards compatibility.
130
131 This can be also used for setting quick access names for things, eg. if
132 you have an item called epiclylongmodname:stuff, you could do
133   minetest.register_alias("stuff", "epiclylongmodname:stuff")
134 and be able to use "/giveme stuff".
135
136 Textures
137 --------
138 Mods should generally prefix their textures with modname_, eg. given
139 the mod name "foomod", a texture could be called
140   "foomod_foothing.png"
141
142 Textures are referred to by their complete name, or alternatively by
143 stripping out the file extension:
144   eg. foomod_foothing.png
145   eg. foomod_foothing
146
147 Sounds
148 -------
149 Only OGG files are supported.
150
151 For positional playing of sounds, only single-channel (mono) files are
152 supported. Otherwise OpenAL will play them non-positionally.
153
154 Mods should generally prefix their sounds with modname_, eg. given
155 the mod name "foomod", a sound could be called
156   "foomod_foosound.ogg"
157
158 Sounds are referred to by their name with a dot, a single digit and the
159 file extension stripped out.  When a sound is played, the actual sound file
160 is chosen randomly from the matching sounds.
161
162 When playing the sound "foomod_foosound", the sound is chosen randomly
163 from the available ones of the following files:
164   foomod_foosound.ogg
165   foomod_foosound.0.ogg
166   foomod_foosound.1.ogg
167   ...
168   foomod_foosound.9.ogg
169
170 Examples of sound parameter tables:
171 -- Play locationless on all clients
172 {
173         gain = 1.0, -- default
174 }
175 -- Play locationless to a player
176 {
177         to_player = name,
178         gain = 1.0, -- default
179 }
180 -- Play in a location
181 {
182         pos = {x=1,y=2,z=3},
183         gain = 1.0, -- default
184         max_hear_distance = 32, -- default
185 }
186 -- Play connected to an object, looped
187 {
188     object = <an ObjectRef>,
189     gain = 1.0, -- default
190     max_hear_distance = 32, -- default
191     loop = true, -- only sounds connected to objects can be looped
192 }
193
194 SimpleSoundSpec:
195 eg. ""
196 eg. "default_place_node"
197 eg. {}
198 eg. {name="default_place_node"}
199 eg. {name="default_place_node", gain=1.0}
200
201 Registered definitions of stuff
202 --------------------------------
203 Anything added using certain minetest.register_* functions get added to
204 the global minetest.registered_* tables.
205
206 minetest.register_entity(name, prototype table)
207  -> minetest.registered_entities[name]
208
209 minetest.register_node(name, node definition)
210  -> minetest.registered_items[name]
211  -> minetest.registered_nodes[name]
212
213 minetest.register_tool(name, item definition)
214  -> minetest.registered_items[name]
215
216 minetest.register_craftitem(name, item definition)
217  -> minetest.registered_items[name]
218
219 Note that in some cases you will stumble upon things that are not contained
220 in these tables (eg. when a mod has been removed). Always check for
221 existence before trying to access the fields.
222
223 Example: If you want to check the drawtype of a node, you could do:
224
225 local function get_nodedef_field(nodename, fieldname)
226     if not minetest.registered_nodes[nodename] then
227         return nil
228     end
229     return minetest.registered_nodes[nodename][fieldname]
230 end
231 local drawtype = get_nodedef_field(nodename, "drawtype")
232
233 Example: minetest.get_item_group(name, group) has been implemented as:
234
235 function minetest.get_item_group(name, group)
236         if not minetest.registered_items[name] or not
237                         minetest.registered_items[name].groups[group] then
238                 return 0
239         end
240         return minetest.registered_items[name].groups[group]
241 end
242
243 Nodes
244 ------
245 Nodes are the bulk data of the world: cubes and other things that take the
246 space of a cube. Huge amounts of them are handled efficiently, but they
247 are quite static.
248
249 The definition of a node is stored and can be accessed by name in
250   minetest.registered_nodes[node.name]
251 See "Registered definitions of stuff".
252
253 Nodes are passed by value between Lua and the engine.
254 They are represented by a table:
255   {name="name", param1=num, param2=num}
256
257 param1 and param2 are 8 bit integers. The engine uses them for certain
258 automated functions. If you don't use these functions, you can use them to
259 store arbitrary values.
260
261 The functions of param1 and param2 are determined by certain fields in the
262 node definition:
263 param1 is reserved for the engine when paramtype != "none":
264   paramtype = "light"
265   ^ The value stores light with and without sun in it's
266     upper and lower 4 bits.
267 param2 is reserved for the engine when any of these are used:
268   liquidtype == "flowing"
269   ^ The level and some flags of the liquid is stored in param2
270   drawtype == "flowingliquid"
271   ^ The drawn liquid level is read from param2
272   drawtype == "torchlike"
273   drawtype == "signlike"
274   paramtype2 == "wallmounted"
275   ^ The rotation of the node is stored in param2. You can make this value
276     by using minetest.dir_to_wallmounted().
277   paramtype2 == "facedir"
278   ^ The rotation of the node is stored in param2. Furnaces and chests are
279     rotated this way. Can be made by using minetest.dir_to_facedir().
280
281 Nodes can also contain extra data. See "Node Metadata".
282
283 Node drawtypes
284 ---------------
285 There are a bunch of different looking node types. These are mostly just
286 copied from Minetest 0.3; more may be made in the future.
287
288 Look for examples in games/minimal or games/minetest_game.
289
290 - normal
291 - airlike
292 - liquid
293 - flowingliquid
294 - glasslike
295 - allfaces
296 - allfaces_optional
297 - torchlike
298 - signlike
299 - plantlike
300 - fencelike
301 - raillike
302 - nodebox -- See below. EXPERIMENTAL
303
304 Node boxes
305 -----------
306 Node selection boxes are defined using "node boxes"
307
308 The "nodebox" node drawtype allows defining visual of nodes consisting of
309 arbitrary number of boxes. It allows defining stuff like stairs. Only the
310 "fixed" box type is supported for these.
311 ^ Please note that this is still experimental, and may be incompatibly
312   changed in the future.
313
314 A nodebox is defined as any of:
315 {
316     -- A normal cube; the default in most things
317     type = "regular"
318 }
319 {
320     -- A fixed box (facedir param2 is used, if applicable)
321     type = "fixed",
322     fixed = box OR {box1, box2, ...}
323 }
324 {
325     -- A box like the selection box for torches
326     -- (wallmounted param2 is used, if applicable)
327     type = "wallmounted",
328     wall_top = box,
329     wall_bottom = box,
330     wall_side = box
331 }
332
333 A box is defined as:
334   {x1, y1, z1, x2, y2, z2}
335 A box of a regular node would look like:
336   {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
337
338 Representations of simple things
339 --------------------------------
340 Position/vector:
341   {x=num, y=num, z=num}
342 Currently the API does not provide any helper functions for addition,
343 subtraction and whatever; you can define those that you need yourself.
344
345 pointed_thing:
346   {type="nothing"}
347   {type="node", under=pos, above=pos}
348   {type="object", ref=ObjectRef}
349
350 Items
351 ------
352 Node (register_node):
353   A node from the world
354 Tool (register_tool):
355   A tool/weapon that can dig and damage things according to tool_capabilities
356 Craftitem (register_craftitem):
357   A miscellaneous item
358
359 Items and item stacks can exist in three formats:
360
361 Serialized; This is called stackstring or itemstring:
362 eg. 'default:dirt 5'
363 eg. 'default:pick_wood 21323'
364 eg. 'default:apple'
365
366 Table format:
367 eg. {name="default:dirt", count=5, wear=0, metadata=""} 
368     ^ 5 dirt nodes
369 eg. {name="default:pick_wood", count=1, wear=21323, metadata=""}
370     ^ a wooden pick about 1/3 weared out
371 eg. {name="default:apple", count=1, wear=0, metadata=""}
372     ^ an apple.
373
374 ItemStack:
375 C++ native format with many helper methods. Useful for converting between
376 formats. See the Class reference section for details.
377
378 When an item must be passed to a function, it can usually be in any of
379 these formats.
380
381 Groups
382 -------
383 In a number of places, there is a group table. Groups define the
384 properties of a thing (item, node, armor of entity, capabilities of
385 tool) in such a way that the engine and other mods can can interact with
386 the thing without actually knowing what the thing is.
387
388 Usage:
389 - Groups are stored in a table, having the group names with keys and the
390   group ratings as values. For example:
391     groups = {crumbly=3, soil=1}
392     ^ Default dirt (soil group actually currently not defined; TODO)
393     groups = {crumbly=2, soil=1, level=2, outerspace=1}
394     ^ A more special dirt-kind of thing
395 - Groups always have a rating associated with them. If there is no
396   useful meaning for a rating for an enabled group, it shall be 1.
397 - When not defined, the rating of a group defaults to 0. Thus when you
398   read groups, you must interpret nil and 0 as the same value, 0.
399
400 You can read the rating of a group for an item or a node by using
401   minetest.get_item_group(itemname, groupname)
402
403 Groups of items
404 ----------------
405 Groups of items can define what kind of an item it is (eg. wool).
406
407 Groups of nodes
408 ----------------
409 In addition to the general item things, groups are used to define whether
410 a node is destroyable and how long it takes to destroy by a tool.
411
412 Groups of entities
413 -------------------
414 For entities, groups are, as of now, used only for calculating damage.
415
416 object.get_armor_groups() -> a group-rating table (eg. {fleshy=3})
417 object.set_armor_groups({level=2, fleshy=2, cracky=2})
418
419 Groups of tools
420 ----------------
421 Groups in tools define which groups of nodes and entities they are
422 effective towards.
423
424 Groups in crafting recipes
425 ---------------------------
426 An example: Make meat soup from any meat, any water and any bowl
427 {
428     output = 'food:meat_soup_raw',
429     recipe = {
430         {'group:meat'},
431         {'group:water'},
432         {'group:bowl'},
433     },
434     -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
435 }
436 An another example: Make red wool from white wool and red dye
437 {
438         type = 'shapeless',
439     output = 'wool:red',
440     recipe = {'wool:white', 'group:dye,basecolor_red'},
441 }
442
443 Special groups
444 ---------------
445 - immortal: Disables the group damage system for an entity
446 - level: Can be used to give an additional sense of progression in the game.
447   - A larger level will cause eg. a weapon of a lower level make much less
448     damage, and get weared out much faster, or not be able to get drops
449         from destroyed nodes.
450   - 0 is something that is directly accessible at the start of gameplay
451   - There is no upper limit
452 - dig_immediate: (player can always pick up node without tool wear)
453   - 2: node is removed without tool wear after 0.5 seconds or so
454        (rail, sign)
455   - 3: node is removed without tool wear immediately (torch)
456 - disable_jump: Player (and possibly other things) cannot jump from node
457 - fall_damage_add_percent: damage speed = speed * (1 + value/100)
458 - bouncy: value is bounce speed in percent
459 - falling_node: if there is no walkable block under the node it will fall
460
461 Known damage and digging time defining groups
462 ----------------------------------------------
463 Valid ratings for these are 0, 1, 2 and 3, unless otherwise stated.
464 - crumbly: dirt, sand
465 - cracky: tough but crackable stuff like stone.
466 - snappy: something that can be cut using fine tools; eg. leaves, small
467           plants, wire, sheets of metal
468 - choppy: something that can be cut using force; eg. trees, wooden planks
469 - fleshy: Living things like animals and the player. This could imply
470           some blood effects when hitting.
471 - explody: Especially prone to explosions
472 - oddly_breakable_by_hand:
473    Can be added to nodes that shouldn't logically be breakable by the
474    hand but are. Somewhat similar to dig_immediate, but times are more
475    like {[1]=3.50,[2]=2.00,[3]=0.70} and this does not override the
476    speed of a tool if the tool can dig at a faster speed than this
477    suggests for the hand.
478
479 Examples of custom groups
480 --------------------------
481 Item groups are often used for defining, well, //groups of items//.
482 - meat: any meat-kind of a thing (rating might define the size or healing
483   ability or be irrelevant - it is not defined as of yet)
484 - eatable: anything that can be eaten. Rating might define HP gain in half
485   hearts.
486 - flammable: can be set on fire. Rating might define the intensity of the
487   fire, affecting eg. the speed of the spreading of an open fire.
488 - wool: any wool (any origin, any color)
489 - metal: any metal
490 - weapon: any weapon
491 - heavy: anything considerably heavy
492
493 Digging time calculation specifics
494 -----------------------------------
495 Groups such as **crumbly**, **cracky** and **snappy** are used for this
496 purpose. Rating is 1, 2 or 3. A higher rating for such a group implies
497 faster digging time.
498
499 The **level** group is used to limit the toughness of nodes a tool can dig
500 and to scale the digging times / damage to a greater extent.
501
502 ^ PLEASE DO UNDERSTAND THIS, otherwise you cannot use the system to it's
503   full potential.
504
505 Tools define their properties by a list of parameters for groups. They
506 cannot dig other groups; thus it is important to use a standard bunch of
507 groups to enable interaction with tools.
508
509 **Tools define:**
510   * Full punch interval
511   * Maximum drop level
512   * For an arbitrary list of groups:
513     * Uses (until the tool breaks)
514     * Maximum level (usually 0, 1, 2 or 3)
515     * Digging times
516
517 **Full punch interval**:
518 When used as a weapon, the tool will do full damage if this time is spent
519 between punches. If eg. half the time is spent, the tool will do half
520 damage.
521
522 **Maximum drop level**
523 Suggests the maximum level of node, when dug with the tool, that will drop
524 it's useful item. (eg. iron ore to drop a lump of iron).
525 - This is not automated; it is the responsibility of the node definition
526   to implement this
527
528 **Uses**
529 Determines how many uses the tool has when it is used for digging a node,
530 of this group, of the maximum level. For lower leveled nodes, the use count
531 is multiplied by 3^leveldiff.
532 - uses=10, leveldiff=0 -> actual uses: 10
533 - uses=10, leveldiff=1 -> actual uses: 30
534 - uses=10, leveldiff=2 -> actual uses: 90
535
536 **Maximum level**
537 Tells what is the maximum level of a node of this group that the tool will
538 be able to dig.
539
540 **Digging times**
541 List of digging times for different ratings of the group, for nodes of the
542 maximum level.
543   * For example, as a lua table, ''times={2=2.00, 3=0.70}''. This would
544     result in the tool to be able to dig nodes that have a rating of 2 or 3
545     for this group, and unable to dig the rating 1, which is the toughest.
546     Unless there is a matching group that enables digging otherwise.
547   * For entities, damage equals the amount of nodes dug in the time spent
548     between hits, with a maximum time of ''full_punch_interval''.
549
550 Example definition of the capabilities of a tool
551 -------------------------------------------------
552 tool_capabilities = {
553         full_punch_interval=1.5,
554         max_drop_level=1,
555         groupcaps={
556                 crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
557         }
558 }
559
560 This makes the tool be able to dig nodes that fullfill both of these:
561 - Have the **crumbly** group
562 - Have a **level** group less or equal to 2
563
564 Table of resulting digging times:
565 crumbly        0     1     2     3     4  <- level
566      ->  0     -     -     -     -     -
567          1  0.80  1.60  1.60     -     -
568          2  0.60  1.20  1.20     -     -
569          3  0.40  0.80  0.80     -     -
570
571 level diff:    2     1     0    -1    -2
572
573 Table of resulting tool uses:
574      ->  0     -     -     -     -     -
575          1   180    60    20     -     -
576          2   180    60    20     -     -
577          3   180    60    20     -     -
578
579 Notes:
580 - At crumbly=0, the node is not diggable.
581 - At crumbly=3, the level difference digging time divider kicks in and makes
582   easy nodes to be quickly breakable.
583 - At level > 2, the node is not diggable, because it's level > maxlevel
584
585 Entity damage mechanism
586 ------------------------
587 Damage calculation:
588 - Take the time spent after the last hit
589 - Limit time to full_punch_interval
590 - Take the damage groups and imagine a bunch of nodes that have them
591 - Damage in HP is the amount of nodes destroyed in this time.
592
593 Client predicts damage based on damage groups. Because of this, it is able to
594 give an immediate response when an entity is damaged or dies; the response is
595 pre-defined somehow (eg. by defining a sprite animation) (not implemented;
596 TODO).
597 - Currently a smoke puff will appear when an entity dies.
598
599 The group **immortal** completely disables normal damage.
600
601 Entities can define a special armor group, which is **punch_operable**. This
602 group disables the regular damage mechanism for players punching it by hand or
603 a non-tool item, so that it can do something else than take damage.
604
605 On the Lua side, every punch calls ''entity:on_punch(puncher,
606 time_from_last_punch, tool_capabilities, direction)''. This should never be
607 called directly, because damage is usually not handled by the entity itself.
608   * ''puncher'' is the object performing the punch. Can be nil. Should never be
609     accessed unless absolutely required, to encourage interoperability.
610   * ''time_from_last_punch'' is time from last punch (by puncher) or nil.
611   * ''tool_capabilities'' can be nil.
612   * ''direction'' is a unit vector, pointing from the source of the punch to
613     the punched object.
614
615 To punch an entity/object in Lua, call ''object:punch(puncher,
616 time_from_last_punch, tool_capabilities, direction)''.
617   * Return value is tool wear.
618   * Parameters are equal to the above callback.
619   * If ''direction'' is nil and ''puncher'' is not nil, ''direction'' will be
620     automatically filled in based on the location of ''puncher''.
621
622 Node Metadata
623 -------------
624 The instance of a node in the world normally only contains the three values
625 mentioned in "Nodes". However, it is possible to insert extra data into a
626 node. It is called "node metadata"; See "NodeMetaRef".
627
628 Metadata contains two things:
629 - A key-value store
630 - An inventory
631
632 Some of the values in the key-value store are handled specially:
633 - formspec: Defines a right-click inventory menu. See "Formspec".
634 - infotext: Text shown on the screen when the node is pointed at
635
636 Example stuff:
637
638 local meta = minetest.env:get_meta(pos)
639 meta:set_string("formspec",
640         "invsize[8,9;]"..
641         "list[context;main;0,0;8,4;]"..
642         "list[current_player;main;0,5;8,4;]")
643 meta:set_string("infotext", "Chest");
644 local inv = meta:get_inventory()
645 inv:set_size("main", 8*4)
646 print(dump(meta:to_table()))
647 meta:from_table({
648     inventory = {
649         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] = ""}
650     },
651     fields = {
652         formspec = "invsize[8,9;]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
653         infotext = "Chest"
654     }
655 })
656
657 Formspec
658 --------
659 Formspec defines a menu. Currently not much else than inventories are
660 supported. It is a string, with a somewhat strange format.
661
662 Spaces and newlines can be inserted between the blocks, as is used in the
663 examples.
664
665 Examples:
666 - Chest:
667     invsize[8,9;]
668     list[context;main;0,0;8,4;]
669     list[current_player;main;0,5;8,4;]
670 - Furnace:
671     invsize[8,9;]
672     list[context;fuel;2,3;1,1;]
673     list[context;src;2,1;1,1;]
674     list[context;dst;5,1;2,2;]
675     list[current_player;main;0,5;8,4;]
676 - Minecraft-like player inventory
677     invsize[8,7.5;]
678     image[1,0.6;1,2;player.png]
679     list[current_player;main;0,3.5;8,4;]
680     list[current_player;craft;3,0;3,3;]
681     list[current_player;craftpreview;7,1;1,1;]
682
683 Elements:
684
685 size[<W>,<H>]
686 ^ Define the size of the menu in inventory slots
687 ^ deprecated: invsize[<W>,<H>;]
688
689 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]
690 list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]
691 ^ Show an inventory list
692
693 image[<X>,<Y>;<W>,<H>;<texture name>]
694 ^ Show an image
695 ^ Position and size units are inventory slots
696
697 field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]
698 ^ Textual field; will be sent to server when a button is clicked
699 ^ x and y position the field relative to the top left of the menu
700 ^ w and h are the size of the field
701 ^ fields are a set height, but will be vertically centred on h
702 ^ Position and size units are inventory slots
703 ^ name is the name of the field as returned in fields to on_receive_fields
704 ^ label, if not blank, will be text printed on the top left above the field
705 ^ default is the default value of the field
706   ^ default may contain variable references such as '${text}' which
707     will fill the value from the metadata value 'text'
708         ^ Note: no extra text or more than a single variable is supported ATM.
709
710 field[<name>;<label>;<default>]
711 ^ as above but without position/size units
712 ^ special field for creating simple forms, such as sign text input
713 ^ must be used without a size[] element
714 ^ a 'Proceed' button will be added automatically
715
716 label[<X>,<Y>;<label>]
717 ^ x and y work as per field
718 ^ label is the text on the label
719 ^ Position and size units are inventory slots
720
721 button[<X>,<Y>;<W>,<H>;<name>;<label>]
722 ^ Clickable button. When clicked, fields will be sent.
723 ^ x, y and name work as per field
724 ^ w and h are the size of the button
725 ^ label is the text on the button
726 ^ Position and size units are inventory slots
727
728 image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
729 ^ x, y, w, h, and name work as per button
730 ^ image is the filename of an image
731 ^ Position and size units are inventory slots
732
733 button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]
734 ^ When clicked, fields will be sent and the form will quit.
735
736 image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
737 ^ When clicked, fields will be sent and the form will quit.
738
739 Inventory location:
740
741 - "context": Selected node metadata (deprecated: "current_name")
742 - "current_player": Player to whom the menu is shown
743 - "player:<name>": Any player
744 - "nodemeta:<X>,<Y>,<Z>": Any node metadata
745 - "detached:<name>": A detached inventory
746
747 Helper functions
748 -----------------
749 dump2(obj, name="_", dumped={})
750 ^ Return object serialized as a string, handles reference loops
751 dump(obj, dumped={})
752 ^ Return object serialized as a string
753 string:split(separator)
754 ^ eg. string:split("a,b", ",") == {"a","b"}
755 string:trim()
756 ^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
757 minetest.pos_to_string({x=X,y=Y,z=Z}) -> "(X,Y,Z)"
758 ^ Convert position to a printable string
759 minetest.string_to_pos(string) -> position
760
761 minetest namespace reference
762 -----------------------------
763 minetest.get_current_modname() -> string
764 minetest.get_modpath(modname) -> eg. "/home/user/.minetest/usermods/modname"
765 ^ Useful for loading additional .lua modules or static data from mod
766 minetest.get_modnames() -> list of installed mods
767 ^ Return a list of installed mods, sorted alphabetically
768 minetest.get_worldpath() -> eg. "/home/user/.minetest/world"
769 ^ Useful for storing custom data
770 minetest.is_singleplayer()
771
772 minetest.debug(line)
773 ^ Always printed to stderr and logfile (print() is redirected here)
774 minetest.log(line)
775 minetest.log(loglevel, line)
776 ^ loglevel one of "error", "action", "info", "verbose"
777
778 Registration functions: (Call these only at load time)
779 minetest.register_entity(name, prototype table)
780 minetest.register_abm(abm definition)
781 minetest.register_node(name, node definition)
782 minetest.register_tool(name, item definition)
783 minetest.register_craftitem(name, item definition)
784 minetest.register_alias(name, convert_to)
785 minetest.register_craft(recipe)
786
787 Global callback registration functions: (Call these only at load time)
788 minetest.register_globalstep(func(dtime))
789 ^ Called every server step, usually interval of 0.05s
790 minetest.register_on_placenode(func(pos, newnode, placer, oldnode))
791 ^ Called when a node has been placed
792 ^ Deprecated: Use on_construct or after_place_node in node definition instead
793 minetest.register_on_dignode(func(pos, oldnode, digger))
794 ^ Called when a node has been dug.
795 ^ Deprecated: Use on_destruct or after_dig_node in node definition instead
796 minetest.register_on_punchnode(func(pos, node, puncher))
797 ^ Called when a node is punched
798 minetest.register_on_generated(func(minp, maxp, blockseed))
799 ^ Called after generating a piece of world. Modifying nodes inside the area
800   is a bit faster than usually.
801 minetest.register_on_newplayer(func(ObjectRef))
802 ^ Called after a new player has been created
803 minetest.register_on_dieplayer(func(ObjectRef))
804 ^ Called when a player dies
805 minetest.register_on_respawnplayer(func(ObjectRef))
806 ^ Called when player is to be respawned
807 ^ Called _before_ repositioning of player occurs
808 ^ return true in func to disable regular player placement
809 minetest.register_on_joinplayer(func(ObjectRef))
810 ^ Called when a player joins the game
811 minetest.register_on_leaveplayer(func(ObjectRef))
812 ^ Called when a player leaves the game
813 minetest.register_on_chat_message(func(name, message))
814 ^ Called always when a player says something
815 minetest.register_on_player_receive_fields(func(player, formname, fields))
816 ^ Called when a button is pressed in player's inventory form
817 ^ Newest functions are called first
818 ^ If function returns true, remaining functions are not called
819
820 Other registration functions:
821 minetest.register_chatcommand(cmd, chatcommand definition)
822 minetest.register_privilege(name, definition)
823 ^ definition: "description text"
824 ^ definition: {
825       description = "description text",
826       give_to_singleplayer = boolean, -- default: true
827   }
828 minetest.register_authentication_handler(handler)
829 ^ See minetest.builtin_auth_handler in builtin.lua for reference
830
831 Setting-related:
832 minetest.setting_set(name, value)
833 minetest.setting_get(name) -> string or nil
834 minetest.setting_getbool(name) -> boolean value or nil
835 minetest.setting_get_pos(name) -> position or nil
836 minetest.add_to_creative_inventory(itemstring)
837
838 Authentication:
839 minetest.notify_authentication_modified(name)
840 ^ Should be called by the authentication handler if privileges change.
841 ^ To report everybody, set name=nil.
842 minetest.get_password_hash(name, raw_password)
843 ^ Convert a name-password pair to a password hash that minetest can use
844 minetest.string_to_privs(str) -> {priv1=true,...}
845 minetest.privs_to_string(privs) -> "priv1,priv2,..."
846 ^ Convert between two privilege representations
847 minetest.set_player_password(name, password_hash)
848 minetest.set_player_privs(name, {priv1=true,...})
849 minetest.get_player_privs(name) -> {priv1=true,...}
850 minetest.auth_reload()
851 ^ These call the authentication handler
852 minetest.check_player_privs(name, {priv1=true,...}) -> bool, missing_privs
853 ^ A quickhand for checking privileges
854
855 Chat:
856 minetest.chat_send_all(text)
857 minetest.chat_send_player(name, text)
858
859 Inventory:
860 minetest.get_inventory(location) -> InvRef
861 ^ location = eg. {type="player", name="celeron55"}
862                  {type="node", pos={x=, y=, z=}}
863                  {type="detached", name="creative"}
864 minetest.create_detached_inventory(name, callbacks) -> InvRef
865 ^ callbacks: See "Detached inventory callbacks"
866 ^ Creates a detached inventory. If it already exists, it is cleared.
867
868 Item handling:
869 minetest.inventorycube(img1, img2, img3)
870 ^ Returns a string for making an image of a cube (useful as an item image)
871 minetest.get_pointed_thing_position(pointed_thing, above)
872 ^ Get position of a pointed_thing (that you can get from somewhere)
873 minetest.dir_to_facedir(dir)
874 ^ Convert a vector to a facedir value, used in param2 for paramtype2="facedir"
875 minetest.dir_to_wallmounted(dir)
876 ^ Convert a vector to a wallmounted value, used for paramtype2="wallmounted"
877 minetest.get_node_drops(nodename, toolname)
878 ^ Returns list of item names.
879 ^ Note: This will be removed or modified in a future version.
880 minetest.get_craft_result(input) -> output, decremented_input
881 ^ input.method = 'normal' or 'cooking' or 'fuel'
882 ^ input.width = for example 3
883 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
884                               stack 5, stack 6, stack 7, stack 8, stack 9 }
885 ^ output.item = ItemStack, if unsuccessful: empty ItemStack
886 ^ output.time = number, if unsuccessful: 0
887 ^ decremented_input = like input
888 minetest.get_craft_recipe(output) -> input
889 ^ output is a node or item type such as 'default:torch'
890 ^ input.method = 'normal' or 'cooking' or 'fuel'
891 ^ input.width = for example 3
892 ^ input.items = for example { stack 1, stack 2, stack 3, stack 4,
893                               stack 5, stack 6, stack 7, stack 8, stack 9 }
894 ^ input.items = nil if no recipe found
895 minetest.handle_node_drops(pos, drops, digger)
896 ^ drops: list of itemstrings
897 ^ Handles drops from nodes after digging: Default action is to put them into
898   digger's inventory
899 ^ Can be overridden to get different functionality (eg. dropping items on
900   ground)
901
902 Rollbacks:
903 minetest.rollback_get_last_node_actor(p, range, seconds) -> actor, p, seconds
904 ^ Find who has done something to a node, or near a node
905 ^ actor: "player:<name>", also "liquid".
906 minetest.rollback_revert_actions_by(actor, seconds) -> bool, log messages
907 ^ Revert latest actions of someone
908 ^ actor: "player:<name>", also "liquid".
909
910 Defaults for the on_* item definition functions:
911 (These return the leftover itemstack)
912 minetest.item_place_node(itemstack, placer, pointed_thing)
913 ^ Place item as a node
914 minetest.item_place_object(itemstack, placer, pointed_thing)
915 ^ Place item as-is
916 minetest.item_place(itemstack, placer, pointed_thing)
917 ^ Use one of the above based on what the item is.
918 minetest.item_drop(itemstack, dropper, pos)
919 ^ Drop the item
920 minetest.item_eat(hp_change, replace_with_item)
921 ^ Eat the item. replace_with_item can be nil.
922
923 Defaults for the on_punch and on_dig node definition callbacks:
924 minetest.node_punch(pos, node, puncher)
925 ^ Calls functions registered by minetest.register_on_punchnode()
926 minetest.node_dig(pos, node, digger)
927 ^ Checks if node can be dug, puts item into inventory, removes node
928 ^ Calls functions registered by minetest.registered_on_dignodes()
929
930 Sounds:
931 minetest.sound_play(spec, parameters) -> handle
932 ^ spec = SimpleSoundSpec
933 ^ parameters = sound parameter table
934 minetest.sound_stop(handle)
935
936 Timing:
937 minetest.after(time, func, param)
938 ^ Call function after time seconds
939 ^ param is optional; to pass multiple parameters, pass a table.
940
941 Server:
942 minetest.request_shutdown() -> request for server shutdown
943 minetest.get_server_status() -> server status string
944
945 Bans:
946 minetest.get_ban_list() -> ban list (same as minetest.get_ban_description(""))
947 minetest.get_ban_description(ip_or_name) -> ban description (string)
948 minetest.ban_player(name) -> ban a player
949 minetest.unban_player_or_ip(name) -> unban player or IP address
950
951 Random:
952 minetest.get_connected_players() -> list of ObjectRefs
953 minetest.hash_node_position({x=,y=,z=}) -> 48-bit integer
954 ^ Gives a unique hash number for a node position (16+16+16=48bit)
955 minetest.get_item_group(name, group) -> rating
956 ^ Get rating of a group of an item. (0 = not in group)
957 minetest.get_node_group(name, group) -> rating
958 ^ Deprecated: An alias for the former.
959 minetest.serialize(table) -> string
960 ^ Convert a table containing tables, strings, numbers, booleans and nils
961   into string form readable by minetest.deserialize
962 ^ Example: serialize({foo='bar'}) -> 'return { ["foo"] = "bar" }'
963 minetest.deserialize(string) -> table
964 ^ Convert a string returned by minetest.deserialize into a table
965 ^ String is loaded in an empty sandbox environment.
966 ^ Will load functions, but they cannot access the global environment.
967 ^ Example: deserialize('return { ["foo"] = "bar" }') -> {foo='bar'}
968 ^ Example: deserialize('print("foo")') -> nil (function call fails)
969   ^ error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)
970
971 Global objects:
972 minetest.env - EnvRef of the server environment and world.
973 ^ Using this you can access nodes and entities
974
975 Global tables:
976 minetest.registered_items
977 ^ List of registered items, indexed by name
978 minetest.registered_nodes
979 ^ List of registered node definitions, indexed by name
980 minetest.registered_craftitems
981 ^ List of registered craft item definitions, indexed by name
982 minetest.registered_tools
983 ^ List of registered tool definitions, indexed by name
984 minetest.registered_entities
985 ^ List of registered entity prototypes, indexed by name
986 minetest.object_refs
987 ^ List of object references, indexed by active object id
988 minetest.luaentities
989 ^ List of lua entities, indexed by active object id
990
991 Deprecated but defined for backwards compatibility:
992 minetest.digprop_constanttime(time)
993 minetest.digprop_stonelike(toughness)
994 minetest.digprop_dirtlike(toughness)
995 minetest.digprop_gravellike(toughness)
996 minetest.digprop_woodlike(toughness)
997 minetest.digprop_leaveslike(toughness)
998 minetest.digprop_glasslike(toughness)
999
1000 Class reference
1001 ----------------
1002 EnvRef: basically ServerEnvironment and ServerMap combined.
1003 methods:
1004 - set_node(pos, node)
1005 - add_node(pos, node): alias set_node(pos, node)
1006  ^ Set node at position (node = {name="foo", param1=0, param2=0})
1007 - remove_node(pos)
1008   ^ Equivalent to set_node(pos, "air")
1009 - get_node(pos)
1010   ^ Returns {name="ignore", ...} for unloaded area
1011 - get_node_or_nil(pos)
1012   ^ Returns nil for unloaded area
1013 - get_node_light(pos, timeofday) -> 0...15 or nil
1014   ^ timeofday: nil = current time, 0 = night, 0.5 = day
1015
1016 - place_node(pos, node)
1017   ^ Place node with the same effects that a player would cause
1018 - dig_node(pos)
1019   ^ Dig node with the same effects that a player would cause
1020 - punch_node(pos)
1021   ^ Punch node with the same effects that a player would cause
1022   
1023 - get_meta(pos) -- Get a NodeMetaRef at that position
1024 - get_node_timer(pos) -- Get NodeTimerRef
1025
1026 - add_entity(pos, name): Spawn Lua-defined entity at position
1027   ^ Returns ObjectRef, or nil if failed
1028 - add_item(pos, item): Spawn item
1029   ^ Returns ObjectRef, or nil if failed
1030 - get_player_by_name(name) -- Get an ObjectRef to a player
1031 - get_objects_inside_radius(pos, radius)
1032 - set_timeofday(val): val: 0...1; 0 = midnight, 0.5 = midday
1033 - get_timeofday()
1034 - find_node_near(pos, radius, nodenames) -> pos or nil
1035   ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1036 - find_nodes_in_area(minp, maxp, nodenames) -> list of positions
1037   ^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1038 - get_perlin(seeddiff, octaves, persistence, scale)
1039   ^ Return world-specific perlin noise (int(worldseed)+seeddiff)
1040 - clear_objects()
1041   ^ clear all objects in the environments 
1042 Deprecated:
1043 - add_rat(pos): Add C++ rat object (no-op)
1044 - add_firefly(pos): Add C++ firefly object (no-op)
1045
1046 NodeMetaRef: Node metadata - reference extra data and functionality stored
1047              in a node
1048 - Can be gotten via minetest.env:get_nodemeta(pos)
1049 methods:
1050 - set_string(name, value)
1051 - get_string(name)
1052 - set_int(name, value)
1053 - get_int(name)
1054 - set_float(name, value)
1055 - get_float(name)
1056 - get_inventory() -> InvRef
1057 - to_table() -> nil or {fields = {...}, inventory = {list1 = {}, ...}}
1058 - from_table(nil or {})
1059   ^ See "Node Metadata"
1060   
1061 NodeTimerRef: Node Timers - a high resolution persistent per-node timer
1062 - Can be gotten via minetest.env:get_node_timer(pos)
1063 methods:
1064 - set(timeout,elapsed)
1065   ^ set a timer's state
1066   ^ timeout is in seconds, and supports fractional values (0.1 etc)
1067   ^ elapsed is in seconds, and supports fractional values (0.1 etc)
1068   ^ will trigger the node's on_timer function after timeout-elapsed seconds
1069 - start(timeout)
1070   ^ start a timer
1071   ^ equivelent to set(timeout,0)
1072 - stop()
1073   ^ stops the timer
1074 - get_timeout() -> current timeout in seconds
1075   ^ if timeout is 0, timer is inactive
1076 - get_elapsed() -> current elapsed time in seconds
1077   ^ the node's on_timer function will be called after timeout-elapsed seconds
1078 - is_started() -> boolean state of timer
1079   ^ returns true if timer is started, otherwise false
1080
1081 ObjectRef: Moving things in the game are generally these
1082 (basically reference to a C++ ServerActiveObject)
1083 methods:
1084 - remove(): remove object (after returning from Lua)
1085 - getpos() -> {x=num, y=num, z=num}
1086 - setpos(pos); pos={x=num, y=num, z=num}
1087 - moveto(pos, continuous=false): interpolated move
1088 - punch(puncher, time_from_last_punch, tool_capabilities, direction)
1089   ^ puncher = an another ObjectRef,
1090   ^ time_from_last_punch = time since last punch action of the puncher
1091   ^ direction: can be nil
1092 - right_click(clicker); clicker = an another ObjectRef
1093 - get_hp(): returns number of hitpoints (2 * number of hearts)
1094 - set_hp(hp): set number of hitpoints (2 * number of hearts)
1095 - get_inventory() -> InvRef
1096 - get_wield_list(): returns the name of the inventory list the wielded item is in
1097 - get_wield_index(): returns the index of the wielded item
1098 - get_wielded_item() -> ItemStack
1099 - set_wielded_item(item): replaces the wielded item, returns true if successful
1100 - set_armor_groups({group1=rating, group2=rating, ...})
1101 - set_properties(object property table)
1102 LuaEntitySAO-only: (no-op for other objects)
1103 - setvelocity({x=num, y=num, z=num})
1104 - getvelocity() -> {x=num, y=num, z=num}
1105 - setacceleration({x=num, y=num, z=num})
1106 - getacceleration() -> {x=num, y=num, z=num}
1107 - setyaw(radians)
1108 - getyaw() -> radians
1109 - settexturemod(mod)
1110 - setsprite(p={x=0,y=0}, num_frames=1, framelength=0.2,
1111 -           select_horiz_by_yawpitch=false)
1112   ^ Select sprite from spritesheet with optional animation and DM-style
1113     texture selection based on yaw relative to camera
1114 - get_entity_name() (DEPRECATED: Will be removed in a future version)
1115 - get_luaentity()
1116 Player-only: (no-op for other objects)
1117 - is_player(): true for players, false for others
1118 - get_player_name(): returns "" if is not a player
1119 - get_look_dir(): get camera direction as a unit vector
1120 - get_look_pitch(): pitch in radians
1121 - get_look_yaw(): yaw in radians (wraps around pretty randomly as of now)
1122 - set_inventory_formspec(formspec)
1123   ^ Redefine player's inventory form
1124   ^ Should usually be called in on_joinplayer
1125 - get_inventory_formspec() -> formspec string
1126
1127 InvRef: Reference to an inventory
1128 methods:
1129 - is_empty(listname): return true if list is empty
1130 - get_size(listname): get size of a list
1131 - set_size(listname, size): set size of a list
1132 - get_width(listname): get width of a list
1133 - set_width(listname, width): set width of list; currently used for crafting
1134 - get_stack(listname, i): get a copy of stack index i in list
1135 - set_stack(listname, i, stack): copy stack to index i in list
1136 - get_list(listname): return full list
1137 - set_list(listname, list): set full list (size will not change)
1138 - add_item(listname, stack): add item somewhere in list, returns leftover ItemStack
1139 - room_for_item(listname, stack): returns true if the stack of items
1140     can be fully added to the list
1141 - contains_item(listname, stack): returns true if the stack of items
1142     can be fully taken from the list
1143   remove_item(listname, stack): take as many items as specified from the list,
1144     returns the items that were actually removed (as an ItemStack)
1145
1146 ItemStack: A stack of items.
1147 - Can be created via ItemStack(itemstack or itemstring or table or nil)
1148 methods:
1149 - is_empty(): return true if stack is empty
1150 - get_name(): returns item name (e.g. "default:stone")
1151 - get_count(): returns number of items on the stack
1152 - get_wear(): returns tool wear (0-65535), 0 for non-tools
1153 - get_metadata(): returns metadata (a string attached to an item stack)
1154 - clear(): removes all items from the stack, making it empty
1155 - replace(item): replace the contents of this stack (item can also
1156     be an itemstring or table)
1157 - to_string(): returns the stack in itemstring form
1158 - to_table(): returns the stack in Lua table form
1159 - get_stack_max(): returns the maximum size of the stack (depends on the item)
1160 - get_free_space(): returns get_stack_max() - get_count()
1161 - is_known(): returns true if the item name refers to a defined item type
1162 - get_definition(): returns the item definition table
1163 - get_tool_capabilities(): returns the digging properties of the item,
1164   ^ or those of the hand if none are defined for this item type
1165 - add_wear(amount): increases wear by amount if the item is a tool
1166 - add_item(item): put some item or stack onto this stack,
1167   ^ returns leftover ItemStack
1168 - item_fits(item): returns true if item or stack can be fully added to this one
1169 - take_item(n): take (and remove) up to n items from this stack
1170   ^ returns taken ItemStack
1171   ^ if n is omitted, n=1 is used
1172 - peek_item(n): copy (don't remove) up to n items from this stack
1173   ^ returns copied ItemStack
1174   ^ if n is omitted, n=1 is used
1175
1176 PseudoRandom: A pseudorandom number generator
1177 - Can be created via PseudoRandom(seed)
1178 methods:
1179 - next(): return next integer random number [0...32767]
1180 - next(min, max): return next integer random number [min...max]
1181                   (max - min) must be 32767 or <= 6553 due to the simple
1182                   implementation making bad distribution otherwise.
1183
1184 PerlinNoise: A perlin noise generator
1185 - Can be created via PerlinNoise(seed, octaves, persistence, scale)
1186 - Also minetest.env:get_perlin(seeddiff, octaves, persistence, scale)
1187 methods:
1188 - get2d(pos) -> 2d noise value at pos={x=,y=}
1189 - get3d(pos) -> 3d noise value at pos={x=,y=,z=}
1190
1191 Registered entities
1192 --------------------
1193 - Functions receive a "luaentity" as self:
1194   - It has the member .name, which is the registered name ("mod:thing")
1195   - It has the member .object, which is an ObjectRef pointing to the object
1196   - The original prototype stuff is visible directly via a metatable
1197 - Callbacks:
1198   - on_activate(self, staticdata)
1199     ^ Called when the object is instantiated.
1200   - on_step(self, dtime)
1201     ^ Called on every server tick (dtime is usually 0.05 seconds)
1202   - on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
1203     ^ Called when somebody punches the object.
1204     ^ Note that you probably want to handle most punches using the
1205       automatic armor group system.
1206     ^ puncher: ObjectRef (can be nil)
1207     ^ time_from_last_punch: Meant for disallowing spamming of clicks (can be nil)
1208     ^ tool_capabilities: capability table of used tool (can be nil)
1209         ^ dir: unit vector of direction of punch. Always defined. Points from
1210                the puncher to the punched.
1211   - on_rightclick(self, clicker)
1212   - get_staticdata(self)
1213     ^ Should return a string that will be passed to on_activate when
1214       the object is instantiated the next time.
1215
1216 Definition tables
1217 ------------------
1218
1219 Object Properties
1220 {
1221     hp_max = 1,
1222     physical = true,
1223     weight = 5,
1224     collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
1225     visual = "cube"/"sprite"/"upright_sprite",
1226     visual_size = {x=1, y=1},
1227     textures = {}, -- number of required textures depends on visual
1228     spritediv = {x=1, y=1},
1229     initial_sprite_basepos = {x=0, y=0},
1230     is_visible = true,
1231     makes_footstep_sound = false,
1232     automatic_rotate = false,
1233 }
1234
1235 Entity definition (register_entity)
1236 {
1237     (Deprecated: Everything in object properties is read directly from here)
1238     
1239     initial_properties = <initial object properties>,
1240
1241     on_activate = function(self, staticdata, dtime_s),
1242     on_step = function(self, dtime),
1243     on_punch = function(self, hitter),
1244     on_rightclick = function(self, clicker),
1245     get_staticdata = function(self),
1246     ^ Called sometimes; the string returned is passed to on_activate when
1247       the entity is re-activated from static state
1248     
1249     # Also you can define arbitrary member variables here
1250     myvariable = whatever,
1251 }
1252
1253 ABM (ActiveBlockModifier) definition (register_abm)
1254 {
1255     -- In the following two fields, also group:groupname will work.
1256     nodenames = {"default:lava_source"},
1257     neighbors = {"default:water_source", "default:water_flowing"}, -- (any of these)
1258      ^ If left out or empty, any neighbor will do
1259     interval = 1.0, -- (operation interval)
1260     chance = 1, -- (chance of trigger is 1.0/this)
1261     action = func(pos, node, active_object_count, active_object_count_wider),
1262 }
1263
1264 Item definition (register_node, register_craftitem, register_tool)
1265 {
1266     description = "Steel Axe",
1267     groups = {}, -- key=name, value=rating; rating=1..3.
1268                     if rating not applicable, use 1.
1269                     eg. {wool=1, fluffy=3}
1270                         {soil=2, outerspace=1, crumbly=1}
1271                         {bendy=2, snappy=1},
1272                         {hard=1, metal=1, spikes=1}
1273     inventory_image = "default_tool_steelaxe.png",
1274     wield_image = "",
1275     wield_scale = {x=1,y=1,z=1},
1276     stack_max = 99,
1277     liquids_pointable = false,
1278     tool_capabilities = {
1279         full_punch_interval = 1.0,
1280         max_drop_level=0,
1281         groupcaps={
1282             -- For example:
1283             fleshy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
1284             snappy={times={[2]=0.80, [3]=0.40}, maxwear=0.05, maxlevel=1},
1285             choppy={times={[3]=0.90}, maxwear=0.05, maxlevel=0}
1286         }
1287     }
1288     node_placement_prediction = nil,
1289     ^ If nil and item is node, prediction is made automatically
1290     ^ If nil and item is not a node, no prediction is made
1291     ^ If "" and item is anything, no prediction is made
1292     ^ Otherwise should be name of node which the client immediately places
1293       on ground when the player places the item. Server will always update
1294       actual result to client in a short moment.
1295
1296     on_place = func(itemstack, placer, pointed_thing),
1297     ^ Shall place item and return the leftover itemstack
1298     ^ default: minetest.item_place
1299     on_drop = func(itemstack, dropper, pos),
1300     ^ Shall drop item and return the leftover itemstack
1301     ^ default: minetest.item_drop
1302     on_use = func(itemstack, user, pointed_thing),
1303     ^  default: nil
1304     ^ Function must return either nil if no item shall be removed from
1305       inventory, or an itemstack to replace the original itemstack.
1306         eg. itemstack:take_item(); return itemstack
1307     ^ Otherwise, the function is free to do what it wants.
1308     ^ The default functions handle regular use cases.
1309 }
1310
1311 Tile definition:
1312 - "image.png"
1313 - {name="image.png", animation={Tile Animation definition}}
1314 - {name="image.png", backface_culling=bool}
1315   ^ backface culling only supported in special tiles
1316 - deprecated still supported field names:
1317   - image -> name
1318
1319 Tile animation definition:
1320 - {type="vertical_frames", aspect_w=16, aspect_h=16, length=3.0}
1321
1322 Node definition (register_node)
1323 {
1324     <all fields allowed in item definitions>,
1325
1326     drawtype = "normal", -- See "Node drawtypes"
1327     visual_scale = 1.0,
1328     tiles = {tile definition 1, def2, def3, def4, def5, def6},
1329         ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
1330     ^ List can be shortened to needed length
1331     special_tiles = {tile definition 1, Tile definition 2},
1332         ^ Special textures of node; used rarely (old field name: special_materials)
1333     ^ List can be shortened to needed length
1334     alpha = 255,
1335     post_effect_color = {a=0, r=0, g=0, b=0}, -- If player is inside node
1336     paramtype = "none", -- See "Nodes"
1337     paramtype2 = "none", -- See "Nodes"
1338     is_ground_content = false, -- Currently not used for anything
1339     sunlight_propagates = false, -- If true, sunlight will go infinitely through this
1340     walkable = true, -- If true, objects collide with node
1341     pointable = true, -- If true, can be pointed at
1342     diggable = true, -- If false, can never be dug
1343     climbable = false, -- If true, can be climbed on (ladder)
1344     buildable_to = false, -- If true, placed nodes can replace this node
1345     drop = "", -- alternatively drop = { max_items = ..., items = { ... } }
1346     liquidtype = "none", -- "none"/"source"/"flowing"
1347     liquid_alternative_flowing = "", -- Flowing version of source liquid
1348     liquid_alternative_source = "", -- Source version of flowing liquid
1349     liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
1350     liquid_renewable = true, -- Can new liquid source be created by placing
1351     two or more sources nearly?
1352     light_source = 0, -- Amount of light emitted by node
1353     damage_per_second = 0, -- If player is inside node, this damage is caused
1354     node_box = {type="regular"}, -- See "Node boxes"
1355     selection_box = {type="regular"}, -- See "Node boxes"
1356     legacy_facedir_simple = false, -- Support maps made in and before January 2012
1357     legacy_wallmounted = false, -- Support maps made in and before January 2012
1358     sounds = {
1359         footstep = <SimpleSoundSpec>,
1360         dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
1361         dug = <SimpleSoundSpec>,
1362     },
1363
1364     on_construct = func(pos),
1365     ^ Node constructor; always called after adding node
1366     ^ Can set up metadata and stuff like that
1367     ^ default: nil
1368     on_destruct = func(pos),
1369     ^ Node destructor; always called before removing node
1370     ^ default: nil
1371     after_destruct = func(pos, oldnode),
1372     ^ Node destructor; always called after removing node
1373     ^ default: nil
1374
1375     after_place_node = func(pos, placer),
1376     ^ Called after constructing node when node was placed using
1377       minetest.item_place_node / minetest.env:place_node
1378     ^ default: nil
1379     after_dig_node = func(pos, oldnode, oldmetadata, digger),
1380     ^ oldmetadata is in table format
1381     ^ Called after destructing node when node was dug using
1382       minetest.node_dig / minetest.env:dig_node
1383     ^ default: nil
1384     can_dig = function(pos,player)
1385     ^ returns true if node can be dug, or false if not
1386     ^ default: nil
1387         
1388     on_punch = func(pos, node, puncher),
1389     ^ default: minetest.node_punch
1390     ^ By default: does nothing
1391     on_dig = func(pos, node, digger),
1392     ^ default: minetest.node_dig
1393     ^ By default: checks privileges, wears out tool and removes node
1394     
1395     on_timer = function(pos,elapsed),
1396     ^ default: nil
1397     ^ called by NodeTimers, see EnvRef and NodeTimerRef
1398     ^ elapsed is the total time passed since the timer was started
1399     ^ return true to run the timer for another cycle with the same timeout value
1400
1401     on_receive_fields = func(pos, formname, fields, sender),
1402     ^ fields = {name1 = value1, name2 = value2, ...}
1403     ^ Called when an UI form (eg. sign text input) returns data
1404     ^ default: nil
1405
1406         allow_metadata_inventory_move = func(pos, from_list, from_index,
1407                         to_list, to_index, count, player),
1408         ^ Called when a player wants to move items inside the inventory
1409         ^ Return value: number of items allowed to move
1410         
1411         allow_metadata_inventory_put = func(pos, listname, index, stack, player),
1412         ^ Called when a player wants to put something into the inventory
1413         ^ Return value: number of items allowed to put
1414         ^ Return value: -1: Allow and don't modify item count in inventory
1415   
1416         allow_metadata_inventory_take = func(pos, listname, index, stack, player),
1417         ^ Called when a player wants to take something out of the inventory
1418         ^ Return value: number of items allowed to take
1419         ^ Return value: -1: Allow and don't modify item count in inventory
1420
1421         on_metadata_inventory_move = func(pos, from_list, from_index,
1422                         to_list, to_index, count, player),
1423         on_metadata_inventory_put = func(pos, listname, index, stack, player),
1424         on_metadata_inventory_take = func(pos, listname, index, stack, player),
1425         ^ Called after the actual action has happened, according to what was allowed.
1426         ^ No return value
1427     
1428         on_blast = func(pos, intensity),
1429         ^ intensity: 1.0 = mid range of regular TNT
1430         ^ If defined, called when an explosion touches the node, instead of
1431           removing the node
1432 }
1433
1434 Recipe for register_craft: (shaped)
1435 {
1436     output = 'default:pick_stone',
1437     recipe = {
1438         {'default:cobble', 'default:cobble', 'default:cobble'},
1439         {'', 'default:stick', ''},
1440         {'', 'default:stick', ''}, -- Also groups; eg. 'group:crumbly'
1441     },
1442     replacements = <optional list of item pairs,
1443                     replace one input item with another item on crafting>
1444 }
1445
1446 Recipe for register_craft (shapeless)
1447 {
1448     type = "shapeless",
1449     output = 'mushrooms:mushroom_stew',
1450     recipe = {
1451         "mushrooms:bowl",
1452         "mushrooms:mushroom_brown",
1453         "mushrooms:mushroom_red",
1454     },
1455     replacements = <optional list of item pairs,
1456                     replace one input item with another item on crafting>
1457 }
1458
1459 Recipe for register_craft (tool repair)
1460 {
1461     type = "toolrepair",
1462     additional_wear = -0.02,
1463 }
1464
1465 Recipe for register_craft (cooking)
1466 {
1467     type = "cooking",
1468     output = "default:glass",
1469     recipe = "default:sand",
1470     cooktime = 3,
1471 }
1472
1473 Recipe for register_craft (furnace fuel)
1474 {
1475     type = "fuel",
1476     recipe = "default:leaves",
1477     burntime = 1,
1478 }
1479
1480 Chatcommand definition (register_chatcommand)
1481 {
1482     params = "<name> <privilege>", -- short parameter description
1483     description = "Remove privilege from player", -- full description
1484     privs = {privs=true}, -- require the "privs" privilege to run
1485     func = function(name, param), -- called when command is run
1486 }
1487
1488 Detached inventory callbacks
1489 {
1490         allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
1491     ^ Called when a player wants to move items inside the inventory
1492         ^ Return value: number of items allowed to move
1493         
1494     allow_put = func(inv, listname, index, stack, player),
1495     ^ Called when a player wants to put something into the inventory
1496         ^ Return value: number of items allowed to put
1497         ^ Return value: -1: Allow and don't modify item count in inventory
1498    
1499     allow_take = func(inv, listname, index, stack, player),
1500     ^ Called when a player wants to take something out of the inventory
1501         ^ Return value: number of items allowed to take
1502         ^ Return value: -1: Allow and don't modify item count in inventory
1503         
1504         on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
1505     on_put = func(inv, listname, index, stack, player),
1506     on_take = func(inv, listname, index, stack, player),
1507         ^ Called after the actual action has happened, according to what was allowed.
1508         ^ No return value
1509 }
1510