MineClone2/mods/ITEMS/mcl_cauldrons/API.md

13 lines
517 B
Markdown
Raw Normal View History

2021-03-17 21:47:27 +01:00
# mcl_cauldrons
This mod add an API to add cauldrons to mcl.
2021-03-18 18:02:08 +01:00
## mcl_cauldrons.register_cauldron_type(def)
def can have these fields:
2021-03-17 21:47:27 +01:00
* name: name of the liquid e.g: "water"
2021-03-18 18:02:08 +01:00
* bucket: string of the bucket item. can be nil. e.g: "mcl_buckets:bucket_water"
2021-03-17 21:47:27 +01:00
* desc: description of the item. %s will be replaced by the level. e.g: "Water Cauldron %s/3 full"
2021-03-18 18:02:08 +01:00
* texture: texture of the flowing liquid e.g: "mcl_core_water_flowing.png"
## mcl_cauldrons.registered_cauldrons
Table containing chauldrons def indexed by name.