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
  16 Bucket API
  17 ----------
  18
  19 The bucket API allows registering new types of buckets for non-default liquids.
  20
  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         )
  30
  31 Beds API
  32 --------
  33
  34         beds.register_bed(
  35                 "beds:bed",    -- Bed name
  36                 def            -- See [#Bed definition]
  37         )
  38
  39  * `beds.read_spawns() `   Returns a table containing players respawn positions
  40  * `beds.kick_players()`  Forces all players to leave bed
  41  * `beds.skip_night()`   Sets world time to morning and saves respawn position of all players currently sleeping
  42
  43 ###Bed definition
  44
  45         {
  46                 description = "Simple Bed",
  47                 inventory_image = "beds_bed.png",
  48                 wield_image = "beds_bed.png",
  49                 tiles = {
  50                         bottom = {'Tile definition'}, -- the tiles of the bottom part of the bed.
  51                         top = {Tile definition} -- the tiles of the bottom part of the bed.
  52                 },
  53                 nodebox = {
  54                         bottom = 'regular nodebox',     -- bottom part of bed (see [Node boxes])
  55                         top = 'regular nodebox',        -- top part of bed (see [Node boxes])
  56                 },
  57                 selectionbox = 'regular nodebox',  -- for both nodeboxes (see [Node boxes])
  58                 recipe = {                                         -- Craft recipe
  59                         {"group:wool", "group:wool", "group:wool"},
  60                         {"group:wood", "group:wood", "group:wood"}
  61                 }
  62         }
  63
  64 Doors API
  65 ---------
  66
  67 The doors mod allows modders to register custom doors and trapdoors.
  68
  69 `doors.register_door(name, def)`
  70
  71  * Registers new door
  72  * `name` Name for door
  73  * `def`  See [#Door definition]
  74
  75 `doors.register_trapdoor(name, def)`
  76
  77  * Registers new trapdoor
  78  * `name` Name for trapdoor
  79  * `def`  See [#Trapdoor definition]
  80
  81 `doors.register_fencegate(name, def)`
  82
  83  * Registers new fence gate
  84  * `name` Name for fence gate
  85  * `def`  See [#Fence gate definition]
  86
  87 `doors.get(pos)`
  88
  89  * `pos` A position as a table, e.g `{x = 1, y = 1, z = 1}`
  90  * Returns an ObjecRef to a door, or nil if the position does not contain a door
  91
  92  ###Methods
  93
  94         :open(player)   -- Open the door object, returns if door was opened
  95         :close(player)  -- Close the door object, returns if door was closed
  96         :toggle(player) -- Toggle the door state, returns if state was toggled
  97         :state()        -- returns the door state, true = open, false = closed
  98
  99     the "player" parameter can be omitted in all methods. If passed then
 100     the usual permission checks will be performed to make sure the player
 101     has the permissions needed to open this door. If omitted then no
 102     permission checks are performed.
 103
 104 ###Door definition
 105
 106         description = "Door description",
 107         inventory_image = "mod_door_inv.png",
 108         groups = {choppy = 2},
 109         tiles = {"mod_door.png"}, -- UV map.
 110         recipe = craftrecipe,
 111         sounds = default.node_sound_wood_defaults(), -- optional
 112         sound_open = sound play for open door, -- optional
 113         sound_close = sound play for close door, -- optional
 114         protected = false, -- If true, only placer can open the door (locked for others)
 115
 116 ###Trapdoor definition
 117
 118         description = "Trapdoor description",
 119         inventory_image = "mod_trapdoor_inv.png",
 120         groups = {choppy = 2},
 121         tile_front = "doors_trapdoor.png", -- the texture for the front and back of the trapdoor
 122         tile_side = "doors_trapdoor_side.png", -- the tiles of the four side parts of the trapdoor
 123         sounds = default.node_sound_wood_defaults(), -- optional
 124         sound_open = sound play for open door, -- optional
 125         sound_close = sound play for close door, -- optional
 126         protected = false, -- If true, only placer can open the door (locked for others)
 127
 128 ###Fence gate definition
 129
 130         description = "Wooden Fence Gate",
 131         texture = "default_wood.png",
 132         material = "default:wood",
 133         groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
 134         sounds = default.node_sound_wood_defaults(), -- optional
 135
 136 Fence API
 137 ---------
 138 Allows creation of new fences with "fencelike" drawtype.
 139
 140 `default.register_fence(name, item definition)`
 141
 142  Registers a new fence. Custom fields texture and material are required, as
 143  are name and description. The rest is optional. You can pass most normal
 144  nodedef fields here except drawtype. The fence group will always be added
 145  for this node.
 146
 147 ###fence definition
 148
 149         name = "default:fence_wood",
 150         description = "Wooden Fence",
 151         texture = "default_wood.png",
 152         material = "default:wood",
 153         groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
 154         sounds = default.node_sound_wood_defaults(),
 155
 156 #Walls API
 157 ---------
 158 The walls API allows easy addition of stone auto-connecting wall nodes.
 159
 160 walls.register(name, desc, texture, mat, sounds)
 161 ^ name = "walls:stone_wall". Node name.
 162 ^ desc = "A Stone wall"
 163 ^ texture = "default_stone.png"
 164 ^ mat = "default:stone". Used to auto-generate crafting recipe.
 165 ^ sounds = sounds: see [#Default sounds]
 166
 167 Farming API
 168 -----------
 169
 170 The farming API allows you to easily register plants and hoes.
 171
 172 `farming.register_hoe(name, hoe definition)`
 173  * Register a new hoe, see [#hoe definition]
 174
 175 `farming.register_plant(name, Plant definition)`
 176  * Register a new growing plant, see [#Plant definition]
 177
 178 ###Hoe Definition
 179
 180
 181         {
 182                 description = "",                      -- Description for tooltip
 183                 inventory_image = "unknown_item.png",  -- Image to be used as wield- and inventory image
 184                 max_uses = 30,                         -- Uses until destroyed
 185                 material = "",                         -- Material for recipes
 186                 recipe = {                             -- Craft recipe, if material isn't used
 187                         {"air", "air", "air"},
 188                         {"", "group:stick"},
 189                         {"", "group:stick"},
 190                 }
 191         }
 192
 193 ###Plant definition
 194
 195         {
 196                 description = "",                      -- Description of seed item
 197                 inventory_image = "unknown_item.png",  -- Image to be used as seed's wield- and inventory image
 198                 steps = 8,                             -- How many steps the plant has to grow, until it can be harvested
 199                 -- ^ Always provide a plant texture for each step, format: modname_plantname_i.png (i = stepnumber)
 200                 minlight = 13,                         -- Minimum light to grow
 201                 maxlight = default.LIGHT_MAX           -- Maximum light to grow
 202         }
 203
 204 Fire API
 205 --------
 206
 207 `on_burn(pos)`
 208
 209  * Called when fire attempts to remove a burning node.
 210  * `pos` Position of the burning node.
 211
 212
 213 #TNT API
 214 ----------
 215
 216 tnt.register_tnt(definition)
 217
 218 ^ Register a new type of tnt.
 219
 220  * `name` The name of the node. If no prefix is given `tnt` is used.
 221  * `description` A description for your TNT.
 222  * `radius` The radius within which the TNT can destroy nodes. The default is 3.
 223  * `damage_radius` The radius within which the TNT can damage players and mobs. By default it is twice the `radius`.
 224  * `disable_drops` Disable drops. By default it is set to false.
 225  * `ignore_protection` Don't check `minetest.is_protected` before removing a node.
 226  * `ignore_on_blast` Don't call `on_blast` even if a node has one.
 227  * `tiles` Textures for node
 228   * `side`  Side tiles. By default the name of the tnt with a suffix of `_side.png`.
 229   * `top`  Top tile. By default the name of the tnt with a suffix of `_top.png`.
 230   * `bottom` Bottom tile. By default the name of the tnt with a suffix of `_bottom.png`.
 231   * `burning` Top tile when lit. By default the name of the tnt with a suffix of `_top_burning_animated.png".
 232
 233 `tnt.boom(position, definition)`
 234
 235 ^ Create an explosion.
 236
 237 * `position` The center of explosion.
 238 * `definition` The TNT definion as passed to `tnt.register`
 239
 240 `tnt.burn(position)`
 241
 242 ^ Ignite TNT at position
 243
 244 Screwdriver API
 245 ---------------
 246
 247 The screwdriver API allows you to control a node's behaviour when a screwdriver is used on it.
 248 To use it, add the `on_screwdriver` function to the node definition.
 249
 250 `on_rotate(pos, node, user, mode, new_param2)`
 251
 252  * `pos` Position of the node that the screwdriver is being used on
 253  * `node` that node
 254  * `user` The player who used the screwdriver
 255  * `mode` screwdriver.ROTATE_FACE or screwdriver.ROTATE_AXIS
 256  * `new_param2` the new value of param2 that would have been set if on_rotate wasn't there
 257  * return value: false to disallow rotation, nil to keep default behaviour, true to allow
 258         it but to indicate that changed have already been made (so the screwdriver will wear out)
 259  * use `on_rotate = screwdriver.disallow` to always disallow rotation
 260  * use `on_rotate = screwdriver.rotate_simple` to allow only face rotation
 261
 262 Stairs API
 263 ----------
 264
 265 The stairs API lets you register stairs and slabs and ensures that they are registered the same way as those
 266 delivered with Minetest Game, to keep them compatible with other mods.
 267
 268 `stairs.register_stair(subname, recipeitem, groups, images, description, sounds)`
 269
 270  * Registers a stair.
 271  * `subname`: Basically the material name (e.g. cobble) used for the stair name. Nodename pattern: "stairs:stair_subname"
 272  * `recipeitem`: Item used in the craft recipe, e.g. "default:cobble"
 273  * `groups`: see [Known damage and digging time defining groups]
 274  * `images`: see [Tile definition]
 275  * `description`: used for the description field in the stair's definition
 276  * `sounds`: see [#Default sounds]
 277
 278 `stairs.register_slab(subname, recipeitem, groups, images, description, sounds)`
 279
 280  * Registers a slabs
 281  * `subname`: Basically the material name (e.g. cobble) used for the stair name. Nodename pattern: "stairs:stair_subname"
 282  * `recipeitem`: Item used in the craft recipe, e.g. "default:cobble"
 283  * `groups`: see [Known damage and digging time defining groups]
 284  * `images`: see [Tile definition]
 285  * `description`: used for the description field in the stair's definition
 286  * `sounds`: see [#Default sounds]
 287
 288 `stairs.register_stair_and_slab(subname, recipeitem, groups, images, desc_stair, desc_slab, sounds)`
 289
 290  * A wrapper for stairs.register_stair and stairs.register_slab
 291  * Uses almost the same arguments as stairs.register_stair
 292  * `desc_stair`: Description for stair node
 293  * `desc_slab`: Description for slab node
 294
 295 Xpanes API
 296 ----------
 297
 298 Creates panes that automatically connect to each other
 299
 300 `xpanes.register_pane(subname, def)`
 301
 302  * `subname`: used for nodename. Result: "xpanes:subname" and "xpanes:subname_{2..15}"
 303  * `def`: See [#Pane definition]
 304
 305 ###Pane definition
 306
 307         {
 308                 textures = {"texture_Bottom_top", "texture_left_right", "texture_front_back"}, -- More tiles aren't supported
 309                 groups = {group = rating}, -- Uses the known node groups, see [Known damage and digging time defining groups]
 310                 sounds = SoundSpec,        -- See [#Default sounds]
 311                 recipe = {{"","","","","","","","",""}}, -- Recipe field only
 312         }
 313
 314 Raillike definitions
 315 --------------------
 316
 317 The following nodes use the group `connect_to_raillike` and will only connect to
 318 raillike nodes within this group and the same group value.
 319 Use `minetest.raillike_group(<Name>)` to get the group value.
 320
 321 | Node type             | Raillike group name
 322 |-----------------------|---------------------
 323 | default:rail          | "rail"
 324 | tnt:gunpowder         | "gunpowder"
 325 | tnt:gunpowder_burning | "gunpowder"
 326
 327 Example:
 328 If you want to add a new rail type and want it to connect with default:rail,
 329 add `connect_to_raillike=minetest.raillike_group("rail")` into the `groups` table
 330 of your node.
 331
 332
 333 Default sounds
 334 --------------
 335
 336 Sounds inside the default table can be used within the sounds field of node definitions.
 337
 338  * `default.node_sound_defaults()`
 339  * `default.node_sound_stone_defaults()`
 340  * `default.node_sound_dirt_defaults()`
 341  * `default.node_sound_sand_defaults()`
 342  * `default.node_sound_wood_defaults()`
 343  * `default.node_sound_leaves_defaults()`
 344  * `default.node_sound_glass_defaults()`
 345
 346 Default constants
 347 -----------------
 348
 349 `default.LIGHT_MAX`  The maximum light level (see [Node definition] light_source)
 350
 351 Player API
 352 ----------
 353
 354 The player API can register player models and update the player's appearence
 355
 356 `default.player_register_model(name, def)`
 357
 358  * Register a new model to be used by players.
 359  * name: model filename such as "character.x", "foo.b3d", etc.
 360  * def: See [#Model definition]
 361
 362 `default.registered_player_models[name]`
 363
 364  * Get a model's definition
 365  * see [#Model definition]
 366
 367 `default.player_set_model(player, model_name)`
 368
 369  * Change a player's model
 370  * `player`: PlayerRef
 371  * `model_name`: model registered with player_register_model()
 372
 373 `default.player_set_animation(player, anim_name [, speed])`
 374
 375  * Applies an animation to a player
 376  * anim_name: name of the animation.
 377  * speed: frames per second. If nil, default from the model is used
 378
 379 `default.player_set_textures(player, textures)`
 380
 381  * Sets player textures
 382  * `player`: PlayerRef
 383  * `textures`: array of textures, If `textures` is nil, the default textures from the model def are used
 384
 385 default.player_get_animation(player)
 386
 387  * Returns a table containing fields `model`, `textures` and `animation`.
 388  * Any of the fields of the returned table may be nil.
 389  * player: PlayerRef
 390
 391 ###Model Definition
 392
 393         {
 394                 animation_speed = 30,            -- Default animation speed, in FPS.
 395                 textures = {"character.png", },  -- Default array of textures.
 396                 visual_size = {x = 1, y = 1},    -- Used to scale the model.
 397                 animations = {
 398                         -- <anim_name> = {x = <start_frame>, y = <end_frame>},
 399                         foo = {x = 0, y = 19},
 400                         bar = {x = 20, y = 39},
 401                 -- ...
 402                 },
 403         }
 404
 405 Leafdecay
 406 ---------
 407
 408 To enable leaf decay for a node, add it to the `leafdecay` group.
 409
 410 The rating of the group determines how far from a node in the group `tree`
 411 the node can be without decaying.
 412
 413 If `param2` of the node is ~= 0, the node will always be preserved. Thus, if
 414 the player places a node of that kind, you will want to set `param2 = 1` or so.
 415
 416 The function `default.after_place_leaves` can be set as `after_place_node of a node`
 417 to set param2 to 1 if the player places the node (should not be used for nodes
 418 that use param2 otherwise (e.g. facedir)).
 419
 420 If the node is in the `leafdecay_drop` group then it will always be dropped as an
 421 item.
 422
 423 Dyes
 424 ----
 425
 426 To make recipes that will work with any dye ever made by anybody, define
 427 them based on groups. You can select any group of groups, based on your need for
 428 amount of colors.
 429
 430 ###Color groups
 431
 432 Base color groups:
 433
 434  * `basecolor_white`
 435  * `basecolor_grey`
 436  * `basecolor_black`
 437  * `basecolor_red`
 438  * `basecolor_yellow`
 439  * `basecolor_green`
 440  * `basecolor_cyan`
 441  * `basecolor_blue`
 442  * `basecolor_magenta`
 443
 444 Extended color groups ( * means also base color )
 445
 446  * `excolor_white` *
 447  * `excolor_lightgrey`
 448  * `excolor_grey` *
 449  * `excolor_darkgrey`
 450  * `excolor_black` *
 451  * `excolor_red` *
 452  * `excolor_orange`
 453  * `excolor_yellow` *
 454  * `excolor_lime`
 455  * `excolor_green` *
 456  * `excolor_aqua`
 457  * `excolor_cyan` *
 458  * `excolor_sky_blue`
 459  * `excolor_blue` *
 460  * `excolor_violet`
 461  * `excolor_magenta` *
 462  * `excolor_red_violet`
 463
 464 The whole unifieddyes palette as groups:
 465
 466  * `unicolor_<excolor>`
 467
 468 For the following, no white/grey/black is allowed:
 469
 470  * `unicolor_medium_<excolor>`
 471  * `unicolor_dark_<excolor>`
 472  * `unicolor_light_<excolor>`
 473  * `unicolor_<excolor>_s50`
 474  * `unicolor_medium_<excolor>_s50`
 475  * `unicolor_dark_<excolor>_s50`
 476
 477 Example of one shapeless recipe using a color group:
 478
 479         minetest.register_craft({
 480                 type = "shapeless",
 481                 output = '<mod>:item_yellow',
 482                 recipe = {'<mod>:item_no_color', 'group:basecolor_yellow'},
 483         })
 484
 485 ###Color lists
 486
 487  * `dye.basecolors` are an array containing the names of available base colors
 488
 489  * `dye.excolors` are an array containing the names of the available extended colors
 490
 491 Trees
 492 -----
 493
 494  * `default.grow_tree(pos, is_apple_tree)`
 495   * Grows a mgv6 tree or apple tree at pos
 496
 497  * `default.grow_jungle_tree(pos)`
 498   * Grows a mgv6 jungletree at pos
 499
 500  * `default.grow_pine_tree(pos)`
 501   * Grows a mgv6 pinetree at pos
 502
 503  * `default.grow_new_apple_tree(pos)`
 504   * Grows a new design apple tree at pos
 505
 506  * `default.grow_new_jungle_tree(pos)`
 507   * Grows a new design jungle tree at pos
 508
 509  * `default.grow_new_pine_tree(pos)`
 510   * Grows a new design pine tree at pos
 511
 512  * `default.grow_new_acacia_tree(pos)`
 513   * Grows a new design acacia tree at pos
 514
 515  * `default.grow_new_aspen_tree(pos)`
 516   * Grows a new design aspen tree at pos
 517
 518  * `default.grow_new_snowy_pine_tree(pos)`
 519   * Grows a new design snowy pine tree at pos