Class Alchema

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

public final class Alchema
extends org.bukkit.plugin.java.JavaPlugin
The main plugin class of Alchema.
Author:
Parker Hawke - Choco
  • Field Summary

    Fields
    Modifier and Type Field Description
    static java.lang.String CHAT_PREFIX
    The chat prefix used by Alchema
  • Constructor Summary

    Constructors
    Constructor Description
    Alchema()  
  • Method Summary

    Modifier and Type Method Description
    @NotNull CauldronManager getCauldronManager()
    Get the CauldronManager instance.
    @NotNull java.util.List<@NotNull java.lang.String> getDefaultRecipePaths()
    Get a list of paths to the default recipes provided by Alchema.
    @NotNull EntityEssenceEffectRegistry getEntityEssenceEffectRegistry()
    Get the EntityEssenceEffectRegistry instance.
    static @NotNull Alchema getInstance()
    Get an instance of Alchema.
    @NotNull CauldronRecipeRegistry getRecipeRegistry()
    Get the CauldronRecipeRegistry instance.
    @NotNull java.io.File getRecipesDirectory()
    Get the directory from which Alchema's recipes are loaded.
    static @NotNull org.bukkit.NamespacedKey key​(@NotNull java.lang.String key)
    Get a NamespacedKey where the namespace is Alchema.
    void onDisable()  
    void onEnable()  
    void onLoad()  
    void refreshEntityBlacklists()
    Refresh the entity blacklists from the configuration loaded into memory.

    Methods inherited from class org.bukkit.plugin.java.JavaPlugin

    getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setNaggable, toString

    Methods inherited from class org.bukkit.plugin.PluginBase

    equals, getName, hashCode

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • CHAT_PREFIX

      public static final java.lang.String CHAT_PREFIX
      The chat prefix used by Alchema
  • Constructor Details

    • Alchema

      public Alchema()
  • Method Details

    • onLoad

      public void onLoad()
      Specified by:
      onLoad in interface org.bukkit.plugin.Plugin
      Overrides:
      onLoad in class org.bukkit.plugin.java.JavaPlugin
    • 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
    • getCauldronManager

      @NotNull public @NotNull CauldronManager getCauldronManager()
      Get the CauldronManager instance.
      Returns:
      the cauldron manager
    • getRecipeRegistry

      @NotNull public @NotNull CauldronRecipeRegistry getRecipeRegistry()
      Get the CauldronRecipeRegistry instance.
      Returns:
      the cauldron recipe registry
    • getEntityEssenceEffectRegistry

      @NotNull public @NotNull EntityEssenceEffectRegistry getEntityEssenceEffectRegistry()
      Get the EntityEssenceEffectRegistry instance.
      Returns:
      the entity essence effect registry
    • getRecipesDirectory

      @NotNull public @NotNull java.io.File getRecipesDirectory()
      Get the directory from which Alchema's recipes are loaded.
      Returns:
      the recipes directory
    • refreshEntityBlacklists

      public void refreshEntityBlacklists()
      Refresh the entity blacklists from the configuration loaded into memory.
    • getDefaultRecipePaths

      @NotNull public @NotNull java.util.List<@NotNull java.lang.String> getDefaultRecipePaths()
      Get a list of paths to the default recipes provided by Alchema.

      These paths are NOT the same as those in the plugin's recipe directory. These are paths to the recipe files present in the plugin's jar file.

      Returns:
      the recipe paths
    • getInstance

      @NotNull public static @NotNull Alchema getInstance()
      Get an instance of Alchema.
      Returns:
      the alchema instance
    • key

      @NotNull public static @NotNull org.bukkit.NamespacedKey key​(@NotNull @NotNull java.lang.String key)
      Get a NamespacedKey where the namespace is Alchema.
      Parameters:
      key - the key
      Returns:
      the Alchema namespaced key