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

Document rp_partialblocks API

master
Wuzzy 2022-08-02 00:21:26 +02:00
parent 93caae7dd1
commit 622fca1b72
2 changed files with 31 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
mods/rp_partialblocks/API.md Normal file
View File

@ -0,0 +1,26 @@
# Partialblocks API
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.
This adds a stair, a slab and crafting recipes.
Parameters:
* `name`: Identifier for the material (without mod prefix)
* `desc_slab`: Item description of slab
* `desc_stair`: Item description of stair
* `node`: Name of the base node the new partial nodes will be based on (including recipes)
* `groups`: List of groups for the new nodes
* `is_fuel`: If true, partial blocks can be used as furnace fuel. (default: false)
* `tiles_slab`: Tiles definition for slab
* `tiles_stair`: Tiles definition for stair
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.

8
mods/rp_partialblocks/README.txt
View File

@ -2,7 +2,9 @@ Partial blocks mod
==================
By Kaadmy and Wuzzy, for Repixture.
Adds partial blocks, like slabs, stairs and such.
Adds partial blocks, like slabs and stairs.
Asset license: CC BY-SA 4.0
Source license: LGPLv2.1
Developers: See API.md.
Media license: CC BY-SA 4.0
Source code license: LGPLv2.1