new: option descriptions (#127)

11 files changed, 78 insertions, 8 deletions

diff --git a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Button.java b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Button.java
index 783832e..0a6b66f 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Button.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Button.java
@@ -42,6 +42,8 @@ public @interface Button {
 
     String text();
 
+    String description() default "";
+
     int size() default 1;
 
     String category() default "General";
diff --git a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Checkbox.java b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Checkbox.java
index daddfbd..825549d 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Checkbox.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Checkbox.java
@@ -40,6 +40,8 @@ import java.lang.annotation.Target;
 public @interface Checkbox {
     String name();
 
+    String description() default "";
+
     int size() default 1;
 
     String category() default "General";
diff --git a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Color.java b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Color.java
index 09dfa68..caa69f3 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Color.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Color.java
@@ -40,6 +40,8 @@ import java.lang.annotation.Target;
 public @interface Color {
     String name();
 
+    String description() default "";
+
     boolean allowAlpha() default true;
 
     int size() default 1;
diff --git a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Dropdown.java b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Dropdown.java
index c3ebc6c..02f2ff2 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Dropdown.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Dropdown.java
@@ -42,6 +42,8 @@ public @interface Dropdown {
 
     String[] options();
 
+    String description() default "";
+
     int size() default 1;
 
     String category() default "General";
diff --git a/src/main/java/cc/polyfrost/oneconfig/config/annotations/DualOption.java b/src/main/java/cc/polyfrost/oneconfig/config/annotations/DualOption.java
index 3bcef12..20b340b 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/annotations/DualOption.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/annotations/DualOption.java
@@ -44,6 +44,8 @@ public @interface DualOption {
 
     String right();
 
+    String description() default "";
+
     int size() default 1;
 
     String category() default "General";
diff --git a/src/main/java/cc/polyfrost/oneconfig/config/annotations/KeyBind.java b/src/main/java/cc/polyfrost/oneconfig/config/annotations/KeyBind.java
index d59a316..cab3a2f 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/annotations/KeyBind.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/annotations/KeyBind.java
@@ -40,6 +40,8 @@ import java.lang.annotation.Target;
 public @interface KeyBind {
     String name();
 
+    String description() default "";
+
     int size() default 1;
 
     String category() default "General";
diff --git a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Slider.java b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Slider.java
index 8cdffc8..f01aaf6 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Slider.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Slider.java
@@ -46,6 +46,8 @@ public @interface Slider {
 
     int step() default 0;
 
+    String description() default "";
+
     String category() default "General";
 
     String subcategory() default "";
diff --git a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Switch.java b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Switch.java
index ba8f5d7..253d08d 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Switch.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Switch.java
@@ -40,6 +40,8 @@ import java.lang.annotation.Target;
 public @interface Switch {
     String name();
 
+    String description() default "";
+
     int size() default 1;
 
     String category() default "General";
diff --git a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Text.java b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Text.java
index a2ced12..e68c2a9 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/annotations/Text.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/annotations/Text.java
@@ -46,6 +46,8 @@ public @interface Text {
 
     boolean multiline() default false;
 
+    String description() default "";
+
     int size() default 1;
 
     String category() default "General";
diff --git a/src/main/java/cc/polyfrost/oneconfig/config/elements/BasicOption.java b/src/main/java/cc/polyfrost/oneconfig/config/elements/BasicOption.java
index 3394c52..a06002c 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/elements/BasicOption.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/elements/BasicOption.java
@@ -26,8 +26,15 @@
 
 package cc.polyfrost.oneconfig.config.elements;
 
-import cc.polyfrost.oneconfig.config.Config;
+import cc.polyfrost.oneconfig.gui.animations.Animation;
+import cc.polyfrost.oneconfig.gui.animations.DummyAnimation;
+import cc.polyfrost.oneconfig.gui.animations.EaseOutQuad;
+import cc.polyfrost.oneconfig.internal.assets.Colors;
+import cc.polyfrost.oneconfig.internal.assets.SVGs;
+import cc.polyfrost.oneconfig.renderer.RenderManager;
+import cc.polyfrost.oneconfig.renderer.font.Fonts;
 import cc.polyfrost.oneconfig.utils.InputHandler;
+import cc.polyfrost.oneconfig.utils.gui.GuiUtils;
 
 import java.lang.reflect.Field;
 import java.util.ArrayList;
@@ -39,27 +46,36 @@ public abstract class BasicOption {
     protected final Field field;
     protected Object parent;
     public final String name;
+    public final String description;
     public final String category;
     public final String subcategory;
     private final ArrayList<Supplier<Boolean>> dependencies = new ArrayList<>();
     private final ArrayList<Runnable> listeners = new ArrayList<>();
     private final ArrayList<Supplier<Boolean>> hideConditions = new ArrayList<>();
+    private Animation descriptionAnimation = new DummyAnimation(0f);
+    private float mouseStillTime = 0f;
+    private float prevMouseX = 0f;
+    private float prevMouseY = 0f;
 
     /**
      * Initialize option
      *
-     * @param field  variable attached to option (null for category)
-     * @param parent the parent object of the field, used for getting and setting the variable
-     * @param name   name of option
-     * @param size   size of option, 0 for single column, 1 for double.
+     * @param field       variable attached to option (null for category)
+     * @param parent      the parent object of the field, used for getting and setting the variable
+     * @param name        name of option
+     * @param description The description
+     * @param category    The category
+     * @param subcategory The subcategory
+     * @param size        size of option, 0 for single column, 1 for double.
      */
-    public BasicOption(Field field, Object parent, String name, String category, String subcategory, int size) {
+    public BasicOption(Field field, Object parent, String name, String description, String category, String subcategory, int size) {
         this.field = field;
         this.parent = parent;
         this.name = name;
-        this.size = size;
+        this.description = description;
         this.category = category;
         this.subcategory = subcategory;
+        this.size = size;
         if (field != null) field.setAccessible(true);
     }
 
@@ -114,6 +130,38 @@ public abstract class BasicOption {
     public void keyTyped(char key, int keyCode) {
     }
 
+    public void drawDescription(long vg, int x, int y, int height, InputHandler inputHandler) {
+        if (description.trim().equals("")) return;
+        if (inputHandler.isAreaHovered(x - 16, y, size == 1 ? 512f : 1024f, height) && prevMouseX == inputHandler.mouseX() && prevMouseY == inputHandler.mouseY()) {
+            mouseStillTime += GuiUtils.getDeltaTime();
+        } else {
+            mouseStillTime = 0;
+        }
+        prevMouseX = inputHandler.mouseX();
+        prevMouseY = inputHandler.mouseY();
+        boolean shouldDrawDescription = shouldDrawDescription();
+        if (descriptionAnimation.getEnd() != 1f && shouldDrawDescription) {
+            descriptionAnimation = new EaseOutQuad(150, descriptionAnimation.get(0), 1f, false);
+        } else if (descriptionAnimation.getEnd() != 0f && !shouldDrawDescription) {
+            descriptionAnimation = new EaseOutQuad(150, descriptionAnimation.get(0), 0f, false);
+        }
+        if (!shouldDrawDescription && descriptionAnimation.isFinished()) return;
+        float textWidth = RenderManager.getTextWidth(vg, description, 16, Fonts.MEDIUM);
+        RenderManager.setAlpha(vg, descriptionAnimation.get());
+        RenderManager.drawRoundedRect(vg, x, y - 42f, textWidth + 68f, 44f, Colors.GRAY_700, 8f);
+        RenderManager.drawDropShadow(vg, x, y - 42f, textWidth + 68f, 44f, 32f, 0f, 8f);
+        RenderManager.drawSvg(vg, SVGs.INFO_ARROW, x + 16, y - 30f, 20f, 20f, Colors.WHITE_80);
+        RenderManager.drawText(vg, description, x + 52, y - 20, Colors.WHITE_80, 16, Fonts.MEDIUM);
+        RenderManager.setAlpha(vg, 1f);
+    }
+
+    /**
+     * @return If this option should draw its description
+     */
+    protected boolean shouldDrawDescription() {
+        return mouseStillTime > 350;
+    }
+
     /**
      * @return If the option is enabled, based on the dependencies
      */
diff --git a/src/main/java/cc/polyfrost/oneconfig/config/elements/OptionSubcategory.java b/src/main/java/cc/polyfrost/oneconfig/config/elements/OptionSubcategory.java
index 08c59b8..628e973 100644
--- a/src/main/java/cc/polyfrost/oneconfig/config/elements/OptionSubcategory.java
+++ b/src/main/java/cc/polyfrost/oneconfig/config/elements/OptionSubcategory.java
@@ -90,11 +90,15 @@ public class OptionSubcategory {
             for (int i = 0; i < filteredOptions.size(); i++) {
                 BasicOption option = filteredOptions.get(i);
                 option.draw(vg, x, optionY, inputHandler);
+                int optionHeight =  option.getHeight();
+                option.drawDescription(vg, x, optionY, optionHeight, inputHandler);
                 if (i + 1 < filteredOptions.size()) {
                     BasicOption nextOption = filteredOptions.get(i + 1);
                     if (option.size == 1 && nextOption.size == 1) {
                         nextOption.draw(vg, x + 512, optionY, inputHandler);
-                        optionY += Math.max(option.getHeight(), nextOption.getHeight()) + 16;
+                        nextOption.drawDescription(vg, x + 512, optionY, optionHeight, inputHandler);
+                        int nextOptionHeight = nextOption.getHeight();
+                        optionY += Math.max(optionHeight, nextOptionHeight) + 16;
                         i++;
                         continue;
                     }