game_api.txt

   1 Minetest Game API
   2 =================
   3 GitHub Repo: https://github.com/minetest/minetest_game
   4
   5 Introduction
   6 ------------
   7
   8 The Minetest Game subgame offers multiple new possibilities in addition to the Minetest engine's built-in API,
   9 allowing you to add new plants to farming mod, buckets for new liquids, new stairs and custom panes.
  10 For information on the Minetest API, visit https://github.com/minetest/minetest/blob/master/doc/lua_api.txt
  11 Please note:
  12
  13  * [XYZ] refers to a section the Minetest API
  14  * [#ABC] refers to a section in this document
  15  * [pos] refers to a position table `{x = -5, y = 0, z = 200}`
  16
  17 Bucket API
  18 ----------
  19
  20 The bucket API allows registering new types of buckets for non-default liquids.
  21
  22         bucket.register_liquid(
  23                 "default:lava_source",   -- name of the source node
  24                 "default:lava_flowing",  -- name of the flowing node
  25                 "bucket:bucket_lava",    -- name of the new bucket item (or nil if liquid is not takeable)
  26                 "bucket_lava.png",       -- texture of the new bucket item (ignored if itemname == nil)
  27                 "Lava Bucket",           -- text description of the bucket item
  28                 {lava_bucket = 1},       -- groups of the bucket item, OPTIONAL
  29                 false                    -- force-renew, OPTIONAL. Force the liquid source to renew if it has
  30                                          -- a source neighbour, even if defined as 'liquid_renewable = false'.
  31                                          -- Needed to avoid creating holes in sloping rivers.
  32         )
  33
  34 The filled bucket item is returned to the player that uses an empty bucket pointing to the given liquid source.
  35 When punching with an empty bucket pointing to an entity or a non-liquid node, the on_punch of the entity or node will be triggered.
  36
  37 Beds API
  38 --------
  39
  40         beds.register_bed(
  41                 "beds:bed",    -- Bed name
  42                 def            -- See [#Bed definition]
  43         )
  44
  45  * `beds.read_spawns() `   Returns a table containing players respawn positions
  46  * `beds.kick_players()`  Forces all players to leave bed
  47  * `beds.skip_night()`   Sets world time to morning and saves respawn position of all players currently sleeping
  48
  49 ### Bed definition
  50
  51         {
  52                 description = "Simple Bed",
  53                 inventory_image = "beds_bed.png",
  54                 wield_image = "beds_bed.png",
  55                 tiles = {
  56                         bottom = {'Tile definition'}, -- the tiles of the bottom part of the bed.
  57                         top = {Tile definition} -- the tiles of the bottom part of the bed.
  58                 },
  59                 nodebox = {
  60                         bottom = 'regular nodebox',     -- bottom part of bed (see [Node boxes])
  61                         top = 'regular nodebox',        -- top part of bed (see [Node boxes])
  62                 },
  63                 selectionbox = 'regular nodebox',  -- for both nodeboxes (see [Node boxes])
  64                 recipe = {                                         -- Craft recipe
  65                         {"group:wool", "group:wool", "group:wool"},
  66                         {"group:wood", "group:wood", "group:wood"}
  67                 }
  68         }
  69
  70 Creative API
  71 ------------
  72
  73 A global string called `creative.formspec_add` was added which allows mods to add additional formspec elements onto the default creative inventory formspec to be drawn after each update.
  74
  75 Doors API
  76 ---------
  77
  78 The doors mod allows modders to register custom doors and trapdoors.
  79
  80 `doors.register_door(name, def)`
  81
  82  * Registers new door
  83  * `name` Name for door
  84  * `def`  See [#Door definition]
  85
  86 `doors.register_trapdoor(name, def)`
  87
  88  * Registers new trapdoor
  89  * `name` Name for trapdoor
  90  * `def`  See [#Trapdoor definition]
  91
  92 `doors.register_fencegate(name, def)`
  93
  94  * Registers new fence gate
  95  * `name` Name for fence gate
  96  * `def`  See [#Fence gate definition]
  97
  98 `doors.get(pos)`
  99
 100  * `pos` A position as a table, e.g `{x = 1, y = 1, z = 1}`
 101  * Returns an ObjectRef to a door, or nil if the position does not contain a door
 102
 103     ### Methods
 104
 105         :open(player)   -- Open the door object, returns if door was opened
 106         :close(player)  -- Close the door object, returns if door was closed
 107         :toggle(player) -- Toggle the door state, returns if state was toggled
 108         :state()        -- returns the door state, true = open, false = closed
 109
 110     the "player" parameter can be omitted in all methods. If passed then
 111     the usual permission checks will be performed to make sure the player
 112     has the permissions needed to open this door. If omitted then no
 113     permission checks are performed.
 114
 115 ### Door definition
 116
 117         description = "Door description",
 118         inventory_image = "mod_door_inv.png",
 119         groups = {choppy = 2},
 120         tiles = {"mod_door.png"}, -- UV map.
 121         recipe = craftrecipe,
 122         sounds = default.node_sound_wood_defaults(), -- optional
 123         sound_open = sound play for open door, -- optional
 124         sound_close = sound play for close door, -- optional
 125         protected = false, -- If true, only placer can open the door (locked for others)
 126
 127 ### Trapdoor definition
 128
 129         description = "Trapdoor description",
 130         inventory_image = "mod_trapdoor_inv.png",
 131         groups = {choppy = 2},
 132         tile_front = "doors_trapdoor.png", -- the texture for the front and back of the trapdoor
 133         tile_side = "doors_trapdoor_side.png", -- the tiles of the four side parts of the trapdoor
 134         sounds = default.node_sound_wood_defaults(), -- optional
 135         sound_open = sound play for open door, -- optional
 136         sound_close = sound play for close door, -- optional
 137         protected = false, -- If true, only placer can open the door (locked for others)
 138
 139 ### Fence gate definition
 140
 141         description = "Wooden Fence Gate",
 142         texture = "default_wood.png",
 143         material = "default:wood",
 144         groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
 145         sounds = default.node_sound_wood_defaults(), -- optional
 146
 147 Fence API
 148 ---------
 149
 150 Allows creation of new fences with "fencelike" drawtype.
 151
 152 `default.register_fence(name, item definition)`
 153
 154  Registers a new fence. Custom fields texture and material are required, as
 155  are name and description. The rest is optional. You can pass most normal
 156  nodedef fields here except drawtype. The fence group will always be added
 157  for this node.
 158
 159 ### fence definition
 160
 161         name = "default:fence_wood",
 162         description = "Wooden Fence",
 163         texture = "default_wood.png",
 164         material = "default:wood",
 165         groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
 166         sounds = default.node_sound_wood_defaults(),
 167
 168 Walls API
 169 ---------
 170
 171 The walls API allows easy addition of stone auto-connecting wall nodes.
 172
 173 walls.register(name, desc, texture, mat, sounds)
 174 ^ name = "walls:stone_wall". Node name.
 175 ^ desc = "A Stone wall"
 176 ^ texture = "default_stone.png"
 177 ^ mat = "default:stone". Used to auto-generate crafting recipe.
 178 ^ sounds = sounds: see [#Default sounds]
 179
 180 Farming API
 181 -----------
 182
 183 The farming API allows you to easily register plants and hoes.
 184
 185 `farming.register_hoe(name, hoe definition)`
 186  * Register a new hoe, see [#hoe definition]
 187
 188 `farming.register_plant(name, Plant definition)`
 189  * Register a new growing plant, see [#Plant definition]
 190
 191 `farming.registered_plants[name] = definition`
 192  * Table of registered plants, indexed by plant name
 193
 194 ### Hoe Definition
 195
 196
 197         {
 198                 description = "",                      -- Description for tooltip
 199                 inventory_image = "unknown_item.png",  -- Image to be used as wield- and inventory image
 200                 max_uses = 30,                         -- Uses until destroyed
 201                 material = "",                         -- Material for recipes
 202                 recipe = {                             -- Craft recipe, if material isn't used
 203                         {"air", "air", "air"},
 204                         {"", "group:stick"},
 205                         {"", "group:stick"},
 206                 }
 207         }
 208
 209 ### Plant definition
 210
 211         {
 212                 description = "",                      -- Description of seed item
 213                 inventory_image = "unknown_item.png",  -- Image to be used as seed's wield- and inventory image
 214                 steps = 8,                             -- How many steps the plant has to grow, until it can be harvested
 215                 -- ^ Always provide a plant texture for each step, format: modname_plantname_i.png (i = stepnumber)
 216                 minlight = 13,                         -- Minimum light to grow
 217                 maxlight = default.LIGHT_MAX           -- Maximum light to grow
 218         }
 219
 220 Fire API
 221 --------
 222
 223 New node def property:
 224
 225 `on_burn(pos)`
 226
 227  * Called when fire attempts to remove a burning node.
 228  * `pos` Position of the burning node.
 229
 230 Give Initial Stuff API
 231 ----------------------
 232
 233 `give_initial_stuff.give(player)`
 234
 235 ^ Give initial stuff to "player"
 236
 237 `give_initial_stuff.add(stack)`
 238
 239 ^ Add item to the initial stuff
 240 ^ Stack can be an ItemStack or a item name eg: "default:dirt 99"
 241 ^ Can be called after the game has loaded
 242
 243 `give_initial_stuff.clear()`
 244
 245 ^ Removes all items from the initial stuff
 246 ^ Can be called after the game has loaded
 247
 248 `give_initial_stuff.get_list()`
 249
 250 ^ returns list of item stacks
 251
 252 `give_initial_stuff.set_list(list)`
 253
 254 ^ List of initial items with numeric indices.
 255
 256 `give_initial_stuff.add_from_csv(str)`
 257
 258 ^ str is a comma separated list of initial stuff
 259 ^ Adds items to the list of items to be given
 260
 261 Nyancat API
 262 -----------
 263
 264 `nyancat.place(pos, facedir, length)`
 265
 266 ^ Place a cat at `pos` facing `facedir` with tail length `length`
 267   Only accepts facedir 0-3, if facedir > 3 then it will be interpreted as facedir = 0
 268
 269 `nyancat.generate(minp, maxp, seed)`
 270
 271 ^ Called by `minetest.register_on_generated`. To disable nyancat generation,
 272   you can redefine nyancat.generate() to be an empty function
 273
 274 TNT API
 275 ----------
 276
 277 `tnt.register_tnt(definition)`
 278
 279 ^ Register a new type of tnt.
 280
 281  * `name` The name of the node. If no prefix is given `tnt` is used.
 282  * `description` A description for your TNT.
 283  * `radius` The radius within which the TNT can destroy nodes. The default is 3.
 284  * `damage_radius` The radius within which the TNT can damage players and mobs. By default it is twice the `radius`.
 285  * `disable_drops` Disable drops. By default it is set to false.
 286  * `ignore_protection` Don't check `minetest.is_protected` before removing a node.
 287  * `ignore_on_blast` Don't call `on_blast` even if a node has one.
 288  * `tiles` Textures for node
 289   * `side`  Side tiles. By default the name of the tnt with a suffix of `_side.png`.
 290   * `top`  Top tile. By default the name of the tnt with a suffix of `_top.png`.
 291   * `bottom` Bottom tile. By default the name of the tnt with a suffix of `_bottom.png`.
 292   * `burning` Top tile when lit. By default the name of the tnt with a suffix of `_top_burning_animated.png".
 293
 294 `tnt.boom(position, definition)`
 295
 296 ^ Create an explosion.
 297
 298 * `position` The center of explosion.
 299 * `definition` The TNT definion as passed to `tnt.register`
 300
 301 `tnt.burn(position, [nodename])`
 302
 303 ^ Ignite TNT at position, nodename isn't required unless already known.
 304
 305
 306 To make dropping items from node inventories easier, you can use the
 307 following helper function from 'default':
 308
 309 default.get_inventory_drops(pos, inventory, drops)
 310
 311 ^ Return drops from node inventory "inventory" in drops.
 312
 313 * `pos` - the node position
 314 * `inventory` - the name of the inventory (string)
 315 * `drops` - an initialized list
 316
 317 The function returns no values. The drops are returned in the `drops`
 318 parameter, and drops is not reinitialized so you can call it several
 319 times in a row to add more inventory items to it.
 320
 321
 322 `on_blast` callbacks:
 323
 324 Both nodedefs and entitydefs can provide an `on_blast()` callback
 325
 326 `nodedef.on_blast(pos, intensity)`
 327 ^ Allow drop and node removal overriding
 328 * `pos` - node position
 329 * `intensity` - TNT explosion measure. larger or equal to 1.0
 330 ^ Should return a list of drops (e.g. {"default:stone"})
 331 ^ Should perform node removal itself. If callback exists in the nodedef
 332 ^ then the TNT code will not destroy this node.
 333
 334 `entitydef.on_blast(luaobj, damage)`
 335 ^ Allow TNT effects on entities to be overridden
 336 * `luaobj` - LuaEntityRef of the entity
 337 * `damage` - suggested HP damage value
 338 ^ Should return a list of (bool do_damage, bool do_knockback, table drops)
 339 * `do_damage` - if true then TNT mod wil damage the entity
 340 * `do_knockback` - if true then TNT mod will knock the entity away
 341 * `drops` - a list of drops, e.g. {"wool:red"}
 342
 343
 344 Screwdriver API
 345 ---------------
 346
 347 The screwdriver API allows you to control a node's behaviour when a screwdriver is used on it.
 348 To use it, add the `on_screwdriver` function to the node definition.
 349
 350 `on_rotate(pos, node, user, mode, new_param2)`
 351
 352  * `pos` Position of the node that the screwdriver is being used on
 353  * `node` that node
 354  * `user` The player who used the screwdriver
 355  * `mode` screwdriver.ROTATE_FACE or screwdriver.ROTATE_AXIS
 356  * `new_param2` the new value of param2 that would have been set if on_rotate wasn't there
 357  * return value: false to disallow rotation, nil to keep default behaviour, true to allow
 358         it but to indicate that changed have already been made (so the screwdriver will wear out)
 359  * use `on_rotate = false` to always disallow rotation
 360  * use `on_rotate = screwdriver.rotate_simple` to allow only face rotation
 361
 362
 363 Sethome API
 364 -----------
 365
 366 The sethome API adds three global functions to allow mods to read a players home position,
 367 set a players home position and teleport a player to home position.
 368
 369 `sethome.get(name)`
 370
 371  * `name` Player who's home position you wish to get
 372  * return value: false if no player home coords exist, position table if true
 373
 374 `sethome.set(name, pos)`
 375
 376  * `name` Player who's home position you wish to set
 377  * `pos` Position table containing coords of home position
 378  * return value: false if unable to set and save new home position, otherwise true
 379
 380 `sethome.go(name)`
 381
 382  * `name` Player you wish to teleport to their home position
 383  * return value: false if player cannot be sent home, otherwise true
 384
 385
 386 Stairs API
 387 ----------
 388
 389 The stairs API lets you register stairs and slabs and ensures that they are registered the same way as those
 390 delivered with Minetest Game, to keep them compatible with other mods.
 391
 392 `stairs.register_stair(subname, recipeitem, groups, images, description, sounds)`
 393
 394  * Registers a stair.
 395  * `subname`: Basically the material name (e.g. cobble) used for the stair name. Nodename pattern: "stairs:stair_subname"
 396  * `recipeitem`: Item used in the craft recipe, e.g. "default:cobble", may be `nil`
 397  * `groups`: see [Known damage and digging time defining groups]
 398  * `images`: see [Tile definition]
 399  * `description`: used for the description field in the stair's definition
 400  * `sounds`: see [#Default sounds]
 401
 402 `stairs.register_slab(subname, recipeitem, groups, images, description, sounds)`
 403
 404  * Registers a slabs
 405  * `subname`: Basically the material name (e.g. cobble) used for the stair name. Nodename pattern: "stairs:stair_subname"
 406  * `recipeitem`: Item used in the craft recipe, e.g. "default:cobble"
 407  * `groups`: see [Known damage and digging time defining groups]
 408  * `images`: see [Tile definition]
 409  * `description`: used for the description field in the stair's definition
 410  * `sounds`: see [#Default sounds]
 411
 412 `stairs.register_stair_and_slab(subname, recipeitem, groups, images, desc_stair, desc_slab, sounds)`
 413
 414  * A wrapper for stairs.register_stair and stairs.register_slab
 415  * Uses almost the same arguments as stairs.register_stair
 416  * `desc_stair`: Description for stair node
 417  * `desc_slab`: Description for slab node
 418
 419 Xpanes API
 420 ----------
 421
 422 Creates panes that automatically connect to each other
 423
 424 `xpanes.register_pane(subname, def)`
 425
 426  * `subname`: used for nodename. Result: "xpanes:subname" and "xpanes:subname_{2..15}"
 427  * `def`: See [#Pane definition]
 428
 429 ### Pane definition
 430
 431         {
 432                 textures = {"texture for sides", (unused), "texture for top and bottom"}, -- More tiles aren't supported
 433                 groups = {group = rating}, -- Uses the known node groups, see [Known damage and digging time defining groups]
 434                 sounds = SoundSpec,        -- See [#Default sounds]
 435                 recipe = {{"","","","","","","","",""}}, -- Recipe field only
 436         }
 437
 438 Raillike definitions
 439 --------------------
 440
 441 The following nodes use the group `connect_to_raillike` and will only connect to
 442 raillike nodes within this group and the same group value.
 443 Use `minetest.raillike_group(<Name>)` to get the group value.
 444
 445 | Node type             | Raillike group name
 446 |-----------------------|---------------------
 447 | default:rail          | "rail"
 448 | tnt:gunpowder         | "gunpowder"
 449 | tnt:gunpowder_burning | "gunpowder"
 450
 451 Example:
 452 If you want to add a new rail type and want it to connect with default:rail,
 453 add `connect_to_raillike=minetest.raillike_group("rail")` into the `groups` table
 454 of your node.
 455
 456
 457 Default sounds
 458 --------------
 459
 460 Sounds inside the default table can be used within the sounds field of node definitions.
 461
 462  * `default.node_sound_defaults()`
 463  * `default.node_sound_stone_defaults()`
 464  * `default.node_sound_dirt_defaults()`
 465  * `default.node_sound_sand_defaults()`
 466  * `default.node_sound_wood_defaults()`
 467  * `default.node_sound_leaves_defaults()`
 468  * `default.node_sound_glass_defaults()`
 469  * `default.node_sound_metal_defaults()`
 470
 471 Default constants
 472 -----------------
 473
 474 `default.LIGHT_MAX`  The maximum light level (see [Node definition] light_source)
 475
 476 Player API
 477 ----------
 478
 479 The player API can register player models and update the player's appearence
 480
 481 `default.player_register_model(name, def)`
 482
 483  * Register a new model to be used by players.
 484  * name: model filename such as "character.x", "foo.b3d", etc.
 485  * def: See [#Model definition]
 486
 487 `default.registered_player_models[name]`
 488
 489  * Get a model's definition
 490  * see [#Model definition]
 491
 492 `default.player_set_model(player, model_name)`
 493
 494  * Change a player's model
 495  * `player`: PlayerRef
 496  * `model_name`: model registered with player_register_model()
 497
 498 `default.player_set_animation(player, anim_name [, speed])`
 499
 500  * Applies an animation to a player
 501  * anim_name: name of the animation.
 502  * speed: frames per second. If nil, default from the model is used
 503
 504 `default.player_set_textures(player, textures)`
 505
 506  * Sets player textures
 507  * `player`: PlayerRef
 508  * `textures`: array of textures, If `textures` is nil, the default textures from the model def are used
 509
 510 default.player_get_animation(player)
 511
 512  * Returns a table containing fields `model`, `textures` and `animation`.
 513  * Any of the fields of the returned table may be nil.
 514  * player: PlayerRef
 515
 516 ### Model Definition
 517
 518         {
 519                 animation_speed = 30,            -- Default animation speed, in FPS.
 520                 textures = {"character.png", },  -- Default array of textures.
 521                 visual_size = {x = 1, y = 1},    -- Used to scale the model.
 522                 animations = {
 523                         -- <anim_name> = {x = <start_frame>, y = <end_frame>},
 524                         foo = {x = 0, y = 19},
 525                         bar = {x = 20, y = 39},
 526                 -- ...
 527                 },
 528         }
 529
 530 Leafdecay
 531 ---------
 532
 533 To enable leaf decay for a node, add it to the `leafdecay` group.
 534
 535 The rating of the group determines how far from a node in the group `tree`
 536 the node can be without decaying.
 537
 538 If `param2` of the node is ~= 0, the node will always be preserved. Thus, if
 539 the player places a node of that kind, you will want to set `param2 = 1` or so.
 540
 541 The function `default.after_place_leaves` can be set as `after_place_node of a node`
 542 to set param2 to 1 if the player places the node (should not be used for nodes
 543 that use param2 otherwise (e.g. facedir)).
 544
 545 If the node is in the `leafdecay_drop` group then it will always be dropped as an
 546 item.
 547
 548 Dyes
 549 ----
 550
 551 To make recipes that will work with any dye ever made by anybody, define
 552 them based on groups. You can select any group of groups, based on your need for
 553 amount of colors.
 554
 555 ### Color groups
 556
 557 Base color groups:
 558
 559  * `basecolor_white`
 560  * `basecolor_grey`
 561  * `basecolor_black`
 562  * `basecolor_red`
 563  * `basecolor_yellow`
 564  * `basecolor_green`
 565  * `basecolor_cyan`
 566  * `basecolor_blue`
 567  * `basecolor_magenta`
 568
 569 Extended color groups ( * means also base color )
 570
 571  * `excolor_white` *
 572  * `excolor_lightgrey`
 573  * `excolor_grey` *
 574  * `excolor_darkgrey`
 575  * `excolor_black` *
 576  * `excolor_red` *
 577  * `excolor_orange`
 578  * `excolor_yellow` *
 579  * `excolor_lime`
 580  * `excolor_green` *
 581  * `excolor_aqua`
 582  * `excolor_cyan` *
 583  * `excolor_sky_blue`
 584  * `excolor_blue` *
 585  * `excolor_violet`
 586  * `excolor_magenta` *
 587  * `excolor_red_violet`
 588
 589 The whole unifieddyes palette as groups:
 590
 591  * `unicolor_<excolor>`
 592
 593 For the following, no white/grey/black is allowed:
 594
 595  * `unicolor_medium_<excolor>`
 596  * `unicolor_dark_<excolor>`
 597  * `unicolor_light_<excolor>`
 598  * `unicolor_<excolor>_s50`
 599  * `unicolor_medium_<excolor>_s50`
 600  * `unicolor_dark_<excolor>_s50`
 601
 602 Example of one shapeless recipe using a color group:
 603
 604         minetest.register_craft({
 605                 type = "shapeless",
 606                 output = '<mod>:item_yellow',
 607                 recipe = {'<mod>:item_no_color', 'group:basecolor_yellow'},
 608         })
 609
 610 ### Color lists
 611
 612  * `dye.basecolors` are an array containing the names of available base colors
 613
 614  * `dye.excolors` are an array containing the names of the available extended colors
 615
 616 Trees
 617 -----
 618
 619  * `default.grow_tree(pos, is_apple_tree)`
 620   * Grows a mgv6 tree or apple tree at pos
 621
 622  * `default.grow_jungle_tree(pos)`
 623   * Grows a mgv6 jungletree at pos
 624
 625  * `default.grow_pine_tree(pos)`
 626   * Grows a mgv6 pinetree at pos
 627
 628  * `default.grow_new_apple_tree(pos)`
 629   * Grows a new design apple tree at pos
 630
 631  * `default.grow_new_jungle_tree(pos)`
 632   * Grows a new design jungle tree at pos
 633
 634  * `default.grow_new_pine_tree(pos)`
 635   * Grows a new design pine tree at pos
 636
 637  * `default.grow_new_acacia_tree(pos)`
 638   * Grows a new design acacia tree at pos
 639
 640  * `default.grow_new_aspen_tree(pos)`
 641   * Grows a new design aspen tree at pos
 642
 643  * `default.grow_new_snowy_pine_tree(pos)`
 644   * Grows a new design snowy pine tree at pos