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