Added documentation

Author: Sentropic

src/main/java/com/sentropic/guiapi/GUIAPI.java

@@ -1,7 +1,10 @@
 package com.sentropic.guiapi;
 
 import com.sentropic.guiapi.command.ReloadCommand;
+import com.sentropic.guiapi.gui.GUIManager;
 import com.sentropic.guiapi.packet.PacketManager;
+import com.sentropic.guiapi.gui.GUI;
+import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.HandlerList;
 import org.bukkit.event.Listener;
@@ -79,9 +82,21 @@ private void setProtocolLib(boolean enabled) {
         }
     }
 
+    /**
+     * Gets the singleton {@link GUIAPI} object loaded by the server
+     * @return the singleton {@link GUIAPI} object
+     */
     public static GUIAPI getPlugin() { return singleton; }
 
+    /**
+     * Gets the singleton {@link GUIManager} loaded by the plugin. Use this to access a {@link Player}s' {@link GUI}
+     * @return the {@link GUIManager} instance loaded by the plugin
+     */
     public static GUIManager getGUIManager() { return guiManager; }
 
+    /**
+     * Gets the singleton {@link GUIConfig} loaded by the plugin
+     * @return the {@link GUIConfig} instance loaded by the plugin
+     */
     public static GUIConfig getGUIConfig() { return config; }
 }

src/main/java/com/sentropic/guiapi/GUIConfig.java

@@ -13,6 +13,10 @@
 import java.util.List;
 import java.util.Objects;
 
+/**
+ * Represents the config options of the plugin
+ * For efficiency, use instead of directly getting the config file from the plugin
+ */
 public class GUIConfig {
     private int sendPeriod;
     private int anonPeriod;
@@ -22,6 +26,9 @@ public class GUIConfig {
 
     GUIConfig() { reload(); }
 
+    /**
+     * Reloads the plugin's config and stores all its values
+     */
     public void reload() {
         GUIAPI plugin = GUIAPI.getPlugin();
         plugin.reloadConfig();
@@ -68,11 +75,31 @@ public void reload() {
         }
     }
 
+    /**
+     * @return the maximum delay between sending GUIs to players, in milisecons
+     */
     public int getSendPeriod() { return sendPeriod; }
 
+    /**
+     * Gets the amount of ticks that each anonymous action bar text (sent without the usage of GUIAPI)
+     * is shown in the GUI before switching to a different one, if more than one is available
+     *
+     * @return the period at which anonymous action bar texts are cycled around in the GUI
+     */
     public int getAnonPeriod() { return anonPeriod; }
 
+    /**
+     * Gets the amount of ticks that each anonymous action bar text (sent without the usage of GUIAPI)
+     * remains in memory before being removed (defaults to 40 in vanilla Minecraft)
+     *
+     * @return the duration of anonymous action bars
+     */
     public int getAnonDuration() { return anonDuration; }
 
+    /**
+     * Gets the debug {@link GUIComponent}s defined in the config
+     *
+     * @return a {@link List} containing the debug {@link GUIComponent}s defined in the config, in typing order
+     */
     public List<GUIComponent> getDebugComponents() { return debugComponentsRead; }
 }

src/main/java/com/sentropic/guiapi/GUIManager.java

@@ -11,13 +11,14 @@
 
 public class ReloadCommand implements CommandExecutor {
     @Override
-    public boolean onCommand(CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] args) {
-        if (!sender.hasPermission("misc.command.reload")) { return false; }
+    public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] args) {
         if (args.length == 1 && args[0].equals("reload")) {
+            if (!sender.hasPermission("misc.command.reload")) { return false; }
             GUIAPI.getGUIConfig().reload();
             sender.sendMessage(ChatColor.GREEN+"[GUI API] Reloaded config.yml");
             return true;
         } else if (args.length == 1 && args[0].equals("debug")) {
+            if (!sender.hasPermission("misc.command.debug")) { return false; }
             if (sender instanceof Player) {
                 GUI gui = GUIAPI.getGUIManager().getGUI((Player) sender);
                 gui.setDebug(!gui.isDebugging());

src/main/java/com/sentropic/guiapi/command/ReloadCommand.java

@@ -6,6 +6,9 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Represents a resource pack font, containing its ID and character widths
+ */
 public class Font {
 
     // Static code
@@ -51,9 +54,19 @@ public class Font {
         register(DEFAULT);
     }
 
+    /**
+     * Gets a registered font by its ID
+     * @param id the id of the font
+     * @return the font for the given ID, or null if was not found
+     */
     @Nullable
     public static Font getRegistered(String id) { return registeredFonts.get(id); }
 
+    /**
+     * Registers a Font to be accessed statically later, through {@link Font#getRegistered(String)}
+     * @param font the Font to be registered
+     * @throws IllegalArgumentException if a font with the same ID already is registered
+     */
     public static void register(Font font) {
         String id = font.getID();
         if (registeredFonts.containsKey(id)) {
@@ -62,6 +75,11 @@ public static void register(Font font) {
         registeredFonts.put(id, font);
     }
 
+    /**
+     * Unregisters a Font from the static context
+     * @param font the font to unregister
+     * @return true if the font was unregistered, false if it was not previously registered
+     */
     @SuppressWarnings("unused")
     public static boolean unregister(Font font) {
         boolean success = false;
@@ -73,23 +91,56 @@ public static boolean unregister(Font font) {
 
     private final String id;
     private final int height;
+    private Font parent;
     private Map<Character,Integer> widths;
 
+    /**
+     * @param id the namespaced ID of the font, as used by the resource pack (i.e. "minecraft:default")
+     * @param height the default height of the characters in the font, as specified in the resource pack
+     */
     public Font(@NotNull String id, int height) {
         this.id = id;
         this.height = height;
     }
 
+    /**
+     * Creates a font that inherits its character widths from a parent font
+     * Used for fonts that share the same textures with another one
+     * @param id the namespaced ID of the font, as used by the resource pack (i.e. "minecraft:default")
+     * @param height the default height of the characters in the font, as specified in the resource pack
+     * @param parent the font to inherit its character widths from
+     */
+    public Font(@NotNull String id, int height, Font parent) {
+        this.id = id;
+        this.height = height;
+        this.parent = parent;
+    }
+
+    /**
+     * Registers the width of a character for this font, if different from the default of 6
+     * @param character the character to register the width for
+     * @param width the width of the character
+     */
     public void registerWidth(char character, int width) {
         if (widths == null) { widths = new HashMap<>(); }
         widths.put(character, width);
     }
 
+    /**
+     * Gets the width of a given character for this font
+     * @param character the character to get the width for
+     * @param scale whether to scale the width according to the font's height
+     * @return the width of the character
+     */
     public int getWidth(char character, boolean scale) {
         Integer result = null;
         if (this == DEFAULT) { result = widths.getOrDefault(character, 6); } else {
             try { result = widths.get(character); } catch (NullPointerException ignored) { }
-            if (result == null) { result = DEFAULT.getWidth(character, false); }
+            if (result == null) {
+                result = parent == null ?
+                        DEFAULT.getWidth(character, false) :
+                        parent.getWidth(character, false);
+            }
         }
         if (scale && this != DEFAULT && character != ' ') {
             // Formula figured out experimentally (pain)
@@ -98,17 +149,32 @@ public int getWidth(char character, boolean scale) {
         return result;
     }
 
+    /**
+     * Calculates the width of a given {@link String} for this font
+     * @param text the String to calculate the width for
+     * @param scale whether to scale the width according to the font's height
+     * @return the calculated width of the character
+     */
     public int getWidth(String text, boolean scale) {
         int total = 0;
         for (Character character : text.toCharArray()) { total += getWidth(character, scale); }
         return total;
     }
 
+    /**
+     * @return the namespaced ID of the font, as used by the resource pack (i.e. "minecraft:default")
+     */
     @Override
     public String toString() { return id; }
 
+    /**
+     * @return the namespaced ID of the font, as used by the resource pack (i.e. "minecraft:default")
+     */
     public String getID() { return id; }
 
+    /**
+     * @return the default height of the characters in the font, as specified in the resource pack
+     */
     @SuppressWarnings("unused")
     public int getHeight() { return height; }
 }