Introduction
------------
-The Minetest Game subgame offers multiple new possibilities in addition to the Minetest engine's built-in API,
+The Minetest Game game offers multiple new possibilities in addition to the Minetest engine's built-in API,
allowing you to add new plants to farming mod, buckets for new liquids, new stairs and custom panes.
For information on the Minetest API, visit https://github.com/minetest/minetest/blob/master/doc/lua_api.txt
Please note:
def -- See [#Bed definition]
)
+ * `beds.can_dig(bed_pos)` Returns a boolean whether the bed at `bed_pos` may be dug
* `beds.read_spawns() ` Returns a table containing players respawn positions
* `beds.kick_players()` Forces all players to leave bed
* `beds.skip_night()` Sets world time to morning and saves respawn position of all players currently sleeping
}
}
+Bones API
+---------
+
+An ordered list of listnames (default: "main", "craft") of the player inventory,
+that will be placed into bones or dropped on player death can be looked up or changed
+in `bones.player_inventory_lists`.
+
+e.g. `table.insert(bones.player_inventory_lists, "backpack")`
+
Creative API
------------
page. Mods can use it to add additional formspec elements onto the default
creative inventory formspec to be drawn after each update.
+Chests API
+----------
+
+The chests API allows the creation of chests, which have their own inventories for holding items.
+
+`default.chest.get_chest_formspec(pos)`
+
+ * Returns a formspec for a specific chest.
+ * `pos` Location of the chest node, e.g `{x = 1, y = 1, z = 1}`
+
+`default.chest.chest_lid_obstructed(pos)`
+
+ * Returns a boolean depending on whether or not a chest has its top obstructed by a solid node.
+ * `pos` Location of the chest node, e.g `{x = 1, y = 1, z = 1}`
+
+`default.chest.chest_lid_close(pn)`
+
+ * Closes the chest that a player is currently looking in.
+ * `pn` The name of the player whose chest is going to be closed
+
+`default.chest.open_chests`
+
+ * A table indexed by player name to keep track of who opened what chest.
+ * Key: The name of the player.
+ * Value: A table containing information about the chest the player is looking at.
+ e.g `{ pos = {1, 1, 1}, sound = null, swap = "chest" }`
+
+`default.chest.register_chest(name, def)`
+
+ * Registers new chest
+ * `name` Name for chest
+ * `def` See [#Chest Definition]
+
+### Chest Definition
+
+ description = "Chest",
+ tiles = {
+ "default_chest_top.png",
+ "default_chest_top.png",
+ "default_chest_side.png",
+ "default_chest_side.png",
+ "default_chest_front.png",
+ "default_chest_inside.png"
+ }, -- Textures which are applied to the chest model.
+ sounds = default.node_sound_wood_defaults(),
+ sound_open = "default_chest_open",
+ sound_close = "default_chest_close",
+ groups = {choppy = 2, oddly_breakable_by_hand = 2},
+ protected = false, -- If true, only placer can modify chest.
+
Doors API
---------
groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
sounds = default.node_sound_wood_defaults(), -- optional
+Dungeon Loot API
+----------------
+
+The mod that places chests with loot in dungeons provides an API to register additional loot.
+
+`dungeon_loot.register(def)`
+
+ * Registers one or more loot items
+ * `def` Can be a single [#Loot definition] or a list of them
+
+`dungeon_loot.registered_loot`
+
+ * Table of all registered loot, not to be modified manually
+
+### Loot definition
+
+ name = "item:name",
+ chance = 0.5,
+ -- ^ chance value from 0.0 to 1.0 that the item will appear in the chest when chosen
+ -- due to an extra step in the selection process, 0.5 does not(!) mean that
+ -- on average every second chest will have this item
+ count = {1, 4},
+ -- ^ table with minimum and maximum amounts of this item
+ -- optional, defaults to always single item
+ y = {-32768, -512},
+ -- ^ table with minimum and maximum heights this item can be found at
+ -- optional, defaults to no height restrictions
+ types = {"desert"},
+ -- ^ table with types of dungeons this item can be found in
+ -- supported types: "normal" (the cobble/mossycobble one), "sandstone", "desert"
+ -- optional, defaults to no type restrictions
+
Fence API
---------
bar = {x = 20, y = 39},
-- ...
},
- collisionbox = {-0.3, 0.0, -0.3, 0.3, 1.77, 0.3}, -- In nodes from feet position
+ collisionbox = {-0.3, 0.0, -0.3, 0.3, 1.7, 0.3}, -- In nodes from feet position
stepheight = 0.6, -- In nodes
+ eye_height = 1.47, -- In nodes above feet position
}
Sfinv API
---------
+It is recommended that you read this link for a good introduction to the
+sfinv API by its author: https://rubenwardy.com/minetest_modding_book/en/chapters/sfinv.html
+
### sfinv Methods
**Pages**
groups = {group = rating}, -- Uses the known node groups, see [Known damage and digging time defining groups]
sounds = SoundSpec, -- See [#Default sounds]
recipe = {{"","","","","","","","",""}}, -- Recipe field only
+ use_texture_alpha = true, -- Optional boolean (default: `false`) for colored glass panes
}
Raillike definitions
`default.gui_bg`
- * Background color formspec element
+ * Deprecated, remove from mods.
`default.gui_bg_img`
- * Image overlay formspec element for the background to use in formspecs
+ * Deprecated, remove from mods.
`default.gui_slots`
- * `listcolors` formspec element that is used to format the slots in formspecs
+ * Deprecated, remove from mods.
`default.gui_survival_form`
* Entire formspec for the survival inventory
-`default.get_chest_formspec(pos)`
-
- * Get the chest formspec using the defined GUI elements
- * pos: Location of the node
-
`default.get_furnace_active_formspec(fuel_percent, item_percent)`
* Get the active furnace formspec using the defined GUI elements
* `default.grow_acacia_bush(pos)`
* Grows an acaia bush at pos
+
+ * `default.grow_pine_bush(pos)`
+ * Grows a pine bush at pos
Carts
-----
projects / oweals / minetest_game.git / blobdiff