lots of QOL and minor improvements

smooth category scrolling
individual reset buttons for all controllers
separate Dimension into Dimension and MutableDimension to prevent mods from modifying controller dimensions without invoking the hooks
made the dimension field private in AbstractWidget so people can't modify it without the method setDimension
new Option API method to check if pending value is equal to default value
add documentation to ConfigInstance
fix bug where Option#requestSetDefault and Option#forgetPendingValue implementations weren't notifying listeners

Author: isXander

src/main/java/dev/isxander/yacl/api/Controller.java

@@ -4,7 +4,6 @@
 import dev.isxander.yacl.gui.AbstractWidget;
 import dev.isxander.yacl.gui.YACLScreen;
 import net.minecraft.text.Text;
-import org.jetbrains.annotations.ApiStatus;
 
 /**
  * Provides a widget to control the option.

src/main/java/dev/isxander/yacl/api/Option.java

@@ -104,6 +104,11 @@ public interface Option<T> {
      */
     void requestSetDefault();
 
+    /**
+     * Checks if the current pending value is equal to its default value
+     */
+    boolean isPendingValueDefault();
+
     /**
      * Adds a listener for when the pending value changes
      */

src/main/java/dev/isxander/yacl/api/utils/Dimension.java

@@ -17,25 +17,17 @@ public interface Dimension<T extends Number> {
 
     boolean isPointInside(T x, T y);
 
-    Dimension<T> clone();
-
-    Dimension<T> setX(T x);
-    Dimension<T> setY(T y);
-    Dimension<T> setWidth(T width);
-    Dimension<T> setHeight(T height);
+    MutableDimension<T> clone();
 
     Dimension<T> withX(T x);
     Dimension<T> withY(T y);
     Dimension<T> withWidth(T width);
     Dimension<T> withHeight(T height);
 
-    Dimension<T> move(T x, T y);
-    Dimension<T> expand(T width, T height);
-
     Dimension<T> moved(T x, T y);
     Dimension<T> expanded(T width, T height);
 
-    static Dimension<Integer> ofInt(int x, int y, int width, int height) {
+    static MutableDimension<Integer> ofInt(int x, int y, int width, int height) {
         return new DimensionIntegerImpl(x, y, width, height);
     }
 }

src/main/java/dev/isxander/yacl/api/utils/MutableDimension.java

@@ -0,0 +1,11 @@
+package dev.isxander.yacl.api.utils;
+
+public interface MutableDimension<T extends Number> extends Dimension<T> {
+    MutableDimension<T> setX(T x);
+    MutableDimension<T> setY(T y);
+    MutableDimension<T> setWidth(T width);
+    MutableDimension<T> setHeight(T height);
+
+    MutableDimension<T> move(T x, T y);
+    MutableDimension<T> expand(T width, T height);
+}

src/main/java/dev/isxander/yacl/config/ConfigInstance.java

@@ -5,6 +5,16 @@
 import java.lang.reflect.InvocationTargetException;
 import java.util.function.BiFunction;
 
+/**
+ * Responsible for handing the actual config data type.
+ * Holds the instance along with a final default instance
+ * to reference default values for options and should not be changed.
+ *
+ * Abstract methods to save and load the class, implementations are responsible for
+ * how it saves and load.
+ *
+ * @param <T> config data type
+ */
 public abstract class ConfigInstance<T> {
     private final Class<T> configClass;
     private final T defaultInstance;
@@ -18,7 +28,6 @@ public ConfigInstance(Class<T> configClass) {
         } catch (InstantiationException | IllegalAccessException | NoSuchMethodException | InvocationTargetException e) {
             throw new IllegalStateException(String.format("Could not create default instance of config for %s. Make sure there is a default constructor!", this.configClass.getSimpleName()));
         }
-
     }
 
     public T getConfig() {

src/main/java/dev/isxander/yacl/config/YACLConfigManager.java

@@ -3,24 +3,58 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Simple storage of config instances ({@link ConfigInstance}) for ease of access.
+ */
 @SuppressWarnings("unchecked")
 public class YACLConfigManager {
     private static final Map<Class<?>, ConfigInstance<?>> configs = new HashMap<>();
 
+    /**
+     * Registers and loads a config instance
+     *
+     * @param configInstance config to register
+     * @param <T> config data type
+     */
     public static <T> void register(ConfigInstance<T> configInstance) {
         configs.put(configInstance.getConfigClass(), configInstance);
         configInstance.load();
     }
 
+    /**
+     * Retrieves config data for a certain config.
+     * <p>
+     * Shorthand of {@code YACLConfigManager.getConfigInstance(configClass).getConfig()}
+     *
+     * @param configClass config data to get
+     * @return config data
+     * @param <T> config data type
+     */
     public static <T> T getConfigData(Class<T> configClass) {
         return ((ConfigInstance<T>) configs.get(configClass)).getConfig();
     }
 
+    /**
+     * Retrieves the config instance for a certain config.
+     *
+     * @param configClass config data type instance is bound to
+     * @return config instance
+     * @param <T> config data type
+     */
     public static <T> ConfigInstance<T> getConfigInstance(Class<T> configClass) {
         return (ConfigInstance<T>) configs.get(configClass);
     }
 
-    public static <T, I extends ConfigInstance<T>> I getConfigInstanceType(Class<T> configClass) {
-        return (I) configs.get(configClass);
+    /**
+     * Very similar to {@link YACLConfigManager#getConfigInstance(Class)} but can retrieve
+     * a certain implementation of {@link ConfigInstance}
+     *
+     * @param configClass config data type is bound to
+     * @return config instance
+     * @param <T> config data type
+     * @param <U> config instance type
+     */
+    public static <T, U extends ConfigInstance<T>> U getConfigInstanceType(Class<T> configClass) {
+        return (U) configs.get(configClass);
     }
 }

src/main/java/dev/isxander/yacl/gui/AbstractWidget.java

@@ -22,7 +22,7 @@ public abstract class AbstractWidget implements Element, Drawable, Selectable {
     protected final TextRenderer textRenderer = client.textRenderer;
     protected final int inactiveColor = 0xFFA0A0A0;
 
-    protected Dimension<Integer> dim;
+    private Dimension<Integer> dim;
 
     public AbstractWidget(Dimension<Integer> dim) {
         this.dim = dim;
@@ -32,6 +32,10 @@ public void postRender(MatrixStack matrices, int mouseX, int mouseY, float delta
 
     }
 
+    public boolean canReset() {
+        return false;
+    }
+
     @Override
     public boolean isMouseOver(double mouseX, double mouseY) {
         if (dim == null) return false;

src/main/java/dev/isxander/yacl/gui/OptionListWidget.java

@@ -28,6 +28,9 @@ public class OptionListWidget extends ElementListWidget<OptionListWidget.Entry>
 
     private ImmutableList<Entry> viewableChildren;
 
+    private double smoothScrollAmount = getScrollAmount();
+    private boolean returnSmoothAmount = false;
+
     public OptionListWidget(YACLScreen screen, MinecraftClient client, int width, int height) {
         super(client, width / 3 * 2, height, 0, height, 22);
         this.yaclScreen = screen;
@@ -62,7 +65,7 @@ public void refreshOptions() {
 
                 List<OptionEntry> optionEntries = new ArrayList<>();
                 for (Option<?> option : group.options()) {
-                    OptionEntry entry = new OptionEntry(category, group, option.controller().provideWidget(yaclScreen, Dimension.ofInt(getRowLeft(), 0, getRowWidth(), 20)), viewableSupplier);
+                    OptionEntry entry = new OptionEntry(option, category, group, option.controller().provideWidget(yaclScreen, Dimension.ofInt(getRowLeft(), 0, getRowWidth(), 20)), viewableSupplier);
                     addEntry(entry);
                     optionEntries.add(entry);
                 }
@@ -148,14 +151,34 @@ protected void renderList(MatrixStack matrices, int mouseX, int mouseY, float de
         }
     }
 
+    /* END cloth config code */
+
+    @Override
+    public void render(MatrixStack matrices, int mouseX, int mouseY, float delta) {
+        smoothScrollAmount = MathHelper.lerp(MinecraftClient.getInstance().getLastFrameDuration() * 0.5, smoothScrollAmount, getScrollAmount());
+        returnSmoothAmount = true;
+        super.render(matrices, mouseX, mouseY, delta);
+        returnSmoothAmount = false;
+    }
+
+    /**
+     * awful code to only use smooth scroll state when rendering,
+     * not other code that needs target scroll amount
+     */
+    @Override
+    public double getScrollAmount() {
+        if (returnSmoothAmount)
+            return smoothScrollAmount;
+
+        return super.getScrollAmount();
+    }
+
     public void postRender(MatrixStack matrices, int mouseX, int mouseY, float delta) {
         for (Entry entry : children()) {
             entry.postRender(matrices, mouseX, mouseY, delta);
         }
     }
 
-    /* END cloth config code */
-
     @Override
     public int getRowWidth() {
         return Math.min(396, (int)(width / 1.3f));
@@ -178,7 +201,7 @@ public boolean mouseScrolled(double mouseX, double mouseY, double amount) {
                 return true;
         }
 
-        this.setScrollAmount(this.getScrollAmount() - amount * (double) (getMaxScroll() / getEntryCount()) / 2.0D);
+        this.setScrollAmount(this.getScrollAmount() - amount * 20 /* * (double) (getMaxScroll() / getEntryCount()) / 2.0D */);
         return true;
     }
 
@@ -221,7 +244,7 @@ public void recacheViewableChildren() {
         int i = 0;
         for (Entry entry : viewableChildren) {
             if (entry instanceof OptionEntry optionEntry)
-                optionEntry.widget.setDimension(optionEntry.widget.getDimension().setY(getRowTop(i)));
+                optionEntry.widget.setDimension(optionEntry.widget.getDimension().withY(getRowTop(i)));
             i++;
         }
     }
@@ -250,29 +273,48 @@ protected boolean isHovered() {
     }
 
     public class OptionEntry extends Entry {
+        public final Option<?> option;
         public final ConfigCategory category;
         public final OptionGroup group;
 
         public final AbstractWidget widget;
         private final Supplier<Boolean> viewableSupplier;
 
+        private final TextScaledButtonWidget resetButton;
+
         private final String categoryName;
         private final String groupName;
 
-        private OptionEntry(ConfigCategory category, OptionGroup group, AbstractWidget widget, Supplier<Boolean> viewableSupplier) {
+        private OptionEntry(Option<?> option, ConfigCategory category, OptionGroup group, AbstractWidget widget, Supplier<Boolean> viewableSupplier) {
+            this.option = option;
             this.category = category;
             this.group = group;
             this.widget = widget;
             this.viewableSupplier = viewableSupplier;
             this.categoryName = category.name().getString().toLowerCase();
             this.groupName = group.name().getString().toLowerCase();
+            if (this.widget.canReset()) {
+                this.widget.setDimension(this.widget.getDimension().expanded(-21, 0));
+                this.resetButton = new TextScaledButtonWidget(widget.getDimension().xLimit() + 1, -50, 20, 20, 2f, Text.of("\u21BB"), button -> {
+                    option.requestSetDefault();
+                });
+                option.addListener((opt, val) -> this.resetButton.active = !opt.isPendingValueDefault() && opt.available());
+                this.resetButton.active = !option.isPendingValueDefault() && option.available();
+            } else {
+                this.resetButton = null;
+            }
         }
 
         @Override
         public void render(MatrixStack matrices, int index, int y, int x, int entryWidth, int entryHeight, int mouseX, int mouseY, boolean hovered, float tickDelta) {
-            widget.setDimension(widget.getDimension().setY(y));
+            widget.setDimension(widget.getDimension().withY(y));
 
             widget.render(matrices, mouseX, mouseY, tickDelta);
+
+            if (resetButton != null) {
+                resetButton.y = y;
+                resetButton.render(matrices, mouseX, mouseY, tickDelta);
+            }
         }
 
         @Override
@@ -312,12 +354,18 @@ public int getItemHeight() {
 
         @Override
         public List<? extends Selectable> selectableChildren() {
-            return ImmutableList.of(widget);
+            if (resetButton == null)
+                return ImmutableList.of(widget);
+
+            return ImmutableList.of(widget, resetButton);
         }
 
         @Override
         public List<? extends Element> children() {
-            return ImmutableList.of(widget);
+            if (resetButton == null)
+                return ImmutableList.of(widget);
+
+            return ImmutableList.of(widget, resetButton);
         }
     }
 

src/main/java/dev/isxander/yacl/gui/TextScaledButtonWidget.java

@@ -0,0 +1,43 @@
+package dev.isxander.yacl.gui;
+
+import net.minecraft.client.MinecraftClient;
+import net.minecraft.client.font.TextRenderer;
+import net.minecraft.client.gui.widget.ButtonWidget;
+import net.minecraft.client.util.math.MatrixStack;
+import net.minecraft.text.OrderedText;
+import net.minecraft.text.Text;
+import net.minecraft.util.math.MathHelper;
+
+public class TextScaledButtonWidget extends ButtonWidget {
+    public float textScale;
+
+    public TextScaledButtonWidget(int x, int y, int width, int height, float textScale, Text message, PressAction onPress) {
+        super(x, y, width, height, message, onPress);
+        this.textScale = textScale;
+    }
+
+    public TextScaledButtonWidget(int x, int y, int width, int height, float textScale, Text message, PressAction onPress, TooltipSupplier tooltipSupplier) {
+        super(x, y, width, height, message, onPress, tooltipSupplier);
+        this.textScale = textScale;
+    }
+
+    @Override
+    public void renderButton(MatrixStack matrices, int mouseX, int mouseY, float delta) {
+        // prevents super from rendering text
+        Text message = getMessage();
+        setMessage(Text.empty());
+
+        super.renderButton(matrices, mouseX, mouseY, delta);
+
+        setMessage(message);
+        int j = this.active ? 16777215 : 10526880;
+        OrderedText orderedText = getMessage().asOrderedText();
+        TextRenderer textRenderer = MinecraftClient.getInstance().textRenderer;
+
+        matrices.push();
+        matrices.translate(((this.x + this.width / 2f) - textRenderer.getWidth(orderedText) * textScale / 2), (float)this.y + (this.height - 8 * textScale) / 2f / textScale, 0);
+        matrices.scale(textScale, textScale, 1);
+        textRenderer.drawWithShadow(matrices, orderedText, 0, 0, j | MathHelper.ceil(this.alpha * 255.0F) << 24);
+        matrices.pop();
+    }
+}

src/main/java/dev/isxander/yacl/gui/YACLScreen.java

@@ -3,6 +3,7 @@
 import com.mojang.blaze3d.systems.RenderSystem;
 import dev.isxander.yacl.api.*;
 import dev.isxander.yacl.api.utils.Dimension;
+import dev.isxander.yacl.api.utils.MutableDimension;
 import dev.isxander.yacl.api.utils.OptionUtils;
 import net.minecraft.client.font.MultilineText;
 import net.minecraft.client.font.TextRenderer;
@@ -48,7 +49,7 @@ protected void init() {
         columnWidth = Math.min(columnWidth, 400);
         int paddedWidth = columnWidth - padding * 2;
 
-        Dimension<Integer> actionDim = Dimension.ofInt(width / 3 / 2, height - padding - 20, paddedWidth, 20);
+        MutableDimension<Integer> actionDim = Dimension.ofInt(width / 3 / 2, height - padding - 20, paddedWidth, 20);
         finishedSaveButton = new TooltipButtonWidget(this, actionDim.x() - actionDim.width() / 2, actionDim.y(), actionDim.width(), actionDim.height(), Text.empty(), Text.empty(), (btn) -> {
             saveButtonMessage = null;