moreblocks/stairsplus/API.md
2014-03-09 10:38:18 +01:00

26 lines
941 B
Markdown

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)`