From 8337a6c192b9961f8947767690c13951696c3c1e Mon Sep 17 00:00:00 2001 From: Calinou Date: Sun, 9 Mar 2014 10:38:18 +0100 Subject: Merge ShadowNinja's rewrite. --- stairsplus/API.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 stairsplus/API.md (limited to 'stairsplus/API.md') diff --git a/stairsplus/API.md b/stairsplus/API.md new file mode 100644 index 0000000..480b848 --- /dev/null +++ b/stairsplus/API.md @@ -0,0 +1,25 @@ +API documentation for StairsPlus +================================ +- - - - - - - - - - - - - - - - + +* `stairsplus:register_all(modname, subname, recipeitem, fields)` + Registers a stair, slab, panel, microblock, and any other types of + microblocks to be added in the future. + Also registers the node with the circular saw. + Example: + ```lua + 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)` + -- cgit v1.2.3