NO11
/
MineClone2
forked from VoxeLibre/VoxeLibre
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix doc 2

This commit is contained in:
AFCMS 2021-03-18 20:58:06 +01:00
parent 36f479b2ec
commit 2b73c16c69
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
mods/ITEMS/mcl_cauldrons/API.md
View File

@ -5,6 +5,14 @@ This mod add an API to add cauldrons to mcl.
## mcl_cauldrons.is_cauldron(name)
return true if name is cauldron, false overwise.
## mcl_cauldrons.take_cauldron(pos, itemstack, user, sounds)
empty cauldron at `pos`
return `bucket` field of the cauldron def if user is player, itemstack overwise.
* pos: position of the cauldron
* itemstack: will be return if `bucket` field isn't defined in cauldron def or user is nil or not player.
* user: player who takes cauldron
* sounds: sounds table. If not nil, dug sound will be played.
## mcl_cauldrons.register_cauldron_type(def)
def can have these fields:
* name: name of the liquid e.g: "water"