Class VeinMiner

java.lang.Object
org.bukkit.plugin.PluginBase
org.bukkit.plugin.java.JavaPlugin
wtf.choco.veinminer.VeinMiner
All Implemented Interfaces:
org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class VeinMiner
extends org.bukkit.plugin.java.JavaPlugin
  • Field Details

  • Constructor Details

  • Method Details

    • onEnable

      public void onEnable()
      Specified by:
      onEnable in interface org.bukkit.plugin.Plugin
      Overrides:
      onEnable in class org.bukkit.plugin.java.JavaPlugin
    • onDisable

      public void onDisable()
      Specified by:
      onDisable in interface org.bukkit.plugin.Plugin
      Overrides:
      onDisable in class org.bukkit.plugin.java.JavaPlugin
    • getPlugin

      @NotNull public static @NotNull VeinMiner getPlugin()
      Get an instance of the main VeinMiner class (for VeinMiner API usages).
      Returns:
      an instance of the VeinMiner class
    • getVeinMinerManager

      @NotNull public @NotNull VeinMinerManager getVeinMinerManager()
      Get the VeinMiner Manager used to keep track of Veinminable blocks, and other utilities.
      Returns:
      an instance of the VeinMiner manager
    • getPatternRegistry

      @NotNull public @NotNull PatternRegistry getPatternRegistry()
      Get the pattern registry used to register custom vein mining patterns.
      Returns:
      an instance of the pattern registry
    • getCategoriesConfig

      @NotNull public @NotNull ConfigWrapper getCategoriesConfig()
      Get an instance of the categories configuration file.
      Returns:
      the categories config
    • getPlayerDataDirectory

      @NotNull public @NotNull File getPlayerDataDirectory()
      Get VeinMiner's playerdata directory.
      Returns:
      the playerdata directory
    • getEconomyModifier

      @NotNull public @NotNull EconomyModifier getEconomyModifier()
      Get the economy abstraction layer for a Vault economy.
      Returns:
      economy abstraction
    • setVeinMiningPattern

      public void setVeinMiningPattern​(@NotNull @NotNull VeinMiningPattern pattern)
      Set the vein mining pattern to use.
      Parameters:
      pattern - the pattern to set
    • getVeinMiningPattern

      @NotNull public @NotNull VeinMiningPattern getVeinMiningPattern()
      Get the vein mining pattern to use.
      Returns:
      the pattern
    • registerAntiCheatHook

      public boolean registerAntiCheatHook​(@NotNull @NotNull AntiCheatHook hook)
      Register an anticheat hook to VeinMiner. Hooks should be registered for all anticheat plugins as to support VeinMining and not false-flag players with fast-break.
      Parameters:
      hook - the hook to register
      Returns:
      true if successful, false if a hook for a plugin with a similar name is already registered or the hook is unsupported according to AntiCheatHook.isSupported().
    • getAnticheatHooks

      @NotNull public @NotNull List<AntiCheatHook> getAnticheatHooks()
      Get an immutable list of all anti cheat hooks.
      Returns:
      all anticheat hooks