Module api.lua
Main functions for mineral registration
Functions
| mineral.register_item (def) | Registers a new craft item. |
| mineral.register_node (def) | Registers a new node. |
| mineral.register_ore (def) | Registers a new ore. |
| mineral.register (defs) | Registers a new mineral |
Definition Tables
| MineralDef | Mineral Definition |
| ItemDef | Item Definition
Same as definition for minetest.register_craftitem except also requires name field. |
| NodeDef | Node Definition
Same as definition used for minetest.register_node except also requires name field. |
| OreDef | Ore Definition
Same as definition used for minetest.register_ore. |
Functions
- mineral.register_item (def)
-
Registers a new craft item.
Parameters:
- def ItemDef Item definition.
- mineral.register_node (def)
-
Registers a new node.
Parameters:
- def NodeDef Node definition.
- mineral.register_ore (def)
-
Registers a new ore.
Parameters:
- def OreDef Ore definition.
- mineral.register (defs)
-
Registers a new mineral
Parameters:
- defs MineralDef Mineral definition
Definition Tables
- MineralDef
-
Mineral Definition
Fields:
- ItemDef
-
Item Definition
Same as definition for minetest.register_craftitem except also requires name field. Can optionally contain replaces field to register this item as a replacement for another.
Example:
{ name = "mineral:iron_lump", description = "Iron Lump", inventory_image = "mineral_iron_lump.png", replaces = "default:iron_lump", }FIXME: replaces should optionally be table value.
- NodeDef
-
Node Definition
Same as definition used for minetest.register_node except also requires name field. Can optionally contain replaces field to register this node as a replacement for another.
Example:
{ name = "mineral:stone_with_iron", description = "Iron Ore", tiles = {"default_stone.png^mineral_overlay_iron.png"}, groups = {cracky = 2}, drop = "mineral:iron_lump", sounds = default.node_sound_stone_defaults(), replaces = "default:stone_with_iron", }FIXME: replaces should optionally be table value.
- OreDef
-
Ore Definition
Same as definition used for minetest.register_ore. Can optionally contain replaces field to register this ore as a replacement for another.
Example:
{ ore_type = "scatter", ore = "mineral:stone_with_iron", wherein = "default:stone", clust_scarcity = 9 * 9 * 9, clust_num_ores = 12, clust_size = 3, y_max = 31000, y_min = 1025, replaces = "default:stone_with_iron", }FIXME: replaces should optionally be table value.