Wuzzy
/
Repixture
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Cleanup partialblocks API doc

master
Wuzzy 2022-08-02 01:10:50 +02:00
parent 709a99c271
commit 79e1991c0e
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
mods/rp_partialblocks/API.md
View File

@ -4,8 +4,8 @@ This function lets you register partial blocks.
## `partialblocks.register_material(name, desc_slab, desc_stair, node, groups, is_fuel, tiles_slab, tiles_stair)`
Registers a new material as a partial block (slab and stair). This requirs a base node (`node`) on which the
partial blocks are based on.
Registers a new material as a partial block (slab and stair). This requires a base node (`node`) from which
the partial blocks will be derived.
This adds a stair, a slab and crafting recipes.
@ -20,8 +20,7 @@ Parameters:
* `tiles_slab`: Tiles definition for slab
* Special: `nil` automatically creates tiles from the base node
* Special: `"a|<texture_prefix>"` creates advanced textures for custom stair side texture.
You must provide the texture file `<texture_prefix>_<name>_slab.png` for the stair side.
You must provide the texture file `<texture_prefix>_<name>_slab.png` for the slab side.
* `tiles_stair`: Tiles definition for stair
* Special: `nil` automatically creates tiles from the base node
* Special: `"a|<texture_prefix>"` creates advanced textures for custom stair top, bottom and side textures.
@ -33,4 +32,4 @@ Parameters:
If `is_fuel` is true, the burning time of the partial blocks is based on the burning
time of the base node. It’s 75% of the base node burn time for the stair and 50%
of the base node burn time for the slab.
If the base node is not a fuel, the burn time will be 7 seconds for stair and slab.
If the base node is not a fuel, the burn time will be 7 seconds for both stair and slab.