Minetest/VoxeLibre
2
0
Fork 0
mirror of https://git.minetest.land/VoxeLibre/VoxeLibre.git synced 2024-12-25 01:19:33 +01:00
Code Issues Projects Releases Packages Wiki Activity
VoxeLibre/mods/CORE/mcl_autogroup/API.md
AFCMS ce123d4676 add API documentation to mcl_autogroup
2021-03-28 00:02:35 +01:00

1.3 KiB
Raw Blame History

mcl_autogroup

This mod emulate digging times from mc.

mcl_autogroup.can_harvest(nodename, toolname)

Return true if can be dig with .

  • nodename: string, valid nodename
  • toolname: (optional) string, valid toolname

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 with 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.