From 2b73c16c697f7168a1079711ccde318d2d70ccfd Mon Sep 17 00:00:00 2001 From: AFCMS Date: Thu, 18 Mar 2021 20:58:06 +0100 Subject: [PATCH] fix doc 2 --- mods/ITEMS/mcl_cauldrons/API.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/mods/ITEMS/mcl_cauldrons/API.md b/mods/ITEMS/mcl_cauldrons/API.md index 456798e76..5477ad19f 100644 --- a/mods/ITEMS/mcl_cauldrons/API.md +++ b/mods/ITEMS/mcl_cauldrons/API.md @@ -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"