minetest-mods/moreblocks
1
0
Fork 2
mirror of https://github.com/minetest-mods/moreblocks.git synced 2024-11-14 14:30:19 +01:00
Code Issues Releases Wiki Activity
e43e4a1911
moreblocks/stairsplus/API.md
Hugo Locurcio 95155a3bc6
Add pre-commit hooks 
See https://pre-commit.com/ for more information.
2019-02-21 23:10:58 +01:00

2.6 KiB
Raw Blame History

API documentation for Stairs+

  • stairsplus:register_all(modname, subname, recipeitem, fields) Registers a stair, slab, panel, microblock, and any other types of nodes to be added in the future. This also registers the node with the circular saw. Example: 
    stairsplus:register_all("moreblocks", "wood", "defaut:wood", {
	description = "Wooden",
	tiles = {"default_wood.png"},
	groups = {oddly_breakabe_by_hand=1},
	sounds = default.node_sound_wood_defaults(),
})

The following register only a particular type of microblock. You will probably never want to use them directly:

  • stairsplus:register_stair(modname, subname, recipeitem, fields)
  • stairsplus:register_slab(modname, subname, recipeitem, fields)
  • stairsplus:register_panel(modname, subname, recipeitem, fields)
  • stairsplus:register_micro(modname, subname, recipeitem, fields)
  • stairsplus:register_slope(modname, subname, recipeitem, fields)

If you only want to register a subset of stairsplus nodes, you can use the stairsplus:register_custom_subset(subset, modname, subname, recipeitem, fields) function. The subset table should have the following format:

    local subset = {
    	{ "micro", "" },
    	{ "micro", "_1" },
    	{ "micro", "_2" },
    	{ "micro", "_4" },
    	{ "micro", "_12" },
    	{ "micro", "_14" },
    	{ "micro", "_15" },
    	{ "panel", "" },
    	{ "panel", "_1" },
    	{ "panel", "_2" },
    	{ "panel", "_4" },
    	{ "panel", "_12" },
    	{ "panel", "_14" },
    	{ "panel", "_15" },
    	{ "slab",  "" },
    	{ "slab",  "_quarter" },
    	{ "slab",  "_three_quarter" },
    	{ "slab",  "_1" },
    	{ "slab",  "_2" },
    	{ "slab",  "_14" },
    	{ "slab",  "_15" },
    	{ "slab",  "_two_sides" },
    	{ "slab",  "_three_sides" },
    	{ "slab",  "_three_sides_u" },
    	{ "slope", "" },
    	{ "slope", "_half" },
    	{ "slope", "_half_raised" },
    	{ "slope", "_inner" },
    	{ "slope", "_inner_half" },
    	{ "slope", "_inner_half_raised" },
    	{ "slope", "_inner_cut" },
    	{ "slope", "_inner_cut_half" },
    	{ "slope", "_inner_cut_half_raised" },
    	{ "slope", "_outer" },
    	{ "slope", "_outer_half" },
    	{ "slope", "_outer_half_raised" },
    	{ "slope", "_outer_cut" },
    	{ "slope", "_outer_cut_half" },
    	{ "slope", "_outer_cut_half_raised" },
    	{ "slope", "_cut" },
    	{ "stair", "" },
    	{ "stair", "_half" },
    	{ "stair", "_right_half" },
    	{ "stair", "_inner" },
    	{ "stair", "_outer" },
    	{ "stair", "_alt" },
    	{ "stair", "_alt_1" },
    	{ "stair", "_alt_2" },
    	{ "stair", "_alt_4" },
    }

You can remove entries as needed.