Package io.github.toberocat.guiengine

Class GuiEngineApiPlugin

java.lang.Object
org.bukkit.plugin.PluginBase
org.bukkit.plugin.java.JavaPlugin
io.github.toberocat.guiengine.GuiEngineApiPlugin
All Implemented Interfaces:
org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin
public class GuiEngineApiPlugin extends org.bukkit.plugin.java.JavaPlugin
This class represents the main plugin class for the GuiEngineApi plugin. It extends JavaPlugin and acts as the entry point for the plugin's functionality. The plugin provides a graphical user interface (GUI) engine for creating and managing custom GUIs in Minecraft. It supports various components like SimpleItemComponent, EmbeddedGuiComponent, ToggleItemComponent, and PagedComponent. Additionally, it allows the registration of functions and actions for GUI interactions. The plugin is licensed under the GNU GENERAL PUBLIC LICENSE. For usage and documentation, refer to the README or the official documentation of the GuiEngineApi.
Since:
04/02/2023
Author:
Tobias Madlberger (Tobias)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static boolean
    LATEST_VERSION
    The current version of this plugin

  • Constructor Summary

    Constructors
    Constructor
    Description
    GuiEngineApiPlugin()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    GuiEngineApi
    getGuiApi()
     
    GuiItemManager
    getGuiItemManager()
    Gets the item manager
    @NotNull DefaultGuiViewManager
    getGuiViewManager()
    Gets the manager responsible for managing GUI views.
    @NotNull InterpreterManager
    getInterpreterManager()
    Gets the manager responsible for handling GUI interpreters.
    static @NotNull GuiEngineApiPlugin
    getPlugin()
    Returns the singleton instance of the GuiEngineApiPlugin.
    void
    onEnable()
    Called when the plugin is enabled.

    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, onDisable, onLoad, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

    Methods inherited from class org.bukkit.plugin.PluginBase

    equals, getName, hashCode

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • LATEST_VERSION

      public static boolean LATEST_VERSION
      The current version of this plugin

  • Constructor Details

    • GuiEngineApiPlugin

      public GuiEngineApiPlugin()

  • Method Details

    • onEnable

      public void onEnable()
      Called when the plugin is enabled. Initializes the plugin and registers necessary components, functions, actions, and commands. Creates and initializes the manager instances for GUI views and interpreters. Registers default shared factories for supported GUI components. Register default functions for GUI interactions, such as adding, editing, or removing components. Register default compute functions for evaluating GUI component properties and permissions. Adds a default API instance for handling GUI data. Register default actions for GUI interactions.
      Specified by:
      onEnable in interface org.bukkit.plugin.Plugin
      Overrides:
      onEnable in class org.bukkit.plugin.java.JavaPlugin

    • getPlugin

      @NotNull public static @NotNull GuiEngineApiPlugin getPlugin()
      Returns the singleton instance of the GuiEngineApiPlugin.
      Returns:
      The GuiEngineApiPlugin instance.

    • getInterpreterManager

      @NotNull public @NotNull InterpreterManager getInterpreterManager()
      Gets the manager responsible for handling GUI interpreters.
      Returns:
      The InterpreterManager instance.

    • getGuiViewManager

      @NotNull public @NotNull DefaultGuiViewManager getGuiViewManager()
      Gets the manager responsible for managing GUI views.
      Returns:
      The DefaultGuiViewManager instance.

    • getGuiItemManager

      public GuiItemManager getGuiItemManager()
      Gets the item manager
      Returns:
      The GuiItem Manager

    • getGuiApi

      public GuiEngineApi getGuiApi()