MineClone2/mods/CORE/mcl_autogroup/API.md

29 lines
1.3 KiB
Markdown
Raw Normal View History

2021-03-28 00:02:35 +01:00
# mcl_autogroup
This mod emulates digging times from MC.
2021-03-28 00:02:35 +01:00
2023-01-11 19:31:56 +01:00
## mcl_autogroup.can_harvest(nodename, toolname, player)
Return true if `nodename` can be dig with `toolname` by <player>.
2021-03-28 00:02:35 +01:00
* nodename: string, valid nodename
* toolname: (optional) string, valid toolname
2023-01-11 19:31:56 +01:00
* player: (optinal) ObjectRef, valid player
2021-03-28 00:02:35 +01:00
## mcl_autogroup.get_groupcaps(toolname, efficiency)
This function is used to calculate diggroups for tools.
WARNING: This function can only be called after mod initialization.
* toolname: string, name of the tool being enchanted (like "mcl_tools:diamond_pickaxe")
* efficiency: (optional) integer, the efficiency level the tool is enchanted with (default 0)
## mcl_autogroup.get_wear(toolname, diggroup)
Return the max wear of `toolname` with `diggroup`
2021-03-28 00:02:35 +01:00
WARNING: This function can only be called after mod initialization.
* toolname: string, name of the tool used
* diggroup: string, the name of the diggroup the tool is used on
## mcl_autogroup.register_diggroup(group, def)
* group: string, name of the group to register as a digging group
* def: (optional) table, table with information about the diggroup (defaults to {} if unspecified)
* level: (optional) string, if specified it is an array containing the names of the different digging levels the digging group supports
## mcl_autogroup.registered_diggroups
List of registered diggroups, indexed by name.