Package wtf.choco.veinminer
Class VeinMinerPlugin
java.lang.Object
org.bukkit.plugin.PluginBase
org.bukkit.plugin.java.JavaPlugin
wtf.choco.veinminer.VeinMinerPlugin
- All Implemented Interfaces:
CommandExecutor
,TabCompleter
,TabExecutor
,Plugin
The VeinMiner
JavaPlugin
class.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription@NotNull List<AntiCheatHook>
Get an immutable list of all anti cheat hooks.@NotNull ConfigWrapper
Get an instance of the categories configuration file.@NotNull VeinMiningPattern
Get the defaultVeinMiningPattern
to be used for new players.static @NotNull VeinMinerPlugin
Get an instance of the main VeinMiner class (for VeinMiner API).@NotNull PatternRegistry
Get thePatternRegistry
.@NotNull VeinMinerPlayerManager
Get theVeinMinerPlayerManager
instance.@NotNull ToolCategoryRegistry
Get theToolCategoryRegistry
.@NotNull VeinMinerManager
Get theVeinMinerManager
.static @NotNull NamespacedKey
Get aNamespacedKey
with VeinMiner's namespace.void
void
onEnable()
void
onLoad()
boolean
registerAntiCheatHook
(@NotNull AntiCheatHook hook) Register an anti cheat hook to VeinMiner.Methods inherited from class org.bukkit.plugin.java.JavaPlugin
getClassLoader, getCommand, getConfig, getDataFolder, getDefaultBiomeProvider, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString
Methods inherited from class org.bukkit.plugin.PluginBase
equals, getName, hashCode
-
Constructor Details
-
VeinMinerPlugin
public VeinMinerPlugin()
-
-
Method Details
-
onLoad
public void onLoad()- Specified by:
onLoad
in interfacePlugin
- Overrides:
onLoad
in classJavaPlugin
-
onEnable
public void onEnable()- Specified by:
onEnable
in interfacePlugin
- Overrides:
onEnable
in classJavaPlugin
-
onDisable
public void onDisable()- Specified by:
onDisable
in interfacePlugin
- Overrides:
onDisable
in classJavaPlugin
-
getInstance
Get an instance of the main VeinMiner class (for VeinMiner API).- Returns:
- an instance of the VeinMiner class
-
getVeinMinerManager
Get theVeinMinerManager
.- Returns:
- the vein miner manager
-
getToolCategoryRegistry
Get theToolCategoryRegistry
.- Returns:
- the tool category registry
-
getPatternRegistry
Get thePatternRegistry
.- Returns:
- the pattern registry
-
getPlayerManager
Get theVeinMinerPlayerManager
instance.- Returns:
- the player manager
-
getDefaultVeinMiningPattern
Get the defaultVeinMiningPattern
to be used for new players.- Returns:
- the default vein mining pattern
-
getCategoriesConfig
Get an instance of the categories configuration file.- Returns:
- the categories config
-
registerAntiCheatHook
Register an anti cheat hook to VeinMiner. Hooks should be registered for all anti cheat plugins as to support VeinMining and not false-flag players with fast-break.- Parameters:
hook
- the hook to register- Returns:
- true if registered, false if unsupported
-
getAnticheatHooks
Get an immutable list of all anti cheat hooks.- Returns:
- all anti cheat hooks
-
key
Get aNamespacedKey
with VeinMiner's namespace.- Parameters:
key
- the key- Returns:
- a VeinMiner namespaced key
-